openapi: 3.1.0
info:
  version: '6'
  x-publicVersion: true
  title: Adyen Account acceptDispute Payments API
  description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```"
  x-timestamp: '2023-05-30T15:27:20Z'
  termsOfService: https://www.adyen.com/legal/terms-and-conditions
  contact:
    name: Adyen Developer Experience team
    url: https://github.com/Adyen/adyen-openapi
servers:
- url: https://cal-test.adyen.com/cal/services/Account/v6
tags:
- name: Payments
paths:
  /paymentLinks:
    post:
      tags:
      - Payments
      summary: Adyen Create a Payment Link
      description: 'Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.


        For more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).'
      operationId: post-paymentLinks
      x-sortIndex: 1
      x-methodName: paymentLinks
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-paymentLinks-basic'
            schema:
              $ref: '#/components/schemas/PaymentLinkRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '201':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/post-paymentLinks-basic-201'
              schema:
                $ref: '#/components/schemas/PaymentLinkResponse'
          description: Created - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentLinks/{linkId}:
    get:
      tags:
      - Payments
      summary: Adyen Get a Payment Link
      description: Retrieves the payment link details using the payment link `id`.
      operationId: get-paymentLinks-linkId
      x-sortIndex: 2
      x-methodName: getPaymentLink
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: Unique identifier of the payment link.
        name: linkId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/get-paymentLinks-linkId-basic-200'
              schema:
                $ref: '#/components/schemas/PaymentLinkResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - Payments
      summary: Adyen Update the Status of a Payment Link
      description: Updates the status of a payment link. Use this endpoint to [force the expiry of a payment link](https://docs.adyen.com/online-payments/pay-by-link#update-payment-link-status).
      operationId: patch-paymentLinks-linkId
      x-sortIndex: 3
      x-methodName: updatePaymentLink
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/patch-paymentLinks-linkId-basic'
            schema:
              $ref: '#/components/schemas/UpdatePaymentLinkRequest'
      parameters:
      - description: Unique identifier of the payment link.
        name: linkId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200'
              schema:
                $ref: '#/components/schemas/PaymentLinkResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentMethods:
    post:
      tags:
      - Payments
      summary: Adyen Get a List of Available Payment Methods
      description: 'Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).


        Although we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.'
      operationId: post-paymentMethods
      x-sortIndex: 2
      x-methodName: paymentMethods
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-paymentMethods-basic'
              filtered:
                $ref: '#/components/examples/post-paymentMethods-filtered'
              include-stored:
                $ref: '#/components/examples/post-paymentMethods-include-stored'
            schema:
              $ref: '#/components/schemas/PaymentMethodsRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/post-paymentMethods-basic-200'
                filtered:
                  $ref: '#/components/examples/post-paymentMethods-filtered-200'
                include-stored:
                  $ref: '#/components/examples/post-paymentMethods-include-stored-200'
              schema:
                $ref: '#/components/schemas/PaymentMethodsResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentMethods/balance:
    post:
      tags:
      - Payments
      summary: Adyen Get the Balance of a Gift Card
      description: Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.
      operationId: post-paymentMethods-balance
      x-sortIndex: 1
      x-methodName: getBalanceOfGiftCard
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-paymentMethods-balance-basic'
              not-enough:
                $ref: '#/components/examples/post-paymentMethods-balance-not-enough'
            schema:
              $ref: '#/components/schemas/BalanceCheckRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/post-paymentMethods-balance-basic-200'
                not-enough:
                  $ref: '#/components/examples/post-paymentMethods-balance-not-enough-200'
              schema:
                $ref: '#/components/schemas/BalanceCheckResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentSession:
    post:
      tags:
      - Payments
      summary: Adyen Create a Payment Session
      description: 'Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.


        For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).'
      deprecated: true
      x-deprecatedInVersion: '37'
      operationId: post-paymentSession
      x-sortIndex: 1
      x-methodName: paymentSession
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              android:
                $ref: '#/components/examples/post-paymentSession-android'
              enableOneClick:
                $ref: '#/components/examples/post-paymentSession-enableOneClick'
              ios:
                $ref: '#/components/examples/post-paymentSession-ios'
              split:
                $ref: '#/components/examples/post-paymentSession-split'
              web:
                $ref: '#/components/examples/post-paymentSession-web'
            schema:
              $ref: '#/components/schemas/PaymentSetupRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                enableOneClick:
                  $ref: '#/components/examples/post-paymentSession-enableOneClick-200'
                web:
                  $ref: '#/components/examples/post-paymentSession-web-200'
              schema:
                $ref: '#/components/schemas/PaymentSetupResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments:
    post:
      tags:
      - Payments
      summary: Adyen Start a Transaction
      description: "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. "
      operationId: post-payments
      x-sortIndex: 3
      x-methodName: payments
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              applepay:
                $ref: '#/components/examples/post-payments-applepay'
              card-3d-secure-2-web:
                $ref: '#/components/examples/post-payments-card-3d-secure-2-web'
              card-3d-secure-direct:
                $ref: '#/components/examples/post-payments-card-3d-secure-direct'
              card-direct:
                $ref: '#/components/examples/post-payments-card-direct'
              card-securedfields:
                $ref: '#/components/examples/post-payments-card-securedfields'
              enableOneClick-SF:
                $ref: '#/components/examples/post-payments-enableOneClick-SF'
              googlepay:
                $ref: '#/components/examples/post-payments-googlepay'
              ideal:
                $ref: '#/components/examples/post-payments-ideal'
              klarna:
                $ref: '#/components/examples/post-payments-klarna'
              oneclick-securedfields:
                $ref: '#/components/examples/post-payments-oneclick-securedfields'
              recurring:
                $ref: '#/components/examples/post-payments-recurring'
              split-balanceplatform:
                $ref: '#/components/examples/post-payments-split-balanceplatform'
              split-classic:
                $ref: '#/components/examples/post-payments-split-classic'
              subscription-first-transaction:
                $ref: '#/components/examples/post-payments-subscription-first-transaction'
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                card-direct:
                  $ref: '#/components/examples/post-payments-card-direct-200'
                card-securedfields:
                  $ref: '#/components/examples/post-payments-card-securedfields-200'
                enableOneClick-SF:
                  $ref: '#/components/examples/post-payments-enableOneClick-SF-200'
                ideal:
                  $ref: '#/components/examples/post-payments-ideal-200'
                split-balanceplatform:
                  $ref: '#/components/examples/post-payments-split-balanceplatform-200'
                subscription-first-transaction:
                  $ref: '#/components/examples/post-payments-subscription-first-transaction-200'
              schema:
                $ref: '#/components/schemas/PaymentResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/details:
    post:
      tags:
      - Payments
      summary: Adyen Submit Details for a Payment
      description: 'Submits details for a payment created using `/payments`. This step is only needed when no final state has been reached on the `/payments` request, for example when the shopper was redirected to another page to complete the payment.


        '
      operationId: post-payments-details
      x-sortIndex: 4
      x-methodName: paymentsDetails
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              00.redirect:
                $ref: '#/components/examples/post-payments-details-00.redirect'
              3d-secure-2-native:
                $ref: '#/components/examples/post-payments-details-3d-secure-2-native'
            schema:
              $ref: '#/components/schemas/PaymentDetailsRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                00.redirect:
                  $ref: '#/components/examples/post-payments-details-00.redirect-200'
              schema:
                $ref: '#/components/schemas/PaymentDetailsResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/result:
    post:
      tags:
      - Payments
      summary: Adyen Verify a Payment Result
      description: 'Verifies the payment result using the payload returned from the Checkout SDK.


        For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).'
      deprecated: true
      x-deprecatedInVersion: '37'
      operationId: post-payments-result
      x-sortIndex: 2
      x-methodName: verifyPaymentResult
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              basic:
                $ref: '#/components/examples/post-payments-result-basic'
            schema:
              $ref: '#/components/schemas/PaymentVerificationRequest'
      parameters:
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '200':
          content:
            application/json:
              examples:
                basic:
                  $ref: '#/components/examples/post-payments-result-basic-200'
              schema:
                $ref: '#/components/schemas/PaymentVerificationResponse'
          description: OK - the request has succeeded.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/{paymentPspReference}/amountUpdates:
    post:
      tags:
      - Payments
      summary: Adyen Update an Authorised Amount
      description: 'Increases or decreases the authorised payment amount and returns a unique reference for this request. You get the outcome of the request asynchronously, in an [**AUTHORISATION_ADJUSTMENT** webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes).


        You can only update authorised amounts that have not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures).


        The amount you specify in the request is the updated amount, which is larger or smaller than the initial authorised amount.


        For more information, refer to [Authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#use-cases).'
      operationId: post-payments-paymentPspReference-amountUpdates
      x-sortIndex: 6
      x-methodName: updateAuthorisedAmount
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              amount-update:
                $ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update'
            schema:
              $ref: '#/components/schemas/PaymentAmountUpdateRequest'
      parameters:
      - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment.
        name: paymentPspReference
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '201':
          content:
            application/json:
              examples:
                amount-update:
                  $ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update-201'
              schema:
                $ref: '#/components/schemas/PaymentAmountUpdateResponse'
          description: Created - the request has been fulfilled and has resulted in one or more new resources being created.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/{paymentPspReference}/cancels:
    post:
      tags:
      - Payments
      summary: Adyen Cancel an Authorised Payment
      description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).


        If you want to cancel a payment but don''t have the [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference), use the [`/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cancels) endpoint instead.


        If you want to cancel a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.


        For more information, refer to [Cancel](https://docs.adyen.com/online-payments/cancel).'
      operationId: post-payments-paymentPspReference-cancels
      x-sortIndex: 2
      x-methodName: cancelAuthorisedPaymentByPspReference
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              cancel-with-psp-reference:
                $ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference'
            schema:
              $ref: '#/components/schemas/PaymentCancelRequest'
      parameters:
      - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to cancel. '
        name: paymentPspReference
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '201':
          content:
            application/json:
              examples:
                cancel-with-psp-reference:
                  $ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201'
              schema:
                $ref: '#/components/schemas/PaymentCancelResponse'
          description: Created - the request has been fulfilled and has resulted in one or more new resources being created.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/{paymentPspReference}/captures:
    post:
      tags:
      - Payments
      summary: Adyen Capture an Authorised Payment
      description: " Captures an authorised payment and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CAPTURE** webhook](https://docs.adyen.com/online-payments/capture#capture-notification).\n\nYou can capture either the full authorised amount or a part of the authorised amount. By default, any unclaimed amount after a partial capture gets cancelled. This does not apply if you enabled multiple partial captures on your account and the payment method supports multiple partial captures. \n\n[Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture) is the default setting for most payment methods. In these cases, you don't need to make capture requests. However, making capture requests for payments that are captured automatically does not result in double charges.\n\nFor more information, refer to [Capture](https://docs.adyen.com/online-payments/capture)."
      operationId: post-payments-paymentPspReference-captures
      x-sortIndex: 1
      x-methodName: captureAuthorisedPayment
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              capture:
                $ref: '#/components/examples/post-payments-paymentPspReference-captures-capture'
            schema:
              $ref: '#/components/schemas/PaymentCaptureRequest'
      parameters:
      - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to capture.
        name: paymentPspReference
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '201':
          content:
            application/json:
              examples:
                capture:
                  $ref: '#/components/examples/post-payments-paymentPspReference-captures-capture-201'
              schema:
                $ref: '#/components/schemas/PaymentCaptureResponse'
          description: Created - the request has been fulfilled and has resulted in one or more new resources being created.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/{paymentPspReference}/refunds:
    post:
      tags:
      - Payments
      summary: Adyen Refund a Captured Payment
      description: "Refunds a payment that has been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures), and returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**REFUND** webhook](https://docs.adyen.com/online-payments/refund#refund-webhook).\n\nYou can refund either the full captured amount or a part of the captured amount. You can also perform multiple partial refunds, as long as their sum doesn't exceed the captured amount.\n\n> Some payment methods do not support partial refunds. To learn if a payment method supports partial refunds, refer to the payment method page such as [cards](https://docs.adyen.com/payment-methods/cards#supported-cards), [iDEAL](https://docs.adyen.com/payment-methods/ideal), or [Klarna](https://docs.adyen.com/payment-methods/klarna). \n\nIf you want to refund a payment but are not sure whether it has been captured, use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/reversals) endpoint instead.\n\nFor more information, refer to [Refund](https://docs.adyen.com/online-payments/refund)."
      operationId: post-payments-paymentPspReference-refunds
      x-sortIndex: 4
      x-methodName: refundCapturedPayment
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              refund:
                $ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund'
            schema:
              $ref: '#/components/schemas/PaymentRefundRequest'
      parameters:
      - description: The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to refund.
        name: paymentPspReference
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '201':
          content:
            application/json:
              examples:
                refund:
                  $ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund-201'
              schema:
                $ref: '#/components/schemas/PaymentRefundResponse'
          description: Created - the request has been fulfilled and has resulted in one or more new resources being created.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /payments/{paymentPspReference}/reversals:
    post:
      tags:
      - Payments
      summary: Adyen Refund or Cancel a Payment
      description: '[Refunds](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/refunds) a payment if it has already been captured, and [cancels](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/cancels) a payment if it has not yet been captured. Returns a unique reference for this request. You get the outcome of the request asynchronously, in a [**CANCEL_OR_REFUND** webhook](https://docs.adyen.com/online-payments/reverse#cancel-or-refund-webhook).


        The reversed amount is always the full payment amount.

        > Do not use this request for payments that involve multiple partial captures.


        For more information, refer to [Reversal](https://docs.adyen.com/online-payments/reversal).'
      operationId: post-payments-paymentPspReference-reversals
      x-sortIndex: 5
      x-methodName: refundOrCancelPayment
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              reversal:
                $ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal'
            schema:
              $ref: '#/components/schemas/PaymentReversalRequest'
      parameters:
      - description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment that you want to reverse. '
        name: paymentPspReference
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/Idempotency-Key'
      responses:
        '201':
          content:
            application/json:
              examples:
                reversal:
                  $ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal-201'
              schema:
                $ref: '#/components/schemas/PaymentReversalResponse'
          description: Created - the request has been fulfilled and has resulted in one or more new resources being created.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Unprocessable Entity - a request validation error.
          headers:
            Idempotency-Key:
              $ref: '#/components/headers/Idempotency-Key'
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500'
              schema:
                $ref: '#/components/schemas/ServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /storedPaymentMethods:
    get:
      tags:
      - Payments
      summary: Adyen Get Tokens for Stored Payment Details
      description: 'Lists the tokens for stored payment details for the shopper identified in the path, if there are any available. The token ID can be used with payment requests for the shopper''s payment. A summary of the stored details is included.


        '
      x-addedInVersion: '70'
      operationId: get-storedPaymentMethods
      x-sortIndex: 2
      x-methodName: getTokensForStoredPaymentDetails
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

          > Your reference must not include personally identifiable information (PII), for example name or email address.'
        name: shopperReference
        in: query
        required: false
        schema:
          type: string
      - description: Your merchant account.
        name: merchantAccount
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-storedPaymentMethods-success-200'
              schema:
                $ref: '#/components/schemas/ListStoredPaymentMethodsResponse'
          description: OK - the request has succeeded.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /storedPaymentMethods/{storedPaymentMethodId}:
    delete:
      tags:
      - Payments
      summary: Adyen Delete a Token for Stored Payment Details
      description: Deletes the token identified in the path. The token can no longer be used with payment requests.
      x-addedInVersion: '70'
      operationId: delete-storedPaymentMethods-storedPaymentMethodId
      x-sortIndex: 4
      x-methodName: deleteTokenForStoredPaymentDetails
      security:
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the token.
        name: storedPaymentMethodId
        in: path
        required: true
        schema:
          type: string
      - description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

          > Your reference must not include personally identifiable information (PII), for example name or email address.'
        name: shopperReference
        in: query
        required: true
        schema:
          type: string
      - description: Your merchant account.
        name: merchantAccount
        in: query
        required: true
        schema:
          type: string
      responses:
        '204':
          description: 'No Content - look at the actual response code for the status of the request. '
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstrumentGroups:
    post:
      tags:
      - Payments
      summary: Adyen Create a Payment Instrument Group
      description: Creates a payment instrument group to associate and group payment instrument resources together. You can apply a transaction rule to a payment instrument group.
      x-addedInVersion: '1'
      operationId: post-paymentInstrumentGroups
      x-sortIndex: 1
      x-methodName: createPaymentInstrumentGroup
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              createPaymentInstrumentGroups:
                $ref: '#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups'
            schema:
              $ref: '#/components/schemas/PaymentInstrumentGroupInfo'
      responses:
        '200':
          content:
            application/json:
              examples:
                createPaymentInstrumentGroups:
                  $ref: '#/components/examples/post-paymentInstrumentGroups-createPaymentInstrumentGroups-200'
              schema:
                $ref: '#/components/schemas/PaymentInstrumentGroup'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstrumentGroups/{id}:
    get:
      tags:
      - Payments
      summary: Adyen Get a Payment Instrument Group
      description: Returns the details of a payment instrument group.
      x-addedInVersion: '1'
      operationId: get-paymentInstrumentGroups-id
      x-sortIndex: 2
      x-methodName: getPaymentInstrumentGroup
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the payment instrument group.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-paymentInstrumentGroups-id-success-200'
              schema:
                $ref: '#/components/schemas/PaymentInstrumentGroup'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstrumentGroups/{id}/transactionRules:
    get:
      tags:
      - Payments
      summary: Adyen Get All Transaction Rules for a Payment Instrument Group
      description: Returns a list of all the transaction rules associated with a payment instrument group.
      x-addedInVersion: '1'
      operationId: get-paymentInstrumentGroups-id-transactionRules
      x-sortIndex: 3
      x-methodName: getAllTransactionRulesForPaymentInstrumentGroup
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the payment instrument group.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-paymentInstrumentGroups-id-transactionRules-success-200'
              schema:
                $ref: '#/components/schemas/TransactionRulesResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstruments:
    post:
      tags:
      - Payments
      summary: Adyen Create a Payment Instrument
      description: "Creates a payment instrument to issue a physical card, a virtual card, or a business account to your user.\n\n For more information, refer to [Issue cards](https://docs.adyen.com/issuing/create-cards) or [Issue business accounts](https://docs.adyen.com/marketplaces-and-platforms/business-accounts)."
      x-addedInVersion: '1'
      operationId: post-paymentInstruments
      x-sortIndex: 11
      x-methodName: createPaymentInstrument
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              createBusinessAccountNL:
                $ref: '#/components/examples/post-paymentInstruments-createBusinessAccountNL'
              createBusinessAccountUS:
                $ref: '#/components/examples/post-paymentInstruments-createBusinessAccountUS'
              createPhysicalCard:
                $ref: '#/components/examples/post-paymentInstruments-createPhysicalCard'
              createVirtualCard:
                $ref: '#/components/examples/post-paymentInstruments-createVirtualCard'
            schema:
              $ref: '#/components/schemas/PaymentInstrumentInfo'
      responses:
        '200':
          content:
            application/json:
              examples:
                createBusinessAccountNL:
                  $ref: '#/components/examples/post-paymentInstruments-createBusinessAccountNL-200'
                createBusinessAccountUS:
                  $ref: '#/components/examples/post-paymentInstruments-createBusinessAccountUS-200'
                createPhysicalCard:
                  $ref: '#/components/examples/post-paymentInstruments-createPhysicalCard-200'
                createVirtualCard:
                  $ref: '#/components/examples/post-paymentInstruments-createVirtualCard-200'
              schema:
                $ref: '#/components/schemas/PaymentInstrument'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstruments/{id}:
    get:
      tags:
      - Payments
      summary: Adyen Get a Payment Instrument
      description: Returns the details of a payment instrument.
      x-addedInVersion: '1'
      operationId: get-paymentInstruments-id
      x-sortIndex: 13
      x-methodName: getPaymentInstrument
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the payment instrument.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-paymentInstruments-id-success-200'
              schema:
                $ref: '#/components/schemas/PaymentInstrument'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      tags:
      - Payments
      summary: Adyen Update a Payment Instrument
      description: Updates a payment instrument. Once a payment instrument is already active, you can only update its status. However, for cards created with **inactive** status, you can still update the balance account associated with the card.
      x-addedInVersion: '1'
      operationId: patch-paymentInstruments-id
      x-sortIndex: 12
      x-methodName: updatePaymentInstrument
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      requestBody:
        content:
          application/json:
            examples:
              updatePaymentInstrumentBalanceAccount:
                $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount'
              updatePaymentInstrumentStatus:
                $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus'
            schema:
              $ref: '#/components/schemas/PaymentInstrumentUpdateRequest'
      parameters:
      - description: The unique identifier of the payment instrument.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                updatePaymentInstrumentBalanceAccount:
                  $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount-200'
                updatePaymentInstrumentStatus:
                  $ref: '#/components/examples/patch-paymentInstruments-id-updatePaymentInstrumentStatus-200'
              schema:
                $ref: '#/components/schemas/UpdatePaymentInstrument'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstruments/{id}/networkTokens:
    get:
      tags:
      - Payments
      summary: Adyen List Network Tokens
      description: List the network tokens connected to a payment instrument.
      x-addedInVersion: '1'
      operationId: get-paymentInstruments-id-networkTokens
      x-sortIndex: 15
      x-methodName: listNetworkTokens
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the payment instrument.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListNetworkTokensResponse'
              examples:
                get-paymentInstruments-id-networkTokens200Example:
                  summary: Default get-paymentInstruments-id-networkTokens 200 response
                  x-microcks-default: true
                  value:
                    networkTokens:
                    - example_value
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstruments/{id}/reveal:
    get:
      tags:
      - Payments
      summary: Adyen Get the PAN of a Payment Instrument
      description: 'Returns the primary account number (PAN) of a payment instrument.


        To make this request, your API credential must have the following [role](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service#api-permissions):


        * Balance Platform BCL PCI role'
      x-addedInVersion: '1'
      operationId: get-paymentInstruments-id-reveal
      x-sortIndex: 14
      x-methodName: getPanOfPaymentInstrument
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the payment instrument.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-paymentInstruments-id-reveal-success-200'
              schema:
                $ref: '#/components/schemas/PaymentInstrumentRevealInfo'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /paymentInstruments/{id}/transactionRules:
    get:
      tags:
      - Payments
      summary: Adyen Get All Transaction Rules for a Payment Instrument
      description: Returns a list of transaction rules associated with a payment instrument.
      x-addedInVersion: '1'
      operationId: get-paymentInstruments-id-transactionRules
      x-sortIndex: 14
      x-methodName: getAllTransactionRulesForPaymentInstrument
      security:
      - clientKey: []
      - BasicAuth: []
      - ApiKeyAuth: []
      parameters:
      - description: The unique identifier of the payment instrument.
        name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                success:
                  $ref: '#/components/examples/get-paymentInstruments-id-transactionRules-success-200'
              schema:
                $ref: '#/components/schemas/TransactionRulesResponse'
          description: OK - the request has succeeded.
        '400':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-400_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Bad Request - a problem reading or understanding the request.
        '401':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-401_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unauthorized - authentication required.
        '403':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-403_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Forbidden - insufficient permissions to process the request.
        '422':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-422_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Unprocessable Entity - a request validation error.
        '500':
          content:
            application/json:
              examples:
                generic:
                  $ref: '#/components/examples/generic-500_2'
              schema:
                $ref: '#/components/schemas/RestServiceError'
          description: Internal Server Error - the server could not process the request.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    LineItem:
      properties:
        amountExcludingTax:
          description: Item amount excluding the tax, in minor units.
          format: int64
          type: integer
        amountIncludingTax:
          description: Item amount including the tax, in minor units.
          format: int64
          type: integer
        brand:
          x-addedInVersion: '70'
          description: Brand of the item.
          type: string
        color:
          x-addedInVersion: '70'
          description: Color of the item.
          type: string
        description:
          description: Description of the line item.
          type: string
        id:
          description: ID of the line item.
          type: string
        imageUrl:
          description: Link to the picture of the purchased item.
          type: string
        itemCategory:
          description: Item category, used by the payment methods PayPal and Ratepay.
          type: string
        manufacturer:
          x-addedInVersion: '70'
          description: Manufacturer of the item.
          type: string
        productUrl:
          description: Link to the purchased item.
          type: string
        quantity:
          description: Number of items.
          format: int64
          type: integer
        receiverEmail:
          x-addedInVersion: '70'
          description: Email associated with the given product in the basket (usually in electronic gift cards).
          type: string
        size:
          x-addedInVersion: '70'
          description: Size of the item.
          type: string
        sku:
          x-addedInVersion: '70'
          description: Stock keeping unit.
          type: string
        taxAmount:
          description: Tax amount, in minor units.
          format: int64
          type: integer
        taxPercentage:
          description: Tax percentage, in minor units.
          format: int64
          type: integer
        upc:
          x-addedInVersion: '70'
          description: Universal Product Code.
          type: string
      type: object
    EcontextVoucherDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        firstName:
          description: The shopper's first name.
          type: string
        lastName:
          description: The shopper's last name.
          type: string
        shopperEmail:
          description: The shopper's email.
          type: string
        telephoneNumber:
          description: The shopper's contact number. It must have an international number format, for example **+31 20 779 1846**. Formats like **+31 (0)20 779 1846** or **0031 20 779 1846** are not accepted.
          type: string
        type:
          description: '**econtextvoucher**'
          enum:
          - econtext_seveneleven
          - econtext_stores
          type: string
      required:
      - type
      - firstName
      - lastName
      - shopperEmail
      - telephoneNumber
      title: Voucher
      type: object
    ThreeDSRequestorPriorAuthenticationInfo:
      properties:
        threeDSReqPriorAuthData:
          description: 'Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.'
          type: string
        threeDSReqPriorAuthMethod:
          description: 'Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values:

            * **01**  Frictionless authentication occurred by ACS.

            * **02**  Cardholder challenge occurred by ACS.

            * **03**  AVS verified.

            * **04**  Other issuer methods.'
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          maxLength: 2
          minLength: 2
          type: string
        threeDSReqPriorAuthTimestamp:
          description: 'Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM'
          maxLength: 12
          minLength: 12
          type: string
        threeDSReqPriorRef:
          description: 'This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters.'
          maxLength: 36
          minLength: 36
          type: string
      type: object
    BillDeskDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The issuer id of the shopper's selected bank.
          type: string
        type:
          description: '**billdesk**'
          enum:
          - billdesk_online
          - billdesk_wallet
          type: string
      required:
      - type
      - issuer
      title: BillDesk
      type: object
    CountriesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes.
          items:
            type: string
          type: array
      required:
      - operation
      type: object
    UpdatePaymentInstrument:
      properties:
        balanceAccountId:
          description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
          type: string
        bankAccount:
          description: Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**.
          oneOf:
          - $ref: '#/components/schemas/IbanAccountIdentification'
          - $ref: '#/components/schemas/USLocalAccountIdentification'
        card:
          description: Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**.
          $ref: '#/components/schemas/Card_2'
        description:
          description: Your description for the payment instrument, maximum 300 characters.
          maxLength: 300
          type: string
        id:
          description: The unique identifier of the payment instrument.
          type: string
        issuingCountryCode:
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.
          type: string
        paymentInstrumentGroupId:
          description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.
          type: string
        reference:
          description: Your reference for the payment instrument, maximum 150 characters.
          maxLength: 150
          type: string
        status:
          description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**:  The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n"
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        statusComment:
          description: 'Comment for the status of the payment instrument.


            Required if `statusReason` is **other**.'
          type: string
        statusReason:
          x-addedInVersion: '2'
          description: 'The reason for the status of the payment instrument.


            Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**.

            If the reason is **other**, you must also send the `statusComment` parameter describing the status change.'
          enum:
          - accountClosure
          - damaged
          - endOfLife
          - expired
          - lost
          - other
          - stolen
          - suspectedFraud
          - transactionRule
          type: string
        type:
          description: 'Type of payment instrument.


            Possible value: **card**, **bankAccount**. '
          enum:
          - bankAccount
          - card
          type: string
      required:
      - balanceAccountId
      - issuingCountryCode
      - type
      - id
      type: object
    ForexQuote:
      properties:
        account:
          description: The account name.
          type: string
        accountType:
          description: The account type.
          type: string
        baseAmount:
          description: The base amount.
          $ref: '#/components/schemas/Amount'
        basePoints:
          description: The base points.
          format: int32
          type: integer
        buy:
          description: The buy rate.
          $ref: '#/components/schemas/Amount'
        interbank:
          description: The interbank amount.
          $ref: '#/components/schemas/Amount'
        reference:
          description: The reference assigned to the forex quote request.
          type: string
        sell:
          description: The sell rate.
          $ref: '#/components/schemas/Amount'
        signature:
          description: The signature to validate the integrity.
          type: string
        source:
          description: The source of the forex quote.
          type: string
        type:
          description: The type of forex.
          type: string
        validTill:
          description: The date until which the forex quote is valid.
          format: date-time
          type: string
      required:
      - validTill
      - basePoints
      type: object
    MatchingTransactionsRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: The number of transactions.
          format: int32
          type: integer
      required:
      - operation
      type: object
    PaymentCancelResponse:
      properties:
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        paymentPspReference:
          description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to cancel. '
          type: string
        pspReference:
          description: Adyen's 16-character reference associated with the cancel request.
          type: string
        reference:
          description: Your reference for the cancel request.
          type: string
        status:
          description: The status of your request. This will always have the value **received**.
          enum:
          - received
          type: string
      required:
      - status
      - merchantAccount
      - paymentPspReference
      - pspReference
      type: object
    PaymentMethodsResponse:
      properties:
        paymentMethods:
          description: Detailed list of payment methods required to generate payment forms.
          items:
            $ref: '#/components/schemas/PaymentMethod'
          type: array
        storedPaymentMethods:
          x-addedInVersion: '49'
          description: List of all stored payment methods.
          items:
            $ref: '#/components/schemas/StoredPaymentMethod'
          type: array
      type: object
    UpdatePaymentLinkRequest:
      properties:
        status:
          description: 'Status of the payment link. Possible values:

            * **expired**'
          enum:
          - expired
          type: string
      required:
      - status
      type: object
    AdditionalDataRiskStandalone:
      properties:
        PayPal.CountryCode:
          description: Shopper's country of residence in the form of ISO standard 3166 2-character country codes.
          type: string
        PayPal.EmailId:
          description: Shopper's email.
          type: string
        PayPal.FirstName:
          description: Shopper's first name.
          type: string
        PayPal.LastName:
          description: Shopper's last name.
          type: string
        PayPal.PayerId:
          description: 'Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.'
          type: string
        PayPal.Phone:
          description: Shopper's phone number.
          type: string
        PayPal.ProtectionEligibility:
          description: 'Allowed values:

            * **Eligible**  Merchant is protected by PayPal''s Seller Protection Policy for Unauthorized Payments and Item Not Received.


            * **PartiallyEligible**  Merchant is protected by PayPal''s Seller Protection Policy for Item Not Received.


            * **Ineligible**  Merchant is not protected under the Seller Protection Policy.'
          type: string
        PayPal.TransactionId:
          description: Unique transaction ID of the payment.
          type: string
        avsResultRaw:
          description: 'Raw AVS result received from the acquirer, where available. Example: D'
          type: string
        bin:
          description: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).
          type: string
        cvcResultRaw:
          description: 'Raw CVC result received from the acquirer, where available. Example: 1'
          type: string
        riskToken:
          description: Unique identifier or token for the shopper's card details.
          type: string
        threeDAuthenticated:
          description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true'
          type: string
        threeDOffered:
          description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true'
          type: string
        tokenDataType:
          description: 'Required for PayPal payments only. The only supported value is: **paypal**.'
          type: string
      type: object
    ResponseAdditionalDataNetworkTokens:
      properties:
        networkToken.available:
          description: Indicates whether a network token is available for the specified card.
          type: string
        networkToken.bin:
          description: The Bank Identification Number of a tokenized card, which is the first six digits of a card number.
          type: string
        networkToken.tokenSummary:
          description: The last four digits of a network token.
          type: string
      type: object
    PaymentMethod:
      properties:
        brand:
          x-addedInVersion: '65'
          description: 'Brand for the selected gift card. For example: plastix, hmclub.'
          type: string
        brands:
          x-addedInVersion: '49'
          description: 'List of possible brands. For example: visa, mc.'
          items:
            type: string
          type: array
        configuration:
          additionalProperties:
            type: string
          description: The configuration of the payment method.
          type: object
        fundingSource:
          x-addedInVersion: '53'
          description: The funding source of the payment method.
          enum:
          - credit
          - debit
          type: string
        group:
          description: The group where this payment method belongs to.
          $ref: '#/components/schemas/PaymentMethodGroup'
        inputDetails:
          deprecated: true
          description: All input details to be provided to complete the payment with this payment method.
          items:
            $ref: '#/components/schemas/InputDetail'
          type: array
        issuers:
          x-addedInVersion: '68'
          description: A list of issuers for this payment method.
          items:
            $ref: '#/components/schemas/PaymentMethodIssuer'
          type: array
        name:
          description: The displayable name of this payment method.
          type: string
        type:
          description: The unique payment method code.
          type: string
      type: object
    PaymentSetupRequest:
      properties:
        additionalAmount:
          description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).

            Required to be in the same currency as the `amount`. '
          $ref: '#/components/schemas/Amount'
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/AdditionalData3DSecure'
          - $ref: '#/components/schemas/AdditionalDataAirline'
          - $ref: '#/components/schemas/AdditionalDataCarRental'
          - $ref: '#/components/schemas/AdditionalDataCommon'
          - $ref: '#/components/schemas/AdditionalDataLevel23'
          - $ref: '#/components/schemas/AdditionalDataLodging'
          - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
          - $ref: '#/components/schemas/AdditionalDataOpi'
          - $ref: '#/components/schemas/AdditionalDataRatepay'
          - $ref: '#/components/schemas/AdditionalDataRetry'
          - $ref: '#/components/schemas/AdditionalDataRisk'
          - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
          - $ref: '#/components/schemas/AdditionalDataSubMerchant'
          - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
          - $ref: '#/components/schemas/AdditionalDataWallets'
          description: 'This field contains additional data, which may be required for a particular payment request.


            The `additionalData` object consists of entries, each of which includes the key and value.'
          type: object
        allowedPaymentMethods:
          x-addedInVersion: '33'
          description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"allowedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        amount:
          description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          x-addedInVersion: '40'
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        billingAddress:
          x-addedInVersion: '4'
          description: 'The address where to send the invoice.

            > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.

            >* For 3D Secure 2 transactions in all browser-based and mobile implementations.

            >* For cross-border payouts to and from Canada.'
          $ref: '#/components/schemas/Address'
        blockedPaymentMethods:
          x-addedInVersion: '33'
          description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"blockedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        captureDelayHours:
          x-addedInVersion: '2'
          description: The delay between the authorisation and scheduled auto-capture, specified in hours.
          format: int32
          type: integer
        channel:
          description: 'The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`.


            Possible values:

            * iOS

            * Android

            * Web'
          enum:
          - iOS
          - Android
          - Web
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
          type: string
        company:
          x-addedInVersion: '32'
          description: Information regarding the company.
          $ref: '#/components/schemas/Company'
        configuration:
          description: Specify configurations to enable additional features.
          $ref: '#/components/schemas/Configuration'
        conversionId:
          x-addedInVersion: '49'
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `checkoutAttemptId` instead
          description: Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
          type: string
        countryCode:
          description: 'The shopper country.


            Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

            Example: NL or DE'
          type: string
        dateOfBirth:
          x-addedInVersion: '7'
          description: 'The shopper''s date of birth.


            Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
          format: date
          type: string
        dccQuote:
          description: The forex quote as returned in the response of the forex service.
          $ref: '#/components/schemas/ForexQuote'
        deliveryAddress:
          description: The address where the purchased goods should be delivered.
          $ref: '#/components/schemas/Address'
        deliveryDate:
          x-addedInVersion: '8'
          description: 'The date and time the purchased goods should be delivered.


            Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD


            Example: 2017-07-17T13:42:40.428+01:00'
          format: date-time
          type: string
        enableOneClick:
          x-addedInVersion: '32'
          description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
          type: boolean
        enablePayOut:
          x-addedInVersion: '32'
          description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
          type: boolean
        enableRecurring:
          x-addedInVersion: '32'
          description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
          type: boolean
        entityType:
          x-addedInVersion: '24'
          description: The type of the entity the payment is processed for.
          enum:
          - NaturalPerson
          - CompanyName
          type: string
        fraudOffset:
          description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
          format: int32
          type: integer
        installments:
          x-addedInVersion: '4'
          description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
          $ref: '#/components/schemas/Installments'
        lineItems:
          x-addedInVersion: '32'
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        localizedShopperStatement:
          x-addedInVersion: '68'
          additionalProperties:
            type: string
          description: "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters."
          type: object
        mandate:
          description: The mandate details to initiate recurring transaction.
          $ref: '#/components/schemas/Mandate'
        mcc:
          x-addedInVersion: '12'
          description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
          type: string
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        merchantOrderReference:
          x-addedInVersion: '9'
          description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.

            The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

            > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
          type: string
        metadata:
          x-addedInVersion: '17'
          additionalProperties:
            type: string
          description: 'Metadata consists of entries, each of which includes a key and a value.

            Limits:

            * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".

            * Maximum 20 characters per key.

            * Maximum 80 characters per value. '
          type: object
        orderReference:
          description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
          type: string
        origin:
          description: 'Required for the Web integration.


            Set this parameter to the origin URL of the page that you are loading the SDK from.'
          type: string
        platformChargebackLogic:
          x-addedInVersion: '68'
          description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
          $ref: '#/components/schemas/PlatformChargebackLogic'
        recurringExpiry:
          description: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
          type: string
        recurringFrequency:
          description: Minimum number of days between authorisations. Only for 3D Secure 2.
          type: string
        reference:
          description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.

            If you need to provide multiple references for a transaction, separate them with hyphens ("-").

            Maximum length: 80 characters.'
          type: string
        returnUrl:
          description: 'The URL to return to in case of a redirection.

            The format depends on the channel. This URL can have a maximum of 1024 characters.

            * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.

            Example: `https://your-company.com/checkout?shopperOrder=12xy`

            * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).

            Example: `my-app://`

            * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).

            Example: `my-app://your.package.name`'
          maxLength: 8000
          type: string
        riskData:
          description: Contains risk data, such as client-side data, used to identify risk for a transaction.
          $ref: '#/components/schemas/RiskData'
        sdkVersion:
          x-addedInVersion: '32'
          description: The version of the SDK you are using (for Web SDK integrations only).
          type: string
        sessionValidity:
          description: 'The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.


            For example: 2020-07-18T15:42:40.428+01:00'
          type: string
        shopperEmail:
          description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks.

            > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.'
          type: string
        shopperIP:
          description: 'The shopper''s IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

            > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.

            This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
          type: string
        shopperInteraction:
          description: 'Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

            For the web service API, Adyen assumes Ecommerce shopper interaction by default.


            This field has the following possible values:

            * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.

            * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).

            * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.

            * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.'
          enum:
          - Ecommerce
          - ContAuth
          - Moto
          - POS
          type: string
        shopperLocale:
          x-addedInVersion: '7'
          description: The combination of a language code and a country code to specify the language to be used in the payment.
          type: string
        shopperName:
          x-addedInVersion: '7'
          description: The shopper's full name.
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address."
          type: string
        shopperStatement:
          description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**."
          type: string
        socialSecurityNumber:
          x-addedInVersion: '4'
          description: The shopper's social security number.
          type: string
        splits:
          x-addedInVersion: '37'
          description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        store:
          x-addedInVersion: '23'
          description: Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
          maxLength: 16
          minLength: 1
          type: string
        storePaymentMethod:
          x-addedInVersion: '49'
          description: When true and `shopperReference` is provided, the payment details will be stored.
          type: boolean
        telephoneNumber:
          x-addedInVersion: '7'
          description: The shopper's telephone number.
          type: string
        threeDSAuthenticationOnly:
          x-addedInVersion: '50'
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
          default: false
          description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
          type: boolean
        token:
          description: 'The token obtained when initializing the SDK.


            > This parameter is required for iOS and Android; not required for Web.'
          type: string
        trustedShopper:
          x-addedInVersion: '37'
          description: Set to true if the payment should be routed to a trusted MID.
          type: boolean
      required:
      - merchantAccount
      - reference
      - amount
      - returnUrl
      - countryCode
      type: object
    UpiCollectDetails:
      additionalProperties: false
      properties:
        billingSequenceNumber:
          description: The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        shopperNotificationReference:
          description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: upi_collect
          description: '**upi_collect**'
          enum:
          - upi_collect
          type: string
        virtualPaymentAddress:
          description: The virtual payment address for UPI.
          type: string
      required:
      - type
      - billingSequenceNumber
      title: UPI Collect
      type: object
    BalanceCheckRequest:
      properties:
        accountInfo:
          x-addedInVersion: '40'
          description: 'Shopper account information for 3D Secure 2.

            > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
          $ref: '#/components/schemas/AccountInfo'
        additionalAmount:
          description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).

            Required to be in the same currency as the `amount`. '
          $ref: '#/components/schemas/Amount'
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/AdditionalData3DSecure'
          - $ref: '#/components/schemas/AdditionalDataAirline'
          - $ref: '#/components/schemas/AdditionalDataCarRental'
          - $ref: '#/components/schemas/AdditionalDataCommon'
          - $ref: '#/components/schemas/AdditionalDataLevel23'
          - $ref: '#/components/schemas/AdditionalDataLodging'
          - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
          - $ref: '#/components/schemas/AdditionalDataOpi'
          - $ref: '#/components/schemas/AdditionalDataRatepay'
          - $ref: '#/components/schemas/AdditionalDataRetry'
          - $ref: '#/components/schemas/AdditionalDataRisk'
          - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
          - $ref: '#/components/schemas/AdditionalDataSubMerchant'
          - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
          - $ref: '#/components/schemas/AdditionalDataWallets'
          description: 'This field contains additional data, which may be required for a particular payment request.


            The `additionalData` object consists of entries, each of which includes the key and value.'
          type: object
        amount:
          description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          x-addedInVersion: '40'
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        billingAddress:
          x-addedInVersion: '4'
          description: 'The address where to send the invoice.

            > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.

            >* For 3D Secure 2 transactions in all browser-based and mobile implementations.

            >* For cross-border payouts to and from Canada.'
          $ref: '#/components/schemas/Address'
        browserInfo:
          description: 'The shopper''s browser information.

            > For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate  that your integration can support a redirect in case a payment is routed to 3D Secure 1.'
          $ref: '#/components/schemas/BrowserInfo'
        captureDelayHours:
          x-addedInVersion: '2'
          description: The delay between the authorisation and scheduled auto-capture, specified in hours.
          format: int32
          type: integer
        dateOfBirth:
          x-addedInVersion: '7'
          description: 'The shopper''s date of birth.


            Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
          format: date
          type: string
        dccQuote:
          description: The forex quote as returned in the response of the forex service.
          $ref: '#/components/schemas/ForexQuote'
        deliveryAddress:
          description: The address where the purchased goods should be delivered.
          $ref: '#/components/schemas/Address'
        deliveryDate:
          x-addedInVersion: '8'
          description: 'The date and time the purchased goods should be delivered.


            Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD


            Example: 2017-07-17T13:42:40.428+01:00'
          format: date-time
          type: string
        deviceFingerprint:
          x-addedInVersion: '2'
          description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
          maxLength: 5000
          type: string
        fraudOffset:
          description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
          format: int32
          type: integer
        installments:
          x-addedInVersion: '4'
          description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
          $ref: '#/components/schemas/Installments'
        localizedShopperStatement:
          x-addedInVersion: '68'
          additionalProperties:
            type: string
          description: "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters."
          type: object
        mcc:
          x-addedInVersion: '12'
          description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
          type: string
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        merchantOrderReference:
          x-addedInVersion: '9'
          description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.

            The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

            > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
          type: string
        merchantRiskIndicator:
          x-addedInVersion: '40'
          description: 'Additional risk fields for 3D Secure 2.

            > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
          $ref: '#/components/schemas/MerchantRiskIndicator'
        metadata:
          x-addedInVersion: '17'
          additionalProperties:
            type: string
          description: 'Metadata consists of entries, each of which includes a key and a value.

            Limits:

            * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".

            * Maximum 20 characters per key.

            * Maximum 80 characters per value. '
          type: object
        orderReference:
          description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
          type: string
        paymentMethod:
          additionalProperties:
            type: string
          description: The collection that contains the type of the payment method and its specific information.
          type: object
        recurring:
          description: The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).
          $ref: '#/components/schemas/Recurring'
        recurringProcessingModel:
          x-addedInVersion: '30'
          description: 'Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.

            Allowed values:

            * `Subscription`  A transaction for a fixed or variable amount, which follows a fixed schedule.

            * `CardOnFile`  With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.

            * `UnscheduledCardOnFile`  An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder''s balance drops below a certain amount.

            '
          enum:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: string
        reference:
          description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.

            If you need to provide multiple references for a transaction, separate them with hyphens ("-").

            Maximum length: 80 characters.'
          type: string
        selectedBrand:
          description: 'Some payment methods require defining a value for this field to specify how to process the transaction.


            For the Bancontact payment method, it can be set to:

            * `maestro` (default), to be processed like a Maestro card, or

            * `bcmc`, to be processed like a Bancontact card.'
          type: string
        selectedRecurringDetailReference:
          description: The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.
          type: string
        sessionId:
          description: A session ID used to identify a payment session.
          type: string
        shopperEmail:
          description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks.

            > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.'
          type: string
        shopperIP:
          description: 'The shopper''s IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

            > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.

            This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
          type: string
        shopperInteraction:
          description: 'Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

            For the web service API, Adyen assumes Ecommerce shopper interaction by default.


            This field has the following possible values:

            * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.

            * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).

            * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.

            * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.'
          enum:
          - Ecommerce
          - ContAuth
          - Moto
          - POS
          type: string
        shopperLocale:
          x-addedInVersion: '7'
          description: The combination of a language code and a country code to specify the language to be used in the payment.
          type: string
        shopperName:
          x-addedInVersion: '7'
          description: The shopper's full name.
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address."
          type: string
        shopperStatement:
          description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**."
          type: string
        socialSecurityNumber:
          x-addedInVersion: '4'
          description: The shopper's social security number.
          type: string
        splits:
          x-addedInVersion: '37'
          description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        store:
          x-addedInVersion: '23'
          description: Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
          maxLength: 16
          minLength: 1
          type: string
        telephoneNumber:
          x-addedInVersion: '7'
          description: The shopper's telephone number.
          type: string
        threeDS2RequestData:
          x-addedInVersion: '40'
          description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
          $ref: '#/components/schemas/ThreeDS2RequestData'
        threeDSAuthenticationOnly:
          x-addedInVersion: '50'
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
          default: false
          description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
          type: boolean
        totalsGroup:
          x-addedInVersion: '23'
          description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
          maxLength: 16
          minLength: 1
          type: string
        trustedShopper:
          x-addedInVersion: '37'
          description: Set to true if the payment should be routed to a trusted MID.
          type: boolean
      required:
      - merchantAccount
      - amount
      - paymentMethod
      type: object
    BalanceCheckResponse:
      properties:
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
          - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
          - $ref: '#/components/schemas/ResponseAdditionalDataCard'
          - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
          - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
          - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
          - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
          - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
          - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
          description: 'Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.'
          type: object
        balance:
          description: The balance for the payment method.
          $ref: '#/components/schemas/Amount'
        fraudResult:
          description: The fraud result properties of the payment.
          $ref: '#/components/schemas/FraudResult'
        pspReference:
          description: Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
          type: string
        refusalReason:
          description: 'If the payment''s authorisation is refused or an error occurs during authorisation, this field holds Adyen''s mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.


            For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
          type: string
        resultCode:
          description: 'The result of the cancellation request.


            Possible values:


            * **Success**  Indicates that the balance check was successful.

            * **NotEnoughBalance**  Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount.

            * **Failed**  Indicates that the balance check failed.'
          enum:
          - Success
          - NotEnoughBalance
          - Failed
          type: string
        transactionLimit:
          x-addedInVersion: '65'
          description: The maximum spendable balance for a single transaction. Applicable to some gift cards.
          $ref: '#/components/schemas/Amount'
      required:
      - balance
      - resultCode
      type: object
    Phone_2:
      properties:
        number:
          description: "The full phone number provided as a single string. \nFor example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, \n\n or **\"(0031) 611223344\"**."
          type: string
        type:
          description: "Type of phone number.\nPossible values: \n**Landline**, **Mobile**.\n"
          enum:
          - landline
          - mobile
          type: string
      required:
      - number
      - type
      type: object
    PaymentInstrument:
      properties:
        balanceAccountId:
          description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
          type: string
        bankAccount:
          description: Contains the business account details. Returned when you create a payment instrument with `type` **bankAccount**.
          oneOf:
          - $ref: '#/components/schemas/IbanAccountIdentification'
          - $ref: '#/components/schemas/USLocalAccountIdentification'
        card:
          description: Contains information about the card payment instrument. Returned when you create a payment instrument with `type` **card**.
          $ref: '#/components/schemas/Card_2'
        description:
          description: Your description for the payment instrument, maximum 300 characters.
          maxLength: 300
          type: string
        id:
          description: The unique identifier of the payment instrument.
          type: string
        issuingCountryCode:
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.
          type: string
        paymentInstrumentGroupId:
          description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.
          type: string
        reference:
          description: Your reference for the payment instrument, maximum 150 characters.
          maxLength: 150
          type: string
        status:
          description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**:  The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n"
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        statusReason:
          x-addedInVersion: '2'
          description: 'The reason for the status of the payment instrument.


            Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**.

            If the reason is **other**, you must also send the `statusComment` parameter describing the status change.'
          enum:
          - accountClosure
          - damaged
          - endOfLife
          - expired
          - lost
          - other
          - stolen
          - suspectedFraud
          - transactionRule
          type: string
        type:
          description: 'Type of payment instrument.


            Possible value: **card**, **bankAccount**. '
          enum:
          - bankAccount
          - card
          type: string
      required:
      - balanceAccountId
      - issuingCountryCode
      - type
      - id
      type: object
    TimeOfDay:
      properties:
        endTime:
          description: 'The end time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**.


            '
          type: string
        startTime:
          description: 'The start time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**.


            '
          type: string
      type: object
    OpenInvoiceDetails:
      additionalProperties: false
      properties:
        billingAddress:
          description: The address where to send the invoice.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        deliveryAddress:
          description: The address where the goods should be delivered.
          type: string
        personalDetails:
          description: Shopper name, date of birth, phone number, and email address.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: openinvoice
          description: '**openinvoice**'
          enum:
          - openinvoice
          - afterpay_directdebit
          - atome_pos
          type: string
      title: Open Invoice
      type: object
    DeliveryContact:
      properties:
        address:
          description: The address of the contact.
          $ref: '#/components/schemas/DeliveryAddress_2'
        email:
          description: The email address of the contact.
          type: string
        fullPhoneNumber:
          description: 'The full phone number of the contact provided as a single string. It will be handled as a landline phone.

            **Examples:** "0031 6 11 22 33 44", "+316/1122-3344", "(0031) 611223344"'
          type: string
        name:
          description: The name of the contact.
          $ref: '#/components/schemas/Name'
        phoneNumber:
          description: The phone number of the contact.
          $ref: '#/components/schemas/PhoneNumber'
        webAddress:
          description: The URL of the contact's website.
          type: string
      required:
      - name
      - address
      type: object
    PayWithGoogleDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        googlePayToken:
          description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: paywithgoogle
          description: '**paywithgoogle**'
          enum:
          - paywithgoogle
          type: string
      required:
      - googlePayToken
      title: Google Pay
      type: object
    AdditionalDataWallets:
      properties:
        androidpay.token:
          description: The Android Pay token retrieved from the SDK.
          type: string
        masterpass.transactionId:
          description: The Mastercard Masterpass Transaction ID retrieved from the SDK.
          type: string
        payment.token:
          description: The Apple Pay token retrieved from the SDK.
          type: string
        paywithgoogle.token:
          description: The Google Pay token retrieved from the SDK.
          type: string
        samsungpay.token:
          description: The Samsung Pay token retrieved from the SDK.
          type: string
        visacheckout.callId:
          description: The Visa Checkout Call ID retrieved from the SDK.
          type: string
      type: object
    InstallmentsNumber:
      properties:
        maxNumberOfInstallments:
          description: Maximum number of installments
          format: int32
          type: integer
      required:
      - maxNumberOfInstallments
      type: object
    CardConfiguration:
      properties:
        activation:
          description: Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions.
          type: string
        activationUrl:
          description: "Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. \n\nMaximum length: 255 characters."
          maxLength: 255
          type: string
        bulkAddress:
          description: Overrides the shipment bulk address defined in the `configurationProfileId`.
          $ref: '#/components/schemas/BulkAddress'
        cardImageId:
          description: The ID of the card image. This is the image that will be printed on the full front of the card.
          type: string
        carrier:
          description: Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached.
          type: string
        carrierImageId:
          description: The ID of the carrier image. This is the image that will printed on the letter to which the card is attached.
          type: string
        configurationProfileId:
          description: 'The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them.


            For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile.'
          type: string
        currency:
          description: The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**.
          type: string
        envelope:
          description: 'Overrides the envelope design ID defined in the `configurationProfileId`. '
          type: string
        insert:
          description: Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card.
          type: string
        language:
          description: The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**.
          type: string
        logoImageId:
          description: The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner.
          type: string
        pinMailer:
          description: Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed.
          type: string
        shipmentMethod:
          description: Overrides the logistics company defined in the `configurationProfileId`.
          type: string
      required:
      - configurationProfileId
      type: object
    Address:
      properties:
        city:
          description: 'The name of the city. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        country:
          description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**.

            > If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.'
          type: string
        houseNumberOrName:
          description: 'The number or name of the house. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        postalCode:
          description: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
          type: string
        stateOrProvince:
          description: 'The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.

            > Required for the US and Canada.'
          type: string
        street:
          description: 'The name of the street. Maximum length: 3000 characters.

            > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.'
          maxLength: 3000
          type: string
      required:
      - street
      - houseNumberOrName
      - city
      - postalCode
      - country
      type: object
    AdditionalDataRatepay:
      properties:
        ratepay.installmentAmount:
          description: Amount the customer has to pay each month.
          type: string
        ratepay.interestRate:
          description: Interest rate of this installment.
          type: string
        ratepay.lastInstallmentAmount:
          description: Amount of the last installment.
          type: string
        ratepay.paymentFirstday:
          description: Calendar day of the first payment.
          type: string
        ratepaydata.deliveryDate:
          description: Date the merchant delivered the goods to the customer.
          type: string
        ratepaydata.dueDate:
          description: Date by which the customer must settle the payment.
          type: string
        ratepaydata.invoiceDate:
          description: Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.
          type: string
        ratepaydata.invoiceId:
          description: Identification name or number for the invoice, defined by the merchant.
          type: string
      type: object
    PaymentCompletionDetails:
      properties:
        MD:
          description: A payment session identifier returned by the card issuer.
          maxLength: 20000
          type: string
        PaReq:
          description: (3D) Payment Authentication Request data for the card issuer.
          type: string
        PaRes:
          description: (3D) Payment Authentication Response data by the card issuer.
          maxLength: 20000
          type: string
        authorization_token:
          type: string
        billingToken:
          description: PayPal-generated token for recurring payments.
          type: string
        cupsecureplus.smscode:
          description: The SMS verification code collected from the shopper.
          type: string
        facilitatorAccessToken:
          description: PayPal-generated third party access token.
          type: string
        oneTimePasscode:
          description: A random number sent to the mobile phone number of the shopper to verify the payment.
          type: string
        orderID:
          description: PayPal-assigned ID for the order.
          type: string
        payerID:
          description: PayPal-assigned ID for the payer (shopper).
          type: string
        payload:
          description: Payload appended to the `returnURL` as a result of the redirect.
          maxLength: 20000
          type: string
        paymentID:
          description: PayPal-generated ID for the payment.
          type: string
        paymentStatus:
          description: 'Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`.'
          type: string
        redirectResult:
          description: The result of the redirect as appended to the `returnURL`.
          maxLength: 20000
          type: string
        resultCode:
          description: Value you received from the WeChat Pay SDK.
          type: string
        threeDSResult:
          description: 'Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.'
          maxLength: 50000
          type: string
        threeds2.challengeResult:
          description: 'Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.'
          maxLength: 50000
          type: string
        threeds2.fingerprint:
          description: 'Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.'
          maxLength: 100000
          type: string
      type: object
    AdditionalData3DSecure:
      properties:
        allow3DS2:
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS` instead.
          description: "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\nor send the `executeThreeD` parameter.\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false**  Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n"
          type: string
        challengeWindowSize:
          description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          type: string
        executeThreeD:
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead
          description: "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true**  Perform 3D Secure authentication.\n* **false**  Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive  or other, national regulations. \n"
          type: string
        mpiImplementationType:
          description: In case of Secure+, this field must be set to **CUPSecurePlus**.
          type: string
        scaExemption:
          description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** "
          type: string
        threeDSVersion:
          description: "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n"
          type: string
      type: object
    StringMatch:
      properties:
        operation:
          description: 'The type of string matching operation. Possible values:  **startsWith**, **endsWith**, **isEqualTo**, **contains**,'
          enum:
          - contains
          - endsWith
          - isEqualTo
          - startsWith
          type: string
        value:
          description: The string to be matched.
          type: string
      type: object
    RatepayDetails:
      additionalProperties: false
      properties:
        billingAddress:
          description: The address where to send the invoice.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        deliveryAddress:
          description: The address where the goods should be delivered.
          type: string
        personalDetails:
          description: Shopper name, date of birth, phone number, and email address.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: ratepay
          description: '**ratepay**'
          enum:
          - ratepay
          - ratepay_directdebit
          type: string
      required:
      - type
      title: Ratepay
      type: object
    AdditionalDataSubMerchant:
      properties:
        subMerchant.numberOfSubSellers:
          description: Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.
          type: string
        subMerchant.subSeller[subSellerNr].city:
          description: 'Required for transactions performed by registered payment facilitators. The city of the sub-merchant''s address.

            * Format: Alphanumeric

            * Maximum length: 13 characters'
          type: string
        subMerchant.subSeller[subSellerNr].country:
          description: "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters"
          type: string
        subMerchant.subSeller[subSellerNr].id:
          description: "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters"
          type: string
        subMerchant.subSeller[subSellerNr].mcc:
          description: "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits"
          type: string
        subMerchant.subSeller[subSellerNr].name:
          description: 'Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement  that will appear in the card statement.

            * Format: Alphanumeric

            * Maximum length: 22 characters'
          type: string
        subMerchant.subSeller[subSellerNr].postalCode:
          description: 'Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant''s address, without dashes.

            * Format: Numeric

            * Fixed length: 8 digits'
          type: string
        subMerchant.subSeller[subSellerNr].state:
          description: 'Required for transactions performed by registered payment facilitators. The state code of the sub-merchant''s address, if applicable to the country.

            * Format: Alphanumeric

            * Maximum length: 2 characters'
          type: string
        subMerchant.subSeller[subSellerNr].street:
          description: 'Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant''s address.

            * Format: Alphanumeric

            * Maximum length: 60 characters'
          type: string
        subMerchant.subSeller[subSellerNr].taxId:
          description: 'Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.

            * Format: Numeric

            * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
          type: string
      type: object
    CheckoutSDKAction:
      additionalProperties: false
      properties:
        paymentData:
          description: Encoded payment data.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        sdkData:
          additionalProperties:
            type: string
          description: The data to pass to the SDK.
          type: object
        type:
          description: The type of the action.
          enum:
          - sdk
          - wechatpaySDK
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    MolPayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The shopper's bank. Specify this with the issuer value that corresponds to this bank.
          type: string
        type:
          description: '**molpay**'
          enum:
          - molpay_ebanking_fpx_MY
          - molpay_ebanking_TH
          type: string
      required:
      - type
      - issuer
      title: MOLPay
      type: object
    InstallmentOption:
      properties:
        maxValue:
          description: The maximum number of installments offered for this payment method.
          format: int32
          type: integer
        plans:
          x-addedInVersion: '64'
          description: 'Defines the type of installment plan. If not set, defaults to **regular**.


            Possible values:

            * **regular**

            * **revolving**'
          items:
            enum:
            - regular
            - revolving
            type: string
          type: array
        preselectedValue:
          x-addedInVersion: '64'
          description: Preselected number of installments offered for this payment method.
          format: int32
          type: integer
        values:
          x-addedInVersion: '64'
          description: An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`.
          items:
            format: int32
            type: integer
          type: array
      type: object
    ResponseAdditionalDataDomesticError:
      properties:
        domesticRefusalReasonRaw:
          description: "The reason the transaction was declined, given by the local issuer. \nCurrently available for merchants in Japan."
          type: string
        domesticShopperAdvice:
          description: "The action the shopper should take, in a local language. \nCurrently available in Japanese, for merchants in Japan."
          type: string
      type: object
    ExternalPlatform:
      properties:
        integrator:
          description: External platform integrator.
          type: string
        name:
          description: Name of the field. For example, Name of External Platform.
          type: string
        version:
          description: Version of the field. For example, Version of External Platform.
          type: string
      type: object
    PaymentSetupResponse:
      properties:
        paymentSession:
          description: The encoded payment session that you need to pass to the SDK.
          type: string
        recurringDetails:
          deprecated: true
          description: The detailed list of stored payment details required to generate payment forms. Will be empty if oneClick is set to false in the request.
          items:
            $ref: '#/components/schemas/RecurringDetail'
          type: array
      type: object
    ProcessingTypesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: 'List of processing types.


            Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **recurring**, **token**.


            '
          items:
            enum:
            - atmWithdraw
            - balanceInquiry
            - ecommerce
            - moto
            - pos
            - recurring
            - token
            - unknown
            type: string
          type: array
      required:
      - operation
      type: object
    CellulantDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The Cellulant issuer.
          type: string
        type:
          default: cellulant
          description: '**Cellulant**'
          enum:
          - cellulant
          type: string
      title: Cellulant
      type: object
    ThreeDSecureData:
      properties:
        authenticationResponse:
          description: 'In 3D Secure 1, the authentication response if the shopper was redirected.


            In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.'
          enum:
          - Y
          - N
          - U
          - A
          type: string
        cavv:
          description: The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).
          format: byte
          type: string
        cavvAlgorithm:
          description: The CAVV algorithm used. Include this only for 3D Secure 1.
          type: string
        challengeCancel:
          x-addedInVersion: '67'
          description: Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          - '07'
          type: string
        directoryResponse:
          description: 'In 3D Secure 1, this is the enrollment response from the 3D directory server.


            In 3D Secure 2, this is the `transStatus` from the `ARes`.'
          enum:
          - A
          - C
          - D
          - I
          - N
          - R
          - U
          - Y
          type: string
        dsTransID:
          x-addedInVersion: '40'
          description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.
          type: string
        eci:
          description: The electronic commerce indicator.
          type: string
        riskScore:
          x-addedInVersion: '67'
          description: Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations.
          type: string
        threeDSVersion:
          x-addedInVersion: '40'
          description: The version of the 3D Secure protocol.
          type: string
        tokenAuthenticationVerificationValue:
          x-addedInVersion: '68'
          description: Network token authentication verification value (TAVV). The network token cryptogram.
          format: byte
          type: string
        transStatusReason:
          x-addedInVersion: '67'
          description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
          type: string
        xid:
          description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).
          format: byte
          type: string
      type: object
    PaymentCaptureRequest:
      properties:
        amount:
          description: The amount that you want to capture. The `currency` must match the currency used in authorisation, the `value` must be smaller than or equal to the authorised amount.
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        lineItems:
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        platformChargebackLogic:
          x-addedInVersion: '70'
          description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
          $ref: '#/components/schemas/PlatformChargebackLogic'
        reference:
          description: 'Your reference for the capture request. Maximum length: 80 characters.'
          type: string
        splits:
          description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        subMerchants:
          x-addedInVersion: '70'
          description: A List of sub-merchants.
          items:
            $ref: '#/components/schemas/SubMerchantInfo'
          type: array
      required:
      - merchantAccount
      - amount
      type: object
    AndroidPayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        type:
          default: androidpay
          description: '**androidpay**'
          enum:
          - androidpay
          type: string
      title: Android Pay
      type: object
    Configuration:
      properties:
        avs:
          description: Describes the configuration for AVS ([Address Verification System](https://en.wikipedia.org/wiki/Address_Verification_System)).
          $ref: '#/components/schemas/Avs'
        cardHolderName:
          x-addedInVersion: '37'
          description: 'Determines whether the cardholder name should be provided or not.


            Permitted values:

            * NONE

            * OPTIONAL

            * REQUIRED'
          enum:
          - NONE
          - OPTIONAL
          - REQUIRED
          type: string
        installments:
          description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
          $ref: '#/components/schemas/InstallmentsNumber'
        shopperInput:
          x-addedInVersion: '37'
          description: Determines how to display the details fields.
          $ref: '#/components/schemas/ShopperInput'
      type: object
    AdditionalDataOpenInvoice:
      properties:
        openinvoicedata.merchantData:
          description: 'Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.


            The `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.


            Since the field is optional, if it''s not included it does not impact computing the merchant signature.


            Applies only to Klarna.


            You can contact Klarna for the format and structure of the string.'
          type: string
        openinvoicedata.numberOfLines:
          description: 'The number of invoice lines included in `openinvoicedata`.


            There needs to be at least one line, so `numberOfLines` needs to be at least 1.'
          type: string
        openinvoicedata.recipientFirstName:
          description: First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna.
          type: string
        openinvoicedata.recipientLastName:
          description: Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna.
          type: string
        openinvoicedataLine[itemNr].currencyCode:
          description: The three-character ISO currency code.
          type: string
        openinvoicedataLine[itemNr].description:
          description: A text description of the product the invoice line refers to.
          type: string
        openinvoicedataLine[itemNr].itemAmount:
          description: 'The price for one item in the invoice line, represented in minor units.


            The due amount for the item, VAT excluded.'
          type: string
        openinvoicedataLine[itemNr].itemId:
          description: A unique id for this item. Required for RatePay if the description of each item is not unique.
          type: string
        openinvoicedataLine[itemNr].itemVatAmount:
          description: The VAT due for one item in the invoice line, represented in minor units.
          type: string
        openinvoicedataLine[itemNr].itemVatPercentage:
          description: 'The VAT percentage for one item in the invoice line, represented in minor units.


            For example, 19% VAT is specified as 1900.'
          type: string
        openinvoicedataLine[itemNr].numberOfItems:
          description: The number of units purchased of a specific product.
          type: string
        openinvoicedataLine[itemNr].returnShippingCompany:
          description: Name of the shipping company handling the the return shipment.
          type: string
        openinvoicedataLine[itemNr].returnTrackingNumber:
          description: The tracking number for the return of the shipment.
          type: string
        openinvoicedataLine[itemNr].returnTrackingUri:
          description: URI where the customer can track the return of their shipment.
          type: string
        openinvoicedataLine[itemNr].shippingCompany:
          description: Name of the shipping company handling the delivery.
          type: string
        openinvoicedataLine[itemNr].shippingMethod:
          description: Shipping method.
          type: string
        openinvoicedataLine[itemNr].trackingNumber:
          description: The tracking number for the shipment.
          type: string
        openinvoicedataLine[itemNr].trackingUri:
          description: URI where the customer can track their shipment.
          type: string
      type: object
    PaymentInstrumentRevealInfo:
      properties:
        cvc:
          description: The CVC2 value of the card.
          type: string
        expiration:
          description: The expiration date of the card.
          $ref: '#/components/schemas/Expiry'
        pan:
          description: The primary account number (PAN) of the card.
          type: string
      required:
      - pan
      - expiration
      - cvc
      type: object
    ListNetworkTokensResponse:
      properties:
        networkTokens:
          description: List of network tokens.
          items:
            $ref: '#/components/schemas/NetworkToken'
          type: array
      type: object
    AdditionalDataRetry:
      properties:
        retry.chainAttemptNumber:
          description: 'The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.


            > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.'
          type: string
        retry.orderAttemptNumber:
          description: 'The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.


            > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.'
          type: string
        retry.skipRetry:
          description: 'The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.


            > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.'
          type: string
      type: object
    ShopperInteractionDevice:
      properties:
        locale:
          description: Locale on the shopper interaction device.
          type: string
        os:
          description: Operating system running on the shopper interaction device.
          type: string
        osVersion:
          description: Version of the operating system on the shopper interaction device.
          type: string
      type: object
    Card:
      properties:
        cvc:
          description: 'The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as:

            * CVV2/CVC2  length: 3 digits

            * CID  length: 4 digits

            > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server.

            > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).

            > When this value is returned in a response, it is always empty because it is not stored.'
          maxLength: 20
          minLength: 1
          type: string
        expiryMonth:
          description: 'The card expiry month.

            Format: 2 digits, zero-padded for single digits. For example:

            * 03 = March

            * 11 = November'
          maxLength: 2
          minLength: 1
          type: string
        expiryYear:
          description: 'The card expiry year.

            Format: 4 digits. For example: 2020'
          maxLength: 4
          minLength: 4
          type: string
        holderName:
          description: The name of the cardholder, as printed on the card.
          maxLength: 50
          minLength: 1
          type: string
        issueNumber:
          description: The issue number of the card (for some UK debit cards only).
          maxLength: 2
          minLength: 1
          type: string
        number:
          description: 'The card number (4-19 characters). Do not use any separators.

            When this value is returned in a response, only the last 4 digits of the card number are returned.'
          maxLength: 19
          minLength: 4
          type: string
        startMonth:
          description: The month component of the start date (for some UK debit cards only).
          maxLength: 2
          minLength: 1
          type: string
        startYear:
          description: The year component of the start date (for some UK debit cards only).
          maxLength: 4
          minLength: 4
          type: string
      type: object
    RiskData:
      properties:
        clientData:
          description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings.
          type: string
        customFields:
          x-addedInVersion: '65'
          additionalProperties:
            type: string
          description: Any custom fields used as part of the input to configured risk rules.
          type: object
        fraudOffset:
          x-addedInVersion: '65'
          description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
          format: int32
          type: integer
        profileReference:
          x-addedInVersion: '65'
          description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied.
          type: string
      type: object
    USLocalAccountIdentification:
      additionalProperties: false
      properties:
        accountNumber:
          description: The bank account number, without separators or whitespace.
          maxLength: 18
          minLength: 2
          type: string
        accountType:
          default: checking
          description: 'The bank account type.


            Possible values: **checking** or **savings**. Defaults to **checking**.'
          enum:
          - checking
          - savings
          type: string
        routingNumber:
          description: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace.
          maxLength: 9
          minLength: 9
          type: string
        type:
          default: usLocal
          description: '**usLocal**'
          enum:
          - usLocal
          type: string
      required:
      - type
      - accountNumber
      - routingNumber
      type: object
    PaymentRefundResponse:
      properties:
        amount:
          description: The refund amount.
          $ref: '#/components/schemas/Amount'
        lineItems:
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        merchantRefundReason:
          description: Your reason for the refund request.
          enum:
          - FRAUD
          - CUSTOMER REQUEST
          - RETURN
          - DUPLICATE
          - OTHER
          type: string
        paymentPspReference:
          description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund. '
          type: string
        pspReference:
          description: Adyen's 16-character reference associated with the refund request.
          type: string
        reference:
          description: Your reference for the refund request.
          type: string
        splits:
          description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        status:
          description: The status of your request. This will always have the value **received**.
          enum:
          - received
          type: string
        store:
          description: The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area.  Otherwise, you get an error and the refund fails.
          type: string
      required:
      - status
      - merchantAccount
      - amount
      - pspReference
      - paymentPspReference
      type: object
    PlatformChargebackLogic:
      properties:
        behavior:
          x-addedInVersion: '68'
          description: 'The method of handling the chargeback.


            Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.'
          enum:
          - deductAccordingToSplitRatio
          - deductFromLiableAccount
          - deductFromOneBalanceAccount
          type: string
        costAllocationAccount:
          x-addedInVersion: '68'
          description: The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account.
          type: string
        targetAccount:
          x-addedInVersion: '68'
          description: 'The unique identifier of the balance account against which the disputed amount is booked.


            Required if `behavior` is **deductFromOneBalanceAccount**.'
          type: string
      type: object
    TimeOfDayRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          $ref: '#/components/schemas/TimeOfDay'
      required:
      - operation
      type: object
    StoredPaymentMethod:
      properties:
        bankAccountNumber:
          description: The bank account number (without separators).
          type: string
        bankLocationId:
          description: The location id of the bank. The field value is `nil` in most cases.
          type: string
        brand:
          description: The brand of the card.
          type: string
        expiryMonth:
          description: The month the card expires.
          type: string
        expiryYear:
          description: The last two digits of the year the card expires. For example, **22** for the year 2022.
          type: string
        holderName:
          description: The unique payment method code.
          type: string
        iban:
          x-addedInVersion: '67'
          description: The IBAN of the bank account.
          type: string
        id:
          description: A unique identifier of this stored payment method.
          type: string
        label:
          x-addedInVersion: '70'
          description: The shoppers issuer account label
          type: string
        lastFour:
          description: The last four digits of the PAN.
          type: string
        name:
          description: The display name of the stored payment method.
          type: string
        networkTxReference:
          x-addedInVersion: '68'
          description: 'Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.


            This contains either the Mastercard Trace ID or the Visa Transaction ID.'
          type: string
        ownerName:
          x-addedInVersion: '67'
          description: The name of the bank account holder.
          type: string
        shopperEmail:
          description: The shoppers email address.
          type: string
        supportedRecurringProcessingModels:
          x-addedInVersion: '70'
          description: The supported recurring processing models for this stored payment method.
          items:
            type: string
          type: array
        supportedShopperInteractions:
          description: The supported shopper interactions for this stored payment method.
          items:
            type: string
          type: array
        type:
          description: The type of payment method.
          type: string
      type: object
    ResponseAdditionalDataBillingAddress:
      properties:
        billingAddress.city:
          description: The billing address city passed in the payment request.
          type: string
        billingAddress.country:
          description: 'The billing address country passed in the payment request.


            Example: NL'
          type: string
        billingAddress.houseNumberOrName:
          description: The billing address house number or name passed in the payment request.
          type: string
        billingAddress.postalCode:
          description: 'The billing address postal code passed in the payment request.


            Example: 1011 DJ'
          type: string
        billingAddress.stateOrProvince:
          description: 'The billing address state or province passed in the payment request.


            Example: NH'
          type: string
        billingAddress.street:
          description: The billing address street passed in the payment request.
          type: string
      type: object
    AchDetails:
      additionalProperties: false
      properties:
        bankAccountNumber:
          description: The bank account number (without separators).
          type: string
        bankAccountType:
          description: The bank account type (checking, savings...).
          enum:
          - balance
          - checking
          - deposit
          - general
          - other
          - payment
          - savings
          type: string
        bankLocationId:
          description: The bank routing number of the account. The field value is `nil` in most cases.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        encryptedBankAccountNumber:
          description: Encrypted bank account number. The bank account number (without separators).
          type: string
        encryptedBankLocationId:
          description: Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases.
          type: string
        ownerName:
          description: 'The name of the bank account holder.

            If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:

            * 12 is converted to ch12.

            * A is converted to euA.

            * Peter Mller is converted to Peter Mller, because banks don''t accept ''''.

            After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:

            * John17 - allowed.

            * J17 - allowed.

            * 171 - not allowed.

            * John-7 - allowed.

            > If provided details don''t match the required format, the response returns the error message: 203 ''Invalid bank account holder name''.'
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: ach
          description: '**ach**'
          enum:
          - ach
          - ach_plaid
          type: string
      required:
      - bankAccountNumber
      title: ACH Direct Debit
      type: object
    TotalAmountRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: The amount value and currency.
          $ref: '#/components/schemas/Amount'
      required:
      - operation
      type: object
    FundRecipient:
      properties:
        billingAddress:
          description: The address where to send the invoice.
          $ref: '#/components/schemas/Address'
        paymentMethod:
          description: the used paymentMetohd
          $ref: '#/components/schemas/CardDetails'
        shopperEmail:
          description: the email address of the person
          type: string
        shopperName:
          description: the name of the person
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address."
          maxLength: 256
          minLength: 3
          type: string
        storedPaymentMethodId:
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        subMerchant:
          description: 'Required for Back-to-Back/ purchase driven load in Wallet transactions.

            Contains the final merchant who will be receiving the money, also known as subMerchant, information.'
          $ref: '#/components/schemas/SubMerchant'
        telephoneNumber:
          description: the telephone number of the person
          type: string
        walletIdentifier:
          description: indicates where the money is going
          type: string
        walletOwnerTaxId:
          description: indicates the tax identifier of the fund recepient
          type: string
      type: object
    DeviceInfo:
      properties:
        cardCaptureTechnology:
          description: The technology used to capture the card details.
          type: string
        deviceName:
          description: The name of the device.
          type: string
        formFactor:
          description: The form factor of the device to be provisioned.
          type: string
        imei:
          description: The IMEI number of the device being provisioned.
          type: string
        isoDeviceType:
          description: The 2-digit device type provided on the ISO messages that the token is being provisioned to.
          type: string
        msisdn:
          description: The MSISDN of the device being provisioned.
          type: string
        osName:
          description: The name of the device operating system.
          type: string
        osVersion:
          description: The version of the device operating system.
          type: string
        paymentTypes:
          description: Different types of payments supported for the network token.
          items:
            type: string
          type: array
        serialNumber:
          description: The serial number of the device.
          type: string
        storageTechnology:
          description: The architecture or technology used for network token storage.
          type: string
      type: object
    InternationalTransactionRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: 'Boolean indicating whether transaction is an international transaction.


            Possible values:


            - **true**: The transaction is an international transaction.


            - **false**: The transaction is a domestic transaction.


            '
          type: boolean
      required:
      - operation
      type: object
    AccountInfo:
      properties:
        accountAgeIndicator:
          description: 'Indicator for the length of time since this shopper account was created in the merchant''s environment.

            Allowed values:

            * notApplicable

            * thisTransaction

            * lessThan30Days

            * from30To60Days

            * moreThan60Days'
          enum:
          - notApplicable
          - thisTransaction
          - lessThan30Days
          - from30To60Days
          - moreThan60Days
          type: string
        accountChangeDate:
          description: Date when the shopper's account was last changed.
          format: date-time
          type: string
        accountChangeIndicator:
          description: 'Indicator for the length of time since the shopper''s account was last updated.

            Allowed values:

            * thisTransaction

            * lessThan30Days

            * from30To60Days

            * moreThan60Days'
          enum:
          - thisTransaction
          - lessThan30Days
          - from30To60Days
          - moreThan60Days
          type: string
        accountCreationDate:
          description: Date when the shopper's account was created.
          format: date-time
          type: string
        accountType:
          x-addedInVersion: '50'
          description: 'Indicates the type of account. For example, for a multi-account card product.

            Allowed values:

            * notApplicable

            * credit

            * debit'
          enum:
          - notApplicable
          - credit
          - debit
          type: string
        addCardAttemptsDay:
          description: Number of attempts the shopper tried to add a card to their account in the last day.
          format: int32
          type: integer
        deliveryAddressUsageDate:
          description: Date the selected delivery address was first used.
          format: date-time
          type: string
        deliveryAddressUsageIndicator:
          description: 'Indicator for the length of time since this delivery address was first used.

            Allowed values:

            * thisTransaction

            * lessThan30Days

            * from30To60Days

            * moreThan60Days'
          enum:
          - thisTransaction
          - lessThan30Days
          - from30To60Days
          - moreThan60Days
          type: string
        homePhone:
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead.
          description: Shopper's home phone number (including the country code).
          type: string
        mobilePhone:
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead.
          description: Shopper's mobile phone number (including the country code).
          type: string
        passwordChangeDate:
          description: Date when the shopper last changed their password.
          format: date-time
          type: string
        passwordChangeIndicator:
          description: 'Indicator when the shopper has changed their password.

            Allowed values:

            * notApplicable

            * thisTransaction

            * lessThan30Days

            * from30To60Days

            * moreThan60Days'
          enum:
          - notApplicable
          - thisTransaction
          - lessThan30Days
          - from30To60Days
          - moreThan60Days
          type: string
        pastTransactionsDay:
          description: Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.
          format: int32
          type: integer
        pastTransactionsYear:
          description: Number of all transactions (successful and abandoned) from this shopper in the past year.
          format: int32
          type: integer
        paymentAccountAge:
          description: Date this payment method was added to the shopper's account.
          format: date-time
          type: string
        paymentAccountIndicator:
          description: 'Indicator for the length of time since this payment method was added to this shopper''s account.

            Allowed values:

            * notApplicable

            * thisTransaction

            * lessThan30Days

            * from30To60Days

            * moreThan60Days'
          enum:
          - notApplicable
          - thisTransaction
          - lessThan30Days
          - from30To60Days
          - moreThan60Days
          type: string
        purchasesLast6Months:
          description: Number of successful purchases in the last six months.
          format: int32
          type: integer
        suspiciousActivity:
          description: Whether suspicious activity was recorded on this account.
          type: boolean
        workPhone:
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead.
          description: Shopper's work phone number (including the country code).
          type: string
      type: object
    ThreeDSRequestorAuthenticationInfo:
      properties:
        threeDSReqAuthData:
          description: 'Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.'
          type: string
        threeDSReqAuthMethod:
          description: 'Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values:

            * **01**  No 3DS Requestor authentication occurred (for example, cardholder logged in as guest).

            * **02**  Login to the cardholder account at the 3DS Requestor system using 3DS Requestors own credentials.

            * **03**  Login to the cardholder account at the 3DS Requestor system using federated ID.

            * **04**  Login to the cardholder account at the 3DS Requestor system using issuer credentials.

            * **05**  Login to the cardholder account at the 3DS Requestor system using third-party authentication.

            * **06**  Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator.'
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          maxLength: 2
          minLength: 2
          type: string
        threeDSReqAuthTimestamp:
          description: 'Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM'
          maxLength: 12
          minLength: 12
          type: string
      type: object
    PaymentMethodGroup:
      properties:
        name:
          description: The name of the group.
          type: string
        paymentMethodData:
          description: Echo data to be used if the payment method is displayed as part of this group.
          type: string
        type:
          description: The unique code of the group.
          type: string
      type: object
    ListStoredPaymentMethodsResponse:
      properties:
        merchantAccount:
          description: Your merchant account.
          type: string
        shopperReference:
          description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

            > Your reference must not include personally identifiable information (PII), for example name or email address.'
          type: string
        storedPaymentMethods:
          description: List of all stored payment methods.
          items:
            $ref: '#/components/schemas/StoredPaymentMethodResource'
          type: array
      type: object
    Expiry:
      properties:
        month:
          description: The month in which the card will expire.
          type: string
        year:
          description: The year in which the card will expire.
          type: string
      type: object
    BulkAddress:
      properties:
        city:
          description: The name of the city.
          type: string
        company:
          description: The name of the company.
          type: string
        country:
          description: The two-character ISO-3166-1 alpha-2 country code. For example, **US**.
          type: string
        email:
          description: The email address.
          type: string
        houseNumberOrName:
          description: The house number or name.
          type: string
        mobile:
          description: The full telephone number.
          type: string
        postalCode:
          description: 'The postal code.


            Maximum length:


            * 5 digits for addresses in the US.


            * 10 characters for all other countries.'
          type: string
        stateOrProvince:
          description: 'The two-letter ISO 3166-2 state or province code.


            Maximum length: 2 characters for addresses in the US.'
          type: string
        street:
          description: The streetname of the house.
          type: string
      required:
      - country
      type: object
    GenericIssuerPaymentMethodDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The issuer id of the shopper's selected bank.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          description: '**genericissuer**'
          enum:
          - onlineBanking_PL
          - eps
          - onlineBanking_SK
          - onlineBanking_CZ
          type: string
      required:
      - type
      - issuer
      title: Stored Payment Method
      type: object
    Duration:
      properties:
        unit:
          description: 'The unit of time. You can only use **minutes** and **hours** if the `interval.type` is **sliding**.


            Possible values: **minutes**, **hours**, **days**, **weeks**, or **months**'
          enum:
          - days
          - hours
          - minutes
          - months
          - weeks
          type: string
        value:
          description: 'The length of time by the unit. For example, 5 days.


            The maximum duration is 90 days or an equivalent in other units. For example, 3 months.'
          format: int32
          type: integer
      type: object
    PaymentAmountUpdateResponse:
      properties:
        amount:
          description: The updated amount.
          $ref: '#/components/schemas/Amount'
        industryUsage:
          x-addedInVersion: '70'
          description: "The reason for the amount update. Possible values: \n* **delayedCharge** \n* **noShow** \n* **installment**"
          enum:
          - delayedCharge
          - installment
          - noShow
          type: string
        lineItems:
          x-addedInVersion: '71'
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        paymentPspReference:
          description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to update. '
          type: string
        pspReference:
          description: Adyen's 16-character reference associated with the amount update request.
          type: string
        reference:
          description: 'Your reference for the amount update request. Maximum length: 80 characters.'
          type: string
        splits:
          description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        status:
          description: The status of your request. This will always have the value **received**.
          enum:
          - received
          type: string
      required:
      - status
      - merchantAccount
      - amount
      - reference
      - pspReference
      - paymentPspReference
      type: object
    MerchantNamesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          items:
            $ref: '#/components/schemas/StringMatch'
          type: array
      required:
      - operation
      type: object
    UpiIntentDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        shopperNotificationReference:
          description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: upi_intent
          description: '**upi_intent**'
          enum:
          - upi_intent
          type: string
      required:
      - type
      title: UPI Intent
      type: object
    SameCounterpartyRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          type: boolean
      required:
      - operation
      type: object
    PaymentRefundRequest:
      properties:
        amount:
          description: The amount that you want to refund. The `currency` must match the currency used in authorisation, the `value` must be smaller than or equal to the authorised amount.
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        lineItems:
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        merchantRefundReason:
          description: Your reason for the refund request
          enum:
          - FRAUD
          - CUSTOMER REQUEST
          - RETURN
          - DUPLICATE
          - OTHER
          type: string
        reference:
          description: 'Your reference for the refund request. Maximum length: 80 characters.'
          type: string
        splits:
          description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        store:
          description: The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area.  Otherwise, you get an error and the refund fails.
          type: string
      required:
      - merchantAccount
      - amount
      type: object
    BrowserInfo:
      properties:
        acceptHeader:
          description: The accept header value of the shopper's browser.
          type: string
        colorDepth:
          x-addedInVersion: '40'
          description: 'The color depth of the shopper''s browser in bits per pixel. This should be obtained by using the browser''s `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.'
          format: int32
          type: integer
        javaEnabled:
          x-addedInVersion: '40'
          description: Boolean value indicating if the shopper's browser is able to execute Java.
          type: boolean
        javaScriptEnabled:
          x-addedInVersion: '40'
          default: true
          description: Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.
          type: boolean
        language:
          x-addedInVersion: '40'
          description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).
          type: string
        screenHeight:
          x-addedInVersion: '40'
          description: The total height of the shopper's device screen in pixels.
          format: int32
          type: integer
        screenWidth:
          x-addedInVersion: '40'
          description: The total width of the shopper's device screen in pixels.
          format: int32
          type: integer
        timeZoneOffset:
          x-addedInVersion: '40'
          description: Time difference between UTC time and the shopper's browser local time, in minutes.
          format: int32
          type: integer
        userAgent:
          description: The user agent value of the shopper's browser.
          type: string
      required:
      - userAgent
      - acceptHeader
      - javaEnabled
      - colorDepth
      - screenHeight
      - screenWidth
      - timeZoneOffset
      - language
      type: object
    PaymentCaptureResponse:
      properties:
        amount:
          description: The captured amount.
          $ref: '#/components/schemas/Amount'
        lineItems:
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        paymentPspReference:
          description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture. '
          type: string
        platformChargebackLogic:
          x-addedInVersion: '70'
          description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
          $ref: '#/components/schemas/PlatformChargebackLogic'
        pspReference:
          description: Adyen's 16-character reference associated with the capture request.
          type: string
        reference:
          description: Your reference for the capture request.
          type: string
        splits:
          description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        status:
          description: The status of your request. This will always have the value **received**.
          enum:
          - received
          type: string
        subMerchants:
          x-addedInVersion: '70'
          description: List of sub-merchants.
          items:
            $ref: '#/components/schemas/SubMerchantInfo'
          type: array
      required:
      - status
      - merchantAccount
      - amount
      - pspReference
      - paymentPspReference
      type: object
    CommonField:
      properties:
        name:
          description: Name of the field. For example, Name of External Platform.
          type: string
        version:
          description: Version of the field. For example, Version of External Platform.
          type: string
      type: object
    TransactionRulesResponse:
      properties:
        transactionRules:
          description: List of transaction rules.
          items:
            $ref: '#/components/schemas/TransactionRule'
          type: array
      type: object
    SubMerchantInfo:
      properties:
        address:
          $ref: '#/components/schemas/BillingAddress'
        id:
          type: string
        mcc:
          type: string
        name:
          type: string
        taxId:
          type: string
      type: object
    RestServiceError:
      properties:
        detail:
          description: A human-readable explanation specific to this occurrence of the problem.
          type: string
        errorCode:
          description: A code that identifies the problem type.
          type: string
        instance:
          description: A unique URI that identifies the specific occurrence of the problem.
          type: string
        invalidFields:
          description: Detailed explanation of each validation error, when applicable.
          items:
            $ref: '#/components/schemas/InvalidField'
          type: array
        requestId:
          description: A unique reference for the request, essentially the same as `pspReference`.
          type: string
        response:
          description: JSON response payload.
          $ref: '#/components/schemas/JSONObject'
        status:
          description: The HTTP status code.
          format: int32
          type: integer
        title:
          description: A short, human-readable summary of the problem type.
          type: string
        type:
          description: A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
          type: string
      required:
      - type
      - errorCode
      - title
      - detail
      - status
      type: object
    PaymentVerificationResponse:
      properties:
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
          - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
          - $ref: '#/components/schemas/ResponseAdditionalDataCard'
          - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
          - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
          - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
          - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
          - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
          - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
          description: 'Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.'
          type: object
        fraudResult:
          description: The fraud result properties of the payment.
          $ref: '#/components/schemas/FraudResult'
        merchantReference:
          description: A unique value that you provided in the initial `/paymentSession` request as a `reference` field.
          type: string
        order:
          description: Contains updated information regarding the order in case order information was provided in the request.
          $ref: '#/components/schemas/CheckoutOrderResponse'
        pspReference:
          description: Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
          type: string
        refusalReason:
          description: 'If the payment''s authorisation is refused or an error occurs during authorisation, this field holds Adyen''s mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.


            For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
          type: string
        refusalReasonCode:
          x-addedInVersion: '37'
          description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
          type: string
        resultCode:
          description: 'The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).


            Possible values:


            * **AuthenticationFinished**  The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.

            * **AuthenticationNotRequired**  The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).

            * **Authorised**  The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.

            * **Cancelled**  Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.

            * **ChallengeShopper**  The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.

            * **Error**  There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.

            * **IdentifyShopper**  The issuer requires the shopper''s device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.

            * **PartiallyAuthorised**  The payment has been authorised for a partial amount.

            This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.

            * **Pending**  Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.

            * **PresentToShopper**  Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.

            * **Received**  Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.

            * **RedirectShopper**  Indicates the shopper should be redirected to an external web page or app to complete the authorisation.

            * **Refused**  Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.'
          enum:
          - AuthenticationFinished
          - AuthenticationNotRequired
          - Authorised
          - Cancelled
          - ChallengeShopper
          - Error
          - IdentifyShopper
          - PartiallyAuthorised
          - Pending
          - PresentToShopper
          - Received
          - RedirectShopper
          - Refused
          - Success
          type: string
        serviceError:
          description: The type of the error.
          $ref: '#/components/schemas/ServiceErrorDetails'
        shopperLocale:
          description: The shopperLocale value provided in the payment request.
          type: string
      required:
      - merchantReference
      - shopperLocale
      type: object
    ThreeDS2RequestFields:
      properties:
        acctInfo:
          x-addedInVersion: '68'
          description: Additional information about the Cardholders account provided by the 3DS Requestor.
          $ref: '#/components/schemas/AcctInfo'
        acctType:
          x-addedInVersion: '68'
          description: 'Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values:

            * **01**  Not applicable

            * **02**  Credit

            * **03**  Debit'
          enum:
          - '01'
          - '02'
          - '03'
          maxLength: 2
          minLength: 2
          type: string
        acquirerBIN:
          x-addedInVersion: '49'
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
          type: string
        acquirerMerchantID:
          x-addedInVersion: '49'
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
          type: string
        addrMatch:
          x-addedInVersion: '68'
          description: 'Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values:

            * **Y**  Shipping Address matches Billing Address.

            * **N**  Shipping Address does not match Billing Address.'
          enum:
          - Y
          - N
          maxLength: 1
          minLength: 1
          type: string
        authenticationOnly:
          deprecated: true
          x-deprecatedInVersion: '50'
          x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
          default: false
          description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
          type: boolean
        challengeIndicator:
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead.
          description: 'Possibility to specify a preference for receiving a challenge from the issuer.

            Allowed values:

            * `noPreference`

            * `requestNoChallenge`

            * `requestChallenge`

            * `requestChallengeAsMandate`

            '
          enum:
          - noPreference
          - requestNoChallenge
          - requestChallenge
          - requestChallengeAsMandate
          type: string
        deviceRenderOptions:
          description: 'Display options for the 3D Secure 2 SDK.

            Optional and only for `deviceChannel` **app**.'
          $ref: '#/components/schemas/DeviceRenderOptions'
        homePhone:
          x-addedInVersion: '68'
          description: The home phone number provided by the Cardholder.
          $ref: '#/components/schemas/Phone'
        mcc:
          x-addedInVersion: '49'
          description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.
          type: string
        merchantName:
          x-addedInVersion: '49'
          description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.

            > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.'
          type: string
        messageVersion:
          description: The `messageVersion` value indicating the 3D Secure 2 protocol version.
          type: string
        mobilePhone:
          x-addedInVersion: '68'
          description: The mobile phone number provided by the Cardholder.
          $ref: '#/components/schemas/Phone'
        notificationURL:
          description: URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.
          type: string
        payTokenInd:
          x-addedInVersion: '68'
          description: Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS.
          type: boolean
        paymentAuthenticationUseCase:
          x-addedInVersion: '68'
          description: Indicates the type of payment for which an authentication is requested (message extension)
          type: string
        platform:
          description: 'The platform of the shopper.

            Allowed values:

            * `iOS`

            * `android`

            * `browser`'
          enum:
          - iOS
          - android
          - browser
          type: string
        purchaseInstalData:
          x-addedInVersion: '68'
          description: 'Indicates the maximum number of authorisations permitted for instalment payments. Length: 13 characters.'
          maxLength: 3
          minLength: 1
          type: string
        recurringExpiry:
          x-addedInVersion: '68'
          description: 'Date after which no further authorisations shall be performed. Format: YYYYMMDD'
          type: string
        recurringFrequency:
          x-addedInVersion: '68'
          description: 'Indicates the minimum number of days between authorisations. Maximum length: 4 characters.'
          maxLength: 4
          type: string
        sdkAppID:
          description: The `sdkAppID` value as received from the 3D Secure 2 SDK.
          type: string
        sdkEphemPubKey:
          description: The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.
          $ref: '#/components/schemas/SDKEphemPubKey'
        sdkMaxTimeout:
          default: 60
          description: 'The maximum amount of time in minutes for the 3D Secure 2 authentication process.

            Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.'
          format: int32
          type: integer
        sdkReferenceNumber:
          description: The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.
          type: string
        sdkTransID:
          description: The `sdkTransID` value as received from the 3D Secure 2 SDK.
          type: string
        threeDSCompInd:
          description: Completion indicator for the device fingerprinting.
          type: string
        threeDSRequestorAuthenticationInd:
          x-addedInVersion: '68'
          description: Indicates the type of Authentication request.
          type: string
        threeDSRequestorAuthenticationInfo:
          x-addedInVersion: '68'
          description: Information about how the 3DS Requestor authenticated the cardholder before or during the transaction
          $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo'
        threeDSRequestorChallengeInd:
          x-addedInVersion: '68'
          description: 'Indicates whether a challenge is requested for this transaction. Possible values:

            * **01**  No preference

            * **02**  No challenge requested

            * **03**  Challenge requested (3DS Requestor preference)

            * **04**  Challenge requested (Mandate)

            * **05**  No challenge (transactional risk analysis is already performed)

            * **06**  Data Only'
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          type: string
        threeDSRequestorID:
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.
          type: string
        threeDSRequestorName:
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.
          type: string
        threeDSRequestorPriorAuthenticationInfo:
          x-addedInVersion: '68'
          description: Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
          $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo'
        threeDSRequestorURL:
          description: URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.
          type: string
        transType:
          x-addedInVersion: '68'
          description: 'Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values:

            * **01**  Goods/Service Purchase

            * **03**  Check Acceptance

            * **10**  Account Funding

            * **11**  Quasi-Cash Transaction

            * **28**  Prepaid Activation and Load'
          enum:
          - '01'
          - '03'
          - '10'
          - '11'
          - '28'
          maxLength: 2
          minLength: 2
          type: string
        transactionType:
          x-addedInVersion: '50'
          description: Identify the type of the transaction being authenticated.
          enum:
          - goodsOrServicePurchase
          - checkAcceptance
          - accountFunding
          - quasiCashTransaction
          - prepaidActivationAndLoad
          type: string
        whiteListStatus:
          x-addedInVersion: '49'
          description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
          type: string
        workPhone:
          x-addedInVersion: '68'
          description: The work phone number provided by the Cardholder.
          $ref: '#/components/schemas/Phone'
      type: object
    MobilePayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        type:
          default: mobilepay
          description: '**mobilepay**'
          enum:
          - mobilepay
          type: string
      title: MobilePay
      type: object
    ThreeDS2RequestData:
      properties:
        acctInfo:
          x-addedInVersion: '68'
          description: Additional information about the Cardholders account provided by the 3DS Requestor.
          $ref: '#/components/schemas/AcctInfo'
        acctType:
          x-addedInVersion: '68'
          description: 'Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values:

            * **01**  Not applicable

            * **02**  Credit

            * **03**  Debit'
          enum:
          - '01'
          - '02'
          - '03'
          maxLength: 2
          minLength: 2
          type: string
        acquirerBIN:
          x-addedInVersion: '49'
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
          type: string
        acquirerMerchantID:
          x-addedInVersion: '49'
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.
          type: string
        addrMatch:
          x-addedInVersion: '68'
          description: 'Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values:

            * **Y**  Shipping Address matches Billing Address.

            * **N**  Shipping Address does not match Billing Address.'
          enum:
          - Y
          - N
          maxLength: 1
          minLength: 1
          type: string
        authenticationOnly:
          deprecated: true
          x-deprecatedInVersion: '50'
          x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead.
          default: false
          description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
          type: boolean
        challengeIndicator:
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead.
          description: 'Possibility to specify a preference for receiving a challenge from the issuer.

            Allowed values:

            * `noPreference`

            * `requestNoChallenge`

            * `requestChallenge`

            * `requestChallengeAsMandate`

            '
          enum:
          - noPreference
          - requestNoChallenge
          - requestChallenge
          - requestChallengeAsMandate
          type: string
        deviceChannel:
          description: 'The environment of the shopper.

            Allowed values:

            * `app`

            * `browser`'
          type: string
        deviceRenderOptions:
          description: 'Display options for the 3D Secure 2 SDK.

            Optional and only for `deviceChannel` **app**.'
          $ref: '#/components/schemas/DeviceRenderOptions'
        homePhone:
          x-addedInVersion: '68'
          description: The home phone number provided by the Cardholder.
          $ref: '#/components/schemas/Phone'
        mcc:
          x-addedInVersion: '49'
          description: Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.
          type: string
        merchantName:
          x-addedInVersion: '49'
          description: 'Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.

            > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.'
          type: string
        messageVersion:
          description: The `messageVersion` value indicating the 3D Secure 2 protocol version.
          type: string
        mobilePhone:
          x-addedInVersion: '68'
          description: The mobile phone number provided by the Cardholder.
          $ref: '#/components/schemas/Phone'
        notificationURL:
          description: URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.
          type: string
        payTokenInd:
          x-addedInVersion: '68'
          description: Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS.
          type: boolean
        paymentAuthenticationUseCase:
          x-addedInVersion: '68'
          description: Indicates the type of payment for which an authentication is requested (message extension)
          type: string
        platform:
          description: 'The platform of the shopper.

            Allowed values:

            * `iOS`

            * `android`

            * `browser`'
          enum:
          - iOS
          - android
          - browser
          type: string
        purchaseInstalData:
          x-addedInVersion: '68'
          description: 'Indicates the maximum number of authorisations permitted for instalment payments. Length: 13 characters.'
          maxLength: 3
          minLength: 1
          type: string
        recurringExpiry:
          x-addedInVersion: '68'
          description: 'Date after which no further authorisations shall be performed. Format: YYYYMMDD'
          type: string
        recurringFrequency:
          x-addedInVersion: '68'
          description: 'Indicates the minimum number of days between authorisations. Maximum length: 4 characters.'
          maxLength: 4
          type: string
        sdkAppID:
          description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK.

            Required for `deviceChannel` set to **app**.'
          type: string
        sdkEncData:
          description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK.

            Required for `deviceChannel` set to **app**.'
          type: string
        sdkEphemPubKey:
          description: 'The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.

            Required for `deviceChannel` set to **app**.'
          $ref: '#/components/schemas/SDKEphemPubKey'
        sdkMaxTimeout:
          default: 60
          description: 'The maximum amount of time in minutes for the 3D Secure 2 authentication process.

            Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.'
          format: int32
          type: integer
        sdkReferenceNumber:
          description: 'The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.

            Only for `deviceChannel` set to **app**.'
          type: string
        sdkTransID:
          description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK.

            Only for `deviceChannel` set to **app**.'
          type: string
        sdkVersion:
          x-addedInVersion: '40'
          description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel` set to **app**."
          type: string
        threeDSCompInd:
          description: Completion indicator for the device fingerprinting.
          type: string
        threeDSRequestorAuthenticationInd:
          x-addedInVersion: '68'
          description: Indicates the type of Authentication request.
          type: string
        threeDSRequestorAuthenticationInfo:
          x-addedInVersion: '68'
          description: Information about how the 3DS Requestor authenticated the cardholder before or during the transaction
          $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo'
        threeDSRequestorChallengeInd:
          x-addedInVersion: '68'
          description: 'Indicates whether a challenge is requested for this transaction. Possible values:

            * **01**  No preference

            * **02**  No challenge requested

            * **03**  Challenge requested (3DS Requestor preference)

            * **04**  Challenge requested (Mandate)

            * **05**  No challenge (transactional risk analysis is already performed)

            * **06**  Data Only'
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          type: string
        threeDSRequestorID:
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.
          type: string
        threeDSRequestorName:
          description: Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.
          type: string
        threeDSRequestorPriorAuthenticationInfo:
          x-addedInVersion: '68'
          description: Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction.
          $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo'
        threeDSRequestorURL:
          description: URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.
          type: string
        transType:
          x-addedInVersion: '68'
          description: 'Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values:

            * **01**  Goods/Service Purchase

            * **03**  Check Acceptance

            * **10**  Account Funding

            * **11**  Quasi-Cash Transaction

            * **28**  Prepaid Activation and Load'
          enum:
          - '01'
          - '03'
          - '10'
          - '11'
          - '28'
          maxLength: 2
          minLength: 2
          type: string
        transactionType:
          x-addedInVersion: '50'
          description: Identify the type of the transaction being authenticated.
          enum:
          - goodsOrServicePurchase
          - checkAcceptance
          - accountFunding
          - quasiCashTransaction
          - prepaidActivationAndLoad
          type: string
        whiteListStatus:
          x-addedInVersion: '49'
          description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.
          type: string
        workPhone:
          x-addedInVersion: '68'
          description: The work phone number provided by the Cardholder.
          $ref: '#/components/schemas/Phone'
      required:
      - deviceChannel
      type: object
    Card_2:
      properties:
        authentication:
          description: Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) for more information.
          $ref: '#/components/schemas/Authentication'
        bin:
          description: The bank identification number (BIN) of the card number.
          type: string
        brand:
          description: 'The brand of the physical or the virtual card.

            Possible values: **visa**, **mc**.'
          type: string
        brandVariant:
          description: 'The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**.

            >Reach out to your Adyen contact to get the values relevant for your integration.'
          type: string
        cardholderName:
          description: "The name of the cardholder.\n Maximum length: 26 characters."
          maxLength: 26
          type: string
        configuration:
          description: "Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object."
          $ref: '#/components/schemas/CardConfiguration'
        cvc:
          description: 'The CVC2 value of the card.

            > The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards.'
          type: string
        deliveryContact:
          x-addedInVersion: '2'
          description: The delivery contact (name and address) for physical card delivery.
          $ref: '#/components/schemas/DeliveryContact'
        expiration:
          description: The expiration date of the card.
          $ref: '#/components/schemas/Expiry'
        formFactor:
          description: 'The form factor of the card.

            Possible values: **virtual**, **physical**.'
          enum:
          - physical
          - unknown
          - virtual
          type: string
        lastFour:
          description: Last last four digits of the card number.
          type: string
        number:
          description: 'The primary account number (PAN) of the card.

            > The PAN is masked by default and returned only for single-use virtual cards.'
          readOnly: true
          type: string
        threeDSecure:
          description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.

            >Reach out to your Adyen contact to get the values relevant for your integration.'
          type: string
      required:
      - formFactor
      - cardholderName
      - brand
      - brandVariant
      - number
      type: object
    SubInputDetail:
      properties:
        configuration:
          additionalProperties:
            type: string
          description: Configuration parameters for the required input.
          type: object
        items:
          description: In case of a select, the items to choose from.
          items:
            $ref: '#/components/schemas/Item'
          type: array
        key:
          description: The value to provide in the result.
          type: string
        optional:
          description: True if this input is optional to provide.
          type: boolean
        type:
          description: The type of the required input.
          type: string
        value:
          description: The value can be pre-filled, if available.
          type: string
      type: object
    SplitAmount:
      properties:
        currency:
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency.
          maxLength: 3
          minLength: 3
          type: string
        value:
          description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          format: int64
          type: integer
      required:
      - value
      type: object
    BankAccountModel:
      properties:
        formFactor:
          description: Form factor of the bank account - **virtual** or **physical** (default)
          enum:
          - physical
          - unknown
          - virtual
          type: string
      type: object
    CounterpartyBankRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of counterparty Bank Institutions and the operation.
          items:
            $ref: '#/components/schemas/BankIdentification'
          type: array
      required:
      - operation
      type: object
    IbanAccountIdentification:
      additionalProperties: false
      properties:
        iban:
          description: The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard.
          type: string
        type:
          default: iban
          description: '**iban**'
          enum:
          - iban
          type: string
      required:
      - type
      - iban
      type: object
    DifferentCurrenciesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: 'Checks the currency of the payment against the currency of the payment instrument.


            Possible values:


            - **true**: The currency of the payment is different from the currency of the payment instrument.


            - **false**: The currencies are the same.


            '
          type: boolean
      required:
      - operation
      type: object
    Authentication:
      properties:
        email:
          description: The email address where the one-time password (OTP) is sent.
          type: string
        password:
          description: 'The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters.


            * Characters between **a-z**, **A-Z**, and **0-9**


            * Special characters: **+-*/%()=?!#''",;:$&**'
          maxLength: 30
          minLength: 1
          type: string
        phone:
          description: 'The phone number where the one-time password (OTP) is sent.


            This object must have:


            * A `type` set to **mobile**.


            * A `number` with a valid country code.


            * A `number` with more than 4 digits, excluding the country code.


            >Make sure to verify that the card user owns the phone number.'
          $ref: '#/components/schemas/Phone_2'
      type: object
    PaymentReversalRequest:
      properties:
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        reference:
          description: 'Your reference for the reversal request. Maximum length: 80 characters.'
          type: string
      required:
      - merchantAccount
      type: object
    PhoneNumber:
      properties:
        phoneCountryCode:
          description: 'The two-character ISO-3166-1 alpha-2 country code of the phone number.

            For example, **US** or **NL**.'
          type: string
        phoneNumber:
          description: 'The phone number.

            The inclusion of the phone number country code is not necessary.'
          type: string
        phoneType:
          description: 'The type of the phone number.

            Possible values: **Landline**, **Mobile**, **SIP**, **Fax**.'
          enum:
          - Fax
          - Landline
          - Mobile
          - SIP
          type: string
      type: object
    StoredDetails:
      properties:
        bank:
          description: The stored bank account.
          $ref: '#/components/schemas/BankAccount'
        card:
          description: The stored card information.
          $ref: '#/components/schemas/Card'
        emailAddress:
          description: The email associated with stored payment details.
          type: string
      type: object
    WeChatPayMiniProgramDetails:
      additionalProperties: false
      properties:
        appId:
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        openid:
          type: string
        type:
          default: wechatpayMiniProgram
          description: '**wechatpayMiniProgram**'
          enum:
          - wechatpayMiniProgram
          type: string
      title: WeChat Pay - Mini Program
      type: object
    DayOfWeekRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: 'List of days of the week.


            Possible values: **monday**, **tuesday**, **wednesday**, **thursday**, **friday**, **saturday**, **sunday**.


            '
          items:
            enum:
            - friday
            - monday
            - saturday
            - sunday
            - thursday
            - tuesday
            - wednesday
            type: string
          type: array
      required:
      - operation
      type: object
    SepaDirectDebitDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        iban:
          description: The International Bank Account Number (IBAN).
          type: string
        ownerName:
          description: The name of the bank account holder.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: sepadirectdebit
          description: '**sepadirectdebit**'
          enum:
          - sepadirectdebit
          - sepadirectdebit_amazonpay
          type: string
      required:
      - iban
      - ownerName
      title: SEPA Direct Debit
      type: object
    ResponseAdditionalDataOpi:
      properties:
        opi.transToken:
          description: 'Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
          type: string
      type: object
    AdditionalDataRisk:
      properties:
        riskdata.[customFieldName]:
          description: The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).
          type: string
        riskdata.basket.item[itemNr].amountPerItem:
          description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          type: string
        riskdata.basket.item[itemNr].brand:
          description: Brand of the item.
          type: string
        riskdata.basket.item[itemNr].category:
          description: Category of the item.
          type: string
        riskdata.basket.item[itemNr].color:
          description: Color of the item.
          type: string
        riskdata.basket.item[itemNr].currency:
          description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
          type: string
        riskdata.basket.item[itemNr].itemID:
          description: ID of the item.
          type: string
        riskdata.basket.item[itemNr].manufacturer:
          description: Manufacturer of the item.
          type: string
        riskdata.basket.item[itemNr].productTitle:
          description: A text description of the product the invoice line refers to.
          type: string
        riskdata.basket.item[itemNr].quantity:
          description: Quantity of the item purchased.
          type: string
        riskdata.basket.item[itemNr].receiverEmail:
          description: Email associated with the given product in the basket (usually in electronic gift cards).
          type: string
        riskdata.basket.item[itemNr].size:
          description: Size of the item.
          type: string
        riskdata.basket.item[itemNr].sku:
          description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).'
          type: string
        riskdata.basket.item[itemNr].upc:
          description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).'
          type: string
        riskdata.promotions.promotion[itemNr].promotionCode:
          description: Code of the promotion.
          type: string
        riskdata.promotions.promotion[itemNr].promotionDiscountAmount:
          description: The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          type: string
        riskdata.promotions.promotion[itemNr].promotionDiscountCurrency:
          description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).
          type: string
        riskdata.promotions.promotion[itemNr].promotionDiscountPercentage:
          description: 'Promotion''s percentage discount. It is represented in percentage value and there is no need to include the ''%'' sign.


            e.g. for a promotion discount of 30%, the value of the field should be 30.'
          type: string
        riskdata.promotions.promotion[itemNr].promotionName:
          description: Name of the promotion.
          type: string
        riskdata.riskProfileReference:
          description: Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).
          type: string
        riskdata.skipRisk:
          description: If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score.
          type: string
      type: object
    AdditionalDataAirline:
      properties:
        airline.agency_invoice_number:
          description: 'The reference number for the invoice, issued by the agency.

            * Encoding: ASCII

            * minLength: 1 character

            * maxLength: 6 characters'
          type: string
        airline.agency_plan_name:
          description: 'The two-letter agency plan identifier.

            * Encoding: ASCII

            * minLength: 2 characters

            * maxLength: 2 characters'
          type: string
        airline.airline_code:
          description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier.

            * Format: IATA 3-digit accounting code (PAX)

            * Example: KLM = 074

            * minLength: 3 characters

            * maxLength: 3 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.airline_designator_code:
          description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.

            * Encoding: ASCII

            * Example: KLM = KL

            * minLength: 2 characters

            * maxLength: 2 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.boarding_fee:
          description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Encoding: Numeric

            * minLength: 1 character

            * maxLength: 18 characters'
          type: string
        airline.computerized_reservation_system:
          description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.

            * Encoding: ASCII

            * minLength: 4 characters

            * maxLength: 4 characters'
          type: string
        airline.customer_reference_number:
          description: 'The alphanumeric customer reference number.

            * Encoding: ASCII

            * maxLength: 20 characters

            * If you send more than 20 characters, the customer reference number is truncated

            * Must not be all spaces'
          type: string
        airline.document_type:
          description: 'A code that identifies the type of item bought. The description of the code can appear on credit card statements.

            * Encoding: ASCII

            * Example: Passenger ticket = 01

            * minLength: 2 characters

            * maxLength: 2 characters'
          type: string
        airline.flight_date:
          description: 'The flight departure date. Local time `(HH:mm)` is optional.

            * Date format: `yyyy-MM-dd`

            * Date and time format: `yyyy-MM-dd HH:mm`

            * minLength: 10 characters

            * maxLength: 16 characters'
          type: string
        airline.leg.carrier_code:
          description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier.

            This field is required if the airline data includes leg details.

            * Example: KLM = KL

            * minLength: 2 characters

            * maxLength: 2 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.leg.class_of_travel:
          description: "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros."
          type: string
        airline.leg.date_of_travel:
          description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n* maxLength: 16 characters"
          type: string
        airline.leg.depart_airport:
          description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport.

            This field is required if the airline data includes leg details.


            * Encoding: ASCII

            * Example: Amsterdam = AMS

            * minLength: 3 characters

            * maxLength: 3 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.leg.depart_tax:
          description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Encoding: Numeric

            * minLength: 1

            * maxLength: 12

            *Must not be all zeros.'
          type: string
        airline.leg.destination_code:
          description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport.

            This field is required if the airline data includes leg details.

            * Example: Amsterdam = AMS

            * Encoding: ASCII

            * minLength: 3 characters

            * maxLength: 3 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.leg.fare_base_code:
          description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric.

            * minLength: 1 character

            * maxLength: 6 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.leg.flight_number:
          description: 'The flight identifier.

            * minLength: 1 character

            * maxLength: 5 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.leg.stop_over_code:
          description: 'A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not.

            * Encoding: ASCII

            * minLength: 1 character

            * maxLength: 1 character'
          type: string
        airline.passenger.date_of_birth:
          description: 'The passenger''s date of birth.


            Date format: `yyyy-MM-dd`

            * minLength: 10

            * maxLength: 10'
          type: string
        airline.passenger.first_name:
          description: 'The passenger''s first name.

            > This field is required if the airline data includes passenger details or leg details.

            * Encoding: ASCII'
          type: string
        airline.passenger.last_name:
          description: 'The passenger''s last name.

            > This field is required if the airline data includes passenger details or leg details.

            * Encoding: ASCII'
          type: string
        airline.passenger.telephone_number:
          description: 'The passenger''s telephone number, including country code. This is an alphanumeric field that can include the ''+'' and ''-'' signs.

            * Encoding: ASCII

            * minLength: 3 characters

            * maxLength: 30 characters'
          type: string
        airline.passenger.traveller_type:
          description: 'The IATA passenger type code (PTC).

            * Encoding: ASCII

            * minLength: 3 characters

            * maxLength: 6 characters'
          type: string
        airline.passenger_name:
          description: "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros."
          type: string
        airline.ticket_issue_address:
          description: 'The address of the organization that issued the ticket.

            * minLength: 0 characters

            * maxLength: 16 characters'
          type: string
        airline.ticket_number:
          description: 'The ticket''s unique identifier.

            * minLength: 1 character

            * maxLength: 15 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.travel_agency_code:
          description: 'The unique identifier from IATA or ARC for the travel agency that issues the ticket.

            * Encoding: ASCII

            * minLength: 1 character

            * maxLength: 8 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        airline.travel_agency_name:
          description: 'The name of the travel agency.


            * Encoding: ASCII

            * minLength: 1 character

            * maxLength: 25 characters

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
      required:
      - airline.passenger_name
      type: object
    SamsungPayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        samsungPayToken:
          description: The payload you received from the Samsung Pay SDK response.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: samsungpay
          description: '**samsungpay**'
          enum:
          - samsungpay
          type: string
      required:
      - samsungPayToken
      title: Samsung Pay
      type: object
    TransactionRuleRestrictions:
      properties:
        activeNetworkTokens:
          description: 'The total number of tokens that a card can have across different kinds of digital wallets on the user''s phones, watches, or other wearables.


            Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
          $ref: '#/components/schemas/ActiveNetworkTokensRestriction'
        brandVariants:
          description: 'List of card brand variants and the operation.


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/BrandVariantsRestriction'
        counterpartyBank:
          description: 'List of counterparty Institutions and the operation. Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/CounterpartyBankRestriction'
        countries:
          description: 'List of countries and the operation.


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/CountriesRestriction'
        dayOfWeek:
          description: 'List of week days and the operation. Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/DayOfWeekRestriction'
        differentCurrencies:
          description: 'Compares the currency of the payment against the currency of the payment instrument, and specifies the operation.


            Supported operations: **equals**, **notEquals**.'
          $ref: '#/components/schemas/DifferentCurrenciesRestriction'
        entryModes:
          description: 'List of point-of-sale entry modes and the operation..


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/EntryModesRestriction'
        internationalTransaction:
          description: 'Indicates whether transaction is an international transaction and specifies the operation.


            Supported operations: **equals**, **notEquals**.'
          $ref: '#/components/schemas/InternationalTransactionRestriction'
        matchingTransactions:
          description: 'The number of transactions and the operation.


            Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
          $ref: '#/components/schemas/MatchingTransactionsRestriction'
        mccs:
          description: 'List of merchant category codes (MCCs) and the operation.


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/MccsRestriction'
        merchantNames:
          description: 'List of names that will be compared to the merchant name according to the matching type.


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/MerchantNamesRestriction'
        merchants:
          description: 'List of merchant ID and acquirer ID pairs, and the operation.


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/MerchantsRestriction'
        processingTypes:
          description: 'List of processing types and the operation.


            Supported operations: **anyMatch**, **noneMatch**.'
          $ref: '#/components/schemas/ProcessingTypesRestriction'
        sameAmountRestriction:
          description: 'Checks if a user has recently sent the same amount of funds in multiple transfers.


            To use this restriction, you must:


            - Set the rule `type` to **velocity**.


            - Specify a time `interval`.


            - Specify a number of `matchingTransactions`.


            Supported operation: **equals**.'
          $ref: '#/components/schemas/SameAmountRestriction'
        sameCounterpartyRestriction:
          description: 'Checks if a user has recently made multiple transfers to the same counterparty.


            To use this restriction, you must:


            - Set the rule `type` to **velocity**.


            - Specify a time `interval`.


            - Specify a number of `matchingTransactions`.


            Supported operations: **equals**.'
          $ref: '#/components/schemas/SameCounterpartyRestriction'
        timeOfDay:
          description: 'A start and end time in a time-only ISO-8601 extended offset format. Supported operations: **equals**, **notEquals**.'
          $ref: '#/components/schemas/TimeOfDayRestriction'
        totalAmount:
          description: 'The total amount and the operation.


            Supported operations: **equals**, **notEquals**, **greaterThanOrEqualTo**, **greaterThan**, **lessThanOrEqualTo**, **lessThan**.'
          $ref: '#/components/schemas/TotalAmountRestriction'
      type: object
    PaymentReversalResponse:
      properties:
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        paymentPspReference:
          description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to reverse. '
          type: string
        pspReference:
          description: Adyen's 16-character reference associated with the reversal request.
          type: string
        reference:
          description: Your reference for the reversal request.
          type: string
        status:
          description: The status of your request. This will always have the value **received**.
          enum:
          - received
          type: string
      required:
      - status
      - merchantAccount
      - pspReference
      - paymentPspReference
      type: object
    CheckoutRedirectAction:
      additionalProperties: false
      properties:
        data:
          additionalProperties:
            type: string
          description: When the redirect URL must be accessed via POST, use this data to post to the redirect URL.
          type: object
        method:
          description: Specifies the HTTP method, for example GET or POST.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        type:
          description: '**redirect**'
          enum:
          - redirect
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    BillingAddress:
      properties:
        city:
          description: 'The name of the city. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        country:
          description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**.

            > If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.'
          type: string
        houseNumberOrName:
          description: 'The number or name of the house. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        postalCode:
          description: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
          type: string
        stateOrProvince:
          description: 'The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.

            > Required for the US and Canada.'
          type: string
        street:
          description: 'The name of the street. Maximum length: 3000 characters.

            > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.'
          maxLength: 3000
          type: string
      required:
      - street
      - houseNumberOrName
      - city
      - postalCode
      - country
      type: object
    StoredPaymentMethodDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          description: The payment method type.
          enum:
          - bcmc_mobile
          - bcmc_mobile_QR
          - bcmc_mobile_app
          - momo_wallet
          - momo_wallet_app
          - twint
          - paymaya_wallet
          - grabpay_SG
          - grabpay_MY
          - grabpay_TH
          - grabpay_ID
          - grabpay_VN
          - grabpay_PH
          - oxxo
          - gcash
          - dana
          - kakaopay
          - truemoney
          type: string
      title: Stored Payment Method
      type: object
    InvalidField:
      properties:
        message:
          description: Description of the validation error.
          type: string
        name:
          description: The field that has an invalid value.
          type: string
        value:
          description: The invalid value.
          type: string
      required:
      - name
      - value
      - message
      type: object
    IdealDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: ideal
          description: '**ideal**'
          enum:
          - ideal
          type: string
      required:
      - issuer
      title: iDEAL
      type: object
    PaymentLinkResponse:
      properties:
        allowedPaymentMethods:
          description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"allowedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        amount:
          description: The payment amount and currency.
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        billingAddress:
          description: The address where to send the invoice.
          $ref: '#/components/schemas/Address'
        blockedPaymentMethods:
          description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"blockedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        captureDelayHours:
          x-addedInVersion: '69'
          description: The delay between the authorisation and scheduled auto-capture, specified in hours.
          format: int32
          type: integer
        countryCode:
          description: The shopper's two-letter country code.
          type: string
        dateOfBirth:
          x-addedInVersion: '69'
          description: 'The shopper''s date of birth.


            Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
          format: date
          type: string
        deliverAt:
          description: 'The date and time when the purchased goods should be delivered.


            [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.'
          format: date-time
          type: string
        deliveryAddress:
          description: The address where the purchased goods should be delivered.
          $ref: '#/components/schemas/Address'
        description:
          description: 'A short description visible on the payment page.

            Maximum length: 280 characters.'
          type: string
        expiresAt:
          x-addedInVersion: '71'
          description: 'The date when the payment link expires.


            [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.


            The maximum expiry date is 70 days after the payment link is created.


            If not provided, the payment link expires 24 hours after it was created.'
          format: date-time
          type: string
        id:
          x-addedInVersion: '51'
          description: A unique identifier of the payment link.
          readOnly: true
          type: string
        installmentOptions:
          additionalProperties:
            $ref: '#/components/schemas/InstallmentOption'
          description: A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
          type: object
        lineItems:
          description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper.

            This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        manualCapture:
          description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
          type: boolean
        mcc:
          x-addedInVersion: '69'
          description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
          type: string
        merchantAccount:
          description: The merchant account identifier for which the payment link is created.
          type: string
        merchantOrderReference:
          description: This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'Metadata consists of entries, each of which includes a key and a value.

            Limitations:

            * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit"

            * Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata key size exceeds limit"

            * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID.'
          maxLength: 80
          type: object
        recurringProcessingModel:
          description: 'Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**.

            Possible values:

            * **Subscription**  A transaction for a fixed or variable amount, which follows a fixed schedule.

            * **CardOnFile**  With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.

            * **UnscheduledCardOnFile**  An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder''s balance drops below a certain amount.

            '
          enum:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: string
        reference:
          description: A reference that is used to uniquely identify the payment in future communications about the payment status.
          type: string
        requiredShopperFields:
          x-addedInVersion: '67'
          description: 'List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information).


            Possible values:

            * **billingAddress**  The address where to send the invoice.

            * **deliveryAddress**  The address where the purchased goods should be delivered.

            * **shopperEmail**  The shopper''s email address.

            * **shopperName**  The shopper''s full name.

            * **telephoneNumber**  The shopper''s phone number.

            '
          items:
            enum:
            - billingAddress
            - deliveryAddress
            - shopperEmail
            - shopperName
            - telephoneNumber
            type: string
          type: array
        returnUrl:
          description: 'Website URL used for redirection after payment is completed.

            If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.'
          type: string
        reusable:
          description: Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.
          type: boolean
        riskData:
          x-addedInVersion: '65'
          description: Any risk-related settings to apply to the payment.
          $ref: '#/components/schemas/RiskData'
        shopperEmail:
          description: The shopper's email address.
          type: string
        shopperLocale:
          description: 'The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.


            For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).'
          type: string
        shopperName:
          description: The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

            > Your reference must not include personally identifiable information (PII), for example name or email address.'
          maxLength: 256
          minLength: 3
          type: string
        shopperStatement:
          x-addedInVersion: '69'
          description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**."
          type: string
        showRemovePaymentMethodButton:
          default: true
          description: Set to **false** to hide the button that lets the shopper remove a stored payment method.
          type: boolean
        socialSecurityNumber:
          x-addedInVersion: '69'
          description: The shopper's social security number.
          type: string
        splitCardFundingSources:
          x-addedInVersion: '69'
          default: false
          description: Boolean value indicating whether the card payment method should be split into separate debit and credit options.
          type: boolean
        splits:
          description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        status:
          description: 'Status of the payment link. Possible values:

            * **active**: The link can be used to make payments.

            * **expired**: The expiry date for the payment link has passed. Shoppers can no longer use the link to make payments.

            * **completed**: The shopper completed the payment.

            * **paymentPending**: The shopper is in the process of making the payment. Applies to payment methods with an asynchronous flow.'
          enum:
          - active
          - completed
          - expired
          - paid
          - paymentPending
          type: string
        store:
          description: The physical store, for which this payment is processed.
          type: string
        storePaymentMethodMode:
          x-addedInVersion: '68'
          description: "Indicates if the details of the payment method will be stored for the shopper. Possible values:\n* **disabled**  No details will be stored (default).\n* **askForConsent**  If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored.\n* **enabled**  If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. \n When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter."
          enum:
          - askForConsent
          - disabled
          - enabled
          type: string
        telephoneNumber:
          x-addedInVersion: '68'
          description: The shopper's telephone number.
          type: string
        themeId:
          x-addedInVersion: '67'
          description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area.
          type: string
        updatedAt:
          description: 'The date when the payment link status was updated.


            [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.'
          format: date-time
          type: string
        url:
          description: The URL at which the shopper can complete the payment.
          readOnly: true
          type: string
      required:
      - amount
      - reference
      - merchantAccount
      - id
      - url
      - status
      type: object
    Installments:
      properties:
        plan:
          x-addedInVersion: '64'
          description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values:

            * **regular**

            * **revolving**

            '
          enum:
          - regular
          - revolving
          type: string
        value:
          description: 'Defines the number of installments. Its value needs to be greater than zero.


            Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.'
          format: int32
          type: integer
      required:
      - value
      type: object
    WeChatPayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        type:
          default: wechatpay
          description: '**wechatpay**'
          enum:
          - wechatpay
          - wechatpay_pos
          type: string
      title: WeChat Pay
      type: object
    JSONObject:
      type: object
    AdditionalDataLodging:
      properties:
        lodging.checkInDate:
          description: 'The arrival date.

            * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.'
          type: string
        lodging.checkOutDate:
          description: 'The departure date.

            * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.'
          type: string
        lodging.customerServiceTollFreeNumber:
          description: 'The toll-free phone number for the lodging.

            * Format: numeric

            * Max length: 17 characters.

            * For US and CA numbers must be 10 characters in length

            * Must not start with a space

            * Must not contain any special characters such as + or -

            *Must not be all zeros.'
          type: string
        lodging.fireSafetyActIndicator:
          description: 'Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be ''Y'' or ''N''.

            * Format: alphabetic

            * Max length: 1 character'
          type: string
        lodging.folioCashAdvances:
          description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: numeric

            * Max length: 12 characters'
          type: string
        lodging.folioNumber:
          description: 'The card acceptors internal invoice or billing ID reference number.

            * Max length: 25 characters.

            * Must not start with a space

            *Must not be all zeros.'
          type: string
        lodging.foodBeverageCharges:
          description: 'Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: numeric

            * Max length: 12 characters'
          type: string
        lodging.noShowIndicator:
          description: "Indicates if the customer didn't check in for their booking.\n Possible values: \n* **Y**: the customer didn't check in \n* **N**: the customer checked in"
          type: string
        lodging.prepaidExpenses:
          description: 'The prepaid expenses for the booking.

            * Format: numeric

            * Max length: 12 characters'
          type: string
        lodging.propertyPhoneNumber:
          description: 'The lodging property location''s phone number.

            * Format: numeric.

            * Min length: 10 characters

            * Max length: 17 characters

            * For US and CA numbers must be 10 characters in length

            * Must not start with a space

            * Must not contain any special characters such as + or -

            *Must not be all zeros.'
          type: string
        lodging.room1.numberOfNights:
          description: 'The total number of nights the room is booked for.

            * Format: numeric

            * Must be a number between 0 and 99

            * Max length: 4 characters'
          type: string
        lodging.room1.rate:
          description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: numeric

            * Max length: 12 characters

            * Must not be a negative number'
          type: string
        lodging.totalRoomTax:
          description: 'The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: numeric

            * Max length: 12 characters

            * Must not be a negative number'
          type: string
        lodging.totalTax:
          description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: numeric

            * Max length: 12 characters

            * Must not be a negative number'
          type: string
        travelEntertainmentAuthData.duration:
          description: 'The number of nights. This should be included in the auth message.

            * Format: numeric

            * Max length: 4 characters'
          type: string
        travelEntertainmentAuthData.market:
          description: 'Indicates what market-specific dataset will be submitted. Must be ''H'' for Hotel. This should be included in the auth message.


            * Format: alphanumeric

            * Max length: 1 character'
          type: string
      type: object
    CheckoutThreeDS2Action:
      additionalProperties: false
      properties:
        authorisationToken:
          description: A token needed to authorise a payment.
          type: string
        paymentData:
          description: Encoded payment data.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        subtype:
          description: A subtype of the token.
          type: string
        token:
          description: A token to pass to the 3DS2 Component to get the fingerprint.
          type: string
        type:
          description: '**threeDS2**'
          enum:
          - threeDS2
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    Item:
      properties:
        id:
          description: The value to provide in the result.
          type: string
        name:
          description: The display name.
          type: string
      type: object
    Split:
      properties:
        account:
          description: 'The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**.


            * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked.

            * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.'
          type: string
        amount:
          description: 'The amount of the split item.


            * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic).

            * Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.'
          $ref: '#/components/schemas/SplitAmount'
        description:
          description: Your description for the split item.
          type: string
        reference:
          description: 'Your unique reference for the split item.


            This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)).


            For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.'
          type: string
        type:
          description: 'The type of the split item.


            Possible values:


            * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**.

            * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.'
          enum:
          - AcquiringFees
          - AdyenCommission
          - AdyenFees
          - AdyenMarkup
          - BalanceAccount
          - Commission
          - Default
          - Interchange
          - MarketPlace
          - PaymentFee
          - Remainder
          - SchemeFee
          - Surcharge
          - Tip
          - VAT
          type: string
      required:
      - type
      type: object
    AdditionalDataLevel23:
      properties:
        enhancedSchemeData.customerReference:
          description: 'The customer code.

            * Encoding: ASCII

            * Max length: 25 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.destinationCountryCode:
          description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address.

            * Encoding: ASCII

            * Fixed length: 3 characters'
          type: string
        enhancedSchemeData.destinationPostalCode:
          description: 'The postal code of the destination address.

            * Encoding: ASCII

            * Max length: 10 characters

            * Must not start with a space'
          type: string
        enhancedSchemeData.destinationStateProvinceCode:
          description: 'Destination state or province code.

            * Encoding: ASCII

            * Max length: 3 characters

            * Must not start with a space'
          type: string
        enhancedSchemeData.dutyAmount:
          description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * For example, 2000 means USD 20.00.

            * Encoding: Numeric

            * Max length: 12 characters'
          type: string
        enhancedSchemeData.freightAmount:
          description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * For example, 2000 means USD 20.00.

            * Encoding: Numeric

            *Max length: 12 characters'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].commodityCode:
          description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item.

            * Encoding: ASCII

            * Max length: 12 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].description:
          description: 'A description of the item.

            * Encoding: ASCII

            * Max length: 26 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].discountAmount:
          description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * For example, 2000 means USD 20.00.

            * Encoding: Numeric

            * Max length: 12 characters'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].productCode:
          description: 'The product code.

            * Encoding: ASCII.

            * Max length: 12 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].quantity:
          description: 'The number of items. Must be an integer greater than zero.

            * Encoding: Numeric

            * Max length: 12 characters

            * Must not start with a space or be all spaces


            '
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].totalAmount:
          description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * For example, 2000 means USD 20.00.

            * Max length: 12 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure:
          description: 'The unit of measurement for an item.

            * Encoding: ASCII


            Max length: 3 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.itemDetailLine[itemNr].unitPrice:
          description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * For example, 2000 means USD 20.00.

            * Encoding: Numeric

            * Max length: 12 characters

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.orderDate:
          description: 'The order date.

            * Format: `ddMMyy`

            * Encoding: ASCII

            * Max length: 6 characters'
          type: string
        enhancedSchemeData.shipFromPostalCode:
          description: 'The postal code of the address the item is shipped from.

            * Encoding: ASCII

            * Max length: 10 characters

            * Must not start with a space or be all spaces

            * Must not be all zeros.'
          type: string
        enhancedSchemeData.totalTaxAmount:
          description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * For example, 2000 means USD 20.00.

            *Encoding: Numeric

            *Max length: 12 characters

            * Must not be all zeros.'
          type: string
      type: object
    CardDetails:
      additionalProperties: false
      properties:
        brand:
          description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.'
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        cupsecureplus.smscode:
          deprecated: true
          type: string
        cvc:
          description: The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
          type: string
        encryptedCardNumber:
          description: The encrypted card number.
          maxLength: 15000
          type: string
        encryptedExpiryMonth:
          description: The encrypted card expiry month.
          maxLength: 15000
          type: string
        encryptedExpiryYear:
          description: The encrypted card expiry year.
          maxLength: 15000
          type: string
        encryptedSecurityCode:
          description: The encrypted card verification code.
          maxLength: 15000
          type: string
        expiryMonth:
          description: The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
          type: string
        expiryYear:
          description: The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        holderName:
          description: The name of the card holder.
          type: string
        networkPaymentReference:
          description: The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.
          type: string
        number:
          description: The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        shopperNotificationReference:
          description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        threeDS2SdkVersion:
          description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.
          maxLength: 12
          type: string
        type:
          default: scheme
          description: Default payment method details. Common for scheme payment methods, and for simple payment method details.
          enum:
          - bcmc
          - scheme
          - networkToken
          - giftcard
          - card
          type: string
      title: Card
      type: object
    ServiceErrorDetails:
      properties:
        errorCode:
          type: string
        errorType:
          type: string
        message:
          type: string
        pspReference:
          type: string
      type: object
    Recurring:
      properties:
        contract:
          description: 'The type of recurring contract to be used.

            Possible values:

            * `ONECLICK`  Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).

            * `RECURRING`  Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).

            * `ONECLICK,RECURRING`  Payment details can be used regardless of whether the shopper is on your site or not.

            * `PAYOUT`  Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).'
          enum:
          - ONECLICK
          - RECURRING
          - PAYOUT
          type: string
        recurringDetailName:
          description: A descriptive name for this detail.
          type: string
        recurringExpiry:
          x-addedInVersion: '40'
          description: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
          format: date-time
          type: string
        recurringFrequency:
          x-addedInVersion: '40'
          description: Minimum number of days between authorisations. Only for 3D Secure 2.
          type: string
        tokenService:
          x-addedInVersion: '25'
          description: The name of the token service.
          enum:
          - VISATOKENSERVICE
          - MCTOKENSERVICE
          - AMEXTOKENSERVICE
          - TOKEN_SHARING
          type: string
      type: object
    MccsRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of merchant category codes (MCCs).
          items:
            type: string
          type: array
      required:
      - operation
      type: object
    ApplicationInfo:
      properties:
        adyenLibrary:
          description: Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.
          $ref: '#/components/schemas/CommonField'
        adyenPaymentSource:
          description: Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.
          $ref: '#/components/schemas/CommonField'
        externalPlatform:
          description: Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.
          $ref: '#/components/schemas/ExternalPlatform'
        merchantApplication:
          description: Merchant developed software, such as cashier application, used to interact with the Adyen API.
          $ref: '#/components/schemas/CommonField'
        merchantDevice:
          description: Merchant device information.
          $ref: '#/components/schemas/MerchantDevice'
        shopperInteractionDevice:
          description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.
          $ref: '#/components/schemas/ShopperInteractionDevice'
      type: object
    ZipDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        clickAndCollect:
          description: Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: zip
          description: '**zip**'
          enum:
          - zip
          - zip_pos
          type: string
      title: Zip
      type: object
    AfterpayDetails:
      additionalProperties: false
      properties:
        billingAddress:
          description: The address where to send the invoice.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        deliveryAddress:
          description: The address where the goods should be delivered.
          type: string
        personalDetails:
          description: Shopper name, date of birth, phone number, and email address.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: afterpay_default
          description: '**afterpay_default**'
          enum:
          - afterpay_default
          - afterpaytouch
          - afterpay_b2b
          - clearpay
          type: string
      required:
      - type
      title: Afterpay
      type: object
    MerchantDevice:
      properties:
        os:
          description: Operating system running on the merchant device.
          type: string
        osVersion:
          description: Version of the operating system on the merchant device.
          type: string
        reference:
          description: Merchant device reference.
          type: string
      type: object
    KlarnaDetails:
      additionalProperties: false
      properties:
        billingAddress:
          description: The address where to send the invoice.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        deliveryAddress:
          description: The address where the goods should be delivered.
          type: string
        personalDetails:
          description: Shopper name, date of birth, phone number, and email address.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        subtype:
          description: The type of flow to initiate.
          type: string
        type:
          default: klarna
          description: '**klarna**'
          enum:
          - klarna
          - klarnapayments
          - klarnapayments_account
          - klarnapayments_b2b
          - klarna_paynow
          - klarna_account
          - klarna_b2b
          type: string
      required:
      - type
      title: Klarna
      type: object
    PaymentVerificationRequest:
      properties:
        payload:
          description: Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.
          maxLength: 40000
          type: string
      required:
      - payload
      type: object
    FraudCheckResult:
      properties:
        accountScore:
          description: The fraud score generated by the risk check.
          format: int32
          type: integer
        checkId:
          description: The ID of the risk check.
          format: int32
          type: integer
        name:
          description: The name of the risk check.
          type: string
      required:
      - checkId
      - name
      - accountScore
      type: object
    AcctInfo:
      properties:
        chAccAgeInd:
          description: "Length of time that the cardholder has had the account with the 3DS Requestor. \nAllowed values:\n* **01**  No account\n* **02**  Created during this transaction\n* **03**  Less than 30 days\n* **04**  3060 days\n* **05**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          maxLength: 2
          minLength: 2
          type: string
        chAccChange:
          description: "Date that the cardholders account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nFormat: **YYYYMMDD**"
          type: string
        chAccChangeInd:
          description: "Length of time since the cardholders account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. \nAllowed values:\n* **01**  Changed during this transaction\n* **02**  Less than 30 days\n* **03**  3060 days\n* **04**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          maxLength: 2
          minLength: 2
          type: string
        chAccPwChange:
          description: "Date that cardholders account with the 3DS Requestor had a password change or account reset. \nFormat: **YYYYMMDD**"
          type: string
        chAccPwChangeInd:
          description: "Indicates the length of time since the cardholders account with the 3DS Requestor had a password change or account reset. \nAllowed values:\n* **01**  No change\n* **02**  Changed during this transaction\n* **03**  Less than 30 days\n* **04**  3060 days\n* **05**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          maxLength: 2
          minLength: 2
          type: string
        chAccString:
          description: "Date that the cardholder opened the account with the 3DS Requestor. \nFormat: **YYYYMMDD**"
          type: string
        nbPurchaseAccount:
          description: 'Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.'
          type: string
        paymentAccAge:
          description: "String that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nFormat: **YYYYMMDD**"
          type: string
        paymentAccInd:
          description: "Indicates the length of time that the payment account was enrolled in the cardholders account with the 3DS Requestor. \nAllowed values:\n* **01**  No account (guest checkout)\n* **02**  During this transaction\n* **03**  Less than 30 days\n* **04**  3060 days\n* **05**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          maxLength: 2
          minLength: 2
          type: string
        provisionAttemptsDay:
          description: 'Number of Add Card attempts in the last 24 hours. Max length: 3 characters.'
          type: string
        shipAddressUsage:
          description: "String when the shipping address used for this transaction was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**"
          type: string
        shipAddressUsageInd:
          description: "Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. \nAllowed values:\n* **01**  This transaction\n* **02**  Less than 30 days\n* **03**  3060 days\n* **04**  More than 60 days"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          maxLength: 2
          minLength: 2
          type: string
        shipNameIndicator:
          description: "Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. \nAllowed values:\n* **01**  Account Name identical to shipping Name\n* **02**  Account Name different to shipping Name"
          enum:
          - '01'
          - '02'
          maxLength: 2
          minLength: 2
          type: string
        suspiciousAccActivity:
          description: "Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. \nAllowed values:\n* **01**  No suspicious activity has been observed\n* **02**  Suspicious activity has been observed"
          enum:
          - '01'
          - '02'
          maxLength: 2
          minLength: 2
          type: string
        txnActivityDay:
          description: 'Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters.'
          maxLength: 3
          type: string
        txnActivityYear:
          description: 'Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters.'
          maxLength: 3
          type: string
      type: object
    DeliveryAddress:
      properties:
        city:
          description: 'The name of the city. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        country:
          description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**.

            > If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.'
          type: string
        firstName:
          type: string
        houseNumberOrName:
          description: 'The number or name of the house. Maximum length: 3000 characters.'
          maxLength: 3000
          type: string
        lastName:
          type: string
        postalCode:
          description: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.
          type: string
        stateOrProvince:
          description: 'The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.

            > Required for the US and Canada.'
          type: string
        street:
          description: 'The name of the street. Maximum length: 3000 characters.

            > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.'
          maxLength: 3000
          type: string
      required:
      - street
      - houseNumberOrName
      - city
      - postalCode
      - country
      type: object
    DragonpayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.
          type: string
        shopperEmail:
          description: The shoppers email address.
          type: string
        type:
          description: '**dragonpay**'
          enum:
          - dragonpay_ebanking
          - dragonpay_otc_banking
          - dragonpay_otc_non_banking
          - dragonpay_otc_philippines
          type: string
      required:
      - type
      - issuer
      title: Dragonpay
      type: object
    MasterpassDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        masterpassTransactionId:
          description: The Masterpass transaction ID.
          type: string
        type:
          default: masterpass
          description: '**masterpass**'
          enum:
          - masterpass
          type: string
      required:
      - masterpassTransactionId
      title: Masterpass
      type: object
    PaymentInstrumentInfo:
      properties:
        balanceAccountId:
          description: The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument.
          type: string
        bankAccount:
          description: Contains the business account details.
          $ref: '#/components/schemas/BankAccountModel'
        card:
          description: Contains information about the card. Required when you create a payment instrument of `type` **card**.
          $ref: '#/components/schemas/CardInfo'
        description:
          description: Your description for the payment instrument, maximum 300 characters.
          maxLength: 300
          type: string
        issuingCountryCode:
          description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**.
          type: string
        paymentInstrumentGroupId:
          description: The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs.
          type: string
        reference:
          description: Your reference for the payment instrument, maximum 150 characters.
          maxLength: 150
          type: string
        status:
          description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**:  The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n"
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        statusReason:
          x-addedInVersion: '2'
          description: 'The reason for the status of the payment instrument.


            Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**.

            If the reason is **other**, you must also send the `statusComment` parameter describing the status change.'
          enum:
          - accountClosure
          - damaged
          - endOfLife
          - expired
          - lost
          - other
          - stolen
          - suspectedFraud
          - transactionRule
          type: string
        type:
          description: 'Type of payment instrument.


            Possible value: **card**, **bankAccount**. '
          enum:
          - bankAccount
          - card
          type: string
      required:
      - balanceAccountId
      - issuingCountryCode
      - type
      type: object
    ThreeDS2ResponseData:
      properties:
        acsChallengeMandated:
          type: string
        acsOperatorID:
          type: string
        acsReferenceNumber:
          type: string
        acsSignedContent:
          type: string
        acsTransID:
          type: string
        acsURL:
          type: string
        authenticationType:
          type: string
        cardHolderInfo:
          type: string
        cavvAlgorithm:
          type: string
        challengeIndicator:
          type: string
        dsReferenceNumber:
          type: string
        dsTransID:
          type: string
        exemptionIndicator:
          type: string
        messageVersion:
          type: string
        riskScore:
          type: string
        sdkEphemPubKey:
          type: string
        threeDSServerTransID:
          type: string
        transStatus:
          type: string
        transStatusReason:
          type: string
      type: object
    StoredPaymentMethodResource:
      properties:
        brand:
          description: The brand of the card.
          type: string
        expiryMonth:
          description: The month the card expires.
          type: string
        expiryYear:
          description: The last two digits of the year the card expires. For example, **22** for the year 2022.
          type: string
        externalResponseCode:
          x-addedInVersion: '68'
          description: The response code returned by an external system (for example after a provisioning operation).
          type: string
        externalTokenReference:
          x-addedInVersion: '68'
          description: The token reference of a linked token in an external system (for example a network token reference).
          type: string
        holderName:
          description: The unique payment method code.
          type: string
        iban:
          description: The IBAN of the bank account.
          type: string
        id:
          description: A unique identifier of this stored payment method.
          type: string
        issuerName:
          x-addedInVersion: '68'
          description: The name of the issuer of token or card.
          type: string
        lastFour:
          description: The last four digits of the PAN.
          type: string
        name:
          description: The display name of the stored payment method.
          type: string
        networkTxReference:
          description: 'Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.


            This contains either the Mastercard Trace ID or the Visa Transaction ID.'
          type: string
        ownerName:
          x-addedInVersion: '67'
          description: The name of the bank account holder.
          type: string
        shopperEmail:
          description: The shoppers email address.
          type: string
        shopperReference:
          description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

            > Your reference must not include personally identifiable information (PII), for example name or email address.'
          maxLength: 256
          minLength: 3
          type: string
        supportedRecurringProcessingModels:
          x-addedInVersion: '70'
          description: 'Defines a recurring payment type.

            Allowed values:

            * `Subscription`  A transaction for a fixed or variable amount, which follows a fixed schedule.

            * `CardOnFile`  With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.

            * `UnscheduledCardOnFile`  An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder''s balance drops below a certain amount.'
          items:
            type: string
          type: array
        type:
          description: The type of payment method.
          type: string
      type: object
    PaymentMethodIssuer:
      properties:
        disabled:
          default: false
          description: A boolean value indicating whether this issuer is unavailable. Can be `true` whenever the issuer is offline.
          type: boolean
        id:
          description: The unique identifier of this issuer, to submit in requests to /payments.
          type: string
        name:
          description: A localized name of the issuer.
          type: string
      required:
      - id
      - name
      type: object
    CheckoutDelegatedAuthenticationAction:
      additionalProperties: false
      properties:
        authorisationToken:
          description: A token needed to authorise a payment.
          type: string
        paymentData:
          description: Encoded payment data.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        token:
          description: A token to pass to the delegatedAuthentication component.
          type: string
        type:
          description: '**delegatedAuthentication**'
          enum:
          - delegatedAuthentication
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    PaymentDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        type:
          description: The payment method type.
          enum:
          - alipay
          - multibanco
          - bankTransfer_IBAN
          - paybright
          - paynow
          - affirm
          - affirm_pos
          - trustly
          - trustlyvector
          - oney
          - facilypay
          - facilypay_3x
          - facilypay_4x
          - facilypay_6x
          - facilypay_10x
          - facilypay_12x
          - unionpay
          - kcp_banktransfer
          - kcp_payco
          - kcp_creditcard
          - wechatpaySDK
          - wechatpayQR
          - wechatpayWeb
          - molpay_boost
          - wallet_IN
          - payu_IN_cashcard
          - payu_IN_nb
          - upi_qr
          - paytm
          - molpay_ebanking_VN
          - paybybank
          - ebanking_FI
          - molpay_ebanking_MY
          - molpay_ebanking_direct_MY
          - swish
          - pix
          - walley
          - walley_b2b
          - alma
          - paypo
          - molpay_fpx
          - konbini
          - directEbanking
          - boletobancario
          - neteller
          - paysafecard
          - cashticket
          - ikano
          - karenmillen
          - oasis
          - warehouse
          - primeiropay_boleto
          - mada
          - benefit
          - knet
          - omannet
          - gopay_wallet
          - kcp_naverpay
          - onlinebanking_IN
          - fawry
          - atome
          - moneybookers
          - naps
          - nordea
          - boletobancario_bradesco
          - boletobancario_itau
          - boletobancario_santander
          - boletobancario_bancodobrasil
          - boletobancario_hsbc
          - molpay_maybank2u
          - molpay_cimb
          - molpay_rhb
          - molpay_amb
          - molpay_hlb
          - molpay_affin_epg
          - molpay_bankislam
          - molpay_publicbank
          - fpx_agrobank
          - touchngo
          - maybank2u_mae
          - duitnow
          - promptpay
          - twint_pos
          - alipay_hk
          - alipay_hk_web
          - alipay_hk_wap
          - alipay_wap
          - balanceplatform
          type: string
      title: Payment Details
      type: object
    ResponsePaymentMethod:
      properties:
        brand:
          description: The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**.
          type: string
        type:
          description: The `paymentMethod.type` value used in the request.
          type: string
      title: paymentResponse
      type: object
    PaymentAmountUpdateRequest:
      properties:
        amount:
          description: The updated amount. The `currency` must match the currency used in authorisation.
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        industryUsage:
          x-addedInVersion: '70'
          description: "The reason for the amount update. Possible values: \n* **delayedCharge** \n* **noShow** \n* **installment**"
          enum:
          - delayedCharge
          - installment
          - noShow
          type: string
        lineItems:
          x-addedInVersion: '70'
          description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).

            > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        reference:
          description: 'Your reference for the amount update request. Maximum length: 80 characters.'
          type: string
        splits:
          description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).
          items:
            $ref: '#/components/schemas/Split'
          type: array
      required:
      - merchantAccount
      - amount
      type: object
    BrandVariantsRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: "List of card brand variants.\n\nPossible values: \n\n- **mc**, **mccredit**, **mccommercialcredit_b2b**, **mcdebit**, **mcbusinessdebit**, **mcbusinessworlddebit**, **mcprepaid**, **mcmaestro**\n\n - **visa**, **visacredit**, **visadebit**, **visaprepaid**.\n\nYou can specify a rule for a generic variant. For example, to create a rule for all Mastercard payment instruments, use **mc**. The rule is applied to all payment instruments under **mc**, such as **mcbusinessdebit** and **mcdebit**.\n\n"
          items:
            type: string
          type: array
      required:
      - operation
      type: object
    ServiceError:
      properties:
        additionalData:
          x-addedInVersion: '46'
          additionalProperties:
            type: string
          description: Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.
          type: object
        errorCode:
          description: The error code mapped to the error message.
          type: string
        errorType:
          description: The category of the error.
          type: string
        message:
          description: A short explanation of the issue.
          type: string
        pspReference:
          description: The PSP reference of the payment.
          type: string
        status:
          description: The HTTP response status.
          format: int32
          type: integer
      type: object
    ActiveNetworkTokensRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: The number of tokens.
          format: int32
          type: integer
      required:
      - operation
      type: object
    AdditionalDataCommon:
      properties:
        RequestedTestErrorResponseCode:
          description: 'Triggers test scenarios that allow to replicate certain communication errors.


            Allowed values:

            * **NO_CONNECTION_AVAILABLE**  There wasn''t a connection available to service the outgoing communication.

            This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request.

            * **IOEXCEPTION_RECEIVED**  Something went wrong during transmission of the message or receiving the response.

            This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.'
          type: string
        allowPartialAuth:
          description: "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team."
          type: string
        authorisationType:
          description: 'Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).


            Allowed values:

            * **PreAuth**  flags the payment request to be handled as a pre-authorisation.

            * **FinalAuth**  flags the payment request to be handled as a final authorisation.'
          type: string
        customRoutingFlag:
          description: 'Allows you to determine or override the acquirer account that should be used for the transaction.


            If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request''s additional data to target a specific acquirer.


            To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).'
          type: string
        industryUsage:
          description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed."
          enum:
          - NoShow
          - DelayedCharge
          type: string
        manualCapture:
          description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction.
          type: string
        networkTxReference:
          description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.


            Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.


            Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges.


            Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.'
          type: string
        overwriteBrand:
          description: Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.
          type: string
        subMerchantCity:
          description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant''s address.

            * Format: alpha-numeric.

            * Maximum length: 13 characters.'
          type: string
        subMerchantCountry:
          description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant''s address.

            * Format: alpha-numeric.

            * Fixed length: 3 characters.'
          type: string
        subMerchantID:
          description: 'This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.


            A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.

            * Format: alpha-numeric.

            * Fixed length: 15 characters.'
          type: string
        subMerchantName:
          description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.

            * Format: alpha-numeric.

            * Maximum length: 22 characters.'
          type: string
        subMerchantPostalCode:
          description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant''s address.

            * Format: alpha-numeric.

            * Maximum length: 10 characters.'
          type: string
        subMerchantState:
          description: 'This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant''s address.

            * Format: alpha-numeric.

            * Maximum length: 3 characters.'
          type: string
        subMerchantStreet:
          description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant''s address.

            * Format: alpha-numeric.

            * Maximum length: 60 characters.'
          type: string
        subMerchantTaxId:
          description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.

            * Format: alpha-numeric.

            * Fixed length: 11 or 14 characters.'
          type: string
      type: object
    ResponseAdditionalDataCard:
      properties:
        cardBin:
          description: 'The first six digits of the card number.


            This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN.


            Example: 521234'
          type: string
        cardHolderName:
          description: The cardholder name passed in the payment request.
          type: string
        cardIssuingBank:
          description: The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available.
          type: string
        cardIssuingCountry:
          description: 'The country where the card was issued.


            Example: US'
          type: string
        cardIssuingCurrency:
          description: "The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. \n\nExample: USD"
          type: string
        cardPaymentMethod:
          description: 'The card payment method used for the transaction.


            Example: amex'
          type: string
        cardSummary:
          description: 'The last four digits of a card number.


            > Returned only in case of a card payment.'
          type: string
        issuerBin:
          description: 'The first eight digits of the card number. Only returned if the card number is 16 digits or more.


            This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN.


            Example: 52123423'
          type: string
      type: object
    Name:
      properties:
        firstName:
          description: The first name.
          type: string
        lastName:
          description: The last name.
          type: string
      required:
      - firstName
      - lastName
      type: object
    CheckoutOrderResponse:
      properties:
        amount:
          description: The initial amount of the order.
          $ref: '#/components/schemas/Amount'
        expiresAt:
          description: The expiry date for the order.
          type: string
        orderData:
          description: The encrypted order data.
          type: string
        pspReference:
          description: The `pspReference` that belongs to the order.
          type: string
        reference:
          description: The merchant reference for the order.
          type: string
        remainingAmount:
          description: The updated remaining amount.
          $ref: '#/components/schemas/Amount'
      required:
      - pspReference
      type: object
    ThreeDS2Result:
      properties:
        authenticationValue:
          description: The `authenticationValue` value as defined in the 3D Secure 2 specification.
          type: string
        cavvAlgorithm:
          x-addedInVersion: '50'
          description: The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations.
          type: string
        challengeCancel:
          x-addedInVersion: '67'
          description: Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata).
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          - '07'
          type: string
        dsTransID:
          description: The `dsTransID` value as defined in the 3D Secure 2 specification.
          type: string
        eci:
          description: The `eci` value as defined in the 3D Secure 2 specification.
          type: string
        exemptionIndicator:
          x-addedInVersion: '67'
          description: 'Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied.

            Allowed values:

            * `lowValue`

            * `secureCorporate`

            * `trustedBeneficiary`

            * `transactionRiskAnalysis`

            '
          enum:
          - lowValue
          - secureCorporate
          - trustedBeneficiary
          - transactionRiskAnalysis
          type: string
        messageVersion:
          x-addedInVersion: '49'
          description: The `messageVersion` value as defined in the 3D Secure 2 specification.
          type: string
        riskScore:
          x-addedInVersion: '67'
          description: Risk score calculated by Cartes Bancaires Directory Server (DS).
          type: string
        threeDSRequestorChallengeInd:
          x-addedInVersion: '68'
          description: 'Indicates whether a challenge is requested for this transaction. Possible values:

            * **01**  No preference

            * **02**  No challenge requested

            * **03**  Challenge requested (3DS Requestor preference)

            * **04**  Challenge requested (Mandate)

            * **05**  No challenge (transactional risk analysis is already performed)

            * **06**  Data Only'
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          - '06'
          type: string
        threeDSServerTransID:
          description: The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.
          type: string
        timestamp:
          description: The `timestamp` value of the 3D Secure 2 authentication.
          type: string
        transStatus:
          description: The `transStatus` value as defined in the 3D Secure 2 specification.
          type: string
        transStatusReason:
          description: Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values).
          type: string
        whiteListStatus:
          x-addedInVersion: '49'
          description: The `whiteListStatus` value as defined in the 3D Secure 2 specification.
          type: string
      type: object
    MerchantAcquirerPair:
      properties:
        acquirerId:
          description: The acquirer ID.
          type: string
        merchantId:
          description: The merchant identification number (MID).
          type: string
      type: object
    DotpayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        issuer:
          description: The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.
          type: string
        type:
          default: dotpay
          description: '**dotpay**'
          enum:
          - dotpay
          type: string
      required:
      - issuer
      title: Dotpay
      type: object
    Mandate:
      properties:
        amount:
          description: The billing amount (in minor units) of the recurring transactions.
          type: string
        amountRule:
          description: "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n"
          enum:
          - max
          - exact
          type: string
        billingAttemptsRule:
          description: "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**:  Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n"
          enum:
          - 'on'
          - before
          - after
          type: string
        billingDay:
          description: 'The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.


            Possible values: 1-31 based on the `frequency`.'
          type: string
        endsAt:
          description: End date of the billing plan, in YYYY-MM-DD format.
          type: string
        frequency:
          description: 'The frequency with which a shopper should be charged.


            Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.'
          enum:
          - adhoc
          - daily
          - weekly
          - biWeekly
          - monthly
          - quarterly
          - halfYearly
          - yearly
          type: string
        remarks:
          description: The message shown by UPI to the shopper on the approval screen.
          type: string
        startsAt:
          description: Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.
          type: string
      required:
      - frequency
      - amount
      - endsAt
      type: object
    DeviceRenderOptions:
      properties:
        sdkInterface:
          default: both
          description: 'Supported SDK interface types.

            Allowed values:

            * native

            * html

            * both'
          enum:
          - native
          - html
          - both
          type: string
        sdkUiType:
          description: 'UI types supported for displaying specific challenges.

            Allowed values:

            * text

            * singleSelect

            * outOfBand

            * otherHtml

            * multiSelect'
          items:
            enum:
            - multiSelect
            - otherHtml
            - outOfBand
            - singleSelect
            - text
            type: string
          type: array
      type: object
    TransactionRule:
      properties:
        aggregationLevel:
          x-addedInVersion: '2'
          description: 'The level at which data must be accumulated, used in rules with `type` **velocity** or **maxUsage**. The level must be the [same or lower in hierarchy](https://docs.adyen.com/issuing/transaction-rules#accumulate-data) than the `entityKey`.


            If not provided, by default, the rule will accumulate data at the **paymentInstrument** level.


            Possible values: **paymentInstrument**, **paymentInstrumentGroup**, **balanceAccount**, **accountHolder**, **balancePlatform**.'
          type: string
        description:
          description: Your description for the transaction rule, maximum 300 characters.
          maxLength: 300
          type: string
        endDate:
          description: 'The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.


            If not provided, the rule will be evaluated until the rule status is set to **inactive**.'
          type: string
        entityKey:
          x-addedInVersion: '2'
          description: The type and unique identifier of the resource to which the rule applies.
          $ref: '#/components/schemas/TransactionRuleEntityKey'
        id:
          description: The unique identifier of the transaction rule.
          type: string
        interval:
          description: The [time interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) when the rule conditions apply.
          $ref: '#/components/schemas/TransactionRuleInterval'
        outcomeType:
          x-addedInVersion: '2'
          description: "The [outcome](https://docs.adyen.com/issuing/transaction-rules#outcome) that will be applied when a transaction meets the conditions of the rule. If not provided, by default, this is set to **hardBlock**.\n\nPossible values:\n\n * **hardBlock**: the transaction is declined.\n\n* **scoreBased**: the transaction is assigned the `score` you specified. Adyen calculates the total score and if it exceeds 100, the transaction is declined."
          enum:
          - enforceSCA
          - hardBlock
          - scoreBased
          type: string
        reference:
          description: Your reference for the transaction rule, maximum 150 characters.
          maxLength: 150
          type: string
        requestType:
          x-addedInVersion: '2'
          description: 'Indicates the type of request to which the rule applies. If not provided, by default, this is set to **authorization**.


            Possible values: **authorization**, **authentication**, **tokenization**, **bankTransfer**.'
          enum:
          - authentication
          - authorization
          - bankTransfer
          - tokenization
          type: string
        ruleRestrictions:
          x-addedInVersion: '2'
          description: 'Contains one or more objects that define the [rule conditions](https://docs.adyen.com/issuing/transaction-rules#conditions). Each object must have a value and an operation which determines how the values must be evaluated.


            For example, a `countries` object can have a list of country codes **["US", "CA"]** in the `value` field and **anyMatch** in the `operation` field.'
          $ref: '#/components/schemas/TransactionRuleRestrictions'
        score:
          x-addedInVersion: '2'
          description: A positive or negative score applied to the transaction if it meets the conditions of the rule. Required when `outcomeType` is **scoreBased**.  The value must be between **-100** and **100**.
          format: int32
          type: integer
        startDate:
          description: "The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**.\n\nIf not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to **active**. \n\n"
          type: string
        status:
          description: "The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created \nwith an **active** status. \n\nPossible values: **active**, **inactive**."
          enum:
          - active
          - inactive
          type: string
        type:
          description: "The [type of rule](https://docs.adyen.com/issuing/transaction-rules#rule-types), which defines if a rule blocks transactions based on individual characteristics or accumulates data.\n\nPossible values:\n * **blockList**: decline a transaction when the conditions are met.\n * **maxUsage**: add the amount or number of transactions for the lifetime of a payment instrument, and then decline a transaction when the specified limits are met.\n * **velocity**: add the amount or number of transactions based on a specified time interval, and then decline a transaction when the specified limits are met.\n"
          enum:
          - allowList
          - blockList
          - maxUsage
          - velocity
          type: string
      required:
      - type
      - description
      - reference
      - entityKey
      - interval
      - ruleRestrictions
      type: object
    Avs:
      properties:
        addressEditable:
          description: Indicates whether the shopper is allowed to modify the billing address for the current payment request.
          type: boolean
        enabled:
          description: 'Specifies whether the shopper should enter their billing address during checkout.


            Allowed values:

            * yes  Perform AVS checks for every card payment.

            * automatic  Perform AVS checks only when required to optimize the conversion rate.

            * no  Do not perform AVS checks.'
          enum:
          - 'yes'
          - 'no'
          - automatic
          type: string
      type: object
    AdditionalDataTemporaryServices:
      properties:
        enhancedSchemeData.customerReference:
          description: 'The customer code, if supplied by a customer.

            * Encoding: ASCII

            * maxLength: 25'
          type: string
        enhancedSchemeData.employeeName:
          description: "The name or ID of the person working in a temporary capacity.\n* maxLength: 40.  \n* Must not be all spaces. \n*Must not be all zeros."
          type: string
        enhancedSchemeData.jobDescription:
          description: "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros."
          type: string
        enhancedSchemeData.regularHoursRate:
          description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * maxLength: 7

            * Must not be empty

            * Can be all zeros'
          type: string
        enhancedSchemeData.regularHoursWorked:
          description: 'The hours worked.

            * maxLength: 7

            * Must not be empty

            * Can be all zeros'
          type: string
        enhancedSchemeData.requestName:
          description: 'The name of the person requesting temporary services.

            * maxLength: 40

            * Must not be all zeros

            * Must not be all spaces'
          type: string
        enhancedSchemeData.tempStartDate:
          description: 'The billing period start date.

            * Format: ddMMyy

            * maxLength: 6'
          type: string
        enhancedSchemeData.tempWeekEnding:
          description: 'The billing period end date.

            * Format: ddMMyy

            * maxLength: 6'
          type: string
        enhancedSchemeData.totalTaxAmount:
          description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00

            * maxLength: 12'
          type: string
      type: object
    CheckoutVoucherAction:
      additionalProperties: false
      properties:
        alternativeReference:
          description: The voucher alternative reference code.
          type: string
        collectionInstitutionNumber:
          description: A collection institution number (store number) for Econtext Pay-Easy ATM.
          type: string
        downloadUrl:
          description: The URL to download the voucher.
          type: string
        entity:
          description: An entity number of Multibanco.
          type: string
        expiresAt:
          description: The date time of the voucher expiry.
          type: string
        initialAmount:
          description: The initial amount.
          $ref: '#/components/schemas/Amount'
        instructionsUrl:
          description: The URL to the detailed instructions to make payment using the voucher.
          type: string
        issuer:
          description: The issuer of the voucher.
          type: string
        maskedTelephoneNumber:
          description: The shopper telephone number (partially masked).
          type: string
        merchantName:
          description: The merchant name.
          type: string
        merchantReference:
          description: The merchant reference.
          type: string
        passCreationToken:
          x-addedInVersion: '68'
          description: A base64 encoded signature of all properties
          type: string
        paymentData:
          description: Encoded payment data.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        reference:
          description: The voucher reference code.
          type: string
        shopperEmail:
          description: The shopper email.
          type: string
        shopperName:
          description: The shopper name.
          type: string
        surcharge:
          description: The surcharge amount.
          $ref: '#/components/schemas/Amount'
        totalAmount:
          description: The total amount (initial plus surcharge amount).
          $ref: '#/components/schemas/Amount'
        type:
          description: '**voucher**'
          enum:
          - voucher
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    MbwayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        shopperEmail:
          description: ''
          type: string
        telephoneNumber:
          description: ''
          type: string
        type:
          default: mbway
          description: '**mbway**'
          enum:
          - mbway
          type: string
      required:
      - telephoneNumber
      - shopperEmail
      title: MBWay
      type: object
    ResponseAdditionalDataInstallments:
      properties:
        installmentPaymentData.installmentType:
          description: Type of installment. The value of `installmentType` should be **IssuerFinanced**.
          type: string
        installmentPaymentData.option[itemNr].annualPercentageRate:
          description: Annual interest rate.
          type: string
        installmentPaymentData.option[itemNr].firstInstallmentAmount:
          description: First Installment Amount in minor units.
          type: string
        installmentPaymentData.option[itemNr].installmentFee:
          description: Installment fee amount in minor units.
          type: string
        installmentPaymentData.option[itemNr].interestRate:
          description: Interest rate for the installment period.
          type: string
        installmentPaymentData.option[itemNr].maximumNumberOfInstallments:
          description: Maximum number of installments possible for this payment.
          type: string
        installmentPaymentData.option[itemNr].minimumNumberOfInstallments:
          description: Minimum number of installments possible for this payment.
          type: string
        installmentPaymentData.option[itemNr].numberOfInstallments:
          description: Total number of installments possible for this payment.
          type: string
        installmentPaymentData.option[itemNr].subsequentInstallmentAmount:
          description: Subsequent Installment Amount in minor units.
          type: string
        installmentPaymentData.option[itemNr].totalAmountDue:
          description: Total amount in minor units.
          type: string
        installmentPaymentData.paymentOptions:
          description: 'Possible values:

            * PayInInstallmentsOnly

            * PayInFullOnly

            * PayInFullOrInstallments'
          type: string
        installments.value:
          description: 'The number of installments that the payment amount should be charged with.


            Example: 5

            > Only relevant for card payments in countries that support installments.'
          type: string
      type: object
    BlikDetails:
      additionalProperties: false
      properties:
        blikCode:
          description: BLIK code consisting of 6 digits.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          description: '**blik**'
          enum:
          - blik
          type: string
      title: BLIK
      type: object
    ThreeDSRequestData:
      properties:
        challengeWindowSize:
          x-addedInVersion: '69'
          description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen"
          enum:
          - '01'
          - '02'
          - '03'
          - '04'
          - '05'
          type: string
        dataOnly:
          x-addedInVersion: '69'
          description: Flag for data only flow.
          enum:
          - 'false'
          - 'true'
          type: string
        nativeThreeDS:
          x-addedInVersion: '69'
          description: 'Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be used when available.


            Possible values:

            * **preferred**: Use native 3D Secure authentication when available.'
          enum:
          - preferred
          type: string
        threeDSVersion:
          x-addedInVersion: '69'
          description: 'The version of 3D Secure to use.


            Possible values:


            * **2.1.0**

            * **2.2.0**'
          enum:
          - 2.1.0
          - 2.2.0
          type: string
      type: object
    Amount:
      properties:
        currency:
          description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
          maxLength: 3
          minLength: 3
          type: string
        value:
          description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
          format: int64
          type: integer
      required:
      - value
      - currency
      type: object
    CheckoutAwaitAction:
      additionalProperties: false
      properties:
        paymentData:
          description: Encoded payment data.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        type:
          description: '**await**'
          enum:
          - await
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    PaymentCancelRequest:
      properties:
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        merchantAccount:
          description: The merchant account that is used to process the payment.
          type: string
        reference:
          description: 'Your reference for the cancel request. Maximum length: 80 characters.'
          type: string
      required:
      - merchantAccount
      type: object
    TransactionRuleInterval:
      properties:
        dayOfMonth:
          x-addedInVersion: '2'
          description: The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month.
          format: int32
          type: integer
        dayOfWeek:
          x-addedInVersion: '2'
          description: 'The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**.


            Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**.'
          enum:
          - friday
          - monday
          - saturday
          - sunday
          - thursday
          - tuesday
          - wednesday
          type: string
        duration:
          x-addedInVersion: '2'
          description: The duration, which you can specify in hours, days, weeks, or months. The maximum duration is 90 days or an equivalent in other units. Required when the `type` is **rolling** or **sliding**.
          $ref: '#/components/schemas/Duration'
        timeOfDay:
          x-addedInVersion: '2'
          description: The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**.
          type: string
        timeZone:
          x-addedInVersion: '2'
          description: The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**.
          type: string
        type:
          description: "The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset.\n\nPossible values:\n  * **perTransaction**: conditions are evaluated and the counters are reset for every transaction.\n * **daily**: the counters are reset daily at 00:00:00 UTC.\n * **weekly**: the counters are reset every Monday at 00:00:00 UTC. \n * **monthly**: the counters reset every first day of the month at 00:00:00 UTC. \n * **lifetime**: conditions are applied to the lifetime of the payment instrument.\n * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals.\nFor example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 UTC.\n * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify."
          enum:
          - daily
          - lifetime
          - monthly
          - perTransaction
          - rolling
          - sliding
          - weekly
          type: string
      required:
      - type
      type: object
    SDKEphemPubKey:
      properties:
        crv:
          description: The `crv` value as received from the 3D Secure 2 SDK.
          type: string
        kty:
          description: The `kty` value as received from the 3D Secure 2 SDK.
          type: string
        x:
          description: The `x` value as received from the 3D Secure 2 SDK.
          type: string
        y:
          description: The `y` value as received from the 3D Secure 2 SDK.
          type: string
      type: object
    EntryModesRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: 'List of point-of-sale entry modes.


            Possible values: **barcode**, **chip**, **cof**, **contactless**, **magstripe**, **manual**, **ocr**, **server**.


            '
          items:
            enum:
            - barcode
            - chip
            - cof
            - contactless
            - magstripe
            - manual
            - ocr
            - server
            - unknown
            type: string
          type: array
      required:
      - operation
      type: object
    GooglePayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        googlePayCardNetwork:
          description: 'The selected payment card network. '
          type: string
        googlePayToken:
          description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: googlepay
          description: '**googlepay**, **paywithgoogle**'
          enum:
          - googlepay
          type: string
      required:
      - googlePayToken
      title: Google Pay
      type: object
    FundOrigin:
      properties:
        billingAddress:
          description: The address where to send the invoice.
          $ref: '#/components/schemas/Address'
        shopperEmail:
          description: Email address of the person.
          type: string
        shopperName:
          description: The name of the person
          $ref: '#/components/schemas/Name'
        telephoneNumber:
          description: Phone number of the person
          type: string
        walletIdentifier:
          type: string
      type: object
    PaymentLinkRequest:
      properties:
        allowedPaymentMethods:
          description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"allowedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        amount:
          description: The payment amount and currency.
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        billingAddress:
          description: The address where to send the invoice.
          $ref: '#/components/schemas/Address'
        blockedPaymentMethods:
          description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"blockedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        captureDelayHours:
          x-addedInVersion: '69'
          description: The delay between the authorisation and scheduled auto-capture, specified in hours.
          format: int32
          type: integer
        countryCode:
          description: The shopper's two-letter country code.
          type: string
        dateOfBirth:
          x-addedInVersion: '69'
          description: 'The shopper''s date of birth.


            Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
          format: date
          type: string
        deliverAt:
          description: 'The date and time when the purchased goods should be delivered.


            [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.'
          format: date-time
          type: string
        deliveryAddress:
          description: The address where the purchased goods should be delivered.
          $ref: '#/components/schemas/Address'
        description:
          description: 'A short description visible on the payment page.

            Maximum length: 280 characters.'
          type: string
        expiresAt:
          x-addedInVersion: '71'
          description: 'The date when the payment link expires.


            [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**.


            The maximum expiry date is 70 days after the payment link is created.


            If not provided, the payment link expires 24 hours after it was created.'
          format: date-time
          type: string
        installmentOptions:
          additionalProperties:
            $ref: '#/components/schemas/InstallmentOption'
          description: A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.
          type: object
        lineItems:
          description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper.

            This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        manualCapture:
          description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture).
          type: boolean
        mcc:
          x-addedInVersion: '69'
          description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
          type: string
        merchantAccount:
          description: The merchant account identifier for which the payment link is created.
          type: string
        merchantOrderReference:
          description: This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: 'Metadata consists of entries, each of which includes a key and a value.

            Limitations:

            * Maximum 20 key-value pairs per request. Otherwise, error "177" occurs: "Metadata size exceeds limit"

            * Maximum 20 characters per key. Otherwise, error "178" occurs: "Metadata key size exceeds limit"

            * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID.'
          maxLength: 80
          type: object
        recurringProcessingModel:
          description: 'Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**.

            Possible values:

            * **Subscription**  A transaction for a fixed or variable amount, which follows a fixed schedule.

            * **CardOnFile**  With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.

            * **UnscheduledCardOnFile**  An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder''s balance drops below a certain amount.

            '
          enum:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: string
        reference:
          description: A reference that is used to uniquely identify the payment in future communications about the payment status.
          type: string
        requiredShopperFields:
          x-addedInVersion: '67'
          description: 'List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information).


            Possible values:

            * **billingAddress**  The address where to send the invoice.

            * **deliveryAddress**  The address where the purchased goods should be delivered.

            * **shopperEmail**  The shopper''s email address.

            * **shopperName**  The shopper''s full name.

            * **telephoneNumber**  The shopper''s phone number.

            '
          items:
            enum:
            - billingAddress
            - deliveryAddress
            - shopperEmail
            - shopperName
            - telephoneNumber
            type: string
          type: array
        returnUrl:
          description: 'Website URL used for redirection after payment is completed.

            If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.'
          type: string
        reusable:
          description: Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.
          type: boolean
        riskData:
          x-addedInVersion: '65'
          description: Any risk-related settings to apply to the payment.
          $ref: '#/components/schemas/RiskData'
        shopperEmail:
          description: The shopper's email address.
          type: string
        shopperLocale:
          description: 'The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.


            For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language).'
          type: string
        shopperName:
          description: The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.

            > Your reference must not include personally identifiable information (PII), for example name or email address.'
          maxLength: 256
          minLength: 3
          type: string
        shopperStatement:
          x-addedInVersion: '69'
          description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**."
          type: string
        showRemovePaymentMethodButton:
          default: true
          description: Set to **false** to hide the button that lets the shopper remove a stored payment method.
          type: boolean
        socialSecurityNumber:
          x-addedInVersion: '69'
          description: The shopper's social security number.
          type: string
        splitCardFundingSources:
          x-addedInVersion: '69'
          default: false
          description: Boolean value indicating whether the card payment method should be split into separate debit and credit options.
          type: boolean
        splits:
          description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        store:
          description: The physical store, for which this payment is processed.
          type: string
        storePaymentMethodMode:
          x-addedInVersion: '68'
          description: "Indicates if the details of the payment method will be stored for the shopper. Possible values:\n* **disabled**  No details will be stored (default).\n* **askForConsent**  If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored.\n* **enabled**  If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. \n When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter."
          enum:
          - askForConsent
          - disabled
          - enabled
          type: string
        telephoneNumber:
          x-addedInVersion: '68'
          description: The shopper's telephone number.
          type: string
        themeId:
          x-addedInVersion: '67'
          description: A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area.
          type: string
      required:
      - amount
      - reference
      - merchantAccount
      type: object
    PaymentRequest:
      properties:
        accountInfo:
          x-addedInVersion: '40'
          description: 'Shopper account information for 3D Secure 2.

            > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
          $ref: '#/components/schemas/AccountInfo'
        additionalAmount:
          description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).

            Required to be in the same currency as the `amount`. '
          $ref: '#/components/schemas/Amount'
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/AdditionalData3DSecure'
          - $ref: '#/components/schemas/AdditionalDataAirline'
          - $ref: '#/components/schemas/AdditionalDataCarRental'
          - $ref: '#/components/schemas/AdditionalDataCommon'
          - $ref: '#/components/schemas/AdditionalDataLevel23'
          - $ref: '#/components/schemas/AdditionalDataLodging'
          - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
          - $ref: '#/components/schemas/AdditionalDataOpi'
          - $ref: '#/components/schemas/AdditionalDataRatepay'
          - $ref: '#/components/schemas/AdditionalDataRetry'
          - $ref: '#/components/schemas/AdditionalDataRisk'
          - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
          - $ref: '#/components/schemas/AdditionalDataSubMerchant'
          - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
          - $ref: '#/components/schemas/AdditionalDataWallets'
          description: 'This field contains additional data, which may be required for a particular payment request.


            The `additionalData` object consists of entries, each of which includes the key and value.'
          type: object
        amount:
          description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).
          $ref: '#/components/schemas/Amount'
        applicationInfo:
          x-addedInVersion: '40'
          description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).
          $ref: '#/components/schemas/ApplicationInfo'
        authenticationData:
          x-addedInVersion: '69'
          description: Data for 3DS authentication.
          $ref: '#/components/schemas/AuthenticationData'
        billingAddress:
          description: 'The address where to send the invoice.

            > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object.

            >* For 3D Secure 2 transactions in all browser-based and mobile implementations.

            >* For cross-border payouts to and from Canada.'
          $ref: '#/components/schemas/BillingAddress'
        browserInfo:
          description: 'The shopper''s browser information.

            > For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate  that your integration can support a redirect in case a payment is routed to 3D Secure 1.'
          $ref: '#/components/schemas/BrowserInfo'
        captureDelayHours:
          description: The delay between the authorisation and scheduled auto-capture, specified in hours.
          format: int32
          type: integer
        channel:
          description: 'The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`.


            Possible values:

            * iOS

            * Android

            * Web'
          enum:
          - iOS
          - Android
          - Web
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
          type: string
        company:
          x-addedInVersion: '32'
          description: Information regarding the company.
          $ref: '#/components/schemas/Company'
        conversionId:
          x-addedInVersion: '49'
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `checkoutAttemptId` instead
          description: Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
          type: string
        countryCode:
          description: 'The shopper country.


            Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

            Example: NL or DE'
          type: string
        dateOfBirth:
          description: 'The shopper''s date of birth.


            Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD'
          format: date-time
          type: string
        dccQuote:
          description: The forex quote as returned in the response of the forex service.
          $ref: '#/components/schemas/ForexQuote'
        deliverAt:
          x-addedInVersion: '70'
          description: 'The date and time the purchased goods should be delivered.


            Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD


            Example: 2017-07-17T13:42:40.428+01:00'
          format: date-time
          type: string
        deliveryAddress:
          description: The address where the purchased goods should be delivered.
          $ref: '#/components/schemas/DeliveryAddress'
        deliveryDate:
          deprecated: true
          x-deprecatedInVersion: '70'
          x-deprecatedMessage: Use `deliverAt` instead.
          description: 'The date and time the purchased goods should be delivered.


            Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD


            Example: 2017-07-17T13:42:40.428+01:00'
          format: date-time
          type: string
        deviceFingerprint:
          description: A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).
          maxLength: 5000
          type: string
        enableOneClick:
          x-addedInVersion: '32'
          description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
          type: boolean
        enablePayOut:
          x-addedInVersion: '32'
          description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
          type: boolean
        enableRecurring:
          x-addedInVersion: '32'
          description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
          type: boolean
        entityType:
          description: The type of the entity the payment is processed for.
          enum:
          - NaturalPerson
          - CompanyName
          type: string
        fraudOffset:
          description: An integer value that is added to the normal fraud score. The value can be either positive or negative.
          format: int32
          type: integer
        fundOrigin:
          description: The person or entity funding the money.
          $ref: '#/components/schemas/FundOrigin'
        fundRecipient:
          description: the person or entity receiving the money
          $ref: '#/components/schemas/FundRecipient'
        industryUsage:
          x-addedInVersion: '70'
          description: "The reason for the amount update. Possible values: \n* **delayedCharge** \n* **noShow** \n* **installment**"
          enum:
          - delayedCharge
          - installment
          - noShow
          type: string
        installments:
          description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).
          $ref: '#/components/schemas/Installments'
        lineItems:
          x-addedInVersion: '32'
          description: 'Price and product information about the purchased items, to be included on the invoice sent to the shopper.

            > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip.'
          items:
            $ref: '#/components/schemas/LineItem'
          type: array
        localizedShopperStatement:
          x-addedInVersion: '68'
          additionalProperties:
            type: string
          description: "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters."
          type: object
        mandate:
          description: The mandate details to initiate recurring transaction.
          $ref: '#/components/schemas/Mandate'
        mcc:
          description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.
          type: string
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        merchantOrderReference:
          description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.

            The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.

            > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.'
          type: string
        merchantRiskIndicator:
          x-addedInVersion: '40'
          description: 'Additional risk fields for 3D Secure 2.

            > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.'
          $ref: '#/components/schemas/MerchantRiskIndicator'
        metadata:
          additionalProperties:
            type: string
          description: 'Metadata consists of entries, each of which includes a key and a value.

            Limits:

            * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit".

            * Maximum 20 characters per key.

            * Maximum 80 characters per value. '
          type: object
        mpiData:
          description: Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
          $ref: '#/components/schemas/ThreeDSecureData'
        order:
          description: The order information required for partial payments.
          $ref: '#/components/schemas/EncryptedOrderData'
        orderReference:
          description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.
          type: string
        origin:
          x-addedInVersion: '40'
          description: 'Required for the 3D Secure 2 `channel` **Web** integration.


            Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.'
          maxLength: 80
          type: string
        paymentMethod:
          description: The type and required details of a payment method to use.
          oneOf:
          - $ref: '#/components/schemas/AchDetails'
          - $ref: '#/components/schemas/AfterpayDetails'
          - $ref: '#/components/schemas/AmazonPayDetails'
          - $ref: '#/components/schemas/AndroidPayDetails'
          - $ref: '#/components/schemas/ApplePayDetails'
          - $ref: '#/components/schemas/BacsDirectDebitDetails'
          - $ref: '#/components/schemas/BillDeskDetails'
          - $ref: '#/components/schemas/BlikDetails'
          - $ref: '#/components/schemas/CardDetails'
          - $ref: '#/components/schemas/CellulantDetails'
          - $ref: '#/components/schemas/DokuDetails'
          - $ref: '#/components/schemas/DotpayDetails'
          - $ref: '#/components/schemas/DragonpayDetails'
          - $ref: '#/components/schemas/EcontextVoucherDetails'
          - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails'
          - $ref: '#/components/schemas/GiropayDetails'
          - $ref: '#/components/schemas/GooglePayDetails'
          - $ref: '#/components/schemas/IdealDetails'
          - $ref: '#/components/schemas/KlarnaDetails'
          - $ref: '#/components/schemas/MasterpassDetails'
          - $ref: '#/components/schemas/MbwayDetails'
          - $ref: '#/components/schemas/MobilePayDetails'
          - $ref: '#/components/schemas/MolPayDetails'
          - $ref: '#/components/schemas/OpenInvoiceDetails'
          - $ref: '#/components/schemas/PayPalDetails'
          - $ref: '#/components/schemas/PayUUpiDetails'
          - $ref: '#/components/schemas/PayWithGoogleDetails'
          - $ref: '#/components/schemas/PaymentDetails'
          - $ref: '#/components/schemas/RatepayDetails'
          - $ref: '#/components/schemas/SamsungPayDetails'
          - $ref: '#/components/schemas/SepaDirectDebitDetails'
          - $ref: '#/components/schemas/StoredPaymentMethodDetails'
          - $ref: '#/components/schemas/UpiCollectDetails'
          - $ref: '#/components/schemas/UpiIntentDetails'
          - $ref: '#/components/schemas/VippsDetails'
          - $ref: '#/components/schemas/VisaCheckoutDetails'
          - $ref: '#/components/schemas/WeChatPayDetails'
          - $ref: '#/components/schemas/WeChatPayMiniProgramDetails'
          - $ref: '#/components/schemas/ZipDetails'
        platformChargebackLogic:
          x-addedInVersion: '68'
          description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes).
          $ref: '#/components/schemas/PlatformChargebackLogic'
        recurringExpiry:
          description: Date after which no further authorisations shall be performed. Only for 3D Secure 2.
          type: string
        recurringFrequency:
          description: Minimum number of days between authorisations. Only for 3D Secure 2.
          type: string
        recurringProcessingModel:
          x-addedInVersion: '30'
          description: 'Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details.

            Allowed values:

            * `Subscription`  A transaction for a fixed or variable amount, which follows a fixed schedule.

            * `CardOnFile`  With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.

            * `UnscheduledCardOnFile`  An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder''s balance drops below a certain amount.

            '
          enum:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: string
        redirectFromIssuerMethod:
          x-addedInVersion: '32'
          description: Specifies the redirect method (GET or POST) when redirecting back from the issuer.
          type: string
        redirectToIssuerMethod:
          x-addedInVersion: '32'
          description: Specifies the redirect method (GET or POST) when redirecting to the issuer.
          type: string
        reference:
          description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.

            If you need to provide multiple references for a transaction, separate them with hyphens ("-").

            Maximum length: 80 characters.'
          type: string
        returnUrl:
          description: "The URL to return to in case of a redirection.\nThe format depends on the channel. \n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`"
          type: string
        riskData:
          description: Contains risk data, such as client-side data, used to identify risk for a transaction.
          $ref: '#/components/schemas/RiskData'
        sessionValidity:
          description: 'The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.


            For example: 2020-07-18T15:42:40.428+01:00'
          type: string
        shopperEmail:
          description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks.

            > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.'
          type: string
        shopperIP:
          description: 'The shopper''s IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).

            > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.

            This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).'
          type: string
        shopperInteraction:
          description: 'Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.

            For the web service API, Adyen assumes Ecommerce shopper interaction by default.


            This field has the following possible values:

            * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request.

            * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment).

            * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.

            * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.'
          enum:
          - Ecommerce
          - ContAuth
          - Moto
          - POS
          type: string
        shopperLocale:
          description: The combination of a language code and a country code to specify the language to be used in the payment.
          type: string
        shopperName:
          description: The shopper's full name.
          $ref: '#/components/schemas/Name'
        shopperReference:
          description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address."
          maxLength: 256
          minLength: 3
          type: string
        shopperStatement:
          description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**."
          type: string
        socialSecurityNumber:
          description: The shopper's social security number.
          type: string
        splits:
          x-addedInVersion: '37'
          description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
          items:
            $ref: '#/components/schemas/Split'
          type: array
        store:
          description: Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
          maxLength: 64
          minLength: 1
          type: string
        storePaymentMethod:
          x-addedInVersion: '49'
          description: When true and `shopperReference` is provided, the payment details will be stored.
          type: boolean
        telephoneNumber:
          description: The shopper's telephone number.
          type: string
        threeDS2RequestData:
          x-addedInVersion: '40'
          description: Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.
          $ref: '#/components/schemas/ThreeDS2RequestFields'
        threeDSAuthenticationOnly:
          x-addedInVersion: '50'
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
          default: false
          description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.
          type: boolean
        trustedShopper:
          x-addedInVersion: '37'
          description: Set to true if the payment should be routed to a trusted MID.
          type: boolean
      required:
      - merchantAccount
      - reference
      - amount
      - paymentMethod
      - returnUrl
      type: object
    BankAccount:
      properties:
        bankAccountNumber:
          description: The bank account number (without separators).
          type: string
        bankCity:
          x-addedInVersion: '18'
          description: The bank city.
          type: string
        bankLocationId:
          description: The location id of the bank. The field value is `nil` in most cases.
          type: string
        bankName:
          description: The name of the bank.
          type: string
        bic:
          description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.
          type: string
        countryCode:
          description: 'Country code where the bank is located.


            A valid value is an ISO two-character country code (e.g. ''NL'').'
          type: string
        iban:
          description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).
          type: string
        ownerName:
          description: 'The name of the bank account holder.

            If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example:

            * 12 is converted to ch12.

            * A is converted to euA.

            * Peter Mller is converted to Peter Mller, because banks don''t accept ''''.

            After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example:

            * John17 - allowed.

            * J17 - allowed.

            * 171 - not allowed.

            * John-7 - allowed.

            > If provided details don''t match the required format, the response returns the error message: 203 ''Invalid bank account holder name''.'
          type: string
        taxId:
          x-addedInVersion: '18'
          description: The bank account holder's tax ID.
          type: string
      type: object
    CardInfo:
      properties:
        authentication:
          description: Contains the card user's password and mobile phone number. This is required when you issue cards that can be used to make online payments within the EEA and the UK, or can be added to digital wallets. Refer to [3D Secure and digital wallets](https://docs.adyen.com/issuing/3d-secure-and-wallets) for more information.
          $ref: '#/components/schemas/Authentication'
        brand:
          description: 'The brand of the physical or the virtual card.

            Possible values: **visa**, **mc**.'
          type: string
        brandVariant:
          description: 'The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**.

            >Reach out to your Adyen contact to get the values relevant for your integration.'
          type: string
        cardholderName:
          description: "The name of the cardholder.\n Maximum length: 26 characters."
          maxLength: 26
          type: string
        configuration:
          description: "Settings required when creating a physical or a virtual card. \n\nReach out to your Adyen contact to get the values that you can send in this object."
          $ref: '#/components/schemas/CardConfiguration'
        deliveryContact:
          x-addedInVersion: '2'
          description: The delivery contact (name and address) for physical card delivery.
          $ref: '#/components/schemas/DeliveryContact'
        formFactor:
          description: 'The form factor of the card.

            Possible values: **virtual**, **physical**.'
          enum:
          - physical
          - unknown
          - virtual
          type: string
        threeDSecure:
          description: 'Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**.

            >Reach out to your Adyen contact to get the values relevant for your integration.'
          type: string
      required:
      - formFactor
      - cardholderName
      - brand
      - brandVariant
      type: object
    NetworkToken:
      properties:
        brandVariant:
          description: The card brand variant of the payment instrument associated with the network token. For example, **mc_prepaid_mrw**.
          type: string
        creationDate:
          description: Date and time when the network token was created, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) extended format. For example, **2020-12-18T10:15:30+01:00**..
          format: date-time
          type: string
        device:
          description: Device details.
          $ref: '#/components/schemas/DeviceInfo'
        id:
          description: The unique identifier of the network token.
          type: string
        paymentInstrumentId:
          description: The unique identifier of the payment instrument to which this network token belongs to.
          type: string
        status:
          description: 'The status of the network token. Possible values: **active**, **inactive**, **suspended**, **closed**.'
          enum:
          - active
          - inactive
          - suspended
          - closed
          type: string
        tokenLastFour:
          description: The last four digits of the network token `id`.
          type: string
        type:
          description: The type of wallet the network token is associated with. For example, **applePay**.
          type: string
      type: object
    RecurringDetail:
      properties:
        brand:
          x-addedInVersion: '65'
          description: 'Brand for the selected gift card. For example: plastix, hmclub.'
          type: string
        brands:
          x-addedInVersion: '49'
          description: 'List of possible brands. For example: visa, mc.'
          items:
            type: string
          type: array
        configuration:
          additionalProperties:
            type: string
          description: The configuration of the payment method.
          type: object
        fundingSource:
          x-addedInVersion: '53'
          description: The funding source of the payment method.
          enum:
          - credit
          - debit
          type: string
        group:
          description: The group where this payment method belongs to.
          $ref: '#/components/schemas/PaymentMethodGroup'
        inputDetails:
          deprecated: true
          description: All input details to be provided to complete the payment with this payment method.
          items:
            $ref: '#/components/schemas/InputDetail'
          type: array
        issuers:
          x-addedInVersion: '68'
          description: A list of issuers for this payment method.
          items:
            $ref: '#/components/schemas/PaymentMethodIssuer'
          type: array
        name:
          description: The displayable name of this payment method.
          type: string
        recurringDetailReference:
          description: The reference that uniquely identifies the recurring detail.
          type: string
        storedDetails:
          description: Contains information on previously stored payment details.
          $ref: '#/components/schemas/StoredDetails'
        type:
          description: The unique payment method code.
          type: string
      type: object
    AmazonPayDetails:
      additionalProperties: false
      properties:
        amazonPayToken:
          description: This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        checkoutSessionId:
          description: The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken.
          type: string
        type:
          default: amazonpay
          description: '**amazonpay**'
          enum:
          - amazonpay
          type: string
      title: Amazon Pay
      type: object
    CheckoutNativeRedirectAction:
      additionalProperties: false
      properties:
        data:
          additionalProperties:
            type: string
          description: When the redirect URL must be accessed via POST, use this data to post to the redirect URL.
          type: object
        method:
          description: Specifies the HTTP method, for example GET or POST.
          type: string
        nativeRedirectData:
          description: Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        type:
          description: '**nativeRedirect**'
          enum:
          - nativeRedirect
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    CheckoutQrCodeAction:
      additionalProperties: false
      properties:
        expiresAt:
          description: Expiry time of the QR code.
          type: string
        paymentData:
          description: Encoded payment data.
          type: string
        paymentMethodType:
          description: Specifies the payment method.
          type: string
        qrCodeData:
          description: The contents of the QR code as a UTF8 string.
          type: string
        type:
          description: '**qrCode**'
          enum:
          - qrCode
          type: string
        url:
          description: Specifies the URL to redirect to.
          type: string
      required:
      - type
      type: object
    Phone:
      properties:
        cc:
          description: 'Country code. Length: 13 characters.'
          maxLength: 3
          minLength: 1
          type: string
        subscriber:
          description: 'Subscriber number. Maximum length: 15 characters.'
          maxLength: 15
          type: string
      type: object
    PaymentResponse:
      properties:
        action:
          x-addedInVersion: '49'
          description: Action to be taken for completing the payment.
          oneOf:
          - $ref: '#/components/schemas/CheckoutAwaitAction'
          - $ref: '#/components/schemas/CheckoutDelegatedAuthenticationAction'
          - $ref: '#/components/schemas/CheckoutNativeRedirectAction'
          - $ref: '#/components/schemas/CheckoutQrCodeAction'
          - $ref: '#/components/schemas/CheckoutRedirectAction'
          - $ref: '#/components/schemas/CheckoutSDKAction'
          - $ref: '#/components/schemas/CheckoutThreeDS2Action'
          - $ref: '#/components/schemas/CheckoutVoucherAction'
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
          - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
          - $ref: '#/components/schemas/ResponseAdditionalDataCard'
          - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
          - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
          - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
          - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
          - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
          - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
          description: 'Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.'
          type: object
        amount:
          x-addedInVersion: '52'
          description: Authorised amount in the transaction.
          $ref: '#/components/schemas/Amount'
        donationToken:
          x-addedInVersion: '66'
          description: Donation Token containing payment details for Adyen Giving.
          type: string
        fraudResult:
          description: The fraud result properties of the payment.
          $ref: '#/components/schemas/FraudResult'
        merchantReference:
          x-addedInVersion: '49'
          description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.

            If you need to provide multiple references for a transaction, separate them with hyphens ("-").

            Maximum length: 80 characters.'
          type: string
        order:
          description: Contains updated information regarding the order in case order information was provided in the request.
          $ref: '#/components/schemas/CheckoutOrderResponse'
        paymentMethod:
          x-addedInVersion: '69'
          description: "Details about the payment method used in the transaction. \nOnly returned if `resultCode` is **Authorised**."
          $ref: '#/components/schemas/ResponsePaymentMethod'
        pspReference:
          description: 'Adyen''s 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.


            > For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.'
          type: string
        refusalReason:
          description: 'If the payment''s authorisation is refused or an error occurs during authorisation, this field holds Adyen''s mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.


            For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
          type: string
        refusalReasonCode:
          x-addedInVersion: '37'
          description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
          type: string
        resultCode:
          description: 'The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).


            Possible values:


            * **AuthenticationFinished**  The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.

            * **AuthenticationNotRequired**  The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).

            * **Authorised**  The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.

            * **Cancelled**  Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.

            * **ChallengeShopper**  The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.

            * **Error**  There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.

            * **IdentifyShopper**  The issuer requires the shopper''s device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.

            * **PartiallyAuthorised**  The payment has been authorised for a partial amount.

            This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.

            * **Pending**  Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.

            * **PresentToShopper**  Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.

            * **Received**  Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.

            * **RedirectShopper**  Indicates the shopper should be redirected to an external web page or app to complete the authorisation.

            * **Refused**  Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.'
          enum:
          - AuthenticationFinished
          - AuthenticationNotRequired
          - Authorised
          - Cancelled
          - ChallengeShopper
          - Error
          - IdentifyShopper
          - PartiallyAuthorised
          - Pending
          - PresentToShopper
          - Received
          - RedirectShopper
          - Refused
          - Success
          type: string
        threeDS2ResponseData:
          x-addedInVersion: '67'
          description: Response of the 3D Secure 2 authentication.
          $ref: '#/components/schemas/ThreeDS2ResponseData'
        threeDS2Result:
          x-addedInVersion: '41'
          description: Result of the 3D Secure 2 authentication.
          $ref: '#/components/schemas/ThreeDS2Result'
        threeDSPaymentData:
          x-addedInVersion: '67'
          description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.
          type: string
      type: object
    GiropayDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: giropay
          description: '**giropay**'
          enum:
          - giropay
          type: string
      title: Giropay
      type: object
    DokuDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        firstName:
          description: The shopper's first name.
          type: string
        lastName:
          description: The shopper's last name.
          type: string
        shopperEmail:
          description: The shopper's email.
          type: string
        type:
          description: '**doku**'
          enum:
          - doku_mandiri_va
          - doku_cimb_va
          - doku_danamon_va
          - doku_bni_va
          - doku_permata_lite_atm
          - doku_bri_va
          - doku_bca_va
          - doku_alfamart
          - doku_indomaret
          - doku_wallet
          - doku_ovo
          type: string
      required:
      - type
      - firstName
      - lastName
      - shopperEmail
      title: Doku
      type: object
    AdditionalDataCarRental:
      properties:
        carRental.checkOutDate:
          description: 'The pick-up date.

            * Date format: `yyyyMMdd`'
          type: string
        carRental.customerServiceTollFreeNumber:
          description: 'The customer service phone number of the car rental company.

            * Format: Alphanumeric

            * maxLength: 17

            * For US and CA numbers must be 10 characters in length

            * Must not start with a space

            * Must not contain any special characters such as + or -

            *Must not be all zeros.'
          type: string
        carRental.daysRented:
          description: 'Number of days for which the car is being rented.

            * Format: Numeric

            * maxLength: 4

            * Must not be all spaces'
          type: string
        carRental.fuelCharges:
          description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: Numeric

            * maxLength: 12'
          type: string
        carRental.insuranceCharges:
          description: 'Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: Numeric

            * maxLength: 12

            * Must not be all spaces

            *Must not be all zeros.'
          type: string
        carRental.locationCity:
          description: 'The city where the car is rented.

            * Format: Alphanumeric

            * maxLength: 18

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.locationCountry:
          description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

            * Format: Alphanumeric

            * maxLength: 2'
          type: string
        carRental.locationStateProvince:
          description: 'The state or province where the car is rented.

            * Format: Alphanumeric

            * maxLength: 2

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.noShowIndicator:
          description: 'Indicates if the customer didn''t pick up their rental car.

            * Y - Customer did not pick up their car

            * N - Not applicable'
          type: string
        carRental.oneWayDropOffCharges:
          description: 'The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * maxLength: 12'
          type: string
        carRental.rate:
          description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes).

            * Format: Alphanumeric

            * maxLength: 12'
          type: string
        carRental.rateIndicator:
          description: 'Specifies whether the given rate is applied daily or weekly.

            * D - Daily rate

            * W - Weekly rate'
          type: string
        carRental.rentalAgreementNumber:
          description: 'The rental agreement number for the car rental.

            * Format: Alphanumeric

            * maxLength: 9

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.rentalClassId:
          description: 'The classification of the rental car.

            * Format: Alphanumeric

            * maxLength: 4

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.renterName:
          description: 'The name of the person renting the car.

            * Format: Alphanumeric

            * maxLength: 26

            * If you send more than 26 characters, the name is truncated

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.returnCity:
          description: 'The city where the car must be returned.

            * Format: Alphanumeric

            * maxLength: 18

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.returnCountry:
          description: 'The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.

            * Format: Alphanumeric

            * maxLength: 2'
          type: string
        carRental.returnDate:
          description: 'The last date to return the car by.

            * Date format: `yyyyMMdd`

            * maxLength: 8'
          type: string
        carRental.returnLocationId:
          description: 'The agency code, phone number, or address abbreviation

            * Format: Alphanumeric

            * maxLength: 10

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.returnStateProvince:
          description: 'The state or province where the car must be returned.

            * Format: Alphanumeric

            * maxLength: 3

            * Must not start with a space or be all spaces

            *Must not be all zeros.'
          type: string
        carRental.taxExemptIndicator:
          description: 'Indicates if the goods or services were tax-exempt, or if tax was not paid on them.


            Values:

            * Y - Goods or services were tax exempt

            * N - Tax was not collected'
          type: string
        travelEntertainmentAuthData.duration:
          description: 'Number of days the car is rented for. This should be included in the auth message.

            * Format: Numeric

            * maxLength: 4'
          type: string
        travelEntertainmentAuthData.market:
          description: 'Indicates what market-specific dataset will be submitted or is being submitted. Value should be ''A'' for car rental. This should be included in the auth message.

            * Format: Alphanumeric

            * maxLength: 1'
          type: string
      type: object
    PaymentDetailsRequest:
      properties:
        authenticationData:
          x-addedInVersion: '69'
          description: Data for 3DS authentication.
          $ref: '#/components/schemas/DetailsRequestAuthenticationData'
        details:
          description: Use this collection to submit the details that were returned as a result of the `/payments` call.
          $ref: '#/components/schemas/PaymentCompletionDetails'
        paymentData:
          description: 'Encoded payment data. For [authorizing a payment after using 3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-payment-with-adyen):


            If you received `resultCode`: **AuthenticationNotRequired** in the `/payments` response, use the `threeDSPaymentData` from the same response.


            If you received `resultCode`: **AuthenticationFinished** in the `/payments` response, use the `action.paymentData` from the same response.'
          maxLength: 200000
          type: string
        threeDSAuthenticationOnly:
          x-addedInVersion: '40'
          deprecated: true
          x-deprecatedInVersion: '69'
          x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead.
          description: Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.
          type: boolean
      required:
      - details
      type: object
    SameAmountRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          type: boolean
      required:
      - operation
      type: object
    FraudResult:
      properties:
        accountScore:
          description: The total fraud score generated by the risk checks.
          format: int32
          type: integer
        results:
          description: The result of the individual risk checks.
          items:
            $ref: '#/components/schemas/FraudCheckResult'
          type: array
      required:
      - accountScore
      type: object
    PayPalDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        orderID:
          description: The unique ID associated with the order.
          type: string
        payeePreferred:
          description: IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED
          type: string
        payerID:
          description: The unique ID associated with the payer.
          type: string
        payerSelected:
          description: PAYPAL or PAYPAL_CREDIT
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        subtype:
          description: The type of flow to initiate.
          enum:
          - redirect
          - sdk
          type: string
        type:
          default: paypal
          description: '**paypal**'
          enum:
          - paypal
          type: string
      required:
      - type
      title: PayPal
      type: object
    DetailsRequestAuthenticationData:
      properties:
        authenticationOnly:
          x-addedInVersion: '69'
          default: false
          description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.

            Default: *false**.'
          type: boolean
      type: object
    PaymentDetailsResponse:
      properties:
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/ResponseAdditionalData3DSecure'
          - $ref: '#/components/schemas/ResponseAdditionalDataBillingAddress'
          - $ref: '#/components/schemas/ResponseAdditionalDataCard'
          - $ref: '#/components/schemas/ResponseAdditionalDataCommon'
          - $ref: '#/components/schemas/ResponseAdditionalDataDomesticError'
          - $ref: '#/components/schemas/ResponseAdditionalDataInstallments'
          - $ref: '#/components/schemas/ResponseAdditionalDataNetworkTokens'
          - $ref: '#/components/schemas/ResponseAdditionalDataOpi'
          - $ref: '#/components/schemas/ResponseAdditionalDataSepa'
          description: 'Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**.'
          type: object
        amount:
          x-addedInVersion: '52'
          description: Authorised amount in the transaction.
          $ref: '#/components/schemas/Amount'
        donationToken:
          x-addedInVersion: '66'
          description: Donation Token containing payment details for Adyen Giving.
          type: string
        fraudResult:
          description: The fraud result properties of the payment.
          $ref: '#/components/schemas/FraudResult'
        merchantReference:
          x-addedInVersion: '49'
          description: The reference used during the /payments request.
          type: string
        order:
          description: Contains updated information regarding the order in case order information was provided in the request.
          $ref: '#/components/schemas/CheckoutOrderResponse'
        paymentMethod:
          x-addedInVersion: '69'
          description: "Details about the payment method used in the transaction. \nOnly returned if `resultCode` is **Authorised**."
          $ref: '#/components/schemas/ResponsePaymentMethod'
        pspReference:
          description: Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.
          type: string
        refusalReason:
          description: 'If the payment''s authorisation is refused or an error occurs during authorisation, this field holds Adyen''s mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.


            For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).'
          type: string
        refusalReasonCode:
          x-addedInVersion: '37'
          description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).
          type: string
        resultCode:
          description: 'The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).


            Possible values:


            * **AuthenticationFinished**  The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.

            * **AuthenticationNotRequired**  The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).

            * **Authorised**  The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.

            * **Cancelled**  Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.

            * **ChallengeShopper**  The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.

            * **Error**  There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.

            * **IdentifyShopper**  The issuer requires the shopper''s device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.

            * **PartiallyAuthorised**  The payment has been authorised for a partial amount.

            This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.

            * **Pending**  Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.

            * **PresentToShopper**  Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.

            * **Received**  Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.

            * **RedirectShopper**  Indicates the shopper should be redirected to an external web page or app to complete the authorisation.

            * **Refused**  Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.'
          enum:
          - AuthenticationFinished
          - AuthenticationNotRequired
          - Authorised
          - Cancelled
          - ChallengeShopper
          - Error
          - IdentifyShopper
          - PartiallyAuthorised
          - Pending
          - PresentToShopper
          - Received
          - RedirectShopper
          - Refused
          - Success
          type: string
        shopperLocale:
          description: The shopperLocale.
          type: string
        threeDS2ResponseData:
          x-addedInVersion: '67'
          description: Response of the 3D Secure 2 authentication.
          $ref: '#/components/schemas/ThreeDS2ResponseData'
        threeDS2Result:
          x-addedInVersion: '41'
          description: Result of the 3D Secure 2 authentication.
          $ref: '#/components/schemas/ThreeDS2Result'
        threeDSPaymentData:
          x-addedInVersion: '67'
          description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`.
          type: string
      type: object
    AuthenticationData:
      properties:
        attemptAuthentication:
          x-addedInVersion: '69'
          description: 'Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure).


            Possible values:


            * **always**: Perform 3D Secure authentication.

            * **never**: Don''t perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined.'
          enum:
          - always
          - never
          type: string
        authenticationOnly:
          x-addedInVersion: '69'
          default: false
          description: 'If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.

            Default: **false**.'
          type: boolean
        threeDSRequestData:
          x-addedInVersion: '69'
          description: Object with additional parameters for the 3D Secure authentication flow.
          $ref: '#/components/schemas/ThreeDSRequestData'
      type: object
    MerchantsRestriction:
      properties:
        operation:
          description: Defines how the condition must be evaluated.
          type: string
        value:
          description: List of merchant ID and acquirer ID pairs.
          items:
            $ref: '#/components/schemas/MerchantAcquirerPair'
          type: array
      required:
      - operation
      type: object
    InputDetail:
      properties:
        configuration:
          additionalProperties:
            type: string
          description: Configuration parameters for the required input.
          type: object
        details:
          description: Input details can also be provided recursively.
          items:
            $ref: '#/components/schemas/SubInputDetail'
          type: array
        inputDetails:
          deprecated: true
          description: Input details can also be provided recursively (deprecated).
          items:
            $ref: '#/components/schemas/SubInputDetail'
          type: array
        itemSearchUrl:
          description: In case of a select, the URL from which to query the items.
          type: string
        items:
          description: In case of a select, the items to choose from.
          items:
            $ref: '#/components/schemas/Item'
          type: array
        key:
          description: The value to provide in the result.
          type: string
        optional:
          description: True if this input value is optional.
          type: boolean
        type:
          description: The type of the required input.
          type: string
        value:
          description: The value can be pre-filled, if available.
          type: string
      type: object
    EncryptedOrderData:
      properties:
        orderData:
          description: The encrypted order data.
          type: string
        pspReference:
          description: The `pspReference` that belongs to the order.
          type: string
      required:
      - pspReference
      - orderData
      type: object
    ApplePayDetails:
      additionalProperties: false
      properties:
        applePayToken:
          description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.
          maxLength: 10000
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: applepay
          description: '**applepay**'
          enum:
          - applepay
          type: string
      required:
      - applePayToken
      title: Apple Pay
      type: object
    BankIdentification:
      properties:
        country:
          type: string
        identification:
          type: string
        identificationType:
          enum:
          - iban
          - routingNumber
          type: string
      type: object
    AdditionalDataOpi:
      properties:
        opi.includeTransToken:
          description: 'Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.


            You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).'
          type: string
      type: object
    PayUUpiDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        shopperNotificationReference:
          description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: payu_IN_upi
          description: '**payu_IN_upi**'
          enum:
          - payu_IN_upi
          type: string
        virtualPaymentAddress:
          description: The virtual payment address for UPI.
          type: string
      required:
      - type
      title: PayU
      type: object
    VisaCheckoutDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        fundingSource:
          description: The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.
          enum:
          - credit
          - debit
          type: string
        type:
          default: visacheckout
          description: '**visacheckout**'
          enum:
          - visacheckout
          type: string
        visaCheckoutCallId:
          description: The Visa Click to Pay Call ID value. When your shopper selects a payment and/or a shipping address from Visa Click to Pay, you will receive a Visa Click to Pay Call ID.
          type: string
      required:
      - visaCheckoutCallId
      title: Visa Checkout
      type: object
    BacsDirectDebitDetails:
      additionalProperties: false
      properties:
        bankAccountNumber:
          x-addedInVersion: '65'
          description: The bank account number (without separators).
          type: string
        bankLocationId:
          x-addedInVersion: '65'
          description: The bank routing number of the account.
          type: string
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        holderName:
          x-addedInVersion: '65'
          description: The name of the bank account holder.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        type:
          default: directdebit_GB
          description: '**directdebit_GB**'
          enum:
          - directdebit_GB
          type: string
      title: BACS Direct Debit
      type: object
    SubMerchant:
      properties:
        city:
          description: 'The city of the sub-merchant''s address.

            * Format: Alphanumeric

            * Maximum length: 13 characters'
          type: string
        country:
          description: "The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters"
          type: string
        mcc:
          description: "The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits"
          type: string
        name:
          description: 'The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement  that will appear in the card statement.

            * Format: Alphanumeric

            * Maximum length: 22 characters'
          type: string
        taxId:
          description: 'The tax ID of the sub-merchant.

            * Format: Numeric

            * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
          type: string
      type: object
    MerchantRiskIndicator:
      properties:
        addressMatch:
          description: Whether the chosen delivery address is identical to the billing address.
          type: boolean
        deliveryAddressIndicator:
          description: 'Indicator regarding the delivery address.

            Allowed values:

            * `shipToBillingAddress`

            * `shipToVerifiedAddress`

            * `shipToNewAddress`

            * `shipToStore`

            * `digitalGoods`

            * `goodsNotShipped`

            * `other`'
          enum:
          - shipToBillingAddress
          - shipToVerifiedAddress
          - shipToNewAddress
          - shipToStore
          - digitalGoods
          - goodsNotShipped
          - other
          type: string
        deliveryEmail:
          deprecated: true
          x-deprecatedInVersion: '68'
          x-deprecatedMessage: Use `deliveryEmailAddress` instead.
          description: The delivery email address (for digital goods).
          type: string
        deliveryEmailAddress:
          x-addedInVersion: '68'
          description: 'For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters.'
          maxLength: 254
          type: string
        deliveryTimeframe:
          description: 'The estimated delivery time for the shopper to receive the goods.

            Allowed values:

            * `electronicDelivery`

            * `sameDayShipping`

            * `overnightShipping`

            * `twoOrMoreDaysShipping`'
          enum:
          - electronicDelivery
          - sameDayShipping
          - overnightShipping
          - twoOrMoreDaysShipping
          type: string
        giftCardAmount:
          description: For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).
          $ref: '#/components/schemas/Amount'
        giftCardCount:
          description: For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
          format: int32
          type: integer
        giftCardCurr:
          x-addedInVersion: '68'
          description: For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification.
          type: string
        preOrderDate:
          description: For pre-order purchases, the expected date this product will be available to the shopper.
          format: date-time
          type: string
        preOrderPurchase:
          description: Indicator for whether this transaction is for pre-ordering a product.
          type: boolean
        preOrderPurchaseInd:
          x-addedInVersion: '68'
          description: Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
          type: string
        reorderItems:
          description: Indicator for whether the shopper has already purchased the same items in the past.
          type: boolean
        reorderItemsInd:
          x-addedInVersion: '68'
          description: Indicates whether the cardholder is reordering previously purchased merchandise.
          type: string
        shipIndicator:
          x-addedInVersion: '68'
          description: Indicates shipping method chosen for the transaction.
          type: string
      type: object
    PaymentInstrumentGroup:
      properties:
        balancePlatform:
          description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs.
          type: string
        description:
          description: Your description for the payment instrument group, maximum 300 characters.
          maxLength: 300
          type: string
        id:
          description: The unique identifier of the payment instrument group.
          type: string
        properties:
          additionalProperties:
            type: string
          description: Properties of the payment instrument group.
          type: object
        reference:
          description: Your reference for the payment instrument group, maximum 150 characters.
          maxLength: 150
          type: string
        txVariant:
          description: The tx variant of the payment instrument group.
          type: string
      required:
      - balancePlatform
      - txVariant
      type: object
    VippsDetails:
      additionalProperties: false
      properties:
        checkoutAttemptId:
          x-addedInVersion: '68'
          description: The checkout attempt identifier.
          type: string
        recurringDetailReference:
          deprecated: true
          x-deprecatedInVersion: '49'
          x-deprecatedMessage: Use `storedPaymentMethodId` instead.
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          type: string
        storedPaymentMethodId:
          x-addedInVersion: '49'
          description: This is the `recurringDetailReference` returned in the response when you created the token.
          maxLength: 64
          type: string
        telephoneNumber:
          description: ''
          type: string
        type:
          default: vipps
          description: '**vipps**'
          enum:
          - vipps
          type: string
      required:
      - telephoneNumber
      title: Vipps
      type: object
    TransactionRuleEntityKey:
      properties:
        entityReference:
          description: The unique identifier of the resource.
          type: string
        entityType:
          description: 'The type of resource.


            Possible values: **balancePlatform**, **paymentInstrumentGroup**, **accountHolder**, **balanceAccount**, or **paymentInstrument**.'
          type: string
      type: object
    Company:
      properties:
        homepage:
          description: The company website's home page.
          type: string
        name:
          description: The company name.
          type: string
        registrationNumber:
          description: Registration number of the company.
          type: string
        registryLocation:
          description: Registry location of the company.
          type: string
        taxId:
          description: Tax ID of the company.
          type: string
        type:
          description: The company type.
          type: string
      type: object
    ResponseAdditionalDataSepa:
      properties:
        sepadirectdebit.dateOfSignature:
          description: 'The transaction signature date.


            Format: yyyy-MM-dd'
          type: string
        sepadirectdebit.mandateId:
          description: Its value corresponds to the pspReference value of the transaction.
          type: string
        sepadirectdebit.sequenceType:
          description: 'This field can take one of the following values:

            * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.


            * First: (FRST) Initial/first collection in a series of direct debit instructions.

            * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.

            * Final: (FNAL) Last/final collection in a series of direct debit instructions.


            Example: OOFF'
          type: string
      type: object
    PaymentMethodsRequest:
      properties:
        additionalData:
          additionalProperties:
            type: string
          x-anyOf:
          - $ref: '#/components/schemas/AdditionalData3DSecure'
          - $ref: '#/components/schemas/AdditionalDataAirline'
          - $ref: '#/components/schemas/AdditionalDataCarRental'
          - $ref: '#/components/schemas/AdditionalDataCommon'
          - $ref: '#/components/schemas/AdditionalDataLevel23'
          - $ref: '#/components/schemas/AdditionalDataLodging'
          - $ref: '#/components/schemas/AdditionalDataOpenInvoice'
          - $ref: '#/components/schemas/AdditionalDataOpi'
          - $ref: '#/components/schemas/AdditionalDataRatepay'
          - $ref: '#/components/schemas/AdditionalDataRetry'
          - $ref: '#/components/schemas/AdditionalDataRisk'
          - $ref: '#/components/schemas/AdditionalDataRiskStandalone'
          - $ref: '#/components/schemas/AdditionalDataSubMerchant'
          - $ref: '#/components/schemas/AdditionalDataTemporaryServices'
          - $ref: '#/components/schemas/AdditionalDataWallets'
          description: 'This field contains additional data, which may be required for a particular payment request.


            The `additionalData` object consists of entries, each of which includes the key and value.'
          type: object
        allowedPaymentMethods:
          x-addedInVersion: '33'
          description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"allowedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        amount:
          description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).
          $ref: '#/components/schemas/Amount'
        blockedPaymentMethods:
          x-addedInVersion: '33'
          description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types).


            Example: `"blockedPaymentMethods":["ideal","giropay"]`'
          items:
            type: string
          type: array
        channel:
          description: 'The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values:

            * iOS

            * Android

            * Web'
          enum:
          - iOS
          - Android
          - Web
          type: string
        countryCode:
          description: The shopper's country code.
          type: string
        merchantAccount:
          description: The merchant account identifier, with which you want to process the transaction.
          type: string
        order:
          x-addedInVersion: '64'
          description: The order information required for partial payments.
          $ref: '#/components/schemas/EncryptedOrderData'
        shopperLocale:
          x-addedInVersion: '7'
          description: The combination of a language code and a country code to specify the language to be used in the payment.
          type: string
        shopperReference:
          description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address."
          type: string
        splitCardFundingSources:
          x-addedInVersion: '53'
          default: false
          description: Boolean value indicating whether the card payment method should be split into separate debit and credit options.
          type: boolean
        store:
          x-addedInVersion: '23'
          description: Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment.
          maxLength: 16
          minLength: 1
          type: string
      required:
      - merchantAccount
      type: object
    ResponseAdditionalData3DSecure:
      properties:
        cardHolderInfo:
          description: 'Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. '
          type: string
        cavv:
          description: The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array.
          type: string
        cavvAlgorithm:
          description: The CAVV algorithm used.
          type: string
        scaExemptionRequested:
          description: "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** "
          type: string
        threeds2.cardEnrolled:
          description: Indicates whether a card is enrolled for 3D Secure 2.
          type: boolean
      type: object
    ResponseAdditionalDataCommon:
      properties:
        acquirerAccountCode:
          description: 'The name of the Adyen acquirer account.


            Example: PayPalSandbox_TestAcquirer


            > Only relevant for PayPal transactions.'
          type: string
        acquirerCode:
          description: 'The name of the acquirer processing the payment request.


            Example: TestPmmAcquirer'
          type: string
        acquirerReference:
          description: 'The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.


            Example: 7C9N3FNBKT9'
          type: string
        alias:
          description: 'The Adyen alias of the card.


            Example: H167852639363479'
          type: string
        aliasType:
          description: 'The type of the card alias.


            Example: Default'
          type: string
        authCode:
          description: 'Authorisation code:

            * When the payment is authorised successfully, this field holds the authorisation code for the payment.

            * When the payment is not authorised, this field is empty.


            Example: 58747'
          type: string
        authorisationMid:
          description: Merchant ID known by the acquirer.
          type: string
        authorisedAmountCurrency:
          description: The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
          type: string
        authorisedAmountValue:
          description: 'Value of the amount authorised.


            This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).'
          type: string
        avsResult:
          description: 'The AVS result code of the payment, which provides information about the outcome of the AVS check.


            For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).'
          type: string
        avsResultRaw:
          description: 'Raw AVS result received from the acquirer, where available.


            Example: D'
          type: string
        bic:
          description: 'BIC of a bank account.


            Example: TESTNL01


            > Only relevant for SEPA Direct Debit transactions.'
          type: string
        coBrandedWith:
          description: Includes the co-branded card information.
          type: string
        cvcResult:
          description: The result of CVC verification.
          example: 1 Matches
          type: string
        cvcResultRaw:
          description: The raw result of CVC verification.
          example: M
          type: string
        dsTransID:
          description: Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.
          type: string
        eci:
          description: 'The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.


            Example: 02'
          type: string
        expiryDate:
          description: 'The expiry date on the card.


            Example: 6/2016


            > Returned only in case of a card payment.'
          type: string
        extraCostsCurrency:
          description: 'The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request.


            Example: EUR'
          type: string
        extraCostsValue:
          description: The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.
          type: string
        fraudCheck-[itemNr]-[FraudCheckname]:
          description: The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.
          type: string
        fraudManualReview:
          description: Indicates if the payment is sent to manual review.
          type: string
        fraudResultType:
          description: The fraud result properties of the payment.
          enum:
          - GREEN
          - FRAUD
          type: string
        fundingSource:
          description: 'Information regarding the funding type of the card. The possible return values are:

            * CHARGE

            * CREDIT

            * DEBIT

            * PREPAID

            * PREPAID_RELOADABLE


            * PREPAID_NONRELOADABLE

            * DEFFERED_DEBIT


            > This functionality requires additional configuration on Adyen''s end. To enable it, contact the Support Team.


            For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.'
          type: string
        fundsAvailability:
          description: 'Indicates availability of funds.


            Visa:

            * "I" (fast funds are supported)

            * "N" (otherwise)


            Mastercard:

            * "I" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)

            * "N" (otherwise)


            > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is "Y" or "D".'
          type: string
        inferredRefusalReason:
          description: 'Provides the more granular indication of why a transaction was refused. When a transaction fails with either "Refused", "Restricted Card", "Transaction Not Permitted", "Not supported" or "DeclinedNon Generic" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to "Not Supported".


            Possible values:


            * 3D Secure Mandated

            * Closed Account

            * ContAuth Not Supported

            * CVC Mandated

            * Ecommerce Not Allowed

            * Crossborder Not Supported

            * Card Updated


            * Low Authrate Bin

            * Non-reloadable prepaid card'
          type: string
        isCardCommercial:
          description: Indicates if the card is used for business purposes only.
          type: string
        issuerCountry:
          description: 'The issuing country of the card based on the BIN list that Adyen maintains.


            Example: JP'
          type: string
        liabilityShift:
          description: A Boolean value indicating whether a liability shift was offered for this payment.
          type: string
        mcBankNetReferenceNumber:
          description: 'The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.


            > Contact Support Team to enable this field.'
          type: string
        merchantAdviceCode:
          description: 'The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.


            For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).'
          type: string
        merchantReference:
          description: The reference provided for the transaction.
          type: string
        networkTxReference:
          description: 'Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.


            This contains either the Mastercard Trace ID or the Visa Transaction ID.'
          type: string
        ownerName:
          description: 'The owner name of a bank account.


            Only relevant for SEPA Direct Debit transactions.'
          type: string
        paymentAccountReference:
          description: The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.
          type: string
        paymentMethod:
          description: The payment method used in the transaction.
          type: string
        paymentMethodVariant:
          description: 'The Adyen sub-variant of the payment method used for the payment request.


            For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).


            Example: mcpro'
          type: string
        payoutEligible:
          description: 'Indicates whether a payout is eligible or not for this card.


            Visa:

            * "Y"

            * "N"


            Mastercard:

            * "Y" (domestic and cross-border)


            * "D" (only domestic)

            * "N" (no MoneySend)

            * "U" (unknown)'
          type: string
        realtimeAccountUpdaterStatus:
          description: 'The response code from the Real Time Account Updater service.


            Possible return values are:

            * CardChanged

            * CardExpiryChanged

            * CloseAccount


            * ContactCardAccountHolder'
          type: string
        receiptFreeText:
          description: Message to be displayed on the terminal.
          type: string
        recurring.contractTypes:
          x-addedInVersion: '40'
          description: The recurring contract types applicable to the transaction.
          type: string
        recurring.firstPspReference:
          description: 'The `pspReference`, of the first recurring payment that created the recurring detail.


            This functionality requires additional configuration on Adyen''s end. To enable it, contact the Support Team.'
          type: string
        recurring.recurringDetailReference:
          description: The reference that uniquely identifies the recurring transaction.
          type: string
        recurring.shopperReference:
          x-addedInVersion: '40'
          description: The provided reference of the shopper for a recurring transaction.
          type: string
        recurringProcessingModel:
          x-addedInVersion: '40'
          description: The processing model used for the recurring transaction.
          enum:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: string
        referred:
          description: 'If the payment is referred, this field is set to true.


            This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions.


            Example: true'
          type: string
        refusalReasonRaw:
          description: 'Raw refusal reason received from the acquirer, where available.


            Example: AUTHORISED'
          type: string
        requestAmount:
          description: The amount of the payment request.
          type: string
        requestCurrencyCode:
          description: The currency of the payment request.
          type: string
        shopperInteraction:
          description: 'The shopper interaction type of the payment request.


            Example: Ecommerce'
          type: string
        shopperReference:
          description: 'The shopperReference passed in the payment request.


            Example: AdyenTestShopperXX'
          type: string
        terminalId:
          description: 'The terminal ID used in a point-of-sale payment.


            Example: 06022622'
          type: string
        threeDAuthenticated:
          description: 'A Boolean value indicating whether 3DS authentication was completed on this payment.


            Example: true'
          type: string
        threeDAuthenticatedResponse:
          description: 'The raw 3DS authentication result from the card issuer.


            Example: N'
          type: string
        threeDOffered:
          description: 'A Boolean value indicating whether 3DS was offered for this payment.


            Example: true'
          type: string
        threeDOfferedResponse:
          description: 'The raw enrollment result from the 3DS directory services of the card schemes.


            Example: Y'
          type: string
        threeDSVersion:
          description: The 3D Secure 2 version.
          type: string
        visaTransactionId:
          description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters.


            > Contact Support Team to enable this field.'
          type: string
        xid:
          description: 'The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse ''N'' or ''Y''. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.


            Example: ODgxNDc2MDg2MDExODk5MAAAAAA='
          type: string
      type: object
    ShopperInput:
      properties:
        billingAddress:
          description: 'Specifies visibility of billing address fields.


            Permitted values:

            * editable

            * hidden

            * readOnly'
          enum:
          - editable
          - hidden
          - readOnly
          type: string
        deliveryAddress:
          description: 'Specifies visibility of delivery address fields.


            Permitted values:

            * editable

            * hidden

            * readOnly'
          enum:
          - editable
          - hidden
          - readOnly
          type: string
        personalDetails:
          description: 'Specifies visibility of personal details.


            Permitted values:

            * editable

            * hidden

            * readOnly'
          enum:
          - editable
          - hidden
          - readOnly
          type: string
      type: object
    PaymentInstrumentUpdateRequest:
      properties:
        balanceAccountId:
          description: 'The unique identifier of the balance account associated with this payment instrument.

            >You can only change the balance account ID if the payment instrument has **inactive** status.'
          type: string
        card:
          description: Object that contains information about the card payment instrument.
          $ref: '#/components/schemas/CardInfo'
        status:
          description: "The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**.\n\nPossible values: \n\n * **active**:  The payment instrument is active and can be used to make payments. \n\n * **inactive**: The payment instrument is inactive and cannot be used to make payments. \n\n * **suspended**: The payment instrument is suspended, either because it was stolen or lost. \n\n * **closed**: The payment instrument is permanently closed. This action cannot be undone. \n\n"
          enum:
          - active
          - closed
          - inactive
          - suspended
          type: string
        statusComment:
          description: 'Comment for the status of the payment instrument.


            Required if `statusReason` is **other**.'
          type: string
        statusReason:
          x-addedInVersion: '2'
          description: 'The reason for updating the status of the payment instrument.


            Possible values: **lost**, **stolen**, **damaged**, **suspectedFraud**, **expired**, **endOfLife**, **accountClosure**, **other**.

            If the reason is **other**, you must also send the `statusComment` parameter describing the status change.'
          enum:
          - accountClosure
          - damaged
          - endOfLife
          - expired
          - lost
          - other
          - stolen
          - suspectedFraud
          - transactionRule
          type: string
      type: object
    DeliveryAddress_2:
      properties:
        city:
          description: The name of the city.
          type: string
        country:
          description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**.

            >If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.'
          type: string
        line1:
          description: The street name. For example, if the address is "Rokin 49", provide "Rokin".
          type: string
        line2:
          description: The house number or name. For example, if the address is "Rokin 49", provide "49".
          type: string
        line3:
          description: Optional information about the address.
          type: string
        postalCode:
          description: 'The postal code.

            Maximum length:

            * 5 digits for an address in the US.

            * 10 characters for an address in all other countries.'
          type: string
        stateOrProvince:
          description: 'The two-letterISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada.

            > Required for the US and Canada.'
          type: string
      required:
      - country
      type: object
    PaymentInstrumentGroupInfo:
      properties:
        balancePlatform:
          description: The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs.
          type: string
        description:
          description: Your description for the payment instrument group, maximum 300 characters.
          maxLength: 300
          type: string
        properties:
          additionalProperties:
            type: string
          description: Properties of the payment instrument group.
          type: object
        reference:
          description: Your reference for the payment instrument group, maximum 150 characters.
          maxLength: 150
          type: string
        txVariant:
          description: The tx variant of the payment instrument group.
          type: string
      required:
      - balancePlatform
      - txVariant
      type: object
  examples:
    patch-paymentInstruments-id-updatePaymentInstrumentStatus:
      summary: Update the status of a payment instrument
      description: Example request for updating the status of a payment instrument
      value:
        status: suspended
    get-paymentInstruments-id-reveal-success-200:
      summary: Get the card's primary account number (PAN)
      description: Example response for getting the card PAN
      value:
        cvc: '123'
        expiration:
          month: '02'
          year: '2026'
        pan: '5555444411209883'
    patch-paymentInstruments-id-updatePaymentInstrumentStatus-200:
      summary: Payment instrument status updated
      description: Example response for updating the status of a payment instrument
      value:
        balanceAccountId: BA32272223222B59CZ3T52DKZ
        description: S. Hopper - Main card
        issuingCountryCode: GB
        status: suspended
        type: card
        card:
          brand: mc
          brandVariant: mcdebit
          cardholderName: Simon Hopper
          formFactor: virtual
          bin: '555544'
          expiration:
            month: '01'
            year: '2024'
          lastFour: '5785'
          number: '************5785'
        id: PI3227C223222B5CMD278FKGS
    generic-400:
      summary: Response code 400. Bad request.
      value:
        status: 400
        errorCode: '702'
        message: 'Unexpected input: ", expected: }'
        errorType: validation
    post-payments-details-00.redirect-200:
      summary: Payment authorised
      description: Example response when submitting the redirect result
      value:
        resultCode: Authorised
        pspReference: V4HZ4RBFJGXXGN82
    post-paymentSession-enableOneClick-200:
      summary: Example response for request 'enableOneClick'
      value:
        paymentSession: eyJjaGVja291dHNob3BwZXJCYXN...
    generic-422:
      summary: Response code 422. Unprocessable entity.
      value:
        status: 422
        errorCode: '14_030'
        message: Return URL is missing.
        errorType: validation
        pspReference: '8816118280275544'
    post-payments-paymentPspReference-amountUpdates-amount-update-201:
      summary: Amount update requested
      description: Example response when an amount update was requested
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        paymentPspReference: 993617894903480A
        reference: YOUR_UNIQUE_REFERENCE
        pspReference: 993617894906488A
        status: received
        amount:
          currency: EUR
          value: 2500
    patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount-200:
      summary: Balance account updated
      description: Example response for updating the balance account linked to a payment instrument
      value:
        balanceAccountId: BA32272223222B5CM82WL892M
        description: S. Hopper - Main card
        issuingCountryCode: GB
        status: inactive
        type: card
        card:
          brand: mc
          brandVariant: mcdebit
          cardholderName: Simon Hopper
          formFactor: virtual
          bin: '555544'
          expiration:
            month: '01'
            year: '2024'
          lastFour: '5785'
          number: '************5785'
        id: PI3227C223222B5CMD278FKGS
    post-paymentInstruments-createVirtualCard:
      summary: Create a virtual card
      description: Example request for creating a virtual card
      value:
        type: card
        description: My test card
        balanceAccountId: BA3227C223222B5FG88S28BGN
        issuingCountryCode: NL
        card:
          cardholderName: Simon Hopper
          brand: mc
          brandVariant: mcdebit
          formFactor: virtual
    generic-500:
      summary: Response code 500. Internal server error.
      value:
        status: 500
        errorCode: '905'
        message: Payment details are not supported
        errorType: configuration
        pspReference: '8516091485743033'
    post-paymentInstruments-createVirtualCard-200:
      summary: Virtual card created
      description: Example response for creating a virtual card
      value:
        balanceAccountId: BA3227C223222B5FG88S28BGN
        description: My test card
        issuingCountryCode: NL
        status: active
        type: card
        card:
          brand: mc
          brandVariant: mcdebit
          cardholderName: Simon Hopper
          formFactor: virtual
          bin: '555544'
          cvc: '136'
          expiration:
            month: '11'
            year: '2025'
          lastFour: '3703'
          number: '5555444411213703'
        id: PI32272223222C5GXTDWH3TTN
    post-payments-split-classic:
      summary: Split a payment in a Classic Platforms integration
      value:
        paymentMethod:
          type: scheme
          encryptedCardNumber: test_4111111111111111
          encryptedExpiryMonth: test_03
          encryptedExpiryYear: test_2030
          encryptedSecurityCode: test_737
        amount:
          value: 6200
          currency: EUR
        reference: YOUR_ORDER_NUMBER
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        returnUrl: https://your-company.com/...
        splits:
        - amount:
            value: 6000
          type: MarketPlace
          account: '151272963'
          reference: '6124145'
          description: 'Porcelain Doll: Eliza (20cm)'
        - amount:
            value: 200
          type: Commission
          reference: '6124146'
    post-payments-card-3d-secure-direct:
      summary: Make a card payment with 3D Secure redirect authentication
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          number: '4212345678901237'
          expiryMonth: '03'
          expiryYear: '2030'
          holderName: John Smith
          cvc: '737'
        browserInfo:
          userAgent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008052912 Firefox/3.0
          acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
          javaEnabled: true
          colorDepth: 10
          screenHeight: 2000
          screenWidth: 3000
          timeZoneOffset: 5
          language: en
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-payments-enableOneClick-SF-200:
      summary: Card details tokenized for one-off payments
      value:
        additionalData:
          cvcResult: 1 Matches
          authCode: 82338
          avsResult: 4 AVS not supported for this card type
          recurring.recurringDetailReference: '9916178934434753'
          recurringProcessingModel: CardOnFile
          avsResultRaw: '4'
          cvcResultRaw: M
          refusalReasonRaw: AUTHORISED
          recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
          acquirerCode: TestPmmAcquirer
          acquirerReference: 8PQMP9VC172
        pspReference: 993617895195570C
        resultCode: Authorised
        merchantReference: string
    post-paymentMethods-filtered:
      summary: Get payment methods based on the country and amount
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        countryCode: NL
        shopperLocale: nl-NL
        amount:
          currency: EUR
          value: 1000
    patch-paymentInstruments-id-updatePaymentInstrumentBalanceAccount:
      summary: Update the balance account linked to a payment instrument
      description: Example request for updating the balance account of a payment instrument
      value:
        balanceAccountId: BA32272223222B5CM82WL892M
    generic-403_2:
      summary: Response code - 403 Forbidden.
      value:
        type: https://docs.adyen.com/errors/security/unauthorized
        title: Forbidden
        status: 403
        detail: Not the right permission to access this service.
        errorCode: '00_403'
    post-payments-card-direct:
      summary: Make a card payment with unencrypted card details
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          number: '4111111111111111'
          expiryMonth: '03'
          expiryYear: '2030'
          holderName: John Smith
          cvc: '737'
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-payments-result-basic:
      summary: Verify payment results
      value:
        payload: VALUE_YOU_GET_FROM_CHECKOUT_SDK
    post-payments-card-securedfields:
      summary: Make a card payment
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          encryptedCardNumber: test_4111111111111111
          encryptedExpiryMonth: test_03
          encryptedExpiryYear: test_2030
          encryptedSecurityCode: test_737
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentMethods-include-stored:
      summary: Get payment methods including stored card details
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        countryCode: NL
        amount:
          currency: EUR
          value: 1000
        shopperReference: YOUR_SHOPPER_REFERENCE
    post-payments-paymentPspReference-reversals-reversal-201:
      summary: Payment reversal requested
      description: Example response when a payment reversal was requested
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        paymentPspReference: 993617894903480A
        reference: YOUR_UNIQUE_REFERENCE
        pspReference: 993617894906488A
        status: received
    post-payments-oneclick-securedfields:
      summary: Make a one-off payment with a token and CVV
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          storedPaymentMethodId: '8416038790273850'
          encryptedSecurityCode: adyenjs_0_1_18$MT6ppy0FAMVMLH...
        shopperReference: YOUR_UNIQUE_SHOPPER_ID_6738oneoff
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        shopperInteraction: ContAuth
        recurringProcessingModel: CardOnFile
    get-paymentInstrumentGroups-id-success-200:
      summary: Payment instrument group retrieved
      description: Example response when retrieving a payment instrument group
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        txVariant: mc
        id: PG3227C223222B5CMD3FJFKGZ
    post-paymentMethods-balance-not-enough:
      summary: Get gift card balance specifying amount of 100 EUR
      value:
        paymentMethod:
          type: givex
          number: '4126491073027401'
          cvc: '737'
        amount:
          currency: EUR
          value: 10000
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-payments-subscription-first-transaction-200:
      summary: Card details tokenized for a subscription
      value:
        additionalData:
          cvcResult: 1 Matches
          authCode: 98871
          avsResult: 4 AVS not supported for this card type
          recurring.recurringDetailReference: '9916178934434753'
          recurringProcessingModel: Subscription
          avsResultRaw: '4'
          cvcResultRaw: M
          refusalReasonRaw: AUTHORISED
          recurring.shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
          acquirerCode: TestPmmAcquirer
          acquirerReference: 8PQMP9VD896
        pspReference: 993617895199574A
        resultCode: Authorised
        merchantReference: string
    post-paymentSession-web-200:
      summary: Example response for request 'web'
      value:
        paymentSession: eyJjaGVja291dHNob3BwZXJCYXN...
    post-payments-details-00.redirect:
      summary: Submit the redirect result
      description: Example request when submitting a redirect result
      value:
        details:
          redirectResult: X6XtfGC3!Y...
    post-paymentLinks-basic-201:
      summary: Payment link created
      value:
        amount:
          currency: BRL
          value: 1250
        billingAddress:
          city: So Paulo
          country: BR
          houseNumberOrName: '999'
          postalCode: '59000060'
          stateOrProvince: SP
          street: Roque Petroni Jr
        countryCode: BR
        deliveryAddress:
          city: So Paulo
          country: BR
          houseNumberOrName: '999'
          postalCode: '59000060'
          stateOrProvince: SP
          street: Roque Petroni Jr
        expiresAt: '2022-10-28T09:16:22Z'
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        reference: YOUR_ORDER_NUMBER
        reusable: false
        shopperEmail: test@email.com
        shopperLocale: pt-BR
        shopperReference: YOUR_SHOPPER_REFERENCE
        id: PLE83C39B0A0DE0C1E
        status: active
        url: https://test.adyen.link/PLE83C39B0A0DE0C1E
    generic-500_2:
      summary: Response code - 500 Internal Server Error
      value:
        type: https://docs.adyen.com/errors/general/internal
        title: An internal error happened
        status: 500
        detail: Unrecoverable error while trying to create payment instrument
        requestId: 1WAF555PLWNTLYOQ
        errorCode: '00_500'
    post-payments-card-securedfields-200:
      summary: Successful card payment
      value:
        additionalData:
          cvcResult: 1 Matches
          authCode: 65696
          avsResult: 4 AVS not supported for this card type
          avsResultRaw: '4'
          cvcResultRaw: M
          refusalReasonRaw: AUTHORISED
          acquirerCode: TestPmmAcquirer
          acquirerReference: 8PQMP9VIE9N
        pspReference: 993617895215577D
        resultCode: Authorised
        merchantReference: string
    post-paymentSession-android:
      summary: Set up a payment session (Android)
      value:
        amount:
          currency: EUR
          value: 17408
        reference: Your order number
        shopperReference: YOUR_SHOPPER_REFERENCE
        channel: Android
        token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK
        returnUrl: app://
        countryCode: NL
        shopperLocale: nl_NL
        sessionValidity: '2017-04-06T13:09:13Z'
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentInstruments-createPhysicalCard-200:
      summary: Physical card created
      description: Example response for creating a physical card
      value:
        balanceAccountId: BA32272223222B59CZ3T52DKZ
        description: S. Hopper - Main card
        issuingCountryCode: NL
        status: inactive
        type: card
        card:
          brand: mc
          brandVariant: mcdebit
          cardholderName: Sam Hopper
          formFactor: physical
          number: '************5785'
          bin: '555544'
          expiration:
            month: 8
            year: '2024'
          lastFour: '2765'
          authentication:
            password: '******'
            phone:
              number: '+123456789'
              type: mobile
          deliveryContact:
            address:
              city: Amsterdam
              country: NL
              stateOrProvince: NH
              line1: Brannan Street
              line2: '274'
              postalCode: 1020CD
            name:
              firstName: Sam
              lastName: Hopper
          configuration:
            configurationProfileId: CP123AB45678C91ABCD2ABCDE
        id: PI3227C223222B5BPCMFXD2XG
    post-payments-ideal-200:
      summary: Successful iDEAL payment
      value:
        resultCode: RedirectShopper
        action:
          paymentMethodType: ideal
          url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ
          method: GET
          type: redirect
        paymentData: Ab02b4c0!BQABAgCINC3kOq5nsaj4k+VaArf6VIiTWkYALwijaS+VOvzTSf76Un3WYBgKJlEBqALZW3vlw+IDQGw5jqkVBO4axEJEFKu5fDL2RkeHbm+aHY7tlRVsjvNIcVTNbMtHJcclHakOVTrtTCQfspf11XGsmENUaL45bdeu07iDBtpnIvd39p6g8OVaLcSIGaA8Zosd93hs0h3lvIePt3QTekeOUH+zrMMfLyy/4QKBZtLjnWo3/4U0e2tsneOudynW0l5i+VyobWOZb7yZUj7v9GMVpAZ3YEqNZ1aWJlSmty9TJTpXp4PQQcNeELQAfTu4zaarMq5btRZpcmDRvSOQK0Qo/PvfWrv/si0c1NPr5EM43ebdkLiDEUSIGBDTellblheOaRsgD0JlrNLOHSpS6iCiyY5FQaWx7FpnYReP/un2f/2mMGxdehif1MqWWZzgAhjdA4kksQVb8eMIGLY2IveJ4iTmDAkFbhIATs2SuWhYBGqFnBGeH1jlJCJDDV8/XJ0IcX1/r0qC3wsUFecoElZ6gts+4tlfPUoeuSH/NFmyBEzrjZbgCqCH9YVXa/+W+dwQCOQ0G7K4SJepnlNcmpCtI29zMZgeRqmtzI0hImvQYt188MXK44ieh2wsmpVv6Y9EGIgJVR+t1IZKizm6Q2D5MCUC1uAVwu2iw7Xt5Re1XcWSaBC/nZt2iHaZF7kpgIXfrFshAEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifVTgdc9kCwE5LJyeGFVSr+P70S1hwc62Ad03Oy1Ksxr823klh1hxYQDWBJETNf/YmYC9cHDGr6LxMQ8OOnwfg2xjsVU7ZUwWJbHid1vU/oJzHBXe54lHMNNre0HaQD6TSokVpazQsY3hRB84uevmeT7KVal98iqXd755VuiIxwHhhywaub1ogyQQEVxNGWx2+vL5Vh8NKmoghZQ+NLSZWRn77hJTGV+lKJdseGA9nV7DSlWodNmZ8RyRfQoqwtaK9woQ87PIN7XqSznZMS1HWMOE/aDLEXLJEfozHWrHuGVmn6Hupt/fBnm1GckSsMGeQNKS+4XmKGrJefrHDmdoZVBaZS9UjxfKjD2sCwu5vutgb6SLrECgCvu3q5/LTyFeTuPV1ZZrlpapC6umnWmSKmj/SdnhXJO00PNuFT2WY/GyH0cyA498zApE6VtLx2e9IvS01Oex6ZCRFDJ6sDCBzVN5g60vsm9tBut6trpQWyryqVM2cQ39xh9olCQ5Ml+2h4YFV5gA+1c0i+e6SeMtFJN788NW2EnQT/2pzM/rNAaSVwSf8vJcx3ZB9n8Pf8xi2buKZFEkyJpZJSg22JC/38D1E0tPRpQ7gZ1Z86meAGXnfKUtA+w2FllB2Y0dMrqi8jXnS/mqMPBmPVnIxUW96e40cB7W8E0VDf1IKx/wQphI8/vM3UOSqC81agmnyQ3nIDrAy8vqMOD+d1xcoElzRNy0OxU6v/90IKkhfAKr3Tur7Vb3FD6Pi/XrujJX95UlRd7fmaAI7Po1cIh1v7HEhsCNoh1z7WFNag==
        redirect:
          method: GET
          url: https://test.adyen.com/hpp/checkout.shtml?u=redirectIdeal&p=eJxtUl1zmzAQ-DXwZgaB*XrQg0Nwg2s3DTVtJy8ZRbqAYlsikmCMf30FddNMpzOak2bvZm-3Ts*KCJZLBpgzIEeX9kqBoOMMFXXlcq17UCXDCAXIPYGiLRFmRanshcF70GZ3xd6TpTDQKGK4FJ4ZO8D5XZF-vq-3T5*KL0VV5v*tHEBpe*Pob5cKXmBSA1gbxUXzIWF6JW6JITjLUIySNItQliVxsH6v*cYbnNSHZsMfcydYr8SrE9yY7HRjavMAlyyIjhuK*tzszj9ew-uHrN854a3bkfEE1uBp9od833cV6Lra4taYzglXlsueo6Tk2EptLJL6qW8h2gI9yN7oVnYdKItoUAOnoO3z62-aUlB5sk4qYFwBNTYzoD9015odmFYyJ1z-M2yr7uO4nSBW8xisNpua1NlG0SQwmiTaMMpeLWzDjojRs-cMep7natDTrL*TI2fcjDjwA7Twlws-3aPYOkKZDVH26F69THtShE57woUlmpSBqw9czP*k65*9IfCuq0jiJElQGi69Szn8DPebmKXDWATt6vxEWduea7*sLy-Lt*1bcbctGhgZk78A5S7dyQ
    get-paymentInstrumentGroups-id-transactionRules-success-200:
      summary: Transaction rules for a payment instrument group retrieved
      description: Example response when retrieving a list of transaction rules applied to a payment instrument group
      value:
        transactionRules:
        - aggregationLevel: paymentInstrument
          description: Up to 1000 EUR per card for the last 12 hours
          entityKey:
            entityReference: PG3227C223222C5GXR3M5592Q
            entityType: paymentInstrumentGroup
          interval:
            duration:
              unit: hours
              value: 12
            timeZone: UTC
            type: sliding
          outcomeType: hardBlock
          reference: YOUR_REFERENCE_2918A
          requestType: authorization
          ruleRestrictions:
            totalAmount:
              operation: greaterThan
              value:
                currency: EUR
                value: 100000
          status: inactive
          type: velocity
          id: TR3227C223222C5GXR3XP596N
        - aggregationLevel: paymentInstrument
          description: NL only
          entityKey:
            entityReference: PG3227C223222C5GXR3M5592Q
            entityType: paymentInstrumentGroup
          interval:
            duration:
              unit: hours
              value: 12
            timeZone: UTC
            type: sliding
          outcomeType: hardBlock
          reference: myRule12345
          requestType: authorization
          ruleRestrictions:
            totalAmount:
              operation: greaterThan
              value:
                currency: EUR
                value: 100000
          status: inactive
          type: velocity
          id: TR3227C223222C5GXR3WC595H
    post-payments-card-direct-200:
      summary: Successful card payment with unencrypted card details
      value:
        additionalData:
          cvcResult: 1 Matches
          authCode: 44925
          avsResult: 4 AVS not supported for this card type
          avsResultRaw: '4'
          cvcResultRaw: M
          refusalReasonRaw: AUTHORISED
          acquirerCode: TestPmmAcquirer
          acquirerReference: 8PQMP9VEP3H
        pspReference: 993617895204576J
        resultCode: Authorised
        merchantReference: string
    post-payments-paymentPspReference-reversals-reversal:
      summary: Reverse (cancel or refund) a payment
      description: Example request to reverse a payment
      value:
        reference: YOUR_UNIQUE_REFERENCE
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    get-paymentLinks-linkId-basic-200:
      summary: Example response for request 'basic'
      value:
        amount:
          currency: EUR
          value: 8700
        countryCode: NL
        expiresAt: '2021-04-08T14:06:39Z'
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        reference: shopper-reference-ekvL83
        shopperLocale: hu-HU
        shopperReference: shopper-reference-LZfdWZ
        status: active
        url: https://test.adyen.link/PL61C53A8B97E6915A
        id: PL61C53A8B97E6915A
    post-payments-recurring:
      summary: Make a subscription card payment with a token
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          storedPaymentMethodId: '8316038796685850'
        shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3subscription
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        shopperInteraction: ContAuth
        recurringProcessingModel: Subscription
    generic-403:
      summary: Response code 403. Forbidden.
      value:
        status: 403
        errorCode: '901'
        message: Invalid Merchant Account
        errorType: security
        pspReference: 881611827877203B
    post-payments-googlepay:
      summary: Make a Google Pay payment
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: paywithgoogle
          googlePayToken: ==Payload as retrieved from Google Pay response==
        returnUrl: https://your-company.com/...
        merchantAccount: YourMerchantAccount
    post-paymentInstrumentGroups-createPaymentInstrumentGroups:
      summary: Create a payment instrument group
      description: Example request for creating a payment instrument group
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        txVariant: mc
    post-payments-ideal:
      summary: Make an iDEAL payment
      value:
        amount:
          currency: EUR
          value: 1000
        reference: Your order number
        paymentMethod:
          type: ideal
          issuer: '1121'
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentMethods-include-stored-200:
      summary: Example response that includes stored payment methods
      value:
        paymentMethods:
        - name: iDEAL
          type: ideal
        - name: Cards
          type: scheme
        - name: PayPal
          type: paypal
        - name: AfterPay Invoice
          type: afterpay_default
        - name: Pay later with Klarna.
          type: klarna
        - name: SEPA Direct Debit
          type: sepadirectdebit
        - name: Paysafecard
          type: paysafecard
        - name: Bijenkorf Cadeaucard
          type: bijcadeaucard
        - name: Fonq Giftcard
          type: fonqgiftcard
        - name: Bank Transfer (NL)
          type: bankTransfer_NL
        - name: Pathe Giftcard
          type: pathegiftcard
        - name: VVV Giftcard
          type: vvvgiftcard
        - name: Podium Card
          type: podiumcard
        - name: RatePay Direct Debit
          type: ratepay_directdebit
        - name: Rituals Giftcard
          type: rituals
        - name: Hunkemoller Lingerie Card
          type: hmlingerie
        - name: Primera Cadeaukaart
          type: primeracadeaucard
        - name: Fashioncheque
          type: fashioncheque
        - name: NETELLER
          type: neteller
        - name: Adyen Voucher
          type: adyen_test_voucher
        - name: AfterPay B2B
          type: afterpay_b2b
        - name: AfterPay DirectDebit
          type: afterpay_directdebit
        - name: AliPay
          type: alipay
        - name: AliPay
          type: alipay_wap
        - name: Android Pay
          type: androidpay
        - name: Apple Pay
          type: applepay
        - name: Baby Gift Card
          type: babygiftcard
        - name: SEPA Bank Transfer
          type: bankTransfer_IBAN
        - name: Bloemen Giftcard
          type: bloemengiftcard
        - name: Boekenbon Giftcard
          type: boekenbon
        - name: Cash-Ticket
          type: cashticket
        - name: Chasin Giftcard
          type: chasingiftcard
        - name: ClickandBuy
          type: clickandbuy
        - name: Costes Giftcard
          type: costesgiftcard
        - name: custom_settlement
          type: custom_settlement
        - name: eft_directdebit_CA
          type: eft_directdebit_CA
        - name: Nationale Entertainment Card
          type: entertainmentcard
        - name: Expert Cadeaukaart
          type: expertgiftcard
        - name: FijnCadeau
          type: fijncadeau
        - name: Fleurop Bloemenbon
          type: fleuropbloemenbon
        - name: Gall & Gall
          type: gallgall
        - name: Generic GiftCard
          type: genericgiftcard
        - name: GiftFor2
          type: giftfor2card
        - name: Givex
          type: givex
        - name: Goldsmiths Card
          type: goldsmithscard
        - name: Hunkemoller Member Card
          type: hmclub
        - name: Phone Payment
          type: ivr
        - name: Landline phone
          type: ivrLandline
        - name: Mobile phone
          type: ivrMobile
        - name: Kado Wereld
          type: kadowereld
        - name: Karen Millen GiftCard
          type: karenmillengiftcard
        - name: Leisure Card
          type: leisurecard
        - name: Loods5 Cadeaukaart
          type: loods5giftcard
        - name: Loods5 Tegoedbon
          type: loods5prepaidcard
        - name: Amazon Pay
          type: amazonpay
        - name: MOLPoints
          type: molpay_points
        - name: Moneybookers
          type: moneybookers
        - name: De Nationale Musicalcard
          type: musicalcard
        - name: Nationale Bioscoopbon
          type: nationalebioscoopbon
        - name: Nationale Tuinbon
          type: nationaletuinbon
        - name: Nationale Verwen Cadeaubon
          type: nationaleverwencadeaubon
        - name: Onebip
          type: onebip
        - name: Google Pay
          type: paywithgoogle
        - name: Plastix
          type: plastix
        - name: Pluim
          type: pluimgiftcard
        - name: Illicado Gift Card
          type: prosodie_illicado
        - name: RatePay Invoice
          type: ratepay
        - name: Rob Peetoom Giftcard
          type: robpeetoomgiftcard
        - name: Shoes&Accessories Cadeau
          type: sagiftcard
        - name: Score Giftcard
          type: scoregiftcard
        - name: Premium SMS
          type: sms
        - name: SVS
          type: svs
        - name: TCS Test GiftCard
          type: tcstestgiftcard
        - name: The Sting Giftcard
          type: thestinggiftcard
        - name: Ukash
          type: ukash
        - name: UnionPay
          type: unionpay
        - name: Valuelink
          type: valuelink
        - name: V&D Cadeaukaart
          type: vdcadeaucard
        - name: Visa Checkout
          type: visacheckout
        - name: VVV Cadeaubon
          type: vvvcadeaubon
        - name: Webshop Giftcard
          type: webshopgiftcard
        - name: WE Fashion Giftcard
          type: wefashiongiftcard
        - name: Western Union
          type: westernunion
        - name: Winkel Cheque
          type: winkelcheque
        - name: Your Gift
          type: yourgift
        storedPaymentMethods:
        - brand: visa
          expiryMonth: '10'
          expiryYear: '30'
          holderName: John Smith
          id: '7219687191761347'
          issuerName: ISSUER_NAME
          lastFour: '1111'
          name: VISA
          shopperEmail: john.smith@example.com
          shopperReference: YOUR_SHOPPER_REFERENCE
          supportedRecurringProcessingModels:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: scheme
    post-paymentMethods-basic:
      summary: Get available payment methods
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentInstrumentGroups-createPaymentInstrumentGroups-200:
      summary: Create a payment instrument group
      description: Example request for creating a payment instrument group
      value:
        balancePlatform: YOUR_BALANCE_PLATFORM
        txVariant: mc
        id: PG32272223222H5J4DCRVC9DH
    post-payments-paymentPspReference-refunds-refund:
      summary: Refund a payment
      description: Example refund request
      value:
        amount:
          currency: EUR
          value: 2500
        reference: YOUR_UNIQUE_REFERENCE
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentInstruments-createBusinessAccountNL:
      summary: Create a business account in NL
      description: Example request for creating a business account in NL
      value:
        type: bankAccount
        description: YOUR_DESCRIPTION
        balanceAccountId: BA3227C223222B5CTBLR8BWJB
        issuingCountryCode: NL
    post-payments-split-balanceplatform:
      summary: Split a payment between balance accounts
      value:
        paymentMethod:
          type: scheme
          encryptedCardNumber: test_4111111111111111
          encryptedExpiryMonth: test_03
          encryptedExpiryYear: test_2030
          encryptedSecurityCode: test_737
        amount:
          value: 40000
          currency: USD
        reference: YOUR_ORDER_NUMBER
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        returnUrl: https://your-company.com/...
        platformChargebackLogic:
          behavior: deductFromOneBalanceAccount
          targetAccount: BA00000000000000000000001
          costAllocationAccount: BA00000000000000000000001
        splits:
        - amount:
            value: 39600
          type: BalanceAccount
          account: BA00000000000000000000001
          reference: Your reference for the sale amount
          description: Your description for the sale amount
        - amount:
            value: 400
          type: Commission
          reference: Your reference for the commission
          description: Your description for the commission
        - type: PaymentFee
          account: BA00000000000000000000001
          reference: Your reference for the fees
          description: Your description for the fees
    generic-401_2:
      summary: Response code - 401 Unauthorized
      value:
        type: https://docs.adyen.com/errors/security/unauthorized
        title: Unauthorized
        status: 401
        detail: Not authorized to access this service.
        errorCode: '00_401'
    post-payments-klarna:
      summary: Make a Klarna payment
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        reference: YOUR_ORDER_REFERENCE
        paymentMethod:
          type: klarna
        amount:
          currency: SEK
          value: 1000
        shopperLocale: en_US
        countryCode: SE
        telephoneNumber: +46 840 839 298
        shopperEmail: youremail@email.com
        shopperName:
          firstName: Testperson-se
          lastName: Approved
        shopperReference: YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j
        billingAddress:
          city: Ankeborg
          country: SE
          houseNumberOrName: '1'
          postalCode: '12345'
          street: Stargatan
        deliveryAddress:
          city: Ankeborg
          country: SE
          houseNumberOrName: '1'
          postalCode: '12345'
          street: Stargatan
        returnUrl: https://www.your-company.com/...
        lineItems:
        - quantity: 1
          amountExcludingTax: 331
          taxPercentage: 2100
          description: Shoes
          id: 'Item #1'
          taxAmount: 69
          amountIncludingTax: 400
          productUrl: URL_TO_PURCHASED_ITEM
          imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
        - quantity: 2
          amountExcludingTax: 248
          taxPercentage: 2100
          description: Socks
          id: 'Item #2'
          taxAmount: 52
          amountIncludingTax: 300
          productUrl: URL_TO_PURCHASED_ITEM
          imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM
    post-paymentMethods-balance-basic:
      summary: Get gift card balance specifying amount of 10 EUR
      value:
        paymentMethod:
          type: givex
          number: '4126491073027401'
          cvc: '737'
        amount:
          currency: EUR
          value: 1000
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201:
      summary: Refund requested
      description: Example response when a refund was requested
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        paymentPspReference: 993617894903480A
        reference: YOUR_UNIQUE_REFERENCE
        pspReference: 993617894906488A
        status: received
    post-paymentInstruments-createBusinessAccountUS:
      summary: Create a business account in the US
      description: Example request for creating a business account in the US
      value:
        type: bankAccount
        description: YOUR_DESCRIPTION
        balanceAccountId: BA3227C223222B5CTBLR8BWJB
        issuingCountryCode: US
    generic-400_2:
      summary: Response code - 400 Bad request
      value:
        type: https://docs.adyen.com/errors/general/bad-request
        title: Bad request
        status: 400
        detail: Empty input which would have resulted in a null result.
        errorCode: '00_400'
    post-paymentInstruments-createBusinessAccountUS-200:
      summary: Business account in the US created
      description: Example response for creating a business account in the US
      value:
        balanceAccountId: BA3227C223222B5CTBLR8BWJB
        issuingCountryCode: US
        status: active
        type: bankAccount
        description: YOUR_DESCRIPTION
        bankAccount:
          type: usLocal
          accountNumber: '333720756'
          routingNumber: '210000210'
          accountType: checking
        id: PI322LJ223222B5DJS7CD9LWL
    post-paymentInstruments-createPhysicalCard:
      summary: Create a physical card
      description: Example request for creating a physical card
      value:
        type: card
        issuingCountryCode: NL
        balanceAccountId: BA32272223222B59CZ3T52DKZ
        description: S.Hopper - Main card
        status: inactive
        card:
          formFactor: physical
          brand: mc
          brandVariant: mcdebit
          cardholderName: Sam Hopper
          deliveryContact:
            address:
              city: Amsterdam
              country: NL
              stateOrProvince: NH
              line1: Brannan Street
              line2: '274'
              postalCode: 1020CD
            name:
              firstName: Sam
              lastName: Hopper
          configuration:
            configurationProfileId: CP123AB45678C91ABCD2ABCDE
    patch-paymentLinks-linkId-basic-200:
      summary: Example response for request 'basic'
      value:
        amount:
          currency: EUR
          value: 8700
        countryCode: NL
        expiresAt: '2021-04-08T14:06:39Z'
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        reference: shopper-reference-ekvL83
        shopperLocale: hu-HU
        shopperReference: shopper-reference-LZfdWZ
        status: expired
        url: https://test.adyen.link/PL61C53A8B97E6915A
        id: PL61C53A8B97E6915A
    get-paymentInstruments-id-success-200:
      summary: Payment instruments retrieved
      description: Example response for retrieving payment instruments associated with a balance account
      value:
        balanceAccountId: BA32272223222B59CZ3T52DKZ
        description: S. Hopper - Main card
        issuingCountryCode: GB
        status: active
        type: card
        card:
          brand: mc
          brandVariant: mcdebit
          cardholderName: Simon Hopper
          formFactor: virtual
          bin: '555544'
          expiration:
            month: '01'
            year: '2024'
          lastFour: '3548'
          number: '************3548'
        id: PI32272223222B5CMD3MQ3HXX
    post-paymentMethods-balance-basic-200:
      summary: Gift card balance greater than amount specified in request
      value:
        pspReference: KHQC5N7G84BLNK43
        resultCode: Success
        balance:
          currency: EUR
          value: 5000
    generic-401:
      summary: Response code 401. Unauthorized.
      value:
        status: 401
        errorCode: '000'
        message: HTTP Status Response - Unauthorized
        errorType: security
    post-paymentInstruments-createBusinessAccountNL-200:
      summary: Business account in NL created
      description: Example response for creating a business account in NL
      value:
        balanceAccountId: BA3227C223222B5CTBLR8BWJB
        issuingCountryCode: NL
        status: active
        type: bankAccount
        description: YOUR_DESCRIPTION
        bankAccount:
          type: iban
          iban: NL20ADYB2017000035
        id: PI322LJ223222B5DJS7CD9LWL
    get-paymentInstruments-id-transactionRules-success-200:
      summary: Transaction rules for a payment instrument retrieved
      description: Example response when retrieving a list of transaction rules applied to a payment instrument
      value:
        transactionRules:
        - description: Only allow point-of-sale transactions
          entityKey:
            entityReference: PI3227C223222B5FN65FN5NS9
            entityType: paymentInstrument
          interval:
            timeZone: UTC
            type: perTransaction
          outcomeType: hardBlock
          reference: YOUR_REFERENCE_4F7346
          requestType: authorization
          ruleRestrictions:
            processingTypes:
              operation: noneMatch
              value:
              - pos
          startDate: '2022-08-02T16:07:00.851374+02:00'
          status: active
          type: blockList
          id: TR32272223222B5GFSGFLFCHM
        - description: Set the maximum number of active network tokens to one for this card
          entityKey:
            entityReference: PI3227C223222B5FN65FN5NS9
            entityType: paymentInstrument
          interval:
            timeZone: UTC
            type: perTransaction
          outcomeType: hardBlock
          reference: myRule123
          requestType: authorization
          ruleRestrictions:
            activeNetworkTokens:
              operation: greaterThanOrEqualTo
              value: 1
          startDate: '2022-10-03T14:48:28.999314+02:00'
          status: active
          type: blockList
          id: TR32272223222C5GQJ93L7J8Z
    post-payments-card-3d-secure-2-web:
      summary: Make a card payment with 3D Secure 2 native authentication
      value:
        amount:
          currency: EUR
          value: 1000
        reference: YOUR_ORDER_NUMBER
        paymentMethod:
          type: scheme
          encryptedCardNumber: test_4035501428146300
          encryptedExpiryMonth: test_03
          encryptedExpiryYear: test_2030
          encryptedSecurityCode: test_737
          holderName: John Smith
        authenticationData:
          threeDSRequestData:
            nativeThreeDS: preferred
        billingAddress:
          country: US
          city: New York
          street: Redwood Block
          houseNumberOrName: 37C
          stateOrProvince: NY
          postalCode: '10039'
        shopperEmail: s.hopper@test.com
        shopperIP: 192.0.2.1
        browserInfo:
          userAgent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36
          acceptHeader: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8
          language: nl-NL
          colorDepth: 24
          screenHeight: 723
          screenWidth: 1536
          timeZoneOffset: 0
          javaEnabled: true
        channel: Web
        origin: https://your-company.com
        returnUrl: https://your-company.com/checkout/
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-payments-applepay:
      summary: Make an Apple Pay payment
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: applepay
          applePayToken: VNRWtuNlNEWkRCSm1xWndjMDFFbktkQU...
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentMethods-basic-200:
      summary: Example response for request 'basic'
      value:
        paymentMethods:
        - name: ACH Direct Debit
          type: ach
        - name: Adyen Voucher
          type: adyen_test_voucher
        - name: AfterPay Invoice
          type: afterpay_default
        - name: AfterPay DirectDebit
          type: afterpay_directdebit
        - name: Afterpay
          type: afterpaytouch
        - name: Cards
          type: scheme
        - name: AliPay
          type: alipay
        - name: AliPay HK
          type: alipay_hk
        - name: AliPay
          type: alipay_wap
        - name: Android Pay
          type: androidpay
        - name: Apple Pay
          type: applepay
        - name: Credit Card via AsiaPay
          type: asiapay
        - name: China UnionPay
          type: asiapay_unionpay
        - name: Baby Gift Card
          type: babygiftcard
        - name: Baloto
          type: baloto
        - name: BancNet
          type: bancnet
        - name: Bank Transfer (BG)
          type: bankTransfer_BG
        - name: Bank Transfer (CH)
          type: bankTransfer_CH
        - name: Bank Transfer (DE)
          type: bankTransfer_DE
        - name: Bank Transfer (FI)
          type: bankTransfer_FI
        - name: Bank Transfer (GB)
          type: bankTransfer_GB
        - name: Bank Transfer (HU)
          type: bankTransfer_HU
        - name: SEPA Bank Transfer
          type: bankTransfer_IBAN
        - name: Bank Transfer (IE)
          type: bankTransfer_IE
        - name: Electronic Bank Transfer (MX)
          type: bankTransfer_MX_linked
        - name: Bank Transfer (MX)
          type: bankTransfer_MX_offline
        - name: Bank Transfer (NL)
          type: bankTransfer_NL
        - name: Bank Transfer (PL)
          type: bankTransfer_PL
        - name: Bank Transfer (SE)
          type: bankTransfer_SE
        - name: Bank Transfer (US)
          type: bankTransfer_US
        - name: Payconiq by Bancontact
          type: bcmc_mobile
        - name: Bijenkorf Cadeaucard
          type: bijcadeaucard
        - name: 99Bill
          type: bill99
        - name: Online Banking India
          type: billdesk_online
        - name: UPI
          type: billdesk_upi
        - name: Wallets India
          type: billdesk_wallet
        - name: Blik
          type: blik
        - name: Bloemen Giftcard
          type: bloemengiftcard
        - name: Boekenbon Giftcard
          type: boekenbon
        - name: Boleto
          type: boleto
        - name: Boleto Bancario
          type: boletobancario_santander
        - name: Bradesco
          type: bradesco
        - name: Cash-Ticket
          type: cashticket
        - name: CashU
          type: cashu
        - name: CCAvenue
          type: ccavenue
        - name: Mula Checkout
          type: cellulant
        - name: Chasin Giftcard
          type: chasingiftcard
        - name: Clearpay
          type: clearpay
        - name: ClickandBuy
          type: clickandbuy
        - name: Paiement en 3 fois par Cartes Bancaires
          type: cofinoga_3xcb
        - name: Costes Giftcard
          type: costesgiftcard
        - name: custom_settlement
          type: custom_settlement
        - name: DANA
          type: dana
        - name: DineroMail
          type: dineromail
        - name: Online bank transfer.
          type: directEbanking
        - name: Direct Debit Brazil - Banco do Brazil
          type: directdebit_BR_bancodobrasil
        - name: Direct Debit Brazil - Bradesco
          type: directdebit_BR_bradesco
        - name: Direct Debit Brazil - Caixa Economica Federal
          type: directdebit_BR_caixa
        - name: Direct Debit Brazil - HSBC
          type: directdebit_BR_hsbc
        - name: Direct Debit Brazil - Itau
          type: directdebit_BR_itau
        - name: Direct Debit Brazil - Santander
          type: directdebit_BR_santander
        - name: BACS Direct Debit
          type: directdebit_GB
        - name: Alfamart
          type: doku_alfamart
        - name: BCA Bank Transfer
          type: doku_bca_va
        - name: BNI VA
          type: doku_bni_va
        - name: BRI VA
          type: doku_bri_va
        - name: CIMB VA
          type: doku_cimb_va
        - name: Danamon VA
          type: doku_danamon_va
        - name: Indomaret
          type: doku_indomaret
        - name: Mandiri VA
          type: doku_mandiri_va
        - name: OVO
          type: doku_ovo
        - name: Bank Transfer
          type: doku_permata_lite_atm
        - name: DOKU wallet
          type: doku_wallet
        - name: Local Polish Payment Methods
          type: dotpay
        - name: Dragonpay Prepaid Credits
          type: dragonpay_credits
        - name: Online Banking
          type: dragonpay_ebanking
        - name: GCash
          type: dragonpay_gcash
        - name: Over The Counter Banks
          type: dragonpay_otc_banking
        - name: OTC non-Bank via Dragonpay
          type: dragonpay_otc_non_banking
        - name: Convenience Stores
          type: dragonpay_otc_philippines
        - name: 7/11
          type: dragonpay_seveneleven
        - name: eagleeye_voucher
          type: eagleeye_voucher
        - name: Finnish E-Banking
          type: ebanking_FI
        - name: Pay-easy ATM
          type: econtext_atm
        - name: Online Banking
          type: econtext_online
        - name: 7-Eleven
          type: econtext_seven_eleven
        - name: Convenience Stores
          type: econtext_stores
        - name: eft_directdebit_CA
          type: eft_directdebit_CA
        - name: Lastschrift (ELV)
          type: elv
        - name: Bank Payment
          type: entercash
        - name: Nationale Entertainment Card
          type: entertainmentcard
        - name: EPS
          type: eps
        - name: Expert Cadeaukaart
          type: expertgiftcard
        - name: 3x Oney
          type: facilypay_3x
        - name: 4x Oney
          type: facilypay_4x
        - name: Fashioncheque
          type: fashioncheque
        - name: Fawry
          type: fawry
        - name: FijnCadeau
          type: fijncadeau
        - name: Fleurop Bloemenbon
          type: fleuropbloemenbon
        - name: Fonq Giftcard
          type: fonqgiftcard
        - name: Gall & Gall
          type: gallgall
        - name: GCash
          type: gcash
        - name: Generic GiftCard
          type: genericgiftcard
        - name: GiftFor2
          type: giftfor2card
        - name: Givex
          type: givex
        - name: Globe GCash
          type: globegcash
        - name: Goldsmiths Card
          type: goldsmithscard
        - name: GoPay Wallet
          type: gopay_wallet
        - name: OVO
          type: grabpay_ID
        - name: GrabPay
          type: grabpay_PH
        - name: GrabPay
          type: grabpay_SG
        - name: Hallmark Card
          type: hallmarkcard
        - name: HDFC
          type: hdfc
        - name: Hunkemoller Member Card
          type: hmclub
        - name: Hunkemoller Lingerie Card
          type: hmlingerie
        - name: iDEAL
          type: ideal
        - name: igive
          type: igive
        - name: Korean Account Transfer (IniPay)
          type: inicisIniPay_accounttransfer
        - name: Korean Credit Cards (IniPay)
          type: inicisIniPay_creditcard
        - name: Korean Mobile Phone (IniPay)
          type: inicisIniPay_mobilephone
        - name: Korean Virtual Account (IniPay)
          type: inicisIniPay_virtualaccount
        - name: Korean Account Transfer (Mobile)
          type: inicisMobile_accounttransfer
        - name: Korean Credit Cards (Mobile)
          type: inicisMobile_creditcard
        - name: Korean Mobile Phone (Mobile)
          type: inicisMobile_mobilephone
        - name: Korean Virtual Account (Mobile)
          type: inicisMobile_virtualaccount
        - name: Korean Credit Cards
          type: inicis_creditcard
        - name: Interac Online
          type: interac
        - name: Instant EFT
          type: ipay
        - name: iPay88
          type: ipay88
        - name: isracard
          type: isracard
        - name: Phone Payment
          type: ivr
        - name: Landline phone
          type: ivrLandline
        - name: Mobile phone
          type: ivrMobile
        - name: Kado Wereld
          type: kadowereld
        - name: KakaoPay
          type: kakaopay
        - name: Karen Millen Card
          type: karenmillen
        - name: Karen Millen GiftCard
          type: karenmillengiftcard
        - name: Bank Transfer
          type: kcp_banktransfer
        - name: Koreaissued cards
          type: kcp_creditcard
        - name: PayCo
          type: kcp_payco
        - name: Naver Pay
          type: kcp_naverpay
        - name: Virtual Account via KCP
          type: kcp_va
        - name: Pay later with Klarna.
          type: klarna
        - name: Pay over time with Klarna.
          type: klarna_account
        - name: Buy Now, Pay Later with Billie
          type: klarna_b2b
        - name: Pay now with Klarna.
          type: klarna_paynow
        - name: Leisure Card
          type: leisurecard
        - name: China Credit Card
          type: lianlianpay_creditcard
        - name: China Debit Card
          type: lianlianpay_debitcard
        - name: China Online Banking - Credit Card
          type: lianlianpay_ebanking_credit
        - name: China Online Banking - Debit Card
          type: lianlianpay_ebanking_debit
        - name: China Online Banking - Enterprise
          type: lianlianpay_ebanking_enterprise
        - name: Loods5 Cadeaukaart
          type: loods5giftcard
        - name: Loods5 Tegoedbon
          type: loods5prepaidcard
        - name: Love2Shop GiftCard
          type: love2shop
        - name: mada
          type: mada
        - name: Mappin & Webb Card
          type: mappinwebbcard
        - name: MB WAY
          type: mbway
        - name: Amazon Pay
          type: amazonpay
        - name: Mercado Pago
          type: mercadopago
        - name: MobilePay
          type: mobilepay
        - name: AliPay via Razer Merchant Services
          type: molpay_alipay
        - name: 7-Eleven
          type: molpay_cash
        - name: CIMB Virtual Account
          type: molpay_cimb_va
        - name: Malaysia E-Banking via Razer Merchant Services
          type: molpay_ebanking_MY
        - name: Vietnam E-Banking
          type: molpay_ebanking_VN
        - name: Malaysia E-Banking
          type: molpay_ebanking_fpx_MY
        - name: eNETS Debit
          type: molpay_enetsd
        - name: epay
          type: molpay_epay
        - name: Esapay
          type: molpay_esapay
        - name: MyClear FPX
          type: molpay_fpx
        - name: Maybank2u
          type: molpay_maybank2u
        - name: Nganluong
          type: molpay_nganluong
        - name: Convenience Stores Thailand
          type: molpay_paysbuy
        - name: MOLPoints
          type: molpay_points
        - name: RHB Now
          type: molpay_rhb
        - name: SAM by SingPost
          type: molpay_singpost
        - name: MOLWallet
          type: molpay_wallet
        - name: MoMo ATM
          type: momo_atm
        - name: Momo Wallet
          type: momo_wallet
        - name: Moneybookers
          type: moneybookers
        - name: Multibanco
          type: multibanco
        - name: De Nationale Musicalcard
          type: musicalcard
        - name: Nationale Bioscoopbon
          type: nationalebioscoopbon
        - name: Nationale Tuinbon
          type: nationaletuinbon
        - name: Nationale Verwen Cadeaubon
          type: nationaleverwencadeaubon
        - name: BankAxess
          type: netaxept_bankaxess
        - name: NETELLER
          type: neteller
        - name: Onebip
          type: onebip
        - name: One Two Three
          type: onetwothree
        - name: Online Banking PL
          type: onlineBanking_PL
        - name: Online banking
          type: openbanking_UK
        - name: Oxxo
          type: oxxo
        - name: Pathe Giftcard
          type: pathegiftcard
        - name: PayBright
          type: paybright
        - name: Maya Wallet
          type: paymaya_wallet
        - name: PayPal
          type: paypal
        - name: Paysafecard
          type: paysafecard
        - name: Payshop
          type: payshop
        - name: PayD AMT via Paythru
          type: paythru_amt
        - name: EFT via Paythru
          type: paythru_eft
        - name: PayTM
          type: paytm
        - name: PayU UPI
          type: payu_IN_upi
        - name: EFT Pro via PayU
          type: payu_ZA_eftpro
        - name: Google Pay
          type: paywithgoogle
        - name: pix
          type: pix
        - name: Plastix
          type: plastix
        - name: Pluim
          type: pluimgiftcard
        - name: Podium Card
          type: podiumcard
        - name: POLi
          type: poli
        - name: PPS
          type: pps
        - name: Primera Cadeaukaart
          type: primeracadeaucard
        - name: Illicado Gift Card
          type: prosodie_illicado
        - name: PSE
          type: pse
        - name: Qiwi Wallet
          type: qiwiwallet
        - name: RatePay Invoice
          type: ratepay
        - name: RatePay Direct Debit
          type: ratepay_directdebit
        - name: Rituals Giftcard
          type: rituals
        - name: Rob Peetoom Giftcard
          type: robpeetoomgiftcard
        - name: SafetyPay
          type: safetypay
        - name: SafetyPay Cash
          type: safetypay_cash
        - name: Shoes&Accessories Cadeau
          type: sagiftcard
        - name: Score Giftcard
          type: scoregiftcard
        - name: SEB Direktbetalning
          type: sebdirectpayment
        - name: SEPA Direct Debit
          type: sepadirectdebit
        - name: 7-Eleven
          type: seveneleven
        - name: Premium SMS
          type: sms
        - name: SVS
          type: svs
        - name: Swish
          type: swish
        - name: TCS Test GiftCard
          type: tcstestgiftcard
        - name: TenPay
          type: tenpay
        - name: The Sting Giftcard
          type: thestinggiftcard
        - name: TrueMoney
          type: truemoney
        - name: Trustly
          type: trustly
        - name: Online Banking by Trustpay
          type: trustpay
        - name: TWINT
          type: twint
        - name: Ukash
          type: ukash
        - name: UnionPay
          type: unionpay
        - name: UPI Collect
          type: upi_collect
        - name: Valuelink
          type: valuelink
        - name: V&D Cadeaukaart
          type: vdcadeaucard
        - name: Vipps
          type: vipps
        - name: Visa Checkout
          type: visacheckout
        - name: VVV Cadeaubon
          type: vvvcadeaubon
        - name: VVV Giftcard
          type: vvvgiftcard
        - name: Webshop Giftcard
          type: webshopgiftcard
        - name: WeChat Pay
          type: wechatpayMiniProgram
        - name: WeChat Pay
          type: wechatpayQR
        - name: WeChat Pay
          type: wechatpayWeb
        - name: WE Fashion Giftcard
          type: wefashiongiftcard
        - name: Western Union
          type: westernunion
        - name: Winkel Cheque
          type: winkelcheque
        - name: WOS Card
          type: woscard
        - name: Alfa-Click
          type: yandex_alfaclick
        - name: Pay using bank card
          type: yandex_bank_card
        - name: Cash terminals
          type: yandex_cash
        - name: Pay using installments
          type: yandex_installments
        - name: YooMoney
          type: yandex_money
        - name: Promsvyazbank
          type: yandex_promsvyazbank
        - name: SberPay
          type: yandex_sberbank
        - name: WebMoney
          type: yandex_webmoney
        - name: Your Gift
          type: yourgift
        - name: Zip
          type: zip
    post-paymentSession-ios:
      summary: Set up a payment session (iOS)
      value:
        amount:
          currency: EUR
          value: 17408
        reference: Your order number
        shopperReference: YOUR_SHOPPER_REFERENCE
        channel: iOS
        token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK
        returnUrl: app://
        countryCode: NL
        shopperLocale: nl_NL
        sessionValidity: '2017-04-06T13:09:13Z'
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    get-storedPaymentMethods-success-200:
      summary: List of stored payment methods for specified shopper
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        shopperReference: YOUR_SHOPPER_REFERENCE
        storedPaymentMethods:
        - brand: visa
          expiryMonth: '10'
          expiryYear: '30'
          holderName: John Smith
          id: '7219687191761347'
          issuerName: ISSUER_NAME
          lastFour: '1111'
          name: VISA
          shopperEmail: john.smith@example.com
          shopperReference: YOUR_SHOPPER_REFERENCE
          supportedRecurringProcessingModels:
          - CardOnFile
          - Subscription
          - UnscheduledCardOnFile
          type: scheme
    post-paymentSession-enableOneClick:
      summary: Set up a payment session with the option to store card details
      value:
        amount:
          currency: EUR
          value: 17408
        reference: Your order number
        shopperReference: YOUR_SHOPPER_REFERENCE
        enableOneClick: true
        enableRecurring: true
        channel: Web
        origin: https://www.yourwebsite.com
        returnUrl: https://www.yourshop.com/checkout/result
        countryCode: NL
        shopperLocale: nl_NL
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        sdkVersion: 1.7.0
    post-paymentSession-split:
      summary: Split a payment between a sub-merchant and a platform account
      value:
        amount:
          currency: EUR
          value: 6200
        additionalData:
          split.api: '1'
          split.nrOfItems: '2'
          split.totalAmount: '6200'
          split.currencyCode: EUR
          split.item1.amount: '6000'
          split.item1.type: MarketPlace
          split.item1.account: '151272963'
          split.item1.reference: '6124145'
          split.item1.description: 'Porcelain Doll: Eliza (20cm)'
          split.item2.amount: '200'
          split.item2.type: Commission
          split.item2.reference: '6124146'
        reference: Your order number
        shopperReference: YOUR_SHOPPER_REFERENCE
        channel: Android
        token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK
        returnUrl: app://
        countryCode: NL
        shopperLocale: nl_NL
        sessionValidity: '2017-04-06T13:09:13Z'
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentLinks-basic:
      summary: Create a payment link
      value:
        reference: YOUR_ORDER_NUMBER
        amount:
          value: 1250
          currency: BRL
        countryCode: BR
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        shopperReference: YOUR_SHOPPER_REFERENCE
        shopperEmail: test@email.com
        shopperLocale: pt-BR
        billingAddress:
          street: Roque Petroni Jr
          postalCode: '59000060'
          city: So Paulo
          houseNumberOrName: '999'
          country: BR
          stateOrProvince: SP
        deliveryAddress:
          street: Roque Petroni Jr
          postalCode: '59000060'
          city: So Paulo
          houseNumberOrName: '999'
          country: BR
          stateOrProvince: SP
    post-paymentMethods-filtered-200:
      summary: Example response for request 'filtered'
      value:
        paymentMethods:
        - name: iDEAL
          type: ideal
        - name: Hitelkrtya
          type: scheme
        - name: PayPal
          type: paypal
        - name: AfterPay Invoice
          type: afterpay_default
        - name: Pay later with Klarna.
          type: klarna
        - name: SEPA Direct Debit
          type: sepadirectdebit
        - name: Paysafecard
          type: paysafecard
        - name: Bijenkorf Cadeaucard
          type: bijcadeaucard
        - name: Fonq Giftcard
          type: fonqgiftcard
        - name: Bank Transfer (NL)
          type: bankTransfer_NL
        - name: Pathe Giftcard
          type: pathegiftcard
        - name: VVV Giftcard
          type: vvvgiftcard
        - name: Podium Card
          type: podiumcard
        - name: RatePay Direct Debit
          type: ratepay_directdebit
        - name: Rituals Giftcard
          type: rituals
        - name: Hunkemoller Lingerie Card
          type: hmlingerie
        - name: Primera Cadeaukaart
          type: primeracadeaucard
        - name: Fashioncheque
          type: fashioncheque
        - name: NETELLER
          type: neteller
        - name: Adyen Voucher
          type: adyen_test_voucher
        - name: AfterPay B2B
          type: afterpay_b2b
        - name: AfterPay DirectDebit
          type: afterpay_directdebit
        - name: AliPay
          type: alipay
        - name: AliPay
          type: alipay_wap
        - name: Android Pay
          type: androidpay
        - name: Apple Pay
          type: applepay
        - name: Baby Gift Card
          type: babygiftcard
        - name: SEPA Bank Transfer
          type: bankTransfer_IBAN
        - name: Bloemen Giftcard
          type: bloemengiftcard
        - name: Boekenbon Giftcard
          type: boekenbon
        - name: Cash-Ticket
          type: cashticket
        - name: Chasin Giftcard
          type: chasingiftcard
        - name: ClickandBuy
          type: clickandbuy
        - name: Costes Giftcard
          type: costesgiftcard
        - name: custom_settlement
          type: custom_settlement
        - name: eft_directdebit_CA
          type: eft_directdebit_CA
        - name: Nationale Entertainment Card
          type: entertainmentcard
        - name: Expert Cadeaukaart
          type: expertgiftcard
        - name: FijnCadeau
          type: fijncadeau
        - name: Fleurop Bloemenbon
          type: fleuropbloemenbon
        - name: Gall & Gall
          type: gallgall
        - name: Generic GiftCard
          type: genericgiftcard
        - name: GiftFor2
          type: giftfor2card
        - name: Givex
          type: givex
        - name: Goldsmiths Card
          type: goldsmithscard
        - name: Hunkemoller Member Card
          type: hmclub
        - name: Phone Payment
          type: ivr
        - name: Landline phone
          type: ivrLandline
        - name: Mobile phone
          type: ivrMobile
        - name: Kado Wereld
          type: kadowereld
        - name: Karen Millen GiftCard
          type: karenmillengiftcard
        - name: Leisure Card
          type: leisurecard
        - name: Loods5 Cadeaukaart
          type: loods5giftcard
        - name: Loods5 Tegoedbon
          type: loods5prepaidcard
        - name: Amazon Pay
          type: amazonpay
        - name: MOLPoints
          type: molpay_points
        - name: Moneybookers
          type: moneybookers
        - name: De Nationale Musicalcard
          type: musicalcard
        - name: Nationale Bioscoopbon
          type: nationalebioscoopbon
        - name: Nationale Tuinbon
          type: nationaletuinbon
        - name: Nationale Verwen Cadeaubon
          type: nationaleverwencadeaubon
        - name: Onebip
          type: onebip
        - name: Google Pay
          type: paywithgoogle
        - name: Plastix
          type: plastix
        - name: Pluim
          type: pluimgiftcard
        - name: Illicado Gift Card
          type: prosodie_illicado
        - name: RatePay Invoice
          type: ratepay
        - name: Rob Peetoom Giftcard
          type: robpeetoomgiftcard
        - name: Shoes&Accessories Cadeau
          type: sagiftcard
        - name: Score Giftcard
          type: scoregiftcard
        - name: Premium SMS
          type: sms
        - name: SVS
          type: svs
        - name: TCS Test GiftCard
          type: tcstestgiftcard
        - name: The Sting Giftcard
          type: thestinggiftcard
        - name: Ukash
          type: ukash
        - name: UnionPay
          type: unionpay
        - name: Valuelink
          type: valuelink
        - name: V&D Cadeaukaart
          type: vdcadeaucard
        - name: Visa Checkout
          type: visacheckout
        - name: VVV Cadeaubon
          type: vvvcadeaubon
        - name: Webshop Giftcard
          type: webshopgiftcard
        - name: WE Fashion Giftcard
          type: wefashiongiftcard
        - name: Western Union
          type: westernunion
        - name: Winkel Cheque
          type: winkelcheque
        - name: Your Gift
          type: yourgift
    post-paymentMethods-balance-not-enough-200:
      summary: Gift card balance lower than amount specified in request
      value:
        pspReference: FKSPNCQ8HXSKGK82
        resultCode: NotEnoughBalance
        balance:
          currency: EUR
          value: 5000
    post-payments-result-basic-200:
      summary: Payment authorised
      value:
        pspReference: V4HZ4RBFJGXXGN82
        merchantReference: Your order number
        shopperLocale: nl_NL
        paymentMethod: ideal
    post-payments-paymentPspReference-captures-capture:
      summary: Capture an authorised payment
      description: Example capture request
      value:
        reference: YOUR_UNIQUE_REFERENCE
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        amount:
          value: 2000
          currency: EUR
        platformChargebackLogic:
          behavior: deductFromOneBalanceAccount
          targetAccount: BA00000000000000000000001
          costAllocationAccount: BA00000000000000000000001
    post-payments-paymentPspReference-refunds-refund-201:
      summary: Refund requested
      description: Example response when a refund was requested
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        paymentPspReference: 993617894903480A
        reference: YOUR_UNIQUE_REFERENCE
        pspReference: 993617894906488A
        status: received
        amount:
          currency: EUR
          value: 2500
    post-payments-details-3d-secure-2-native:
      summary: Submit 3D Secure 2 authentication result
      value:
        details:
          threeDSResult: eyJ0cmFuc1N0YXR1cyI6IlkifQ==
    patch-paymentLinks-linkId-basic:
      summary: Update the status of a payment link
      value:
        status: expired
    post-payments-split-balanceplatform-200:
      summary: Payment split between balance accounts
      value:
        additionalData:
          refusalReasonRaw: AUTHORISED
          eci: N/A
          acquirerAccountCode: YOUR_ACQUIRER_ACCOUNT
          xid: N/A
          threeDAuthenticated: 'false'
          paymentMethodVariant: visa
          issuerBin: '41111111'
          payoutEligible: Y
          fraudManualReview: 'false'
          threeDOffered: 'false'
          threeDOfferedResponse: N/A
          authorisationMid: '50'
          fundsAvailability: I
          authorisedAmountCurrency: USD
          threeDAuthenticatedResponse: N/A
          avsResultRaw: '5'
          retry.attempt1.rawResponse: AUTHORISED
          paymentMethod: visa
          avsResult: 5 No AVS data provided
          cardSummary: '1111'
          retry.attempt1.avsResultRaw: '5'
          networkTxReference: '777718270854480'
          expiryDate: 3/2030
          cavvAlgorithm: N/A
          cardBin: '411111'
          alias: '8915844059375211'
          cvcResultRaw: M
          merchantReference: YOUR_ORDER_NUMBER
          acquirerReference: YOUR_ACQUIRER_REFERENCE
          cardIssuingCountry: NL
          liabilityShift: 'false'
          fraudResultType: GREEN
          authCode: '035450'
          cardHolderName: John Smith
          isCardCommercial: unknown
          PaymentAccountReference: 6006491286999921374...
          retry.attempt1.acquirerAccount: YOUR_ACQUIRER_ACCOUNT
          cardIssuingBank: ISSUING_BANK_CUSTOMER
          retry.attempt1.acquirer: YOUR_ACQUIRER_CODE
          authorisedAmountValue: '40000'
          issuerCountry: NL
          cvcResult: 1 Matches
          retry.attempt1.responseCode: Approved
          aliasType: Default
          retry.attempt1.shopperInteraction: Ecommerce
          cardPaymentMethod: visa
          acquirerCode: YOUR_ACQUIRER_CODE
        pspReference: PPKFQ89R6QRXGN82
        resultCode: Authorised
        amount:
          currency: USD
          value: 40000
        donationToken: 81234567890123456...
        merchantReference: YOUR_ORDER_NUMBER
        paymentMethod:
          brand: visa
          type: scheme
    post-payments-enableOneClick-SF:
      summary: Tokenize card details for one-off payments
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          encryptedCardNumber: test_4111111111111111
          encryptedExpiryMonth: test_03
          encryptedExpiryYear: test_2030
          encryptedSecurityCode: test_737
        shopperReference: YOUR_SHOPPER_REFERENCE
        storePaymentMethod: true
        shopperInteraction: Ecommerce
        recurringProcessingModel: CardOnFile
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-paymentSession-web:
      summary: Set up a payment session (Web)
      value:
        amount:
          currency: EUR
          value: 17408
        reference: Your order number
        shopperReference: YOUR_SHOPPER_REFERENCE
        channel: Web
        origin: https://www.yourwebsite.com
        returnUrl: https://www.yourshop.com/checkout/result
        countryCode: NL
        shopperLocale: nl_NL
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        sdkVersion: 1.9.5
    post-payments-paymentPspReference-cancels-cancel-with-psp-reference:
      summary: Cancel payment using a PSP reference
      description: Example cancel request with a PSP reference
      value:
        reference: YOUR_UNIQUE_REFERENCE
        merchantAccount: YOUR_MERCHANT_ACCOUNT
    post-payments-paymentPspReference-amountUpdates-amount-update:
      summary: Update the amount of an authorised payment
      description: Example request to update the amount of a payment
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        amount:
          currency: EUR
          value: 2500
        reference: YOUR_UNIQUE_REFERENCE
    generic-422_2:
      summary: Response code - 422 Unprocessable Entity.
      value:
        type: https://docs.adyen.com/errors/general/invalid-field-value
        title: Invalid Payment Instrument information provided
        status: 422
        detail: The balanceAccountId can only be changed when the status is Inactive or Requested
        requestId: 1W1UI15PLVGC9V8O
        errorCode: '30_031'
    post-payments-paymentPspReference-captures-capture-201:
      summary: Capture requested
      description: Example response when a capture was requested
      value:
        merchantAccount: YOUR_MERCHANT_ACCOUNT
        paymentPspReference: 993617894903480A
        reference: YOUR_UNIQUE_REFERENCE
        pspReference: 993617894906488A
        status: received
        amount:
          value: 2000
          currency: EUR
        platformChargebackLogic:
          behavior: deductFromOneBalanceAccount
          targetAccount: BA00000000000000000000001
          costAllocationAccount: BA00000000000000000000001
    post-payments-subscription-first-transaction:
      summary: Tokenize card details for a subscription
      value:
        amount:
          currency: USD
          value: 1000
        reference: Your order number
        paymentMethod:
          type: scheme
          encryptedCardNumber: test_4111111111111111
          encryptedExpiryMonth: test_03
          encryptedExpiryYear: test_2030
          encryptedSecurityCode: test_737
        shopperReference: YOUR_SHOPPER_REFERENCE
        storePaymentMethod: true
        shopperInteraction: Ecommerce
        recurringProcessingModel: Subscription
        returnUrl: https://your-company.com/...
        merchantAccount: YOUR_MERCHANT_ACCOUNT
  parameters:
    Idempotency-Key:
      description: A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
      example: 37ca9c97-d1d1-4c62-89e8-706891a563ed
      name: Idempotency-Key
      in: header
      schema:
        type: string
  headers:
    Idempotency-Key:
      description: The idempotency key used for processing the request. Present if the key was provided in the request.
      schema:
        type: string
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-Key
      type: apiKey
    BasicAuth:
      scheme: basic
      type: http
x-groups:
- Account holders
- Accounts
- Verification