openapi: 3.2.0
info:
  title: Gr4vy Payment Method Definitions API
  version: 1.1.0-beta
  contact:
    name: Gr4vy Support
    email: code@gr4vy.com
    url: https://gr4vy.com
  termsOfService: https://gr4vy.com
  license:
    name: MIT
    url: https://raw.githubusercontent.com/gr4vy/gr4vy-openapi/main/LICENSE
  description: 'Welcome to the Gr4vy API reference documentation.

    Our API is still very much a work in product and subject to change.'
servers:
- url: https://api.sandbox.{id}.gr4vy.app
  x-speakeasy-server-id: sandbox
  variables:
    id:
      default: example
      description: The subdomain for your Gr4vy instance.
- url: https://api.{id}.gr4vy.app
  x-speakeasy-server-id: production
  variables:
    id:
      default: example
      description: The subdomain for your Gr4vy instance.
security:
- bearerAuth: []
tags:
- name: Payment Method Definitions
  description: Payment Method definitions provide display information to a payment method.
paths:
  /payment-method-definitions:
    get:
      operationId: list-payment-method-definitions
      summary: List payment method definitions
      description: Returns a list of all available payment method definitions.
      tags:
      - Payment Method Definitions
      responses:
        '200':
          description: Returns a list of payment method definitions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDefinitions'
        '401':
          description: Returns an error if no valid authentication was provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401Unauthorized'
components:
  schemas:
    PaymentMethodDefinitions:
      title: Payment Method Definitions
      type: object
      description: A list of available payment method definitions.
      x-tags:
      - Payment Method Definitions
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/PaymentMethodDefinition'
    Error401Unauthorized:
      title: Unauthorized Error
      type: object
      description: Unauthorized Error (HTTP 401).
      x-tags:
      - Errors
      properties:
        type:
          type: string
          description: '`error`.'
          enum:
          - error
          example: error
        code:
          type: string
          description: '`unauthorized`.'
          example: unauthorized
          enum:
          - unauthorized
        status:
          type: integer
          description: '`401`.'
          example: 401
          enum:
          - 401
        message:
          type: string
          description: No valid API authentication found.
          example: No valid API authentication found
          enum:
          - No valid API authentication found
        details:
          type: array
          description: 'A list of detail objects that further clarify the reason for the error.

            Not every error supports more detail.'
          example: []
          items:
            $ref: '#/components/schemas/ErrorDetail'
    PaymentMethodDefinition:
      title: Payment Method Definition
      type: object
      description: Definitions of a payment method including icon, label, etc.
      x-tags:
      - Payment Method Definitions
      properties:
        id:
          type: string
          description: The mode of this payment method.
          example: bank
        icon_url:
          type: string
          description: The icon for this payment method.
          example: https://api.sandbox.example.gr4vy.app/assets/payment-method-definitions/bank.svg
        display_name:
          type: string
          description: The display name of this payment method.
          example: Bank
        long_display_name:
          type: string
          description: The long display name of this payment method.
          example: Bank (BACS)
        method:
          type: string
          description: The method, or type, for this payment method.
          example: BACS
    ErrorDetail:
      title: Error details
      description: Additional detail about the part of a request body that caused an issue.
      type: object
      x-tags:
      - Errors
      properties:
        location:
          type: string
          example: body
          description: The location where the error caused an issue.
          enum:
          - query
          - body
          - path
          - header
        type:
          type: string
          example: value_error.missing
          description: A unique identifier for the type of error that occurred.
        pointer:
          type: string
          example: /payment_method/number
          description: 'The exact item for which the validation did not succeed. This is a JSON

            pointer for request bodies, while for query, path, and header parameters

            it is the name of the parameter.'
        message:
          type: string
          example: field required
          description: A human readable message for this error detail.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT