openapi: 3.1.0
info:
  title: Getpaid Accounts Payments API
  version: v2
  contact:
    email: support@getpaid.io
  description: '# Getting started


    Our APIs provide programmatic access to the Getpaid solution. This page contains a comprehensive reference for all

    resources of the Getpaid public API. For walkthrough documentation please see [Getpaid guides](/) for step by step usage

    of the Getpaid platform including the API and [Getpaid API integration](/integration/api) for the technical aspects of

    this Getpaid API.


    To get started, book a demo and sign up at <https://getpaid.io>. This will give you access to the [Getpaid

    dashboard](https://dashboard.getpaid.io) where you can configure your account and retrieve your credentials needed to

    authenticate with Getpaid API.


    ## Postman


    Getpaid provides a Postman collection to test the API features in sandbox. You can [download the Postman collection and

    the environments](/integration/api/postman) to start testing the Getpaid API.


    ## Fields formats


    | Type | Format |

    | :- | :- |

    | `amount-minor` | Amount in the minor currency unit (e.g. 100 cents for 1 EUR). |

    | `country` | The country code fields follow the [ISO 3166-1 alpha-2 standard](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) in uppercase. Examples: `DE`, `US`. |

    | `currency` | The currency code fields follow the [ISO 4217 standard](https://en.wikipedia.org/wiki/ISO_4217) in uppercase. Examples: `EUR`, `USD`. |

    | `date` | Dates are formatted using the complete date format according to the [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime): `YYYY-MM-DD`. Example: `2023-09-30`.                                        |

    | `date-time` | Date-time fields are formatted using the [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime) for the combined date and time in UTC with 3 seconds fractional digits: `YYYY-MM-DDThh:mm:ss.SSSZ`. Example: `2015-09-01T23:59:59.479Z`. |

    | `date-time-offset` | Date-time fields with time-zone are formatted [ISO 8601 standard](https://www.w3.org/TR/NOTE-datetime) for the combined date and time with the time-zone and no second fractional digits: `YYYY-MM-DDThh:mm:ssTZD`. Example: `2015-09-01T23:59:59+01:00`. |

    | `email` | Email fields should follow the [RFC 5322](https://tools.ietf.org/html/rfc5322) standard. Example: `jon.smith@acme.com` |

    | `hex-color` | Colors are represented as a string starting with `#` followed by six hexadecimal digits. Each pair of digits represents the intensity of red, green, and blue components respectively. Examples: `#FFFFFF`, `#000000`, `#FF5733`. |

    | `id` | Identifiers are formatted as a string of 3 alphabetic characters (which represents the type of the identified object), one underscore and 26 alphanumeric characters. Every identifier generated in our system is globally unique. Examples: `acc_44678r08jtm8zbt227tzhc4nw5`, `doc_473cr1y0ghbyc3m1yfbwvn3nxx`. |

    | `ip-address` | IP fields are formatted using the [Internet Protocol version 4 (IPv4)](https://en.wikipedia.org/wiki/Internet_Protocol_version_4) standard: `x.x.x.x` where `x` must be a decimal value between `0` and `255`. Example: `192.158.1.38`. |

    | `version` | A resource version. For resources that can evolved over time, a unique reference of the snapshot used in other resource. For example, the account information used for a payment, the information used for the statement descriptor or the processing configuration are tighted to the version of the account. |

    '
servers:
- url: https://api.getpaid.io
  description: Live
- url: https://api.sandbox.getpaid.io
  description: Sandbox
tags:
- name: Payments
  description: 'Create and manage payments initiated by the platform on behalf of the buyer.


    For recurring and unscheduled payments based on a previous standing instruction.

    '
paths:
  /v2/payments:
    post:
      tags:
      - Payments
      summary: Create a payment
      description: 'Create a payment initiated by the platform on behalf of a buyer.


        Related webhooks:


        - [`payment_captured`](#tag/Accept-payments-webhooks/operation/payment_captured): sent when the payment funds are captured and secured.

        - [`payment_failed`](#tag/Accept-payments-webhooks/operation/payment_failed): sent when a payment fails due to business (decline) or technical issues.

        '
      operationId: create_payment
      security:
      - OAuth:
        - payments:read_write
      parameters:
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentRequest'
            examples:
              CreateSubsequentPayment:
                $ref: '#/components/examples/CreateSubsequentPayment'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentResponse'
              examples:
                PaymentCreated:
                  $ref: '#/components/examples/PaymentCreated'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/payments/{payment_id}:
    get:
      tags:
      - Payments
      summary: Get a payment
      description: Retrieve a payment.
      operationId: get_payment
      security:
      - OAuth:
        - payments:read
      - OAuth:
        - payments:read_write
      parameters:
      - name: payment_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/PaymentId'
      responses:
        '200':
          description: OK
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentResponse'
              examples:
                CompletePayment:
                  $ref: '#/components/examples/CompletePayment'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '404':
          $ref: '#/components/responses/404NotFound'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/payments/{payment_id}/refunds:
    post:
      tags:
      - Payments
      summary: Refund a payment
      description: 'Refund a captured payment fully or partially.


        Related webhooks:


        - [`payment_refunded`](#tag/Accept-payments-webhooks/operation/payment_refunded): sent when the funds are returned to the buyer.

        - [`payment_refund_failed`](#tag/Accept-payments-webhooks/operation/payment_refund_failed): sent when a refund process fails due to business or technical issues.

        '
      operationId: refund_payment
      security:
      - OAuth:
        - payments:read_write
      parameters:
      - name: payment_id
        in: path
        description: The ID of the payment to refund.
        required: true
        schema:
          $ref: '#/components/schemas/PaymentId'
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundPaymentRequest'
            examples:
              CreateFullRefund:
                $ref: '#/components/examples/CreateFullRefund'
              CreatePartialRefund:
                $ref: '#/components/examples/CreatePartialRefund'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundPaymentResponse'
              examples:
                FullRefundCreated:
                  $ref: '#/components/examples/FullRefundCreated'
                PartialRefundCreated:
                  $ref: '#/components/examples/PartialRefundCreated'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
  /v2/payments/query:
    post:
      tags:
      - Payments
      summary: Query payments
      description: 'Query payments filtering, and sorting and paginating results.


        See [Query resources](#tag/Queries/operation/query_resources) for more examples and details

        about other resources, pagination and everything related to operate the Getpaid solution.

        '
      operationId: query_payments
      security:
      - OAuth:
        - payments:read
      parameters:
      - $ref: '#/components/parameters/GetpaidIdempotencyKey'
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryPaymentsRequest'
            examples:
              QueryPayments:
                $ref: '#/components/examples/QueryPayments'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Getpaid-Trace-Id:
              $ref: '#/components/headers/GetpaidTraceId'
              required: true
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryPaymentsResponse'
              examples:
                FilteredPayments:
                  $ref: '#/components/examples/FilteredPayments'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '422':
          $ref: '#/components/responses/422InvalidParameters'
        '429':
          $ref: '#/components/responses/429TooManyRequests'
        '500':
          $ref: '#/components/responses/500InternalServerError'
components:
  examples:
    CreateSubsequentPayment:
      summary: Create a subsequent payment
      value:
        reference: ORD-202510-0232
        amount: 10000
        currency: EUR
        method:
          type: card
          dynamic_descriptor: TITAN*202510-0232
        splits:
          type: per_transaction
          accounts:
          - type: seller
            id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            split:
              type: fixed
              amount: 9000
          - type: platform
            id: acc_4q90qx2kdczs59yqfq34p09qx6
            split:
              type: fixed
              amount: 1000
            processing_fee:
              percentage: 100
        standing_instruction:
          id: sti_4tbftjwzxja1h71nzas1g0g1xm
        webhooks:
          url: https://webhooks.titanauto.com/getpaid
    CreatePartialRefund:
      summary: Create a partial refund
      value:
        type: partial
        reference: RFD-202510-0002
        amount: 500
        splits:
          accounts:
          - id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            split:
              amount: 450
          - id: acc_4q90qx2kdczs59yqfq34p09qx6
            split:
              amount: 50
        webhooks:
          url: https://webhooks.titanauto.com/getpaid
    FilteredPayments:
      summary: Filtered payments
      value:
        type: payments
        cursor: Q3VyaW9zaXR5IEtpbGxlZCB0aGUgQ2F0Cg==
        data:
        - id: pay_4y7kptsvn11qq6d354g5tx735v
          reference: ORD-202510-0232
          status: captured
          amount: 1000
          currency: EUR
          created_at: '2023-03-15T12:34:56.999Z'
          updated_at: '2023-03-15T12:34:56.999Z'
          method:
            type: card
            scheme: visa
            display_hint: 424242******4242
          seller:
            id: acc_44678r08jtm8zbt227tzhc4nw5
            legal_name: Titan Biking
          parties:
          - id: acc_5y789s19kum9act338uaic5ox6
            type: platform
            legal_name: Titan Auto Parts GmbH
        - id: pay_4y7kptsvn11qq6d354g5tx736w
          reference: ORD-202511-0133
          status: captured
          amount: 1000
          currency: EUR
          created_at: '2023-03-15T12:34:56.999Z'
          updated_at: '2023-03-15T12:34:56.999Z'
          method:
            type: card
            scheme: visa
            display_hint: 411111******1111
          seller:
            id: acc_44678r08jtm8zbt227tzhc4nw5
            legal_name: Titan Biking
          parties:
          - id: acc_5y789s19kum9act338uaic5ox6
            type: platform
            legal_name: Titan Auto Parts GmbH
    CompletePayment:
      summary: Get a payment
      value:
        id: pay_4a4m2pjycdb1jbj68h1rvk9kcz
        status: refunded
        reference: ORD-202510-0232
        created_at: '2025-09-01T22:05:48.479Z'
        updated_at: '2025-10-12T09:06:11.773Z'
        amount: 1000
        currency: EUR
        statement_descriptor: GPD*TITAN*202510-0232
        origin:
          type: api
        method:
          type: card
          display_hint: 424242******4242
          card:
            scheme: visa
            holder_name: Jane Doe
            first_digits: '424242'
            last_digits: '4242'
            expiry_month: 12
            expiry_year: 2030
        splits:
          type: per_transaction
          accounts:
          - type: seller
            id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            version: '2'
            legal_name: AutoZentrum Düsseldorf GmbH
            split:
              type: fixed
              amount: 900
            processing_fee:
              percentage: 0
          - type: platform
            id: acc_4q90qx2kdczs59yqfq34p09qx6
            version: '0'
            legal_name: Titan Auto Parts GmbH
            split:
              type: fixed
              amount: 100
            processing_fee:
              percentage: 100
        authentication:
          type: 3ds
          status: succeeded
          result:
            code: Y
            eci: '05'
        refunds:
        - id: rfd_4a4m2pjycdb1jbj68h1rvk9kcz
          status: completed
          type: full
          reference: ORD-202510-0232
          created_at: '2025-09-01T22:05:48.479Z'
          updated_at: '2025-09-01T22:05:48.479Z'
          amount: 1000
        standing_instruction:
          id: sti_4tbftjwzxja1h71nzas1g0g1xm
          status: active
          terms:
            type: recurring
          first:
            type: payment
            id: pay_4a4m2pjycdb1jbj68h1rvk9kcz
        totals:
          net: -67
          captured: 1000
          refunded: 1000
          refundable: 0
          processing_fees: 67
          accounts:
          - type: seller
            id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            version: '0'
            legal_name: Garage Deusthclangen AG
            net: 0
            captured: 900
            refunded: 900
            refundable: 0
            processing_fees: 0
          - type: platform
            id: acc_4q90qx2kdczs59yqfq34p09qx6
            version: '0'
            legal_name: Titan Auto Parts GmbH
            net: -67
            captured: 100
            refunded: 100
            refundable: 0
            processing_fees: 67
        events:
        - index: 6
          type: refund_completed
          occurred_at: '2025-10-12T09:06:11.773Z'
          amount: 1000
          currency: EUR
        - index: 5
          type: refund_initiated
          occurred_at: '2025-10-12T09:00:00.000Z'
          amount: 1000
          currency: EUR
        - index: 4
          type: captured
          occurred_at: '2025-10-01T22:05:48.479Z'
          amount: 1000
          currency: EUR
        - index: 3
          type: authorized
          occurred_at: '2025-09-01T22:05:48.479Z'
          amount: 1000
          currency: EUR
        - index: 2
          type: authenticated
          occurred_at: '2025-09-01T22:05:35.000Z'
          authentication:
            type: 3ds
        - index: 1
          type: authentication_required
          occurred_at: '2025-09-01T22:05:30.000Z'
          authentication:
            type: 3ds
        - index: 0
          type: initiated
          occurred_at: '2025-09-01T22:05:20.000Z'
          amount: 1000
          currency: EUR
    CreateFullRefund:
      summary: Create a full refund
      value:
        type: full
        reference: RFD-202510-0002
        webhooks:
          url: https://webhooks.titanauto.com/getpaid
    QueryPayments:
      summary: Query payments
      value:
        type: payments
        filters:
          seller_legal_name: Titan Biking
          statuses:
          - captured
    FullRefundCreated:
      summary: Full refund created
      value:
        id: rfd_4a4m2pjycdb1jbj68h1rvk9kcz
        type: full
        status: initiated
        reference: RFD-202510-0002
        created_at: '2025-10-25T07:11:57.761Z'
        updated_at: '2025-10-25T07:11:57.761Z'
        amount: 1000
        splits:
          accounts:
          - id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            split:
              amount: 900
          - id: acc_4q90qx2kdczs59yqfq34p09qx6
            split:
              amount: 100
    PaymentCreated:
      summary: Payment captured successfully
      value:
        id: pay_4tbftjwzxja1h71nzas1g0g1xm
        status: captured
        reference: ORD-202510-0232
        statement_descriptor: GPD*TITAN*202510-0232
        created_at: '2025-10-24T14:45:22.993Z'
        updated_at: '2025-10-24T14:45:22.993Z'
        method:
          type: card
          display_hint: 424242******4242
          card:
            scheme: visa
            holder_name: Jane Doe
            first_digits: '424242'
            last_digits: '4242'
            expiry_month: 12
            expiry_year: 2030
        splits:
          type: per_transaction
          accounts:
          - type: seller
            id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            version: '2'
            legal_name: Car Garage GmbH
            split:
              type: fixed
              amount: 9000
            processing_fee:
              percentage: 0
          - type: platform
            id: acc_4q90qx2kdczs59yqfq34p09qx6
            version: '0'
            legal_name: Titan Auto Parts GmbH
            split:
              type: fixed
              amount: 1000
            processing_fee:
              percentage: 100
        totals:
          net: 9933
          captured: 1000
          refunded: 0
          refundable: 1000
          processing_fees: 67
          accounts:
          - type: seller
            id: acc_4f5zanqzxfg9w9jj5e81bm6bc9
            version: '0'
            legal_name: Garage Deusthclangen AG
            net: 900
            captured: 900
            refunded: 0
            refundable: 900
            processing_fees: 0
          - type: platform
            id: acc_4q90qx2kdczs59yqfq34p09qx6
            version: '0'
            legal_name: Titan Auto Parts GmbH
            net: 33
            captured: 100
            refunded: 0
            refundable: 100
            processing_fees: 67
    PartialRefundCreated:
      summary: Partial refund created
      value:
        id: rfd_4a4m2pjycdb1jbj68h1rvk9kcz
        type: partial
        status: initiated
        reference: RFD-202510-0002
        created_at: '2025-10-25T07:11:57.761Z'
        updated_at: '2025-10-25T07:11:57.761Z'
  schemas:
    EstimatedUpdateBefore:
      allOf:
      - description: When the payment status is estimated to be updated next.
      - $ref: '#/components/schemas/DateTimeOffset'
    Reference:
      allOf:
      - $ref: '#/components/schemas/ShortString'
      - description: An identifier in your system. It is recommended to make it unique but the uniqueness is not enforced by the solution.
        example: ORD-202510-0232
    SplitsCalculatedAndCalculatingFees:
      description: 'The list of payment splits for the accounts involved in the funds flow.


        The final split amounts and processing fees have been calculated.

        '
      type: object
      required:
      - type
      - accounts
      properties:
        type:
          $ref: '#/components/schemas/SplitsType'
        accounts:
          description: The list of accounts involved in the payment that will receive the funds.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            description: A payment split account.
            type: object
            required:
            - type
            - id
            - version
            - legal_name
            - split
            - processing_fee
            properties:
              type:
                $ref: '#/components/schemas/SplitsAccountType'
              id:
                $ref: '#/components/schemas/AccountId'
              version:
                $ref: '#/components/schemas/AccountVersion'
              legal_name:
                $ref: '#/components/schemas/AccountLegalName'
              split:
                description: The amount in the payment currency to be allocated to this account.
                oneOf:
                - $ref: '#/components/schemas/SplitFixedAmount'
                - $ref: '#/components/schemas/SplitPercentageAmountCalculated'
                - $ref: '#/components/schemas/SplitRemainingAmountCalculated'
                discriminator:
                  propertyName: type
                  mapping:
                    fixed: '#/components/schemas/SplitFixedAmount'
                    percentage: '#/components/schemas/SplitPercentageAmountCalculated'
                    remaining: '#/components/schemas/SplitRemainingAmountCalculated'
              processing_fee:
                $ref: '#/components/schemas/ProcessingFeeCalculating'
    Version:
      description: A resource version.
      type: string
      format: version
      minLength: 1
      maxLength: 50
      example: '2'
    DateTimeOffset:
      description: 'Date-time with time zone offset in ISO 8601 format without second fractions ([RFC 9557](https://www.rfc-editor.org/rfc/rfc9557.html)).

        '
      type: string
      format: date-time-offset
      minLength: 25
      maxLength: 25
      example: '2025-09-01T22:05:48-08:00'
    AccountId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the account.
        example: acc_44678r08jtm8zbt227tzhc4nw5
    CreatePaymentRequest:
      type: object
      required:
      - reference
      - amount
      - currency
      - splits
      - standing_instruction
      properties:
        reference:
          $ref: '#/components/schemas/Reference'
        amount:
          $ref: '#/components/schemas/AmountMinor'
        currency:
          $ref: '#/components/schemas/Currency'
        method:
          $ref: '#/components/schemas/PaymentMethodRequest'
        splits:
          $ref: '#/components/schemas/SplitsRequest'
        standing_instruction:
          $ref: '#/components/schemas/SubsequentStandingInstructionRequest'
        webhooks:
          $ref: '#/components/schemas/PaymentWebhooksRequest'
    PaymentOriginCheckout:
      allOf:
      - $ref: '#/components/schemas/PaymentOriginBase'
      - required:
        - id
        properties:
          id:
            $ref: '#/components/schemas/CheckoutId'
    PaginationData:
      description: The list of queried elements.
      type: array
      items:
        type: object
    Percentage:
      type: number
      format: float
      minimum: 0
      maximum: 100
      multipleOf: 0.1
      example: 62.5
    PaymentMethodDetails:
      description: The payment method used.
      anyOf:
      - $ref: '#/components/schemas/CardPaymentMethodDetails'
      - $ref: '#/components/schemas/SddPaymentMethodDetails'
      discriminator:
        propertyName: type
        mapping:
          card: '#/components/schemas/CardPaymentMethodDetails'
          sepa_direct_debit: '#/components/schemas/SddPaymentMethodDetails'
    PartialRefundPaymentResponse:
      allOf:
      - $ref: '#/components/schemas/BaseRefundPaymentResponse'
    AmountMinor:
      type: integer
      format: amount-minor
      description: The payment amount in the minor currency unit (e.g. 100 cents for 1 EUR).
      example: 1000
    CreatePaymentResponse:
      type: object
      required:
      - id
      - status
      - reference
      - created_at
      - updated_at
      - method
      - splits
      - totals
      properties:
        id:
          $ref: '#/components/schemas/PaymentId'
        status:
          $ref: '#/components/schemas/PaymentStatus'
        reason:
          $ref: '#/components/schemas/PaymentReason'
        reference:
          $ref: '#/components/schemas/Reference'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        statement_descriptor:
          $ref: '#/components/schemas/StatementDescriptorResponse'
        method:
          $ref: '#/components/schemas/PaymentMethodDetails'
        splits:
          $ref: '#/components/schemas/SplitsCalculatedAndCalculatingFees'
        authentication:
          $ref: '#/components/schemas/PaymentAuthentication'
        totals:
          $ref: '#/components/schemas/PaymentTotals'
    PaymentWebhooksRequest:
      description: Configuration for webhooks to receive payment status updates.
      type: object
      required:
      - url
      properties:
        url:
          allOf:
          - description: The URL to which webhook events will be sent.
            example: https://webhooks.titanauto.com/getpaid
          - $ref: '#/components/schemas/Url'
    PaymentCheckoutDescription:
      allOf:
      - $ref: '#/components/schemas/MediumString'
      - description: 'A description of the checkout session only if the payment was part of a checkout.

          This will be visible to the buyer in the payment page but not in the bank or card statement.

          '
        example: Order 202510-0232
    SplitBaseAmount:
      type: object
      description: 'The amount in payment currency to be allocated to this account.


        The sum of all split amounts for all accounts must be exactly the total amount of the payment

        or use the `remaining` type for one of the accounts to allocate the remaining amount after all

        other splits have been calculated.

        '
      required:
      - type
      properties:
        type:
          type: string
          description: The type of split amount.
          enum:
          - fixed
          - percentage
          - remaining
    PaymentOriginApi:
      allOf:
      - $ref: '#/components/schemas/PaymentOriginBase'
    BasePaymentMethodDetails:
      allOf:
      - $ref: '#/components/schemas/PaymentMethodBase'
      - required:
        - display_hint
        properties:
          display_hint:
            $ref: '#/components/schemas/PaymentMethodDisplayHint'
    PaginatedResponse:
      type: object
      required:
      - data
      properties:
        cursor:
          $ref: '#/components/schemas/PaginationCursor'
        data:
          $ref: '#/components/schemas/PaginationData'
    QueryPaymentsRequest:
      allOf:
      - $ref: '#/components/schemas/BaseQueryRequest'
      - required:
        - type
        properties:
          type:
            type: string
            enum:
            - payments
          filters:
            $ref: '#/components/schemas/PaymentsFiltersRequest'
          sorts:
            $ref: '#/components/schemas/PaymentsSortsRequest'
    SplitRemainingAmountRequest:
      allOf:
      - $ref: '#/components/schemas/SplitBaseAmount'
    SplitPercentageAmountRequest:
      allOf:
      - $ref: '#/components/schemas/SplitBaseAmount'
      - type: object
        required:
        - percentage
        properties:
          percentage:
            allOf:
            - $ref: '#/components/schemas/Percentage'
            - description: The percentage of the total amount to allocate to this account.
    AccountVersion:
      allOf:
      - description: The account version.
      - $ref: '#/components/schemas/Version'
    PaginationCursor:
      description: The cursor to the last item. If non-empty, can be used to fetch the next page. If not set, there is no more elements.
      type: string
      maxLength: 250
      example: Q3VyaW9zaXR5IEtpbGxlZCB0aGUgQ2F0Cg==
    RefundPaymentResponse:
      oneOf:
      - $ref: '#/components/schemas/FullRefundPaymentResponse'
      - $ref: '#/components/schemas/PartialRefundPaymentResponse'
      discriminator:
        propertyName: type
        mapping:
          full: '#/components/schemas/FullRefundPaymentResponse'
          partial: '#/components/schemas/PartialRefundPaymentResponse'
    CardPaymentMethodRequest:
      allOf:
      - $ref: '#/components/schemas/BasePaymentMethodRequest'
      - type: object
        required:
        - dynamic_descriptor
        properties:
          dynamic_descriptor:
            $ref: '#/components/schemas/CardDynamicDescriptor'
    ProcessingFeeAmount:
      allOf:
      - description: The processing fee amount covered by this account in the minor currency unit (e.g. 100 cents for 1 EUR).
      - $ref: '#/components/schemas/AmountMinor'
    SddPaymentMethodDetails:
      allOf:
      - $ref: '#/components/schemas/BasePaymentMethodDetails'
      - required:
        - bank_account
        properties:
          bank_account:
            description: The bank account details.
            type: object
            required:
            - type
            - number
            properties:
              type:
                description: The type of bank account.
                type: string
                enum:
                - business
                - consumer
              number:
                description: The bank account number details.
                type: object
                required:
                - type
                - value
                properties:
                  type:
                    description: The type of bank account number.
                    type: string
                    enum:
                    - iban
                  value:
                    description: The bank account number value.
                    type: string
                    minLength: 15
                    maxLength: 33
                    example: DE85100100100006992334
    PaymentMethodRequest:
      description: The payment method configuration for this payment.
      anyOf:
      - $ref: '#/components/schemas/CardPaymentMethodRequest'
      - $ref: '#/components/schemas/SddPaymentMethodRequest'
      discriminator:
        propertyName: type
        mapping:
          card: '#/components/schemas/CardPaymentMethodRequest'
          sepa_direct_debit: '#/components/schemas/SddPaymentMethodRequest'
    CheckoutId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the checkout.
        example: cko_4kf9v6xp00hzc99rdwr5m97wce
    BaseSortsRequest:
      description: Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
      type: array
      minItems: 1
      uniqueItems: true
      items:
        description: Each field to sort by.
        type: object
        required:
        - field
        - direction
        properties:
          field:
            description: The field to sort by. Each field available can only be used once in the list.
            type: string
          direction:
            description: The sort direction
            type: string
            enum:
            - ascending
            - descending
    CardDynamicDescriptor:
      description: 'The card dynamic descriptor.


        It will be prefixed with `GPD*` when displayed on the buyer statement. You don''t need to include the `GPD*` prefix in the value sent.

        '
      type: string
      pattern: ^[a-zA-Z0-9 *\._-]{1,18}$
      minLength: 1
      maxLength: 18
      example: TITAN*202510-0232
    QueryPaymentsResponse:
      allOf:
      - required:
        - type
        properties:
          type:
            type: string
            enum:
            - payments
          cursor:
            type: string
          data:
            items:
              required:
              - id
              - reference
              - status
              - amount
              - currency
              - created_at
              - updated_at
              - method
              - seller
              - parties
              properties:
                id:
                  $ref: '#/components/schemas/PaymentId'
                reference:
                  $ref: '#/components/schemas/Reference'
                status:
                  $ref: '#/components/schemas/PaymentStatus'
                amount:
                  $ref: '#/components/schemas/AmountMinor'
                currency:
                  $ref: '#/components/schemas/Currency'
                created_at:
                  $ref: '#/components/schemas/CreatedAt'
                updated_at:
                  $ref: '#/components/schemas/UpdatedAt'
                method:
                  $ref: '#/components/schemas/PaymentMethodHint'
                seller:
                  $ref: '#/components/schemas/SellerRef'
                parties:
                  description: The list of parties involved in the transaction.
                  type: array
                  minItems: 1
                  items:
                    $ref: '#/components/schemas/PartyRef'
      - $ref: '#/components/schemas/PaginatedResponse'
    BasePaymentMethodHint:
      allOf:
      - $ref: '#/components/schemas/PaymentMethodBase'
      - required:
        - display_hint
        properties:
          display_hint:
            $ref: '#/components/schemas/PaymentMethodDisplayHint'
    StatementDescriptorResponse:
      description: 'The final statement descriptor shown on the buyer statement.


        This value is calculated per payment method:


        - **Cards**: `dynamic_descriptor` with the `GPD*` prefix.

        - **SEPA Direct Debit**: `remittance_info`.

        '
      type: string
      minLength: 1
      maxLength: 140
      example: GPD*TITAN*202510-0232
    BaseRefundPaymentRequest:
      type: object
      required:
      - type
      - reference
      properties:
        type:
          $ref: '#/components/schemas/RefundType'
        reference:
          $ref: '#/components/schemas/Reference'
        webhooks:
          description: Configuration for webhooks to receive refund status updates.
          type: object
          required:
          - url
          properties:
            url:
              allOf:
              - description: The URL to which webhook events will be sent.
                example: https://webhooks.titanauto.com/getpaid
              - $ref: '#/components/schemas/Url'
    Currency:
      type: string
      format: currency
      minLength: 3
      maxLength: 3
      description: The processing currency code according to the [ISO-4217 standard](https://en.wikipedia.org/wiki/ISO_4217)
      example: EUR
    SplitsRequest:
      description: 'The list of payment splits for the accounts involved in the funds flow.


        See [how splits work](/monetize/splits) for more information.

        '
      type: object
      required:
      - type
      - accounts
      properties:
        type:
          $ref: '#/components/schemas/SplitsType'
        accounts:
          description: The list of accounts involved in the payment that will receive the funds.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            description: A payment split account.
            type: object
            required:
            - type
            - id
            - split
            properties:
              type:
                $ref: '#/components/schemas/SplitsAccountType'
              id:
                $ref: '#/components/schemas/AccountId'
              split:
                description: The amount in the payment currency to be allocated to this account.
                oneOf:
                - $ref: '#/components/schemas/SplitFixedAmount'
                - $ref: '#/components/schemas/SplitPercentageAmountRequest'
                - $ref: '#/components/schemas/SplitRemainingAmountRequest'
                discriminator:
                  propertyName: type
                  mapping:
                    fixed: '#/components/schemas/SplitFixedAmount'
                    percentage: '#/components/schemas/SplitPercentageAmountRequest'
                    remaining: '#/components/schemas/SplitRemainingAmountRequest'
              processing_fee:
                $ref: '#/components/schemas/ProcessingFeeRequest'
    StandingInstructionStatus:
      description: 'The status of the standing instruction.


        - `new`: requested to creation as part of an initial payment.

        - `active`: standing instruction is active and can be used for subsequent payments.

        '
      type: string
      enum:
      - new
      - active
    PaymentMethodType:
      description: The type of payment method.
      type: string
      enum:
      - card
      - sepa_direct_debit
    SplitPercentageAmountCalculated:
      allOf:
      - $ref: '#/components/schemas/SplitPercentageAmountRequest'
      - required:
        - amount
        properties:
          amount:
            $ref: '#/components/schemas/SplitAmountMinor'
    DateTime:
      description: 'UTC timestamp in ISO 8601 format with milliseconds ([RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html)).

        Always includes the ''Z'' UTC indicator.

        '
      type: string
      format: date-time
      minLength: 24
      maxLength: 24
      example: '2025-09-01T22:05:48.479Z'
    FullRefundPaymentRequest:
      allOf:
      - $ref: '#/components/schemas/BaseRefundPaymentRequest'
    PartialRefundPaymentRequest:
      allOf:
      - required:
        - amount
        - splits
        properties:
          type:
            type: string
          reference:
            type: string
          amount:
            allOf:
            - description: The amount to be refunded in minor currency unit (e.g. 100 cents for 1 EUR).
            - $ref: '#/components/schemas/AmountMinor'
          splits:
            description: The list of refund splits for the accounts involved in the funds flow.
            type: object
            required:
            - accounts
            properties:
              accounts:
                description: 'The list of accounts involved in the refund that will return the funds.


                  All the accounts involved in the original payment receiving funds must be included

                  even if they did not receive funds in the payment or they are not returning funds in the refund.

                  '
                type: array
                minItems: 1
                uniqueItems: true
                items:
                  $ref: '#/components/schemas/RefundSplitAccount'
      - $ref: '#/components/schemas/BaseRefundPaymentRequest'
    ReasonBase:
      description: Reason of the status of the resource when it requires additional steps or is a failure state.
      type: object
      required:
      - code
      - description
      properties:
        code:
          description: Code to identify the cause of the status of the resource.
          type: string
        description:
          description: Human-readable description of the reason for the status of the resource.
          type: string
    SplitRemainingAmountCalculated:
      allOf:
      - $ref: '#/components/schemas/SplitRemainingAmountRequest'
      - required:
        - amount
        properties:
          amount:
            $ref: '#/components/schemas/SplitAmountMinor'
    StandingInstructionDetails:
      description: The details of the standing instruction the payment is associated with.
      type: object
      required:
      - status
      - terms
      - first
      properties:
        id:
          $ref: '#/components/schemas/StandingInstructionId'
        status:
          $ref: '#/components/schemas/StandingInstructionStatus'
        terms:
          $ref: '#/components/schemas/StandingInstructionTerms'
        first:
          description: The reference to the first payment in the standing instruction sequence.
          type: object
          required:
          - type
          - id
          properties:
            type:
              description: The type of the reference for the first payment.
              type: string
              enum:
              - payment
            id:
              allOf:
              - description: The identifier of the first payment in the standing instruction sequence.
              - $ref: '#/components/schemas/PaymentId'
    RefundOriginBase:
      type: object
      required:
      - type
      properties:
        type:
          description: 'The refund origin type.


            - `api`: The refund was created via the API.

            '
          type: string
          enum:
          - api
    BaseQueryRequest:
      type: object
      properties:
        type:
          description: 'The type of the Getpaid solution resources to query.


            Some query endpoints infer the resource type from the request path. In those cases, if this field is set, it

            must match the resource targeted by the request URL.

            '
          type: string
        first:
          allOf:
          - $ref: '#/components/schemas/PaginationFirst'
        after:
          $ref: '#/components/schemas/PaginationAfter'
        filters:
          description: Filters to reduce the data set to query. If not set, all resources available of the given type will be queried.
        sorts:
          $ref: '#/components/schemas/BaseSortsRequest'
    UpdatedAt:
      allOf:
      - description: When the resource was last updated.
      - $ref: '#/components/schemas/DateTime'
    CreatedAt:
      allOf:
      - description: When the resource was created.
      - $ref: '#/components/schemas/DateTime'
    PaymentsSortsRequest:
      description: Fields to sort the data by. If not set, the data will be sorted by the creation date descending.
      type: array
      minItems: 1
      uniqueItems: true
      items:
        allOf:
        - $ref: '#/components/schemas/BaseSortItemRequest'
        - properties:
            field:
              enum:
              - created_at
              - amount
              - seller_legal_name
    PaginationAfter:
      description: Pagination. The `cursor` from next page will be retrieved.
      type: string
      maxLength: 250
    CardScheme:
      description: The card scheme.
      type: string
      enum:
      - visa
      - mastercard
    SplitFixedAmount:
      allOf:
      - $ref: '#/components/schemas/SplitBaseAmount'
      - required:
        - amount
        properties:
          amount:
            $ref: '#/components/schemas/SplitAmountMinor'
    CardPaymentMethodHint:
      allOf:
      - required:
        - scheme
        properties:
          type:
            type: string
          scheme:
            $ref: '#/components/schemas/CardScheme'
      - $ref: '#/components/schemas/BasePaymentMethodHint'
    SplitAmountMinor:
      allOf:
      - description: The amount allocated to this account in the minor currency unit (e.g. 100 cents for 1 EUR).
      - $ref: '#/components/schemas/AmountMinor'
    BaseSortItemRequest:
      description: Each field to sort by.
      type: object
      required:
      - field
      - direction
      properties:
        field:
          description: The field to sort by. Each field available can only be used once in the list.
          type: string
        direction:
          description: The sort direction
          type: string
          enum:
          - ascending
          - descending
    PaymentOrigin:
      description: The origin of the payment creation.
      allOf:
      - $ref: '#/components/schemas/PaymentOriginApi'
      - $ref: '#/components/schemas/PaymentOriginCheckout'
      discriminator:
        propertyName: type
        mapping:
          api: '#/components/schemas/PaymentOriginApi'
          checkout: '#/components/schemas/PaymentOriginCheckout'
    StandingInstructionId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the standing instruction.
        example: sti_4tbftjwzxja1h71nzas1g0g1xm
    SplitsAccountType:
      description: 'The type of account.


        Exactly one account of type `platform` and one of type `seller` are required and allowed per payment.

        '
      type: string
      enum:
      - platform
      - seller
      - other
    PaymentMethodBase:
      type: object
      required:
      - type
      properties:
        type:
          $ref: '#/components/schemas/PaymentMethodType'
    FullRefundPaymentResponse:
      allOf:
      - $ref: '#/components/schemas/BaseRefundPaymentResponse'
      - required:
        - amount
        - splits
        properties:
          amount:
            allOf:
            - description: The full amount of the original payment to be refunded in minor units of the currency (e.g., cents for EUR).
            - $ref: '#/components/schemas/AmountMinor'
          splits:
            description: The list of refund splits for the accounts involved in the funds flow from the original payment.
            type: object
            required:
            - accounts
            properties:
              accounts:
                description: The list of accounts involved in the original payment with the funds they are going to return to the buyer.
                type: array
                minItems: 1
                uniqueItems: true
                items:
                  $ref: '#/components/schemas/RefundSplitAccount'
    ProcessingFeeCalculating:
      allOf:
      - $ref: '#/components/schemas/ProcessingFeeRequest'
      - properties:
          amount:
            $ref: '#/components/schemas/ProcessingFeeAmount'
    PaginationFirst:
      description: Pagination. The number of elements that will be retrieved.
      type: integer
      default: 20
      minimum: 1
      maximum: 100
    StandingInstructionTerms:
      description: Terms for standing instructions of recurring payments.
      type: object
      required:
      - type
      properties:
        type:
          description: 'Type of standing instruction.


            - `recurring`: periodic charges at a fixed frequency.

            - `unscheduled`: payments with no fixed schedule or frequency.

            '
          type: string
          enum:
          - recurring
          - unscheduled
    BasePaymentMethodRequest:
      description: The payment method configuration for this payment.
      type: object
      required:
      - type
      properties:
        type:
          description: The payment method type.
          type: string
    PaymentOriginBase:
      type: object
      required:
      - type
      properties:
        type:
          description: 'The payment origin type.


            - `api`: The payment was created via the API.

            - `checkout`: The payment was created as an attempt of a checkout session.

            '
          type: string
          enum:
          - api
          - checkout
    ProcessingFeeRequest:
      description: 'The processing fee covered by this account.


        If not specified, the account will not cover any processing fee.


        The sum of all processing fees covered by all accounts must be exactly 100%.

        '
      type: object
      required:
      - percentage
      properties:
        percentage:
          allOf:
          - $ref: '#/components/schemas/Percentage'
          - description: The percentage of the total processing fee that this account will cover.
            example: 100
    RefundStatus:
      description: 'The status of the refund payment.

        See the [list, transitions, and description of each status](/payments/refunds/lifecycle) for more details.

        '
      type: string
      enum:
      - initiated
      - completed
      - declined
      - failed
    GetPaymentResponse:
      type: object
      required:
      - id
      - status
      - reference
      - created_at
      - updated_at
      - amount
      - currency
      - origin
      - method
      - splits
      - refunds
      - totals
      - events
      properties:
        id:
          $ref: '#/components/schemas/PaymentId'
        status:
          $ref: '#/components/schemas/PaymentStatus'
        reason:
          $ref: '#/components/schemas/PaymentReason'
        reference:
          $ref: '#/components/schemas/Reference'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
        estimated_update_before:
          $ref: '#/components/schemas/EstimatedUpdateBefore'
        amount:
          $ref: '#/components/schemas/AmountMinor'
        currency:
          $ref: '#/components/schemas/Currency'
        description:
          $ref: '#/components/schemas/PaymentCheckoutDescription'
        statement_descriptor:
          $ref: '#/components/schemas/StatementDescriptorResponse'
        origin:
          $ref: '#/components/schemas/PaymentOrigin'
        method:
          $ref: '#/components/schemas/PaymentMethodDetails'
        splits:
          allOf:
          - description: The splits for each the account involved in the funds flow for the original amount.
          - $ref: '#/components/schemas/SplitsCalculatedAndCalculatingFees'
        authentication:
          $ref: '#/components/schemas/PaymentAuthentication'
        standing_instruction:
          $ref: '#/components/schemas/StandingInstructionDetails'
        refunds:
          $ref: '#/components/schemas/PaymentRefunds'
        totals:
          $ref: '#/components/schemas/PaymentTotals'
    CardPaymentMethodDetails:
      allOf:
      - $ref: '#/components/schemas/BasePaymentMethodDetails'
      - required:
        - card
        properties:
          card:
            description: The card details.
            type: object
            required:
            - scheme
            - holder_name
            - first_digits
            - last_digits
            - expiry_month
            - expiry_year
            properties:
              scheme:
                $ref: '#/components/schemas/CardScheme'
              holder_name:
                description: The name of the cardholder as printed on the card.
                type: string
                minLength: 1
                maxLength: 26
                example: Jane Doe
              first_digits:
                description: The first four to six digits of the card number (BIN) that identify the issuing bank.
                type: string
                minLength: 4
                maxLength: 6
                example: '424242'
              last_digits:
                description: The last four digits of the card number.
                type: string
                minLength: 4
                maxLength: 4
                example: '4242'
              expiry_month:
                description: The expiration month of the card.
                type: integer
                minimum: 1
                maximum: 12
                example: 12
              expiry_year:
                description: The expiration year of the card.
                type: integer
                minimum: 2021
                example: 2025
              kind:
                description: Kind of the payment card.
                type: string
                enum:
                - credit
                - debit
                example: credit
              segment:
                description: Segment of the payment card.
                type: string
                enum:
                - consumer
                - corporate
                example: consumer
    ShortString:
      type: string
      minLength: 1
      maxLength: 50
    PaymentTotals:
      description: The payment totals summary to provide an overview of captured, refunded, refundable amounts and processing fees overall and per account associated with the payment.
      type: object
      required:
      - net
      - captured
      - refunded
      - refundable
      - processing_fees
      - accounts
      properties:
        net:
          allOf:
          - description: The net amount for the payment that includes the captured funds and refunded amounts and processing fees deductions in the minor currency unit (e.g. 100 cents for 1 EUR).
          - $ref: '#/components/schemas/AmountMinor'
        captured:
          allOf:
          - description: The total amount captured for the payment in the minor currency unit (e.g. 100 cents for 1 EUR).
          - $ref: '#/components/schemas/AmountMinor'
        refunded:
          allOf:
          - description: The total amount refunded for the payment in the minor currency unit (e.g. 100 cents for 1 EUR).
          - $ref: '#/components/schemas/AmountMinor'
        refundable:
          allOf:
          - description: The amount that can be still be refunded for the payment in the minor currency unit (e.g. 100 cents for 1 EUR).
          - $ref: '#/components/schemas/AmountMinor'
        processing_fees:
          allOf:
          - description: The total processing fees that include captures and refunds fees in the minor currency unit (e.g. 100 cents for 1 EUR).
          - $ref: '#/components/schemas/AmountMinor'
        accounts:
          description: The breakdown of totals per account associated with the payment.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            type: object
            required:
            - type
            - id
            - version
            - legal_name
            - net
            - captured
            - refunded
            - refundable
            - processing_fees
            properties:
              type:
                description: The type of account.
                type: string
                enum:
                - seller
                - platform
              id:
                $ref: '#/components/schemas/AccountId'
              version:
                $ref: '#/components/schemas/AccountVersion'
              legal_name:
                $ref: '#/components/schemas/AccountLegalName'
              net:
                allOf:
                - description: The net amount for the account including their split for the captured funds and deducting their refunded splits and processing fees the account is covering in the minor currency unit (e.g. 100 cents for 1 EUR).
                - $ref: '#/components/schemas/AmountMinor'
              captured:
                allOf:
                - description: The total amount captured for this account in the minor currency unit (e.g. 100 cents for 1 EUR).
                - $ref: '#/components/schemas/AmountMinor'
              refunded:
                allOf:
                - description: The total amount refunded for this account in the minor currency unit (e.g. 100 cents for 1 EUR).
                - $ref: '#/components/schemas/AmountMinor'
              refundable:
                allOf:
                - description: The total refundable amount for this account in the minor currency unit (e.g. 100 cents for 1 EUR).
                - $ref: '#/components/schemas/AmountMinor'
              processing_fees:
                allOf:
                - description: The total processing fees covered by this account in the minor currency unit (e.g. 100 cents for 1 EUR).
                - $ref: '#/components/schemas/AmountMinor'
    PaymentMethodHint:
      description: The payment method used.
      oneOf:
      - $ref: '#/components/schemas/BasePaymentMethodHint'
      - $ref: '#/components/schemas/CardPaymentMethodHint'
      discriminator:
        propertyName: type
        mapping:
          card: '#/components/schemas/CardPaymentMethodHint'
          sepa_direct_debit: '#/components/schemas/BasePaymentMethodHint'
    RefundPaymentRequest:
      oneOf:
      - $ref: '#/components/schemas/FullRefundPaymentRequest'
      - $ref: '#/components/schemas/PartialRefundPaymentRequest'
      discriminator:
        propertyName: type
        mapping:
          full: '#/components/schemas/FullRefundPaymentRequest'
          partial: '#/components/schemas/PartialRefundPaymentRequest'
    ProblemDetailsBase:
      type: object
      description: The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)].
      required:
      - type
      - title
      - status
      properties:
        type:
          type: string
          description: A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank".
          format: uri
          example: https://docs.getpaid.io/ref/error-types#problem
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
          example: Invalid Request
        status:
          type: integer
          description: The HTTP status code.
          minimum: 400
          maximum: 599
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
          example: The request body was invalid
    Url:
      type: string
      format: uri
      maxLength: 1024
    SellerRef:
      description: A reference to the seller account.
      type: object
      required:
      - id
      - legal_name
      properties:
        id:
          $ref: '#/components/schemas/AccountId'
        legal_name:
          $ref: '#/components/schemas/AccountLegalName'
    SddRemittanceInfo:
      description: 'The SEPA Direct Debit remittance information shown on the buyer statement.

        '
      type: string
      minLength: 1
      maxLength: 140
      example: 'Titan Auto Parts Ord. #0232 Inv. #202500632'
    PaymentStatus:
      description: 'The status of the payment.

        See the [list, transitions, and description of each status](/payments/lifecycle) for more details.

        '
      type: string
      enum:
      - initiated
      - action_required
      - submitted
      - authorized
      - captured
      - declined
      - failed
      - partially_refunded
      - refunded
    PaymentRefunds:
      description: A list of refunds associated with the payment if any.
      type: array
      uniqueItems: true
      items:
        type: object
        required:
        - id
        - status
        - type
        - reference
        - created_at
        - updated_at
        - amount
        - origin
        properties:
          id:
            $ref: '#/components/schemas/RefundId'
          status:
            $ref: '#/components/schemas/RefundStatus'
          reason:
            $ref: '#/components/schemas/RefundReason'
          type:
            $ref: '#/components/schemas/RefundType'
          reference:
            $ref: '#/components/schemas/Reference'
          created_at:
            $ref: '#/components/schemas/CreatedAt'
          updated_at:
            $ref: '#/components/schemas/UpdatedAt'
          amount:
            $ref: '#/components/schemas/AmountMinor'
          origin:
            $ref: '#/components/schemas/RefundOrigin'
    PaymentReason:
      allOf:
      - description: 'The reason for the payment status when it requires additional steps or is a failure state.

          See all the [possible payment reasons for each status](/payments/lifecycle/reason-codes) for more details.

          '
        properties:
          code:
            description: 'Code to identify the cause of the payment status.

              See all the [possible payment reason codes for each status](/payments/lifecycle/reason-codes) for more details.

              '
          description:
            description: Human-readable description of the reason for the payment status.
      - $ref: '#/components/schemas/ReasonBase'
    PaymentId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the payment.
        example: pay_4a4m2pjycdb1jbj68h1rvk9kcz
    SubsequentStandingInstructionRequest:
      description: Standing instruction for recurring payments.
      type: object
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/StandingInstructionId'
    PaymentMethodDisplayHint:
      allOf:
      - description: A hint of the payment method used.
      - $ref: '#/components/schemas/ShortString'
    MediumString:
      type: string
      minLength: 1
      maxLength: 250
    RefundType:
      description: The type of refund to be processed.
      type: string
      enum:
      - full
      - partial
    AccountLegalName:
      allOf:
      - description: The legal name of the account.
      - $ref: '#/components/schemas/MediumString'
    SplitsType:
      description: The type of payment split.
      type: string
      enum:
      - per_transaction
    BaseRefundPaymentResponse:
      type: object
      required:
      - id
      - type
      - status
      - reference
      - created_at
      - updated_at
      properties:
        id:
          $ref: '#/components/schemas/RefundId'
        type:
          $ref: '#/components/schemas/RefundType'
        status:
          $ref: '#/components/schemas/RefundStatus'
          const: initiated
        reference:
          $ref: '#/components/schemas/Reference'
        created_at:
          $ref: '#/components/schemas/CreatedAt'
        updated_at:
          $ref: '#/components/schemas/UpdatedAt'
    PartyRef:
      description: A reference to a party account involved in the transaction.
      type: object
      required:
      - id
      - type
      - legal_name
      properties:
        id:
          $ref: '#/components/schemas/AccountId'
        type:
          description: The type of party.
          type: string
          enum:
          - platform
          - other
        legal_name:
          $ref: '#/components/schemas/AccountLegalName'
    RefundSplitAccount:
      description: A refund split account.
      type: object
      required:
      - id
      - split
      properties:
        id:
          $ref: '#/components/schemas/AccountId'
        split:
          description: The amount in the payment currency to return from this account.
          type: object
          required:
          - amount
          properties:
            amount:
              allOf:
              - description: The amount returned from this account in the minor currency unit (e.g. 100 cents for 1 EUR).
              - $ref: '#/components/schemas/AmountMinor'
    Id:
      type: string
      format: id
      minLength: 30
      maxLength: 50
    RefundId:
      allOf:
      - $ref: '#/components/schemas/Id'
      - description: The unique identifier of the refund of a payment.
        example: rfd_4a4m2pjycdb1jbj68h1rvk9kcz
    SddPaymentMethodRequest:
      allOf:
      - $ref: '#/components/schemas/BasePaymentMethodRequest'
      - type: object
        required:
        - remittance_info
        properties:
          type:
            description: The payment method type.
            type: string
          remittance_info:
            $ref: '#/components/schemas/SddRemittanceInfo'
    RefundReason:
      allOf:
      - description: 'The reason for the refund status when it requires additional steps or is a failure state.

          See all the [possible refund reasons for each status](/payments/refunds/lifecycle/reason-codes) for more details.

          '
        properties:
          code:
            description: 'Code to identify the cause of the refund status.

              See all the [possible refund reason codes for each status](/payments/refunds/lifecycle/reason-codes) for more details.

              '
          description:
            description: Human-readable description of the reason for the refund status.
      - $ref: '#/components/schemas/ReasonBase'
    RefundOrigin:
      description: The origin of the refund creation.
      allOf:
      - $ref: '#/components/schemas/RefundOriginApi'
      discriminator:
        propertyName: type
        mapping:
          api: '#/components/schemas/RefundOriginApi'
    PaymentAuthentication:
      description: Information about the authentication performed for the payment if any.
      type: object
      required:
      - type
      - status
      properties:
        type:
          description: The type of authentication performed for the payment.
          type: string
          enum:
          - 3ds
        status:
          description: 'The status of the authentication.


            - `succeeded`: the authentication was successful.

            - `failed`: the authentication failed.

            '
          type: string
          enum:
          - succeeded
          - failed
        result:
          description: The 3DS authentication result.
          type: object
          required:
          - code
          - eci
          properties:
            code:
              description: The 3DS authentication result code.
              type: string
              minLength: 1
              maxLength: 1
              enum:
              - Y
              - A
              - N
              - U
              - R
            eci:
              description: The Electronic Commerce Indicator (ECI) value for the authentication.
              type: string
              minLength: 2
              maxLength: 2
              enum:
              - '05'
              - '06'
              - '07'
              - '01'
              - '02'
              - '03'
    PaymentsFiltersRequest:
      description: Filtering payments.
      type: object
      properties:
        id:
          allOf:
          - description: The payment identifier to filter by using an exact match operation.
          - $ref: '#/components/schemas/PaymentId'
        reference:
          description: The payment reference to filter by using a contains operation.
          type: string
        seller_legal_name:
          description: The seller legal name to filter by using a contains operation.
          type: string
        statuses:
          description: The list of payment statuses to filter by.
          type: array
          minItems: 1
          uniqueItems: true
          items:
            $ref: '#/components/schemas/PaymentStatus'
    RefundOriginApi:
      allOf:
      - $ref: '#/components/schemas/RefundOriginBase'
  responses:
    500InternalServerError:
      description: Internal Server Error
      headers:
        Getpaid-Trace-Id:
          $ref: '#/components/headers/GetpaidTraceId'
    400BadRequest:
      description: Bad Request
      headers:
        Getpaid-Trace-Id:
          $ref: '#/components/headers/GetpaidTraceId'
    422InvalidParameters:
      description: Invalid Parameters
      headers:
        Getpaid-Trace-Id:
          $ref: '#/components/headers/GetpaidTraceId'
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ProblemDetailsBase'
            - type: object
              required:
              - errors
              properties:
                errors:
                  type: object
                  description: The JSON path of any request body fields or header names that are invalid with a description of the error
                  additionalProperties:
                    type: array
                    items:
                      type: string
                  example:
                    currency:
                    - invalid_option
                type:
                  example: https://docs.getpaid.io/integration/api/responses#422---invalid-parameters
                title:
                  example: Invalid Parameters
                status:
                  example: 422
    404NotFound:
      description: Not Found
      headers:
        Getpaid-Trace-Id:
          $ref: '#/components/headers/GetpaidTraceId'
      content:
        application/problem+json:
          schema:
            allOf:
            - $ref: '#/components/schemas/ProblemDetailsBase'
            - type: object
              properties:
                type:
                  example: https://docs.getpaid.io/integration/api/responses#404---not-found
                title:
                  example: Not Found
                status:
                  example: 404
    429TooManyRequests:
      description: Too Many Requests
      headers:
        Getpaid-Trace-Id:
          $ref: '#/components/headers/GetpaidTraceId'
    401Unauthorized:
      description: Unauthorized
      headers:
        Getpaid-Trace-Id:
          $ref: '#/components/headers/GetpaidTraceId'
  parameters:
    GetpaidIdempotencyKey:
      name: Getpaid-Idempotency-Key
      in: header
      description: 'A unique idempotency key to allow safe retrying.

        See [Getpaid API idempotency](/integration/api/idempotency) for more details.

        '
      schema:
        type: string
        minLength: 10
        maxLength: 100
        pattern: ^[a-zA-Z0-9_-]{10,100}$
        example: 5c255194-30ec-11ed-a261-0242ac120002
  headers:
    GetpaidTraceId:
      description: The trace identifier for the request. It is a good idea to log this and provide it with any support requests
      schema:
        type: string
        example: 96ce50247f87f540bb2d86771b3728b8
  securitySchemes:
    OAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.getpaid.io/oauth/token
          scopes:
            accounts:read: Allows to read accounts and onboarding applications.
            accounts:read_write: Allows to read, create and/or operate accounts and onboarding applications.
            payments:read: Allows to read payments and checkouts.
            payments:read_write: Allows to read, create and/or operate payments and checkouts.
x-tagGroups:
- name: General
  tags:
  - Authentication
  - Documents
- name: Accept payments
  tags:
  - Checkouts
  - Payments
  - Accept payments webhooks
- name: Onboard sellers
  tags:
  - Accounts
  - Applications
  - Onboard sellers webhooks
- name: Operate
  tags:
  - Queries
  - Exports
  - Analytics
  - Operate webhooks