openapi: 3.2.0
info:
  title: Gr4vy Refunds API
  description: The Gr4vy API.
  version: 1.0.0
tags:
- name: Refunds
  description: Manage transaction refunds.
paths:
  /transactions/{transaction_id}/refunds:
    get:
      tags:
      - Refunds
      summary: List transaction refunds
      description: List refunds for a transaction.
      operationId: list_transaction_refunds
      security:
      - OAuth2PasswordBearer:
        - transactions.read
      parameters:
      - name: transaction_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the transaction
          examples:
          - 7099948d-7286-47e4-aad8-b68f7eb44591
          title: Transaction Id
        description: The ID of the transaction
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refunds'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: list
      x-speakeasy-group: transactions.refunds
    post:
      tags:
      - Refunds
      summary: Create transaction refund
      description: Create a refund for a transaction.
      operationId: create_transaction_refund
      security:
      - OAuth2PasswordBearer:
        - transactions.write
      parameters:
      - name: transaction_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the transaction
          examples:
          - 7099948d-7286-47e4-aad8-b68f7eb44591
          title: Transaction Id
        description: The ID of the transaction
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      - name: idempotency-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.
          examples:
          - request-12345
          title: Idempotency-Key
        description: A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionRefundCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: create
      x-speakeasy-group: transactions.refunds
  /transactions/{transaction_id}/refunds/{refund_id}:
    get:
      tags:
      - Refunds
      summary: Get transaction refund
      description: Fetch refund for a transaction.
      operationId: get_transaction_refund
      security:
      - OAuth2PasswordBearer:
        - transactions.read
      parameters:
      - name: transaction_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the transaction
          examples:
          - 7099948d-7286-47e4-aad8-b68f7eb44591
          title: Transaction Id
        description: The ID of the transaction
      - name: refund_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the refund
          examples:
          - 6a1d4e46-14ed-4fe1-a45f-eff4e025d211
          title: Refund Id
        description: The ID of the refund
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: get
      x-speakeasy-group: transactions.refunds
  /refunds/{refund_id}:
    get:
      tags:
      - Refunds
      summary: Get refund
      description: Fetch a refund.
      operationId: get_refund
      security:
      - OAuth2PasswordBearer:
        - transactions.read
      parameters:
      - name: refund_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the refund
          examples:
          - 6a1d4e46-14ed-4fe1-a45f-eff4e025d211
          title: Refund Id
        description: The ID of the refund
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refund'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: get
      x-speakeasy-group: refunds
  /transactions/{transaction_id}/refunds/all:
    post:
      tags:
      - Refunds
      summary: Create batch transaction refund
      description: Create a refund for all instruments on a transaction.
      operationId: create_full_transaction_refund
      security:
      - OAuth2PasswordBearer:
        - transactions.write
        - gift-cards.write
      parameters:
      - name: transaction_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the transaction
          examples:
          - 7099948d-7286-47e4-aad8-b68f7eb44591
          title: Transaction Id
        description: The ID of the transaction
      - name: x-gr4vy-merchant-account-id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: The ID of the merchant account to use for this request.
          examples:
          - default
          title: X-Gr4Vy-Merchant-Account-Id
        description: The ID of the merchant account to use for this request.
      - name: idempotency-key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.
          examples:
          - request-12345
          title: Idempotency-Key
        description: A unique key that identifies this request. Providing this header will make this an idempotent request. We recommend using V4 UUIDs, or another random string with enough entropy to avoid collisions.
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/TransactionRefundAllCreate'
              - type: 'null'
              title: Body
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refunds'
        '400':
          description: The request was invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: The request was unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: The credentials were invalid or the caller did not have permission to act on the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: The resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '405':
          description: The request method was not allowed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error405'
        '409':
          description: A duplicate record was found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error409'
        '425':
          description: The request was too early.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error425'
        '429':
          description: Too many requests were made.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error429'
        '500':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
        '502':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error502'
        '504':
          description: The server encountered an error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error504'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-speakeasy-name-override: create
      x-speakeasy-group: transactions.refunds.all
components:
  schemas:
    TransactionRefundCreate:
      properties:
        amount:
          anyOf:
          - type: integer
            maximum: 99999999.0
            minimum: 0.0
          - type: 'null'
          title: Amount
          description: The amount to refund, in the smallest currency unit (e.g., cents). If omitted, a full refund will be requested.
          examples:
          - 1299
        target_type:
          $ref: '#/components/schemas/RefundTargetType'
          description: The target type to refund for. This can be used to target a gift card to refund to instead of the main payment method.
          default: payment-method
          examples:
          - payment-method
        target_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Target Id
          description: The optional ID of the instrument to refund for. This is only required when the `target_type` is set to `gift-card-redemption`.
          examples:
          - 7a6c366d-9205-45ab-8021-0d9ee37f20f2
        reason:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Reason
          description: An optional reason to attach extra context to the refund request.
          examples:
          - Refund due to user request.
        external_identifier:
          anyOf:
          - type: string
            maxLength: 300
            minLength: 1
          - type: 'null'
          title: External Identifier
          description: An external identifier that can be used to match the refund against your own records.
          examples:
          - refund-12345
      additionalProperties: false
      type: object
      title: TransactionRefundCreate
    Error401:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `unauthorized`
          default: unauthorized
          examples:
          - unauthorized
        status:
          type: integer
          title: Status
          description: Always `401`.
          default: 401
          examples:
          - 401
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: No valid API authentication found
          examples:
          - No valid API authentication found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error401
    Error404:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `not_found`
          default: not_found
          examples:
          - not_found
        status:
          type: integer
          title: Status
          description: Always `404`.
          default: 404
          examples:
          - 404
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: The resource could not be found
          examples:
          - The resource could not be found
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error404
    ErrorLocation:
      type: string
      enum:
      - query
      - body
      - path
      - header
      - unknown
      title: ErrorLocation
    api__common_schemas__Creator:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        email_address:
          type: string
          title: Email Address
      additionalProperties: false
      type: object
      required:
      - id
      - name
      - email_address
      title: Creator
    Error425:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_early`
          default: too_early
          examples:
          - too_early
        status:
          type: integer
          title: Status
          description: Always `425`.
          default: 425
          examples:
          - 425
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error425
    Refund:
      properties:
        type:
          type: string
          const: refund
          title: Type
          description: Always `refund`.
          default: refund
          examples:
          - refund
        id:
          type: string
          format: uuid
          title: Id
          description: The unique identifier for the refund.
          examples:
          - 6a1d4e46-14ed-4fe1-a45f-eff4e025d211
        transaction_id:
          type: string
          format: uuid
          title: Transaction Id
          description: The ID of the transaction associated with this refund.
          examples:
          - 7099948d-7286-47e4-aad8-b68f7eb44591
        payment_service_refund_id:
          anyOf:
          - type: string
            maxLength: 300
            minLength: 1
          - type: 'null'
          title: Payment Service Refund Id
          description: The payment service's unique ID for the refund.
          examples:
          - refund_xYqd43gySMtori
        status:
          $ref: '#/components/schemas/RefundStatus'
          description: The status of the refund.
          examples:
          - succeeded
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          title: Currency
          description: The ISO 4217 currency code for this refund. Will always match that of the associated transaction.
          examples:
          - EUR
          - GBP
          - USD
        amount:
          type: integer
          maximum: 99999999.0
          minimum: 0.0
          title: Amount
          description: The amount of this refund, in the smallest currency unit (for example, cents or pence).
          examples:
          - 1299
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: The reason for this refund. Could be a multiline string.
          examples:
          - Refund due to user request.
        target_type:
          $ref: '#/components/schemas/RefundTargetType'
          description: The type of the instrument that was refunded.
          examples:
          - payment-method
        target_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Target Id
          description: The optional ID of the instrument that was refunded. This may be `null` if the instrument was not stored.
          examples:
          - 07e70d14-a0c0-4ff5-bd4a-509959af0e4d
        reconciliation_id:
          type: string
          title: Reconciliation Id
          description: The base62 encoded refund ID. This represents a shorter version of this refund's `id` which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's refund against our system.
          examples:
          - 7jZXl4gBUNl0CnaLEnfXbt
        external_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: External Identifier
          description: An external identifier that can be used to match the refund against your own records.
          examples:
          - refund-12345
        transaction_reconciliation_id:
          type: string
          title: Transaction Reconciliation Id
          description: The base62 encoded transaction ID. This represents a shorter version of the related transaction's `id` which is sent to payment services, anti-fraud services, and other connectors. You can use this ID to reconcile a payment service's transaction against our system.
          examples:
          - aLEnfXbt7jZXl4gBUNl0Cn
        transaction_external_identifier:
          anyOf:
          - type: string
          - type: 'null'
          title: Transaction External Identifier
          description: An external identifier that can be used to match the transaction against your own records.
          examples:
          - transaction-12345
        created_at:
          type: string
          format: date-time
          title: Created At
          description: The date this refund was created at.
          examples:
          - '2013-07-16T19:23:00.000+00:00'
        updated_at:
          type: string
          format: date-time
          title: Updated At
          description: The date this refund was last updated at.
          examples:
          - '2013-07-16T19:23:00.000+00:00'
        creator:
          anyOf:
          - $ref: '#/components/schemas/api__common_schemas__Creator'
          - type: 'null'
          description: The user that created this resource
          examples:
          - email_address: jhon.doe@gr4vy.com
            id: 07e70d14-a0c0-4ff5-bd4a-509959af0e4d
            name: Jhon Doe
        error_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Code
          description: The standardized error code set by Gr4vy.
          examples:
          - service_error
        raw_response_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Raw Response Code
          description: This is the response code received from the payment service. This can be set to any value and is not standardized across different payment services.
          examples:
          - E104
        raw_response_description:
          anyOf:
          - type: string
          - type: 'null'
          title: Raw Response Description
          description: ' This is the response description received from the payment service. This can be set to any value and is not standardized across different payment services.'
          examples:
          - Missing redirect URL
        settled_currency:
          anyOf:
          - type: string
            pattern: ^[A-Z]{3}$
            examples:
            - EUR
            - GBP
            - USD
          - type: 'null'
          title: Settled Currency
          description: The ISO 4217 currency code of this refund's settlement.
          examples:
          - USD
        settled_amount:
          type: integer
          title: Settled Amount
          description: The net amount settled for this refund, in the smallest currency unit (for example, cents or pence).
          default: 0
          examples:
          - 1100
        settled:
          type: boolean
          title: Settled
          description: Indicates whether this refund has been settled.
          examples:
          - true
      additionalProperties: false
      type: object
      required:
      - id
      - transaction_id
      - status
      - currency
      - amount
      - target_type
      - reconciliation_id
      - transaction_reconciliation_id
      - created_at
      - updated_at
      - settled
      title: Refund
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        location:
          $ref: '#/components/schemas/ErrorLocation'
          description: The part of the request where the property can be found that caused the error.
          examples:
          - body
        pointer:
          anyOf:
          - type: string
            format: json-pointer
          - type: string
          title: Pointer
          description: A JSON pointer for the particular property that caused the error.
          examples:
          - /currency
        message:
          type: string
          title: Message
          description: A human-readdable explanation of the error.
          examples:
          - 'Unknown ISO 4217 currency code: USX'
        type:
          type: string
          title: Type
          description: The type of error that was raised for this property.
          examples:
          - value_error
      additionalProperties: false
      type: object
      required:
      - location
      - pointer
      - message
      - type
      title: ErrorDetail
    Error405:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `method_not_allowed`
          default: method_not_allowed
          examples:
          - method_not_allowed
        status:
          type: integer
          title: Status
          description: Always `405`.
          default: 405
          examples:
          - 405
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Method Not Allowed
          examples:
          - Method Not Allowed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error405
    Error429:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `too_many_requests`
          default: too_many_requests
          examples:
          - too_many_requests
        status:
          type: integer
          title: Status
          description: Always `429`.
          default: 429
          examples:
          - 429
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error429
    Refunds:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Refund'
          type: array
          title: Items
          description: A list of items returned for this request.
        limit:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Limit
          description: The number of items for this page.
          default: 20
          examples:
          - 20
        next_cursor:
          anyOf:
          - type: string
            maxLength: 1000
            minLength: 1
          - type: 'null'
          title: Next Cursor
          description: The cursor pointing at the next page of items.
          examples:
          - ZXhhbXBsZTE
        previous_cursor:
          anyOf:
          - type: string
            maxLength: 1000
            minLength: 1
          - type: 'null'
          title: Previous Cursor
          description: The cursor pointing at the previous page of items.
          examples:
          - Xkjss7asS
      additionalProperties: false
      type: object
      required:
      - items
      title: Refunds
    Error500:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `server_error`
          default: server_error
          examples:
          - server_error
        status:
          type: integer
          title: Status
          description: Always `500`.
          default: 500
          examples:
          - 500
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error500
    RefundTargetType:
      type: string
      enum:
      - payment-method
      - gift-card-redemption
      title: RefundTargetType
    Error504:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `gateway_timeout`
          default: gateway_timeout
          examples:
          - gateway_timeout
        status:
          type: integer
          title: Status
          default: 504
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error504
    Error400:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_request`
          default: bad_request
          examples:
          - bad_request
        status:
          type: integer
          title: Status
          description: Always `400`.
          default: 400
          examples:
          - 400
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error400
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Error502:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `bad_gateway`
          default: bad_gateway
          examples:
          - bad_gateway
        status:
          type: integer
          title: Status
          description: Always `502`.
          default: 502
          examples:
          - 502
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Request could not be processed
          examples:
          - Request could not be processed
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error502
    TransactionRefundAllCreate:
      properties:
        reason:
          anyOf:
          - type: string
            maxLength: 100
          - type: 'null'
          title: Reason
          description: An optional reason to attach extra context to the refund requests.
          examples:
          - Refund due to user request.
        external_identifier:
          anyOf:
          - type: string
            maxLength: 300
            minLength: 1
          - type: 'null'
          title: External Identifier
          description: An external identifier that can be used to match the refunds against your own records.
          examples:
          - refund-12345
      additionalProperties: false
      type: object
      title: TransactionRefundAllCreate
    RefundStatus:
      type: string
      enum:
      - processing
      - succeeded
      - failed
      - declined
      - voided
      title: RefundStatus
    Error409:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `duplicate_record`
          default: duplicate_record
          examples:
          - duplicate_record
        status:
          type: integer
          title: Status
          description: Always `409`.
          default: 409
          examples:
          - 409
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
        resource_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Resource Id
          description: The ID of the conflicting resource.
          examples:
          - cdc70639-cb9c-4222-a73f-b8ce39f7821b
      additionalProperties: false
      type: object
      title: Error409
    Error403:
      properties:
        type:
          type: string
          const: error
          title: Type
          description: Always `error`.
          default: error
          examples:
          - error
        code:
          type: string
          title: Code
          description: Always `forbidden`
          default: forbidden
          examples:
          - forbidden
        status:
          type: integer
          title: Status
          description: Always `403`.
          default: 403
          examples:
          - 403
        message:
          type: string
          title: Message
          description: A human readable message that provides more context to the error.
          default: Generic error
          examples:
          - Request failed validation
        details:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          title: Details
          description: A list of details that further ellaborate on the error.
          default: []
      additionalProperties: false
      type: object
      title: Error403
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes:
            embed: Shorthand for all gr4vy embed related scopes
            sessions.refresh: Refresh access-token
            anti-fraud-service-definitions.read: Read Anti Fraud Service Definitions
            anti-fraud-services.read: Read Anti Fraud Services
            api-key-pairs.read: Read API Key Pairs
            api-logs.read: Read API Logs
            apple-pay-certificates.read: Read Apple Pay Certificates
            audit-logs.read: Read Audit Logs
            bin-checker.read: Read BIN Checker
            buyers.read: Read Buyers
            buyers.billing-details.read: Read Billing Details
            card-scheme-definitions.read: Read Card Scheme Definitions
            checkout-sessions.read: Read Checkout Sessions
            connections.read: Read Connections
            digital-wallets.read: Read Digital Wallets
            flows.read: Read Flows
            gift-card-service-definitions.read: Read Gift Card Service Definitions
            gift-card-services.read: Read Gift Card Services
            gift-cards.read: Read Gift Cards
            merchant-accounts.read: Read Merchant Accounts
            payment-links.read: Read Payment Links
            payment-method-definitions.read: Read Payment Method Definitions
            payment-methods.read: Read Payment Methods
            payment-options.read: Read Payment Options
            payment-service-definitions.read: Read Payment Service Definitions
            payment-services.read: Read Payment Service
            payouts.read: Read Payouts
            reports.read: Read Reports
            roles.read: Read Roles
            three-ds-scenarios.read: Read 3DS Scenarios
            transactions.read: Read Transactions
            users.me.read: Read User Profile
            vault-forward.read: Read Vault Forward
            vault-forward-authentications.read: Read Vault Forward Authentications
            vault-forward-configs.read: Read Vault Forward Configurations
            vault-forward-definitions.read: Read Vault Forward Definitions
            webhook-subscriptions.read: Read Webhook Subscriptions
            business-contexts.read: Read Business Contexts
            health-dashboard.read: Read Health Dashboard
            metrics-explorer.read: Read Metrics Explorer
            monitoring.read: Read Monitoring
            reset.read: Read Reset
            sessions.read: Read Sessions
            users.read: Read Users
            anti-fraud-service-definitions.write: Write Anti Fraud Service Definitions
            anti-fraud-services.write: Write Anti Fraud Services
            api-key-pairs.write: Write API Key Pairs
            api-logs.write: Write API Logs
            apple-pay-certificates.write: Write Apple Pay Certificates
            audit-logs.write: Write Audit Logs
            bin-checker.write: Write BIN Checker
            buyers.write: Write Buyers
            buyers.billing-details.write: Write Billing Details
            card-scheme-definitions.write: Write Card Scheme Definitions
            checkout-sessions.write: Write Checkout Sessions
            connections.write: Write Connections
            digital-wallets.write: Write Digital Wallets
            flows.write: Write Flows
            gift-card-service-definitions.write: Write Gift Card Service Definitions
            gift-card-services.write: Write Gift Card Services
            gift-cards.write: Write Gift Cards
            merchant-accounts.write: Write Merchant Accounts
            payment-links.write: Write Payment Links
            payment-method-definitions.write: Write Payment Method Definitions
            payment-methods.write: Write Payment Methods
            payment-options.write: Write Payment Options
            payment-service-definitions.write: Write Payment Service Definitions
            payment-services.write: Write Payment Service
            payouts.write: Write Payouts
            reports.write: Write Reports
            roles.write: Write Roles
            three-ds-scenarios.write: Write 3DS Scenarios
            transactions.write: Write Transactions
            users.me.write: Write User Profile
            vault-forward.write: Write Vault Forward
            vault-forward-authentications.write: Write Vault Forward Authentications
            vault-forward-configs.write: Write Vault Forward Configurations
            vault-forward-definitions.write: Write Vault Forward Definitions
            webhook-subscriptions.write: Write Webhook Subscriptions
            business-contexts.write: Write Business Contexts
            health-dashboard.write: Write Health Dashboard
            metrics-explorer.write: Write Metrics Explorer
            monitoring.write: Write Monitoring
            reset.write: Write Reset
            sessions.write: Write Sessions
            users.write: Write Users
          tokenUrl: auth/token