openapi: 3.1.0 info: title: Adyen Checkout API description: "Adyen Checkout API provides a simple and flexible way to initiate\ \ and authorise online payments. You can use the same integration for payments\ \ made with cards (including 3D Secure), mobile wallets, and local payment methods\ \ (for example, iDEAL and Sofort).\n\nThis API reference provides information\ \ on available endpoints and how to interact with them. To learn more about the\ \ API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\ \n## Authentication\nEach request to Checkout API must be signed with an API key.\ \ For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key)\ \ from your Customer Area, and set this key to the `X-API-Key` header value, for\ \ example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key:\ \ YOUR_API_KEY\" \\\n...\n```\n## Versioning\nCheckout 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://checkout-test.adyen.com/v71/payments\n\ ```\n\n## Server-side API libraries\nWe provide open-source [server-side API libraries](https://docs.adyen.com/development-resources/libraries/)\ \ in several languages: \n- PHP\n- Java\n- Node.js\n- .NET\n- Go\n- Python\n-\ \ Ruby\n- Apex (beta)\n\nSee our [integration examples](https://github.com/adyen-examples#%EF%B8%8F-official-integration-examples)\ \ for example uses of the libraries.\n\n## Developer resources\nCheckout API is\ \ available through a Postman collection. Click the button below to create a fork,\ \ then set the environment variables at **Environments** > **Adyen APIs**.\ \ \n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25716737-46ad970e-dc9e-4246-bac2-769c6083e7b5?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D25716737-46ad970e-dc9e-4246-bac2-769c6083e7b5%26entityType%3Dcollection%26workspaceId%3Da8d63f9f-cfc7-4810-90c5-9e0c60030d3e#?env%5BAdyen%20APIs%5D=W3sia2V5IjoiWC1BUEktS2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0In0seyJrZXkiOiJZT1VSX01FUkNIQU5UX0FDQ09VTlQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0In0seyJrZXkiOiJZT1VSX0NPTVBBTllfQUNDT1VOVCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifSx7ImtleSI6IllPVVJfQkFMQU5DRV9QTEFURk9STSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifV0=)\n\ \n\n## Going live\n\nTo access the live endpoints, you need an API key from your\ \ live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique\ \ to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/checkout/v71/payments\n\ ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ \ **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout\ \ API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist)\ \ to make sure you've got all the required configuration in place.\n\n## Release\ \ notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=71)\ \ to find out what changed in this version!" termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi version: '71' x-publicVersion: true servers: - url: https://checkout-test.adyen.com/v71 tags: - name: Payments - name: Donations - name: Payment links - name: Modifications - name: Recurring - name: Orders - name: Utility paths: /applePay/sessions: post: tags: - Utility summary: Get an Apple Pay session description: 'You need to use this endpoint if you have an API-only integration with Apple Pay which uses Adyen''s Apple Pay certificate. The endpoint returns the Apple Pay session data which you need to complete the [Apple Pay session validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation).' operationId: post-applePay-sessions parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplePaySessionRequest' examples: basic: $ref: '#/components/examples/post-applePay-sessions-basic' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ApplePaySessionResponse' examples: basic: $ref: '#/components/examples/post-applePay-sessions-basic-200' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 2 x-methodName: getApplePaySession /cancels: post: tags: - Modifications summary: 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 [**TECHNICAL_CANCEL** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook). If you want to cancel a payment using the [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference), use the [`/payments/{paymentPspReference}/cancels`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/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-cancels parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/StandalonePaymentCancelRequest' examples: cancel-with-own-reference: $ref: '#/components/examples/post-cancels-cancel-with-own-reference' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/StandalonePaymentCancelResponse' examples: cancel-with-own-reference: $ref: '#/components/examples/post-cancels-cancel-with-own-reference-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 3 x-methodName: cancelAuthorisedPayment /cardDetails: post: tags: - Payments summary: Get the brands and other details of a card description: "Use this endpoint to get information about the card or network\ \ token that enables you to decide on the routing of the transaction and the\ \ eligibility of the card for the type of transaction.\n\nIf you include [your\ \ supported brands](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/cardDetails__reqParam_supportedBrands)\ \ in the request, the response also tells you if you support each [brand that\ \ was identified on the card](https://docs.adyen.com/api-explorer/Checkout/latest/post/cardDetails#responses-200-brands).\n\ \nIf you have an API-only integration and collect card data, use this endpoint\ \ to find out if the shopper's card is co-bad. For co-badged cards, you must\ \ let the shopper choose the brand to pay with if you support both brands.\n\ \n## Server-side API libraries\nWe provide open-source [server-side API libraries](https://docs.adyen.com/development-resources/libraries/)\ \ in several languages: \n- PHP\n- Java\n- Node.js\n- .NET\n- Go\n- Python\n\ - Ruby\n- Apex (beta)\n\nSee our [integration examples](https://github.com/adyen-examples#%EF%B8%8F-official-integration-examples)\ \ for example uses of the libraries.\n\n## Developer resources\nBIN Lookup\ \ API is available through a Postman collection. Click the button below to\ \ create a fork, then set the environment variables at **Environments** > **Adyen APIs**.\ \ \n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25716737-677c7679-a695-4ebb-91da-68b4e7c9228a?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D25716737-677c7679-a695-4ebb-91da-68b4e7c9228a%26entityType%3Dcollection%26workspaceId%3Da8d63f9f-cfc7-4810-90c5-9e0c60030d3e#?env%5BAdyen%20APIs%5D=W3sia2V5IjoiWC1BUEktS2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoic2VjcmV0In0seyJrZXkiOiJZT1VSX01FUkNIQU5UX0FDQ09VTlQiLCJ2YWx1ZSI6IiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0In0seyJrZXkiOiJZT1VSX0NPTVBBTllfQUNDT1VOVCIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifSx7ImtleSI6IllPVVJfQkFMQU5DRV9QTEFURk9STSIsInZhbHVlIjoiIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifV0=)\n\ \n\n" operationId: post-cardDetails parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/CardDetailsRequest' examples: basic: $ref: '#/components/examples/post-cardDetails-basic' supported-brands: $ref: '#/components/examples/post-cardDetails-supported-brands' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/CardDetailsResponse' examples: basic: $ref: '#/components/examples/post-cardDetails-basic-200' supported-brands: $ref: '#/components/examples/post-cardDetails-supported-brands-200' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 6 x-methodName: cardDetails /donationCampaigns: post: tags: - Donations summary: Get a list of donation campaigns. description: Queries the available donation campaigns for a donation based on the donation context (like merchant account, currency, and locale). The response contains active donation campaigns. operationId: post-donationCampaigns parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/DonationCampaignsRequest' examples: donation-campaigns: $ref: '#/components/examples/post-donationCampaigns-donation-campaigns' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/DonationCampaignsResponse' examples: donation-campaigns: $ref: '#/components/examples/post-donationCampaigns-donation-campaigns-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-addedInVersion: '67' x-sortIndex: 1 x-methodName: donationCampaigns /donations: post: tags: - Donations summary: Make a donation description: 'Takes in the donation token generated by the `/payments` request and uses it to make the donation. For more information, see [Donations](https://docs.adyen.com/online-payments/donations).' operationId: post-donations parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/DonationPaymentRequest' examples: donations-campaigns: $ref: '#/components/examples/post-donations-donations-campaigns' donations-classic: $ref: '#/components/examples/post-donations-donations-classic' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/DonationPaymentResponse' examples: donations-campaigns: $ref: '#/components/examples/post-donations-donations-campaigns-200' donations-classic: $ref: '#/components/examples/post-donations-donations-classic-200' donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: donations-with-token: $ref: '#/components/examples/post-donations-donations-with-token-422' generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 2 x-methodName: donations /forward: post: tags: - Recurring summary: Forward stored payment details description: Forwards the payment details you stored with Adyen to a third-party that you specify and returns the response from the third-party. Supports forwarding stored card details or [network tokens](https://docs.adyen.com/online-payments/network-tokenization). For more information, see [Forward stored payment details](https://docs.adyen.com/online-payments/tokenization/forward-payment-details). operationId: post-forward parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/CheckoutForwardRequest' examples: forward-card: $ref: '#/components/examples/post-forward-forward-card' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/CheckoutForwardResponse' examples: forward-card: $ref: '#/components/examples/post-forward-forward-card-200' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 1 x-methodName: forward /orders: post: tags: - Orders summary: Create an order description: Creates an order to be used for partial payments. Make a POST `/orders` call before making a `/payments` call when processing payments with different payment methods. operationId: post-orders parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOrderRequest' examples: basic: $ref: '#/components/examples/post-orders-basic' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/CreateOrderResponse' examples: basic: $ref: '#/components/examples/post-orders-basic-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 2 x-methodName: orders /orders/cancel: post: tags: - Orders summary: Cancel an order description: Cancels an order. Cancellation of an order results in an automatic rollback of all payments made in the order, either by canceling or refunding the payment, depending on the type of payment method. operationId: post-orders-cancel parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelOrderRequest' examples: basic: $ref: '#/components/examples/post-orders-cancel-basic' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/CancelOrderResponse' examples: basic: $ref: '#/components/examples/post-orders-cancel-basic-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 3 x-methodName: cancelOrder /originKeys: post: tags: - Utility summary: Create originKey values for domains description: "This operation takes the origin domains and returns a JSON object\ \ containing the corresponding origin keys for the domains. \n> If you're\ \ still using origin key for your Web Drop-in or Components integration, we\ \ recommend [switching to client key](https://docs.adyen.com/development-resources/client-side-authentication/migrate-from-origin-key-to-client-key).\ \ This allows you to use a single key for all origins, add or remove origins\ \ without generating a new key, and detect the card type from the number entered\ \ in your payment form. " operationId: post-originKeys parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/UtilityRequest' examples: basic: $ref: '#/components/examples/post-originKeys-basic' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/UtilityResponse' examples: basic: $ref: '#/components/examples/post-originKeys-basic-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' deprecated: true security: - BasicAuth: [] - ApiKeyAuth: [] x-deprecatedInVersion: '67' x-sortIndex: 1 x-methodName: originKeys /paymentLinks: post: tags: - Payment links summary: Create a payment link description: 'Creates a payment link to a [Pay by Link](https://docs.adyen.com/unified-commerce/pay-by-link/) page where the shopper 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 parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentLinkRequest' examples: basic: $ref: '#/components/examples/post-paymentLinks-basic' responses: '201': description: Created - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResponse' examples: basic: $ref: '#/components/examples/post-paymentLinks-basic-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 1 x-methodName: paymentLinks /paymentLinks/{linkId}: get: tags: - Payment links summary: Get a payment link description: Retrieves the payment link details using the payment link `id`. operationId: get-paymentLinks-linkId parameters: - name: linkId in: path description: Unique identifier of the payment link. required: true style: simple explode: false schema: type: string responses: '200': description: OK - the request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResponse' examples: basic: $ref: '#/components/examples/get-paymentLinks-linkId-basic-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 2 x-methodName: getPaymentLink patch: tags: - Payment links summary: 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 parameters: - name: linkId in: path description: Unique identifier of the payment link. required: true style: simple explode: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePaymentLinkRequest' examples: basic: $ref: '#/components/examples/patch-paymentLinks-linkId-basic' responses: '200': description: OK - the request has succeeded. content: application/json: schema: $ref: '#/components/schemas/PaymentLinkResponse' examples: basic: $ref: '#/components/examples/patch-paymentLinks-linkId-basic-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 3 x-methodName: updatePaymentLink /paymentMethods: post: tags: - Payments summary: Get a list of available payment methods description: Retrieves the list of available payment methods for the transaction, based on the transaction information like amount, country, and currency. operationId: post-paymentMethods parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentMethodsRequest' examples: basic: $ref: '#/components/examples/post-paymentMethods-basic' filtered: $ref: '#/components/examples/post-paymentMethods-filtered' include-stored: $ref: '#/components/examples/post-paymentMethods-include-stored' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/PaymentMethodsResponse' 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' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 2 x-methodName: paymentMethods /paymentMethods/balance: post: tags: - Orders summary: 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 parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/BalanceCheckRequest' examples: basic: $ref: '#/components/examples/post-paymentMethods-balance-basic' not-enough: $ref: '#/components/examples/post-paymentMethods-balance-not-enough' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/BalanceCheckResponse' examples: basic: $ref: '#/components/examples/post-paymentMethods-balance-basic-200' not-enough: $ref: '#/components/examples/post-paymentMethods-balance-not-enough-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 1 x-methodName: getBalanceOfGiftCard /payments: post: tags: - Payments summary: 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 parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRequest' 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-redirect: $ref: '#/components/examples/post-payments-card-3d-secure-redirect' 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' on-demand-top-up-from-transfer-instrument: $ref: '#/components/examples/post-payments-on-demand-top-up-from-transfer-instrument' on-demand-top-up-visa: $ref: '#/components/examples/post-payments-on-demand-top-up-visa' oneclick-securedfields: $ref: '#/components/examples/post-payments-oneclick-securedfields' 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' subscription-payment: $ref: '#/components/examples/post-payments-subscription-payment' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/PaymentResponse' examples: card-3d-secure-2-web: $ref: '#/components/examples/post-payments-card-3d-secure-2-web-200' card-3d-secure-redirect: $ref: '#/components/examples/post-payments-card-3d-secure-redirect-200' 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' on-demand-top-up-from-transfer-instrument: $ref: '#/components/examples/post-payments-on-demand-top-up-from-transfer-instrument-200' on-demand-top-up-visa: $ref: '#/components/examples/post-payments-on-demand-top-up-visa-200' split-balanceplatform: $ref: '#/components/examples/post-payments-split-balanceplatform-200' subscription-first-transaction: $ref: '#/components/examples/post-payments-subscription-first-transaction-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 3 x-methodName: payments /payments/details: post: tags: - Payments summary: 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 parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentDetailsRequest' 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' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/PaymentDetailsResponse' examples: 00.redirect: $ref: '#/components/examples/post-payments-details-00.redirect-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 4 x-methodName: paymentsDetails /payments/{paymentPspReference}/amountUpdates: post: tags: - Modifications summary: 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/webhook-types/#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 parameters: - name: paymentPspReference in: path description: The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment. required: true style: simple explode: false schema: type: string - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentAmountUpdateRequest' examples: amount-update: $ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/PaymentAmountUpdateResponse' examples: amount-update: $ref: '#/components/examples/post-payments-paymentPspReference-amountUpdates-amount-update-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 6 x-methodName: updateAuthorisedAmount /payments/{paymentPspReference}/cancels: post: tags: - Modifications summary: 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/Checkout/latest/post/payments#responses-200-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 parameters: - name: paymentPspReference in: path description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to cancel. ' required: true style: simple explode: false schema: type: string - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentCancelRequest' examples: cancel-with-psp-reference: $ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/PaymentCancelResponse' examples: cancel-with-psp-reference: $ref: '#/components/examples/post-payments-paymentPspReference-cancels-cancel-with-psp-reference-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 2 x-methodName: cancelAuthorisedPaymentByPspReference /payments/{paymentPspReference}/captures: post: tags: - Modifications summary: 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 parameters: - name: paymentPspReference in: path description: The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to capture. required: true style: simple explode: false schema: type: string - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentCaptureRequest' examples: capture: $ref: '#/components/examples/post-payments-paymentPspReference-captures-capture' split-balanceplatform: $ref: '#/components/examples/post-payments-paymentPspReference-captures-split-balanceplatform' split-classic: $ref: '#/components/examples/post-payments-paymentPspReference-captures-split-classic' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/PaymentCaptureResponse' examples: capture: $ref: '#/components/examples/post-payments-paymentPspReference-captures-capture-201' split-balanceplatform: $ref: '#/components/examples/post-payments-paymentPspReference-captures-split-balanceplatform-201' split-classic: $ref: '#/components/examples/post-payments-paymentPspReference-captures-split-classic-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 1 x-methodName: captureAuthorisedPayment /payments/{paymentPspReference}/refunds: post: tags: - Modifications summary: 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 parameters: - name: paymentPspReference in: path description: The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to refund. required: true style: simple explode: false schema: type: string - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentRefundRequest' examples: refund: $ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/PaymentRefundResponse' examples: refund: $ref: '#/components/examples/post-payments-paymentPspReference-refunds-refund-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 4 x-methodName: refundCapturedPayment /payments/{paymentPspReference}/reversals: post: tags: - Modifications summary: 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/reversal/#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 parameters: - name: paymentPspReference in: path description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment that you want to reverse. ' required: true style: simple explode: false schema: type: string - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentReversalRequest' examples: reversal: $ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/PaymentReversalResponse' examples: reversal: $ref: '#/components/examples/post-payments-paymentPspReference-reversals-reversal-201' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 5 x-methodName: refundOrCancelPayment /paypal/updateOrder: post: tags: - Utility summary: Updates the order for PayPal Express Checkout description: Updates the order for PayPal Express Checkout. This can be used to update the PayPal lightbox with an updated amount and delivery methods based on the delivery address. operationId: post-paypal-updateOrder parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/PaypalUpdateOrderRequest' examples: advanced-with-delivery: $ref: '#/components/examples/post-paypal-updateOrder-advanced-with-delivery' advanced-without-delivery: $ref: '#/components/examples/post-paypal-updateOrder-advanced-without-delivery' sessions-with-delivery: $ref: '#/components/examples/post-paypal-updateOrder-sessions-with-delivery' sessions-without-delivery: $ref: '#/components/examples/post-paypal-updateOrder-sessions-without-delivery' responses: '200': description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/PaypalUpdateOrderResponse' examples: advanced-with-delivery: $ref: '#/components/examples/post-paypal-updateOrder-advanced-with-delivery-200' advanced-without-delivery: $ref: '#/components/examples/post-paypal-updateOrder-advanced-without-delivery-200' sessions-with-delivery: $ref: '#/components/examples/post-paypal-updateOrder-sessions-with-delivery-200' sessions-without-delivery: $ref: '#/components/examples/post-paypal-updateOrder-sessions-without-delivery-200' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-400' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-401' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-403' '422': description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-422' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/ServiceError' examples: generic: $ref: '#/components/examples/generic-500' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 3 x-methodName: updatesOrderForPaypalExpressCheckout /sessions: post: tags: - Payments summary: Create a payment session description: 'Creates a payment session for [Drop-in](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Drop-in), [Components](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Components), and [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/sessions-flow/?platform=Web&integration=Hosted+Checkout) integrations. The response contains encrypted payment session data. The front end then uses the session data to make any required server-side calls for the payment flow. You get the payment outcome asynchronously, in an [AUTHORISATION](https://docs.adyen.com/api-explorer/#/Webhooks/latest/post/AUTHORISATION) webhook.' operationId: post-sessions parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCheckoutSessionRequest' examples: 00.success: $ref: '#/components/examples/post-sessions-00.success' 01.klarna: $ref: '#/components/examples/post-sessions-01.klarna' enableOneClick: $ref: '#/components/examples/post-sessions-enableOneClick' split: $ref: '#/components/examples/post-sessions-split' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/CreateCheckoutSessionResponse' examples: 00.success: $ref: '#/components/examples/post-sessions-00.success-201' 01.klarna: $ref: '#/components/examples/post-sessions-01.klarna-201' enableOneClick: $ref: '#/components/examples/post-sessions-enableOneClick-201' split: $ref: '#/components/examples/post-sessions-split-201' security: - BasicAuth: [] - ApiKeyAuth: [] x-addedInVersion: '68' x-sortIndex: 1 x-methodName: sessions /sessions/{sessionId}: get: tags: - Payments summary: Get the result of a payment session description: Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path. operationId: get-sessions-sessionId parameters: - name: sessionId in: path description: A unique identifier of the session. required: true style: simple explode: false schema: type: string - name: sessionResult in: query description: The `sessionResult` value from the Drop-in or Component. required: true style: form explode: true schema: type: string responses: '200': description: OK - the request has succeeded. content: application/json: schema: $ref: '#/components/schemas/SessionResultResponse' examples: success: $ref: '#/components/examples/get-sessions-sessionId-success-200' security: - BasicAuth: [] - ApiKeyAuth: [] x-addedInVersion: '68' x-sortIndex: 2 x-methodName: getResultOfPaymentSession /storedPaymentMethods: get: tags: - Recurring summary: 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. ' operationId: get-storedPaymentMethods parameters: - name: shopperReference in: query 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.' required: false style: form explode: true schema: type: string - name: merchantAccount in: query description: Your merchant account. required: false style: form explode: true schema: type: string responses: '200': description: OK - the request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ListStoredPaymentMethodsResponse' examples: success: $ref: '#/components/examples/get-storedPaymentMethods-success-200' security: - BasicAuth: [] - ApiKeyAuth: [] x-addedInVersion: '70' x-sortIndex: 2 x-methodName: getTokensForStoredPaymentDetails post: tags: - Recurring summary: Create a token to store payment details description: Creates a token to store the shopper's payment details. This token can be used for the shopper's future payments. operationId: post-storedPaymentMethods parameters: - $ref: '#/components/parameters/Idempotency-Key' requestBody: content: application/json: schema: $ref: '#/components/schemas/StoredPaymentMethodRequest' examples: encrypted-card-details: $ref: '#/components/examples/post-storedPaymentMethods-encrypted-card-details' unencrypted-card-details: $ref: '#/components/examples/post-storedPaymentMethods-unencrypted-card-details' responses: '201': 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' content: application/json: schema: $ref: '#/components/schemas/StoredPaymentMethodResource' examples: encrypted-card-details: $ref: '#/components/examples/post-storedPaymentMethods-encrypted-card-details-201' unencrypted-card-details: $ref: '#/components/examples/post-storedPaymentMethods-unencrypted-card-details-201' security: - BasicAuth: [] - ApiKeyAuth: [] x-sortIndex: 1 x-methodName: storedPaymentMethods /storedPaymentMethods/{storedPaymentMethodId}: delete: tags: - Recurring summary: 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. operationId: delete-storedPaymentMethods-storedPaymentMethodId parameters: - name: storedPaymentMethodId in: path description: The unique identifier of the token. required: true style: simple explode: false schema: type: string - name: shopperReference in: query 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.' required: true style: form explode: true schema: type: string - name: merchantAccount in: query description: Your merchant account. required: true style: form explode: true schema: type: string responses: '204': description: 'No Content - look at the actual response code for the status of the request. ' security: - BasicAuth: [] - ApiKeyAuth: [] x-addedInVersion: '70' x-sortIndex: 4 x-methodName: deleteTokenForStoredPaymentDetails /validateShopperId: post: tags: - Utility summary: Validates shopper Id description: 'Validates the shopperId. ' operationId: post-validateShopperId requestBody: content: application/json: schema: $ref: '#/components/schemas/ValidateShopperIdRequest' required: true responses: '200': description: OK - the request has succeeded. content: application/json: schema: $ref: '#/components/schemas/ValidateShopperIdResponse' '400': description: Bad Request - a problem reading or understanding the request. content: application/json: schema: $ref: '#/components/schemas/CheckoutErrorResponseEntity' '401': description: Unauthorized - authentication required. content: application/json: schema: $ref: '#/components/schemas/CheckoutErrorResponseEntity' '403': description: Forbidden - insufficient permissions to process the request. content: application/json: schema: $ref: '#/components/schemas/CheckoutErrorResponseEntity' '422': description: Unprocessable Entity - a request validation error. content: application/json: schema: $ref: '#/components/schemas/CheckoutErrorResponseEntity' '500': description: Internal Server Error - the server could not process the request. content: application/json: schema: $ref: '#/components/schemas/CheckoutErrorResponseEntity' x-methodName: validateShopperId x-sortIndex: 4 components: schemas: AccountInfo: type: object additionalProperties: false properties: accountAgeIndicator: type: string 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 accountChangeDate: type: string format: date-time description: Date when the shopper's account was last changed. accountChangeIndicator: type: string 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 accountCreationDate: type: string format: date-time description: Date when the shopper's account was created. accountType: type: string description: 'Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit' enum: - notApplicable - credit - debit x-addedInVersion: '50' addCardAttemptsDay: type: integer format: int32 description: Number of attempts the shopper tried to add a card to their account in the last day. deliveryAddressUsageDate: type: string format: date-time description: Date the selected delivery address was first used. deliveryAddressUsageIndicator: type: string 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 homePhone: type: string deprecated: true description: Shopper's home phone number (including the country code). x-deprecatedInVersion: '68' x-deprecatedMessage: Use `ThreeDS2RequestData.homePhone` instead. mobilePhone: type: string deprecated: true description: Shopper's mobile phone number (including the country code). x-deprecatedInVersion: '68' x-deprecatedMessage: Use `ThreeDS2RequestData.mobilePhone` instead. passwordChangeDate: type: string format: date-time description: Date when the shopper last changed their password. passwordChangeIndicator: type: string description: 'Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days' enum: - notApplicable - thisTransaction - lessThan30Days - from30To60Days - moreThan60Days pastTransactionsDay: type: integer format: int32 description: Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. pastTransactionsYear: type: integer format: int32 description: Number of all transactions (successful and abandoned) from this shopper in the past year. paymentAccountAge: type: string format: date-time description: Date this payment method was added to the shopper's account. paymentAccountIndicator: type: string 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 purchasesLast6Months: type: integer format: int32 description: Number of successful purchases in the last six months. suspiciousActivity: type: boolean description: Whether suspicious activity was recorded on this account. workPhone: type: string deprecated: true description: Shopper's work phone number (including the country code). x-deprecatedInVersion: '68' x-deprecatedMessage: Use `ThreeDS2RequestData.workPhone` instead. AcctInfo: type: object additionalProperties: false properties: chAccAgeInd: type: string description: "Length of time that the cardholder has had the account with\ \ the 3DS Requestor. \nAllowed values:\n* **01** \u2014 No account\n*\ \ **02** \u2014 Created during this transaction\n* **03** \u2014 Less\ \ than 30 days\n* **04** \u2014 30\u201360 days\n* **05** \u2014 More\ \ than 60 days" enum: - '01' - '02' - '03' - '04' - '05' maxLength: 2 minLength: 2 chAccChange: type: string description: "Date that the cardholder\u2019s account with the 3DS Requestor\ \ was last changed, including Billing or Shipping address, new payment\ \ account, or new user(s) added. \nFormat: **YYYYMMDD**" chAccChangeInd: type: string description: "Length of time since the cardholder\u2019s 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** \u2014 Changed during this transaction\n* **02** \u2014 Less\ \ than 30 days\n* **03** \u2014 30\u201360 days\n* **04** \u2014 More\ \ than 60 days" enum: - '01' - '02' - '03' - '04' maxLength: 2 minLength: 2 chAccPwChange: type: string description: "Date that cardholder\u2019s account with the 3DS Requestor\ \ had a password change or account reset. \nFormat: **YYYYMMDD**" chAccPwChangeInd: type: string description: "Indicates the length of time since the cardholder\u2019s account\ \ with the 3DS Requestor had a password change or account reset. \nAllowed\ \ values:\n* **01** \u2014 No change\n* **02** \u2014 Changed during this\ \ transaction\n* **03** \u2014 Less than 30 days\n* **04** \u2014 30\u2013\ 60 days\n* **05** \u2014 More than 60 days" enum: - '01' - '02' - '03' - '04' - '05' maxLength: 2 minLength: 2 chAccString: type: string description: "Date that the cardholder opened the account with the 3DS Requestor.\ \ \nFormat: **YYYYMMDD**" nbPurchaseAccount: type: string description: 'Number of purchases with this cardholder account during the previous six months. Max length: 4 characters.' paymentAccAge: type: string description: "String that the payment account was enrolled in the cardholder\u2019\ s account with the 3DS Requestor. \nFormat: **YYYYMMDD**" paymentAccInd: type: string description: "Indicates the length of time that the payment account was\ \ enrolled in the cardholder\u2019s account with the 3DS Requestor. \n\ Allowed values:\n* **01** \u2014 No account (guest checkout)\n* **02**\ \ \u2014 During this transaction\n* **03** \u2014 Less than 30 days\n\ * **04** \u2014 30\u201360 days\n* **05** \u2014 More than 60 days" enum: - '01' - '02' - '03' - '04' - '05' maxLength: 2 minLength: 2 provisionAttemptsDay: type: string description: 'Number of Add Card attempts in the last 24 hours. Max length: 3 characters.' shipAddressUsage: type: string description: "String when the shipping address used for this transaction\ \ was first used with the 3DS Requestor. \nFormat: **YYYYMMDD**" shipAddressUsageInd: type: string description: "Indicates when the shipping address used for this transaction\ \ was first used with the 3DS Requestor. \nAllowed values:\n* **01** \u2014\ \ This transaction\n* **02** \u2014 Less than 30 days\n* **03** \u2014\ \ 30\u201360 days\n* **04** \u2014 More than 60 days" enum: - '01' - '02' - '03' - '04' maxLength: 2 minLength: 2 shipNameIndicator: type: string description: "Indicates if the Cardholder Name on the account is identical\ \ to the shipping Name used for this transaction. \nAllowed values:\n\ * **01** \u2014 Account Name identical to shipping Name\n* **02** \u2014\ \ Account Name different to shipping Name" enum: - '01' - '02' maxLength: 2 minLength: 2 suspiciousAccActivity: type: string description: "Indicates whether the 3DS Requestor has experienced suspicious\ \ activity (including previous fraud) on the cardholder account. \nAllowed\ \ values:\n* **01** \u2014 No suspicious activity has been observed\n\ * **02** \u2014 Suspicious activity has been observed" enum: - '01' - '02' maxLength: 2 minLength: 2 txnActivityDay: type: string 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 txnActivityYear: type: string 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 AchDetails: type: object additionalProperties: false properties: accountHolderType: type: string description: The account holder type (personal or business). enum: - business - personal bankAccountNumber: type: string description: The bank account number (without separators). bankAccountType: type: string description: The bank account type (checking, savings...). enum: - balance - checking - deposit - general - other - payment - savings bankLocationId: type: string description: The bank routing number of the account. The field value is `nil` in most cases. checkoutAttemptId: type: string description: The checkout attempt identifier. encryptedBankAccountNumber: type: string description: Encrypted bank account number. The bank account number (without separators). encryptedBankLocationId: type: string description: Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases. ownerName: type: string description: "The name of the bank account holder.\nIf 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:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ \ accept '\xF8'.\nAfter 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:\n* John17 -\ \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ > If provided details don't match the required format, the response returns\ \ the error message: 203 'Invalid bank account holder name'." recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' transferInstrumentId: type: string description: The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts. type: type: string default: ach description: '**ach**' enum: - ach - ach_plaid title: ACH Direct Debit AdditionalData3DSecure: type: object additionalProperties: false properties: allow3DS2: type: string deprecated: true 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) or send the\ \ `executeThreeD` parameter.\n\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 selects redirect or native\ \ authentication based on your configuration to optimize authorization\ \ rates and improve the shopper's experience.\n* **false** \u2013 Not\ \ ready to support native 3D Secure 2 authentication. Adyen offers redirect\ \ 3D Secure 2 authentication instead, based on your configuration.\n" x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS` instead. challengeWindowSize: type: string 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' executeThreeD: type: string deprecated: true 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**\ \ \u2013 Perform 3D Secure authentication.\n* **false** \u2013 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" x-deprecatedInVersion: '69' x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead mpiImplementationType: type: string description: In case of Secure+, this field must be set to **CUPSecurePlus**. scaExemption: type: string 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** " threeDSVersion: type: string 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* **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.\n* If you the BIN is not enrolled, you will\ \ receive an error.\n\n" AdditionalDataAirline: type: object additionalProperties: false properties: airline.agency_invoice_number: type: string description: 'The reference number for the invoice, issued by the agency. * Encoding: ASCII * minLength: 1 character * maxLength: 6 characters' airline.agency_plan_name: type: string description: 'The two-letter agency plan identifier. * Encoding: ASCII * minLength: 2 characters * maxLength: 2 characters' airline.airline_code: type: string 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.' airline.airline_designator_code: type: string 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.' airline.boarding_fee: type: string 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' airline.computerized_reservation_system: type: string 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' airline.customer_reference_number: type: string 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' airline.document_type: type: string 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' airline.flight_date: type: string 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' airline.issue_date: type: string description: 'The date that the ticket was issued to the passenger. * minLength: 6 characters * maxLength: 6 characters * Date format: YYMMDD' airline.leg.carrier_code: type: string 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.' airline.leg.class_of_travel: type: string 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." airline.leg.date_of_travel: type: string 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" airline.leg.depart_airport: type: string 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.' airline.leg.depart_tax: type: string 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.' airline.leg.destination_code: type: string 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.' airline.leg.fare_base_code: type: string description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric. * minLength: 1 character * maxLength: 15 characters * Must not be all spaces * Must not be all zeros.' airline.leg.flight_number: type: string description: 'The flight identifier. * minLength: 1 character * maxLength: 5 characters * Must not be all spaces * Must not be all zeros.' airline.leg.stop_over_code: type: string 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' airline.passenger.date_of_birth: type: string description: 'The passenger''s date of birth. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10' airline.passenger.first_name: type: string description: 'The passenger''s first name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII' airline.passenger.last_name: type: string description: 'The passenger''s last name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII' airline.passenger.phone_number: type: string description: 'The passenger''s phone number, including country code. This is an alphanumeric field that can include the ''+'' and ''-'' signs. * Encoding: ASCII * minLength: 3 characters * maxLength: 30 characters' airline.passenger.traveller_type: type: string description: 'The IATA passenger type code (PTC). * Encoding: ASCII * minLength: 3 characters * maxLength: 6 characters' airline.passenger_name: type: string 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." airline.ticket_issue_address: type: string description: 'The address of the organization that issued the ticket. * minLength: 0 characters * maxLength: 16 characters' airline.ticket_number: type: string description: 'The ticket''s unique identifier. * minLength: 1 character * maxLength: 15 characters * Must not be all spaces * Must not be all zeros.' airline.travel_agency_code: type: string 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.' airline.travel_agency_name: type: string 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.' required: - airline.passenger_name AdditionalDataCarRental: type: object additionalProperties: false properties: carRental.checkOutDate: type: string description: 'The pick-up date. * Date format: `yyyyMMdd`' carRental.customerServiceTollFreeNumber: type: string 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.' carRental.daysRented: type: string description: 'Number of days for which the car is being rented. * Format: Numeric * maxLength: 4 * Must not be all spaces' carRental.fuelCharges: type: string description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12' carRental.insuranceCharges: type: string 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.' carRental.locationCity: type: string 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.' carRental.locationCountry: type: string 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' carRental.locationStateProvince: type: string 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.' carRental.noShowIndicator: type: string description: 'Indicates if the customer didn''t pick up their rental car. * Y - Customer did not pick up their car * N - Not applicable' carRental.oneWayDropOffCharges: type: string 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' carRental.rate: type: string description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Alphanumeric * maxLength: 12' carRental.rateIndicator: type: string description: 'Specifies whether the given rate is applied daily or weekly. * D - Daily rate * W - Weekly rate' carRental.rentalAgreementNumber: type: string 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.' carRental.rentalClassId: type: string 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.' carRental.renterName: type: string 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.' carRental.returnCity: type: string 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.' carRental.returnCountry: type: string 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' carRental.returnDate: type: string description: 'The last date to return the car by. * Date format: `yyyyMMdd` * maxLength: 8' carRental.returnLocationId: type: string 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.' carRental.returnStateProvince: type: string 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.' carRental.taxExemptIndicator: type: string 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' travelEntertainmentAuthData.duration: type: string description: 'Number of days the car is rented for. This should be included in the auth message. * Format: Numeric * maxLength: 4' travelEntertainmentAuthData.market: type: string 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' AdditionalDataCommon: type: object additionalProperties: false properties: RequestedTestAcquirerResponseCode: type: string description: 'Triggers test scenarios that allow to replicate certain acquirer response codes. See [Testing result codes and refusal reasons](https://docs.adyen.com/development-resources/testing/result-codes/) to learn about the possible values, and the `refusalReason` values you can trigger. ' RequestedTestErrorResponseCode: type: string description: "Triggers test scenarios that allow to replicate certain communication\ \ errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** \u2013 There\ \ wasn't a connection available to service the outgoing communication.\n\ 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.\n* **IOEXCEPTION_RECEIVED** \u2013 Something went\ \ wrong during transmission of the message or receiving the response.\n\ 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." allowPartialAuth: type: string description: "Set to true to authorise a part of the requested amount in\ \ case the cardholder does not have enough funds on their account. \n\ If a payment was partially authorised, the response includes resultCode:\ \ PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\n\ To enable this functionality, contact our Support Team." authorisationType: type: string 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).\n\ \nAllowed values:\n* **PreAuth** \u2013 flags the payment request to be\ \ handled as a pre-authorisation.\n* **FinalAuth** \u2013 flags the payment\ \ request to be handled as a final authorisation." autoRescue: type: string description: Set to **true** to enable [Auto Rescue](https://docs.adyen.com/online-payments/auto-rescue/) for a transaction. Use the `maxDaysToRescue` to specify a rescue window. customRoutingFlag: type: string 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).' industryUsage: type: string 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 manualCapture: type: string description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction. maxDaysToRescue: type: string description: "The rescue window for a transaction, in days, when `autoRescue`\ \ is set to **true**. You can specify a value between 1 and 48.\n\n* For\ \ [cards](https://docs.adyen.com/online-payments/auto-rescue/cards/),\ \ the default is one calendar month.\n * For [SEPA](https://docs.adyen.com/online-payments/auto-rescue/sepa/),\ \ the default is 42 days." networkTxReference: type: string 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.' overwriteBrand: type: string 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. subMerchantCity: type: string 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.' subMerchantCountry: type: string 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.' subMerchantEmail: type: string description: 'This field is required for transactions performed by registered payment facilitators. This field contains the email address of the sub-merchant. * Format: Alphanumeric * Maximum length: 40 characters' subMerchantID: type: string 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.' subMerchantName: type: string 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.' subMerchantPhoneNumber: type: string description: 'This field is required for transactions performed by registered payment facilitators. This field contains the phone number of the sub-merchant.* Format: Alphanumeric * Maximum length: 20 characters' subMerchantPostalCode: type: string 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.' subMerchantState: type: string 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.' subMerchantStreet: type: string 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.' subMerchantTaxId: type: string 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.' transactionLinkId: type: string description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain For Mastercard payments. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from Mastercard. 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.' AdditionalDataLevel23: type: object additionalProperties: false properties: enhancedSchemeData.customerReference: type: string description: "The reference number to identify the customer and their order.\ \ \n* Encoding: ASCII\n* Max length: 25 characters\n* Must not start with\ \ a space or be all spaces.\n* Must not be all zeros." enhancedSchemeData.destinationCountryCode: type: string 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' enhancedSchemeData.destinationPostalCode: type: string description: 'The postal code of the destination address. * Encoding: ASCII * Max length: 10 characters * Must not start with a space. * For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000. * For Canada, it must be in 6 digits format. For example, M4B 1G5.' enhancedSchemeData.destinationStateProvinceCode: type: string description: 'The state or province code of the destination address. * Encoding: ASCII * Max length: 3 characters * Must not start with a space.' enhancedSchemeData.dutyAmount: type: string description: 'The duty 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' enhancedSchemeData.freightAmount: type: string 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' enhancedSchemeData.itemDetailLine[itemNr].commodityCode: type: string description: 'The code that identifies the item in a standardized commodity coding scheme. There are different commodity coding schemes: * [UNSPSC commodity codes](https://www.ungm.org/public/unspsc) * [HS commodity codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx) * [NAICS commodity codes](https://www.census.gov/naics/) * [NAPCS commodity codes](https://www.census.gov/naics/napcs/) * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces. * Must not be all zeros.' enhancedSchemeData.itemDetailLine[itemNr].description: type: string description: "A description of the item, that provides details about the\ \ purchase.\n\n For Visa transactions with level 3 ESD, the description\ \ must not be the same or very similar to your merchant name, or, consist\ \ only of common words like \"product\", or \"service\".\n* Encoding:\ \ ASCII\n* Max length: 26 characters\n* Must not be a single character.\n\ * Must not be blank.\n* Must not be all special characters.\n* Must not\ \ be blank.\n* Must not start with a space or be all spaces.\n* Must not\ \ be all zeros." enhancedSchemeData.itemDetailLine[itemNr].discountAmount: type: string 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' enhancedSchemeData.itemDetailLine[itemNr].productCode: type: string description: "The product code. Must be a unique product code associated\ \ with the item or service. This can be your unique code for the item,\ \ or the manufacturer's product code. \n* Encoding: ASCII.\n* Max length:\ \ 12 characters\n* Must not start with a space or be all spaces.\n* Must\ \ not be all zeros." enhancedSchemeData.itemDetailLine[itemNr].quantity: type: string 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.' enhancedSchemeData.itemDetailLine[itemNr].totalAmount: type: string description: 'The total amount for the line item, in [minor units](https://docs.adyen.com/development-resources/currency-codes). See [Amount requirements for level 2/3 ESD](https://docs.adyen.com//payment-methods/cards/enhanced-scheme-data/l2-l3#amount-requirements) to learn more about how to calculate the line item total. * 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.' enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: type: string 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.' enhancedSchemeData.itemDetailLine[itemNr].unitPrice: type: string 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.' enhancedSchemeData.orderDate: type: string description: 'The order date. * Format: `ddMMyy` * Encoding: ASCII * Max length: 6 characters' enhancedSchemeData.shipFromPostalCode: type: string description: 'The postal code of the address where 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.For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000. * For Canada, it must be in 6 digits format. For example, M4B 1G5.' enhancedSchemeData.totalTaxAmount: type: string description: "The amount of state or provincial [tax included in the total\ \ transaction amount](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/l2-l3#requirements-to-send-level-2-3-esd),\ \ in [minor units](https://docs.adyen.com/development-resources/currency-codes).\ \ \n* For example, 2000 means USD 20.00.\n* Encoding: Numeric \n* Max\ \ length: 12 characters \n* For L2 data: must not be all zeroes. \n* For\ \ L3 data: can be zero." AdditionalDataLodging: type: object additionalProperties: false properties: lodging.SpecialProgramCode: type: string description: 'A code that corresponds to the category of lodging charges for the payment. Possible values: * 1: Lodging * 2: No show reservation * 3: Advanced deposit' lodging.checkInDate: type: string description: 'The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.' lodging.checkOutDate: type: string description: 'The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.' lodging.customerServiceTollFreeNumber: type: string 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.' lodging.fireSafetyActIndicator: type: string 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' lodging.folioCashAdvances: type: string description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters' lodging.folioNumber: type: string description: "The card acceptor\u2019s internal invoice or billing ID reference\ \ number.\n* Max length: 25 characters\n* Must not start with a space\n\ * Must not contain any special characters\n* Must not be all zeros." lodging.foodBeverageCharges: type: string 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' lodging.noShowIndicator: type: string 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" lodging.prepaidExpenses: type: string description: 'The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters' lodging.propertyPhoneNumber: type: string 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.' lodging.room1.numberOfNights: type: string 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' lodging.room1.rate: type: string 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' lodging.totalRoomTax: type: string 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' lodging.totalTax: type: string 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' travelEntertainmentAuthData.duration: type: string description: 'The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters' travelEntertainmentAuthData.market: type: string 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' AdditionalDataOpenInvoice: type: object additionalProperties: false properties: openinvoicedata.merchantData: type: string 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.' openinvoicedata.numberOfLines: type: string 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.' openinvoicedata.recipientFirstName: type: string 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. openinvoicedata.recipientLastName: type: string 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. openinvoicedataLine[itemNr].currencyCode: type: string description: The three-character ISO currency code. openinvoicedataLine[itemNr].description: type: string description: A text description of the product the invoice line refers to. openinvoicedataLine[itemNr].itemAmount: type: string description: 'The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded.' openinvoicedataLine[itemNr].itemId: type: string description: A unique id for this item. Required for RatePay if the description of each item is not unique. openinvoicedataLine[itemNr].itemVatAmount: type: string description: The VAT due for one item in the invoice line, represented in minor units. openinvoicedataLine[itemNr].itemVatPercentage: type: string description: 'The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900.' openinvoicedataLine[itemNr].numberOfItems: type: string description: The number of units purchased of a specific product. openinvoicedataLine[itemNr].returnShippingCompany: type: string description: Name of the shipping company handling the the return shipment. openinvoicedataLine[itemNr].returnTrackingNumber: type: string description: The tracking number for the return of the shipment. openinvoicedataLine[itemNr].returnTrackingUri: type: string description: URI where the customer can track the return of their shipment. openinvoicedataLine[itemNr].shippingCompany: type: string description: Name of the shipping company handling the delivery. openinvoicedataLine[itemNr].shippingMethod: type: string description: Shipping method. openinvoicedataLine[itemNr].trackingNumber: type: string description: The tracking number for the shipment. openinvoicedataLine[itemNr].trackingUri: type: string description: URI where the customer can track their shipment. AdditionalDataOpi: type: object additionalProperties: false properties: opi.includeTransToken: type: string 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).' AdditionalDataRatepay: type: object additionalProperties: false properties: ratepay.installmentAmount: type: string description: Amount the customer has to pay each month. ratepay.interestRate: type: string description: Interest rate of this installment. ratepay.lastInstallmentAmount: type: string description: Amount of the last installment. ratepay.paymentFirstday: type: string description: Calendar day of the first payment. ratepaydata.deliveryDate: type: string description: Date the merchant delivered the goods to the customer. ratepaydata.dueDate: type: string description: Date by which the customer must settle the payment. ratepaydata.invoiceDate: type: string description: Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. ratepaydata.invoiceId: type: string description: Identification name or number for the invoice, defined by the merchant. AdditionalDataRetry: type: object additionalProperties: false properties: retry.chainAttemptNumber: type: string 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.' retry.orderAttemptNumber: type: string 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.' retry.skipRetry: type: string 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.' AdditionalDataRisk: type: object additionalProperties: false properties: riskdata.[customFieldName]: type: string 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). riskdata.basket.item[itemNr].amountPerItem: type: string description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). riskdata.basket.item[itemNr].brand: type: string description: Brand of the item. riskdata.basket.item[itemNr].category: type: string description: Category of the item. riskdata.basket.item[itemNr].color: type: string description: Color of the item. riskdata.basket.item[itemNr].currency: type: string description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). riskdata.basket.item[itemNr].itemID: type: string description: ID of the item. riskdata.basket.item[itemNr].manufacturer: type: string description: Manufacturer of the item. riskdata.basket.item[itemNr].productTitle: type: string description: A text description of the product the invoice line refers to. riskdata.basket.item[itemNr].quantity: type: string description: Quantity of the item purchased. riskdata.basket.item[itemNr].receiverEmail: type: string description: Email associated with the given product in the basket (usually in electronic gift cards). riskdata.basket.item[itemNr].size: type: string description: Size of the item. riskdata.basket.item[itemNr].sku: type: string description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' riskdata.basket.item[itemNr].upc: type: string description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' riskdata.promotions.promotion[itemNr].promotionCode: type: string description: Code of the promotion. riskdata.promotions.promotion[itemNr].promotionDiscountAmount: type: string description: The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: type: string description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: type: string 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.' riskdata.promotions.promotion[itemNr].promotionName: type: string description: Name of the promotion. riskdata.riskProfileReference: type: string 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). riskdata.skipRisk: type: string 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. AdditionalDataRiskStandalone: type: object additionalProperties: false properties: PayPal.CountryCode: type: string description: Shopper's country of residence in the form of ISO standard 3166 2-character country codes. PayPal.EmailId: type: string description: Shopper's email. PayPal.FirstName: type: string description: Shopper's first name. PayPal.LastName: type: string description: Shopper's last name. PayPal.PayerId: type: string description: 'Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.' PayPal.Phone: type: string description: Shopper's phone number. PayPal.ProtectionEligibility: type: string description: "Allowed values:\n* **Eligible** \u2014 Merchant is protected\ \ by PayPal's Seller Protection Policy for Unauthorized Payments and Item\ \ Not Received.\n\n* **PartiallyEligible** \u2014 Merchant is protected\ \ by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible**\ \ \u2014 Merchant is not protected under the Seller Protection Policy." PayPal.TransactionId: type: string description: Unique transaction ID of the payment. avsResultRaw: type: string description: 'Raw AVS result received from the acquirer, where available. Example: D' bin: type: string 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/online-payments/tokenization). cvcResultRaw: type: string description: 'Raw CVC result received from the acquirer, where available. Example: 1' riskToken: type: string description: Unique identifier or token for the shopper's card details. threeDAuthenticated: type: string description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true' threeDOffered: type: string description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true' tokenDataType: type: string description: 'Required for PayPal payments only. The only supported value is: **paypal**.' AdditionalDataSubMerchant: type: object additionalProperties: false properties: subMerchant.numberOfSubSellers: type: string description: Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**. subMerchant.subSeller[subSellerNr].city: type: string description: 'Required for transactions performed by registered payment facilitators. The city of the sub-merchant''s address. * Format: Alphanumeric * Maximum length: 13 characters' subMerchant.subSeller[subSellerNr].country: type: string 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" subMerchant.subSeller[subSellerNr].email: type: string description: 'Required for transactions performed by registered payment facilitators. The email address of the sub-merchant. * Format: Alphanumeric * Maximum length: 40 characters' subMerchant.subSeller[subSellerNr].id: type: string 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" subMerchant.subSeller[subSellerNr].mcc: type: string 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" subMerchant.subSeller[subSellerNr].name: type: string 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. Exception: for acquirers in Brazil, this value does not overwrite the shopper statement. * Format: Alphanumeric * Maximum length: 22 characters' subMerchant.subSeller[subSellerNr].phoneNumber: type: string description: 'Required for transactions performed by registered payment facilitators. The phone number of the sub-merchant. * Format: Alphanumeric and special characters * Maximum length: 20 characters' subMerchant.subSeller[subSellerNr].postalCode: type: string 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' subMerchant.subSeller[subSellerNr].state: type: string 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' subMerchant.subSeller[subSellerNr].street: type: string 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' subMerchant.subSeller[subSellerNr].taxId: type: string 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' AdditionalDataTemporaryServices: type: object additionalProperties: false properties: enhancedSchemeData.customerReference: type: string description: 'The customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25' enhancedSchemeData.employeeName: type: string 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." enhancedSchemeData.jobDescription: type: string 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." enhancedSchemeData.regularHoursRate: type: string 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' enhancedSchemeData.regularHoursWorked: type: string description: 'The hours worked. * maxLength: 7 * Must not be empty * Can be all zeros' enhancedSchemeData.requestName: type: string description: 'The name of the person requesting temporary services. * maxLength: 40 * Must not be all zeros * Must not be all spaces' enhancedSchemeData.tempStartDate: type: string description: 'The billing period start date. * Format: ddMMyy * maxLength: 6' enhancedSchemeData.tempWeekEnding: type: string description: 'The billing period end date. * Format: ddMMyy * maxLength: 6' enhancedSchemeData.totalTaxAmount: type: string 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' AdditionalDataWallets: type: object additionalProperties: false properties: androidpay.token: type: string description: The Android Pay token retrieved from the SDK. masterpass.transactionId: type: string description: The Mastercard Masterpass Transaction ID retrieved from the SDK. payment.token: type: string description: The Apple Pay token retrieved from the SDK. paywithgoogle.token: type: string description: The Google Pay token retrieved from the SDK. samsungpay.token: type: string description: The Samsung Pay token retrieved from the SDK. visacheckout.callId: type: string description: The Visa Checkout Call ID retrieved from the SDK. Address: type: object additionalProperties: false properties: city: type: string description: 'The name of the city. Maximum length: 3000 characters.' maxLength: 3000 country: type: string 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`.' houseNumberOrName: type: string description: 'The number or name of the house. Maximum length: 3000 characters.' maxLength: 3000 postalCode: type: string 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. stateOrProvince: type: string 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.' street: type: string 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 required: - city - country - houseNumberOrName - postalCode - street AffirmDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: affirm description: '**affirm**' enum: - affirm title: Affirm AfterpayDetails: type: object additionalProperties: false properties: billingAddress: type: string description: The address where to send the invoice. checkoutAttemptId: type: string description: The checkout attempt identifier. deliveryAddress: type: string description: The address where the goods should be delivered. personalDetails: type: string description: Shopper name, date of birth, phone number, and email address. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: afterpay_default description: '**afterpay_default**' enum: - afterpay_default - afterpaytouch - afterpay_b2b - clearpay required: - type title: Afterpay Agency: type: object additionalProperties: false properties: invoiceNumber: type: string description: 'The reference number for the invoice, issued by the agency. * Encoding: ASCII * minLength: 1 character * maxLength: 6 characters * **additionalData key:** `airline.agency_invoice_number`' planName: type: string description: 'The two-letter agency plan identifier. * Encoding: ASCII * minLength: 2 characters * maxLength: 2 characters * **additionalData key:** `airline.agency_plan_name`' Airline: type: object additionalProperties: false properties: agency: $ref: '#/components/schemas/Agency' boardingFee: type: integer format: int64 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: 11 characters * **additionalData key:** `airline.boarding_fee`' code: type: string 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 start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.airline_code`' computerizedReservationSystem: type: string 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 * **additionalData key:** `airline.computerized_reservation_system`' customerReferenceNumber: type: string 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 start with a space or be all spaces. * **additionalData key:** `airline.customer_reference_number`' designatorCode: type: string 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 start with a space or be all spaces. * **additionalData key:** `airline.airline_designator_code`' documentType: type: string 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 * **additionalData key:** `airline.document_type`' flightDate: type: string format: date-time description: 'The flight departure date. Time is optional. * Format for date only: `yyyy-MM-dd` * Format for date and time: `yyyy-MM-ddTHH:mm` * Use local time of departure airport. * minLength: 10 characters * maxLength: 16 characters * **additionalData key:** `airline.flight_date`' legs: type: array items: $ref: '#/components/schemas/Leg' passengerName: type: string description: 'The passenger''s name, initials, and title. * Format: last name + first name or initials + title * Example: *FLYER / MARY MS* * minLength: 1 character * maxLength: 20 characters * If you send more than 20 characters, the name is truncated * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.passenger_name`' passengers: type: array items: $ref: '#/components/schemas/Passenger' ticket: $ref: '#/components/schemas/Ticket' travelAgency: $ref: '#/components/schemas/TravelAgency' required: - passengerName AlmaDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. feeType: type: string description: '**Alma payment request fee type**' enum: - merchantPays - shopperPays sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string description: The payment method type. enum: - alma title: Alma AmazonPayDetails: type: object additionalProperties: false properties: amazonPayToken: type: string 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. checkoutAttemptId: type: string description: The checkout attempt identifier. checkoutSessionId: type: string 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. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: amazonpay description: '**amazonpay**' enum: - amazonpay title: Amazon Pay Amount: type: object additionalProperties: false properties: currency: type: string description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. maxLength: 3 minLength: 3 value: type: integer format: int64 description: The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). required: - currency - value Amounts: type: object additionalProperties: false properties: currency: type: string description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/). values: type: array description: The amounts of the donation (in [minor units](https://docs.adyen.com/development-resources/currency-codes/)). items: type: integer format: int64 required: - currency - values AncvDetails: type: object additionalProperties: false properties: beneficiaryId: type: string description: ANCV account identification (email or account number) checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string description: '**ancv**' enum: - ancv title: ANCV AndroidPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: androidpay description: '**androidpay**' enum: - androidpay title: Android Pay AppIdentifierInfo: type: object additionalProperties: false properties: androidPackageId: type: string description: The Android package identifier for this app. iosScheme: type: string description: The iOS URL scheme for this app. ApplePayDetails: type: object additionalProperties: false properties: applePayToken: type: string description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. maxLength: 10000 checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: applepay description: '**applepay**' enum: - applepay required: - applePayToken title: Apple Pay ApplePayDonations: type: object additionalProperties: false properties: applePayToken: type: string description: The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. maxLength: 10000 checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: applepay description: '**applepay**' enum: - applepay required: - applePayToken title: Apple Pay ApplePaySessionRequest: type: object additionalProperties: false properties: displayName: type: string description: 'This is the name that your shoppers will see in the Apple Pay interface. The value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.' maxLength: 64 domainName: type: string description: 'The domain name you provided when you added Apple Pay in your Customer Area. This must match the `window.location.hostname` of the web shop.' merchantIdentifier: type: string description: 'Your merchant identifier registered with Apple Pay. Use the value of the `configuration.merchantId` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response.' required: - displayName - domainName - merchantIdentifier ApplePaySessionResponse: type: object additionalProperties: false properties: data: type: string description: Base64 encoded data you need to [complete the Apple Pay merchant validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation). required: - data ApplicationInfo: type: object additionalProperties: false properties: adyenLibrary: $ref: '#/components/schemas/CommonField' description: Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc. adyenPaymentSource: $ref: '#/components/schemas/CommonField' description: Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc. externalPlatform: $ref: '#/components/schemas/ExternalPlatform' description: Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc. merchantApplication: $ref: '#/components/schemas/CommonField' description: Merchant developed software, such as cashier application, used to interact with the Adyen API. merchantDevice: $ref: '#/components/schemas/MerchantDevice' description: Merchant device information. shopperInteractionDevice: $ref: '#/components/schemas/ShopperInteractionDevice' description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. AuPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: aupay description: '**aupay**' enum: - aupay title: AuPay AuthenticationData: type: object additionalProperties: false properties: attemptAuthentication: type: string 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 x-addedInVersion: '69' authenticationOnly: type: boolean default: false description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization. Default: **false**.' x-addedInVersion: '69' threeDSRequestData: $ref: '#/components/schemas/ThreeDSRequestData' description: Object with additional parameters for the 3D Secure authentication flow. x-addedInVersion: '69' BacsDirectDebitDetails: type: object additionalProperties: false properties: bankAccountNumber: type: string description: The bank account number (without separators). x-addedInVersion: '65' bankLocationId: type: string description: The bank routing number of the account. x-addedInVersion: '65' checkoutAttemptId: type: string description: The checkout attempt identifier. holderName: type: string description: The name of the bank account holder. x-addedInVersion: '65' recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' transferInstrumentId: type: string description: The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts. type: type: string default: directdebit_GB description: '**directdebit_GB**' enum: - directdebit_GB title: BACS Direct Debit BalanceCheckRequest: type: object additionalProperties: false properties: accountInfo: $ref: '#/components/schemas/AccountInfo' 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.' x-addedInVersion: '40' additionalAmount: $ref: '#/components/schemas/Amount' 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`. ' additionalData: type: object additionalProperties: type: string 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.' 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' amount: $ref: '#/components/schemas/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). applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). x-addedInVersion: '40' billingAddress: $ref: '#/components/schemas/Address' 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.' x-addedInVersion: '4' browserInfo: $ref: '#/components/schemas/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 2 redirect.' captureDelayHours: type: integer format: int32 description: The delay between the authorisation and scheduled auto-capture, specified in hours. x-addedInVersion: '2' dateOfBirth: type: string format: date description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' x-addedInVersion: '7' dccQuote: $ref: '#/components/schemas/ForexQuote' description: The forex quote as returned in the response of the forex service. deliveryAddress: $ref: '#/components/schemas/Address' description: The address where the purchased goods should be delivered. deliveryDate: type: string format: date-time 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' x-addedInVersion: '8' deviceFingerprint: type: string 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 x-addedInVersion: '2' fraudOffset: type: integer format: int32 description: An integer value that is added to the normal fraud score. The value can be either positive or negative. installments: $ref: '#/components/schemas/Installments' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). x-addedInVersion: '4' localizedShopperStatement: type: object additionalProperties: type: string description: 'The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.' x-addedInVersion: '68' mcc: type: string 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. x-addedInVersion: '12' merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. merchantOrderReference: type: string 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`.' x-addedInVersion: '9' merchantRiskIndicator: $ref: '#/components/schemas/MerchantRiskIndicator' 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.' x-addedInVersion: '40' metadata: type: object 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. ' x-addedInVersion: '17' orderReference: type: string 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. paymentMethod: type: object additionalProperties: type: string description: The collection that contains the type of the payment method and its specific information. recurring: $ref: '#/components/schemas/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). recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ \ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile` \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile x-addedInVersion: '30' reference: type: string 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.' selectedBrand: type: string 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.' selectedRecurringDetailReference: type: string description: The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. sessionId: type: string description: A session ID used to identify a payment session. shopperEmail: type: string description: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. shopperIP: type: string description: 'The shopper''s IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).' shopperInteraction: type: string 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 shopperLocale: type: string description: 'The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.' x-addedInVersion: '7' shopperName: $ref: '#/components/schemas/Name' description: The shopper's full name. x-addedInVersion: '7' shopperReference: type: string description: "Required for recurring payments. \nYour reference to uniquely\ \ identify this shopper, for example user ID or account ID. The value\ \ is case-sensitive and must be at least three characters.\n> Your reference\ \ must not include personally identifiable information (PII) such as name\ \ or email address." shopperStatement: type: string 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 **. , ' _ - ? + * /**." socialSecurityNumber: type: string description: The shopper's social security number. x-addedInVersion: '4' splits: type: array description: An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' x-addedInVersion: '37' store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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 x-addedInVersion: '23' telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." x-addedInVersion: '7' threeDS2RequestData: $ref: '#/components/schemas/ThreeDS2RequestData' 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. x-addedInVersion: '40' threeDSAuthenticationOnly: type: boolean default: false deprecated: true description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.' x-addedInVersion: '50' x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. totalsGroup: type: string description: The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). maxLength: 16 minLength: 1 x-addedInVersion: '23' trustedShopper: type: boolean description: Set to true if the payment should be routed to a trusted MID. x-addedInVersion: '37' required: - amount - merchantAccount - paymentMethod BalanceCheckResponse: type: object additionalProperties: false properties: additionalData: type: object 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**.' 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' - $ref: '#/components/schemas/ResponseAdditionalDataSwish' balance: $ref: '#/components/schemas/Amount' description: The balance for the payment method. fraudResult: $ref: '#/components/schemas/FraudResult' description: The fraud result properties of the payment. pspReference: type: string 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. refusalReason: type: string 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).' resultCode: type: string description: "The result of the cancellation request.\n\nPossible values:\n\ \n* **Success** \u2013 Indicates that the balance check was successful.\n\ * **NotEnoughBalance** \u2013 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.\n* **Failed** \u2013 Indicates that the balance check failed." enum: - Success - NotEnoughBalance - Failed transactionLimit: $ref: '#/components/schemas/Amount' description: The maximum spendable balance for a single transaction. Applicable to some gift cards. x-addedInVersion: '65' required: - balance - resultCode BillDeskDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The issuer id of the shopper's selected bank. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string description: '**billdesk**' enum: - billdesk_online - billdesk_wallet required: - issuer - type title: BillDesk BillingAddress: type: object additionalProperties: false properties: city: type: string description: 'The name of the city. Maximum length: 3000 characters.' maxLength: 3000 country: type: string 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`.' houseNumberOrName: type: string description: 'The number or name of the house. Maximum length: 3000 characters.' maxLength: 3000 postalCode: type: string 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. stateOrProvince: type: string 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.' maxLength: 1000 street: type: string 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 required: - city - country - houseNumberOrName - postalCode - street BlikDetails: type: object additionalProperties: false properties: blikCode: type: string description: BLIK code consisting of 6 digits. checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string description: '**blik**' enum: - blik title: BLIK BrowserInfo: type: object additionalProperties: false properties: acceptHeader: type: string description: The accept header value of the shopper's browser. colorDepth: type: integer format: int32 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.' x-addedInVersion: '40' javaEnabled: type: boolean description: Boolean value indicating if the shopper's browser is able to execute Java. x-addedInVersion: '40' javaScriptEnabled: type: boolean 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. x-addedInVersion: '40' language: type: string description: The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). x-addedInVersion: '40' screenHeight: type: integer format: int32 description: The total height of the shopper's device screen in pixels. x-addedInVersion: '40' screenWidth: type: integer format: int32 description: The total width of the shopper's device screen in pixels. x-addedInVersion: '40' timeZoneOffset: type: integer format: int32 description: Time difference between UTC time and the shopper's browser local time, in minutes. x-addedInVersion: '40' userAgent: type: string description: The user agent value of the shopper's browser. required: - acceptHeader - colorDepth - javaEnabled - language - screenHeight - screenWidth - timeZoneOffset - userAgent CancelOrderRequest: type: object additionalProperties: false properties: merchantAccount: type: string description: The merchant account identifier that orderData belongs to. order: $ref: '#/components/schemas/EncryptedOrderData' description: The order request object that contains a pspReference that represents the order and the matching encrypted order data. required: - merchantAccount - order CancelOrderResponse: type: object additionalProperties: false properties: pspReference: type: string description: A unique reference of the cancellation request. resultCode: type: string description: "The result of the cancellation request.\n\nPossible values:\n\ \n* **Received** \u2013 Indicates the cancellation has successfully been\ \ received by Adyen, and will be processed." enum: - Received required: - pspReference - resultCode CarRental: type: object additionalProperties: false properties: customerServicePhoneNumber: type: string 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 contain any special characters such as + or - * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.customerServiceTollFreeNumber`' noShow: type: boolean description: 'Indicates if the customer didn''t pick up their rental car. * **additionalData key:** `carRental.noShowIndicator`' pickupInfo: $ref: '#/components/schemas/PickupInfo' rateType: type: string description: 'Indicates whether the rental rate is daily or weekly. * **additionalData key:** `carRental.rateIndicator`' enum: - daily - weekly rentalAgreementNumber: type: string description: 'The rental agreement number for the car rental. * Format: ASCII * maxLength: 9 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.rentalAgreementNumber`' rentalClassId: type: string description: 'The classification of the rental car. * Format: Alphanumeric * maxLength: 4 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.rentalClassId`' rentalDays: type: integer format: int32 description: 'The number of days the car is rented for. * Format: Numeric * Max value: 9999 * **additionalData key:** `carRental.daysRented`' rentalRate: type: integer format: int64 description: 'Rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * Frequency of the rental rate is specified in the rateType field. * **additionalData key:** `carRental.rate`' rentalSurcharges: $ref: '#/components/schemas/RentalSurcharges' renterName: type: string description: 'The name of the person renting the car. * Format: ASCII * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.renterName`' returnInfo: $ref: '#/components/schemas/ReturnInfo' taxExempt: type: boolean description: 'Indicates if the goods or services were tax-exempt, or if tax was not collected. * **additionalData key:** `carRental.taxExemptIndicator`' required: - renterName CardBrandDetails: type: object additionalProperties: false properties: supported: type: boolean description: Indicates if you support the card brand. type: type: string description: The name of the card brand. CardDetails: type: object additionalProperties: false properties: billingSequenceNumber: type: string 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. brand: type: string description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' checkoutAttemptId: type: string description: The checkout attempt identifier. cupsecureplus.smscode: type: string deprecated: true cvc: type: string 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). encryptedCard: type: string description: Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details. maxLength: 40000 encryptedCardNumber: type: string description: The encrypted card number. maxLength: 15000 encryptedExpiryMonth: type: string description: The encrypted card expiry month. maxLength: 15000 encryptedExpiryYear: type: string description: The encrypted card expiry year. maxLength: 15000 encryptedPassword: type: string description: This field contains an encrypted, one-time password or an authentication code provided by the cardholder. maxLength: 15000 encryptedSecurityCode: type: string description: The encrypted card verification code. maxLength: 15000 expiryMonth: type: string 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). expiryYear: type: string 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). fastlaneData: type: string description: The encoded fastlane data blob fundingSource: type: string 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 - prepaid holderName: type: string description: The name of the card holder. maxLength: 15000 networkPaymentReference: type: string description: The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. number: type: string 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). recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperNotificationReference: type: string description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. srcCorrelationId: type: string description: An identifier used for the Click to Pay transaction. srcDigitalCardId: type: string description: The SRC reference for the Click to Pay token. srcScheme: type: string description: The scheme that is being used for Click to Pay. srcTokenReference: type: string description: The reference for the Click to Pay token. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' threeDS2SdkVersion: type: string description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. maxLength: 12 type: type: string default: scheme description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: - bcmc - scheme - networkToken - giftcard - card - clicktopay title: Card CardDetailsRequest: type: object additionalProperties: false properties: cardNumber: type: string description: "A minimum of the first six digits of the card number. The\ \ full card number gives the best result. \n\nYou must be [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide)\ \ to collect raw card data. Alternatively, you can use the `encryptedCardNumber`\ \ field." countryCode: type: string description: 'The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE' encryptedCardNumber: type: string description: The encrypted card number. maxLength: 15000 merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. supportedBrands: type: array description: "The card brands you support. This is the [`brands`](https://docs.adyen.com/api-explorer/Checkout/latest/post/paymentMethods#responses-200-paymentMethods-brands)\ \ array from your [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods)\ \ response. \n\nIf not included, our API uses the ones configured for\ \ your merchant account and, if provided, the country code." items: type: string required: - merchantAccount CardDetailsResponse: type: object additionalProperties: false properties: brands: type: array description: The list of brands identified for the card. items: $ref: '#/components/schemas/CardBrandDetails' fundingSource: type: string description: The funding source of the card, for example **DEBIT**, **CREDIT**, or **PREPAID**. isCardCommercial: type: boolean description: Indicates if this is a commercial card or a consumer card. If **true**, it is a commercial card. If **false**, it is a consumer card. issuingCountryCode: type: string description: The two-letter country code of the country where the card was issued. CardDonations: type: object additionalProperties: false properties: billingSequenceNumber: type: string 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. brand: type: string description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' checkoutAttemptId: type: string description: The checkout attempt identifier. cupsecureplus.smscode: type: string deprecated: true cvc: type: string 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). encryptedCard: type: string description: Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details. maxLength: 40000 encryptedCardNumber: type: string description: The encrypted card number. maxLength: 15000 encryptedExpiryMonth: type: string description: The encrypted card expiry month. maxLength: 15000 encryptedExpiryYear: type: string description: The encrypted card expiry year. maxLength: 15000 encryptedPassword: type: string description: This field contains an encrypted, one-time password or an authentication code provided by the cardholder. maxLength: 15000 encryptedSecurityCode: type: string description: The encrypted card verification code. maxLength: 15000 expiryMonth: type: string 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). expiryYear: type: string 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). fastlaneData: type: string description: The encoded fastlane data blob fundingSource: type: string 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 - prepaid holderName: type: string description: The name of the card holder. maxLength: 15000 networkPaymentReference: type: string description: The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. number: type: string 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). recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperNotificationReference: type: string description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. srcCorrelationId: type: string description: An identifier used for the Click to Pay transaction. srcDigitalCardId: type: string description: The SRC reference for the Click to Pay token. srcScheme: type: string description: The scheme that is being used for Click to Pay. srcTokenReference: type: string description: The reference for the Click to Pay token. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' threeDS2SdkVersion: type: string description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. maxLength: 12 type: type: string default: scheme description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: - bcmc - scheme - networkToken - giftcard - card - clicktopay title: Card CashAppDetails: type: object additionalProperties: false properties: cashtag: type: string description: Cash App issued cashtag for recurring payment checkoutAttemptId: type: string description: The checkout attempt identifier. customerId: type: string description: Cash App issued customerId for recurring payment grantId: type: string description: Cash App issued grantId for one time payment onFileGrantId: type: string description: Cash App issued onFileGrantId for recurring payment recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. requestId: type: string description: Cash App request id sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' subtype: type: string description: The payment method subtype. type: type: string default: cashapp description: cashapp enum: - cashapp title: Stored Payment Method CellulantDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The Cellulant issuer. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: cellulant description: '**Cellulant**' enum: - cellulant title: Cellulant CheckoutAwaitAction: type: object additionalProperties: false properties: paymentData: type: string description: Encoded payment data. paymentMethodType: type: string description: Specifies the payment method. type: type: string description: '**await**' enum: - await url: type: string description: Specifies the URL to redirect to. required: - type CheckoutBankAccount: type: object additionalProperties: false properties: accountType: type: string description: The type of the bank account. enum: - balance - checking - deposit - general - other - payment - savings bankAccountNumber: type: string description: The bank account number (without separators). bankCity: type: string description: The bank city. bankLocationId: type: string description: The location id of the bank. The field value is `nil` in most cases. bankName: type: string description: The name of the bank. bic: type: string 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. countryCode: type: string description: 'Country code where the bank is located. A valid value is an ISO two-character country code (e.g. ''NL'').' iban: type: string description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). ownerName: type: string description: "The name of the bank account holder.\nIf 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:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ \ accept '\xF8'.\nAfter 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:\n* John17 -\ \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ > If provided details don't match the required format, the response returns\ \ the error message: 203 'Invalid bank account holder name'." taxId: type: string description: The bank account holder's tax ID. CheckoutBankTransferAction: type: object additionalProperties: false properties: accountNumber: type: string description: The account number of the bank transfer. bankCode: type: string description: The bank code of the bank transfer. beneficiary: type: string description: The name of the account holder. bic: type: string description: The BIC of the IBAN. branchCode: type: string description: The branch code of the bank transfer. downloadUrl: type: string description: The url to download payment details with. iban: type: string description: The IBAN of the bank transfer. paymentMethodType: type: string description: Specifies the payment method. reference: type: string description: The transfer reference. routingNumber: type: string description: The routing number of the bank transfer. shopperEmail: type: string description: The e-mail of the shopper, included if an e-mail was sent to the shopper. sortCode: type: string description: The sort code of the bank transfer. totalAmount: $ref: '#/components/schemas/Amount' description: The amount of the bank transfer. type: type: string description: The type of the action. enum: - bankTransfer url: type: string description: Specifies the URL to redirect to. required: - type CheckoutDelegatedAuthenticationAction: type: object additionalProperties: false properties: authorisationToken: type: string description: A token needed to authorise a payment. paymentData: type: string description: Encoded payment data. paymentMethodType: type: string description: Specifies the payment method. token: type: string description: A token to pass to the delegatedAuthentication component. type: type: string description: '**delegatedAuthentication**' enum: - delegatedAuthentication url: type: string description: Specifies the URL to redirect to. required: - type CheckoutForwardRequest: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The amount of the forwarded payment. baseUrl: type: string description: The base URL of the third party API, where Adyen will send the request to forward the payment details. merchantAccount: type: string description: Your merchant account. merchantReference: type: string description: Merchant defined payment reference. options: $ref: '#/components/schemas/CheckoutForwardRequestOptions' description: The customizations that can be applied when making a forward request. paymentMethod: $ref: '#/components/schemas/CheckoutForwardRequestCard' description: The card details. request: $ref: '#/components/schemas/CheckoutOutgoingForwardRequest' description: The [details of the request](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#request-to-adyen-card) that you want to forward to the third-party. shopperReference: type: string description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.' storedPaymentMethodId: type: string description: The unique identifier of the token that you want to forward to the third party. This is the `storedPaymentMethodId` you received in the webhook after you created the token. required: - baseUrl - merchantAccount - request - shopperReference CheckoutForwardRequestCard: type: object additionalProperties: false properties: cvc: type: string 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 also known as:\n\ * CVV2/CVC2 \u2013 length: 3 digits\n* CID \u2013 length: 4 digits\n" encryptedCardNumber: type: string description: The encrypted card number. encryptedExpiryMonth: type: string description: The encrypted expiryMonth encryptedExpiryYear: type: string description: The encrypted card expiry year. encryptedSecurityCode: type: string description: The encrypted security code. expiryMonth: type: string description: 'The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November' expiryYear: type: string description: The card expiry year. holderName: type: string description: The name of the cardholder. number: type: string 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). Format: Do not use separators.' type: type: string default: scheme description: Default payment method details. Common for scheme payment methods, and for simple payment method details. enum: - scheme CheckoutForwardRequestOptions: type: object additionalProperties: false properties: accountUpdate: type: boolean description: Whether to check for a card account update (true) or not (false) dryRun: type: boolean description: Set to **true** to receive a copy of the request Adyen is making to the third party in the response. Any sensitive information will be masked in the response you receive. This functionality is only available in the test environment. networkToken: $ref: '#/components/schemas/CheckoutNetworkTokenOption' description: The object that contains the details for forwarding a network token. networkTxReferencePaths: type: array description: Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of networkTxReference in the incoming 3rd party response items: type: string tokenize: type: boolean description: Set to **true**, the payment details are [tokenized](https://docs.adyen.com/online-payments/tokenization). transactionLinkIdPaths: type: array description: Set in tokenize:true case when forwarding PAN. Addresses to the possible location(s) of transactionLinkId in the incoming 3rd party response items: type: string CheckoutForwardResponse: type: object additionalProperties: false properties: merchantReference: type: string description: Merchant defined payment reference. pspReference: type: string description: Adyen's 16-character reference associated with the transaction/request. This value is globally unique. Use this reference when you communicate with us about this request. x-addedInVersion: '71' response: $ref: '#/components/schemas/CheckoutForwardResponseFromUrl' description: The details of the response Adyen received from the third party. storedPaymentMethodId: type: string description: The unique identifier of the token. required: - response CheckoutForwardResponseFromUrl: type: object additionalProperties: false properties: body: type: string description: The body of the response Adyen received from the third party, in string format. headers: type: object additionalProperties: type: string description: The HTTP headers of the response Adyen received from the third party. status: type: integer format: int32 description: The HTTP status of the response Adyen received from the third party. CheckoutNativeRedirectAction: type: object additionalProperties: false properties: data: type: object additionalProperties: type: string description: When the redirect URL must be accessed via POST, use this data to post to the redirect URL. method: type: string description: Specifies the HTTP method, for example GET or POST. nativeRedirectData: type: string description: Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult. paymentMethodType: type: string description: Specifies the payment method. type: type: string description: '**nativeRedirect**' enum: - nativeRedirect url: type: string description: Specifies the URL to redirect to. required: - type CheckoutNetworkTokenOption: type: object additionalProperties: false properties: includeCryptogram: type: boolean description: Set to **true** to enable forwarding network token cryptograms. useNetworkToken: type: boolean description: Set to **true** to forward the network token for a card. CheckoutOrderResponse: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The initial amount of the order. expiresAt: type: string description: The expiry date for the order. orderData: type: string description: The encrypted order data. pspReference: type: string description: The `pspReference` that belongs to the order. reference: type: string description: The merchant reference for the order. remainingAmount: $ref: '#/components/schemas/Amount' description: The updated remaining amount. required: - pspReference CheckoutOutgoingForwardRequest: type: object additionalProperties: false properties: body: type: string description: 'The request body that you want Adyen to forward to the third party on your behalf, in string format. Include key value pairs to specify the payment details, and use [placeholders](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders) for the values. Adyen replaces the placeholders with the payment details when making the request to the third party. When forwarding a network token, include a [condition](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#conditional-placeholders) that checks if the network token exists, and informs Adyen of which fields to send depending on the outcome.' maxLength: 20000 credentials: type: string description: Your credentials that are needed to authenticate with the third party. headers: type: object additionalProperties: type: string description: The request headers that will be included in the request Adyen makes to the third party on your behalf. Supports the `{{credentials}}` [placeholder](https://docs.adyen.com/online-payments/tokenization/forward-payment-details#placeholders). httpMethod: type: string description: The HTTP method to use for the request Adyen makes on your behalf to the third party. enum: - post - put - patch urlSuffix: type: string description: The suffix that Adyen needs to append to the `baseUrl` to construct the destination URL that belongs to the third party. This is usually the endpoint name for the request, for example, **/payments**. required: - body - httpMethod CheckoutQrCodeAction: type: object additionalProperties: false properties: expiresAt: type: string description: Expiry time of the QR code. paymentData: type: string description: Encoded payment data. paymentMethodType: type: string description: Specifies the payment method. qrCodeData: type: string description: The contents of the QR code as a UTF8 string. type: type: string description: '**qrCode**' enum: - qrCode url: type: string description: Specifies the URL to redirect to. required: - type CheckoutRedirectAction: type: object additionalProperties: false properties: data: type: object additionalProperties: type: string description: When the redirect URL must be accessed via POST, use this data to post to the redirect URL. method: type: string description: Specifies the HTTP method, for example GET or POST. paymentMethodType: type: string description: Specifies the payment method. type: type: string description: '**redirect**' enum: - redirect url: type: string description: Specifies the URL to redirect to. required: - type CheckoutSDKAction: type: object additionalProperties: false properties: paymentData: type: string description: Encoded payment data. paymentMethodType: type: string description: Specifies the payment method. sdkData: type: object additionalProperties: type: string description: The data to pass to the SDK. type: type: string description: The type of the action. enum: - sdk - wechatpaySDK url: type: string description: Specifies the URL to redirect to. required: - type CheckoutSessionInstallmentOption: type: object additionalProperties: false properties: plans: type: array description: 'Defines the type of installment plan. If not set, defaults to **regular**. Possible values: * **regular** * **revolving** * **bonus** * **with_interest** * **buynow_paylater** * **nointerest_bonus** * **interest_bonus** * **refund_prctg** * **nointeres_refund_prctg** * **interes_refund_prctg**' items: type: string enum: - bonus - buynow_paylater - interes_refund_prctg - interest_bonus - nointeres_refund_prctg - nointerest_bonus - refund_prctg - regular - revolving - with_interest preselectedValue: type: integer format: int32 description: Preselected number of installments offered for this payment method. values: type: array 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: type: integer format: int32 CheckoutSessionThreeDS2RequestData: type: object additionalProperties: false properties: homePhone: $ref: '#/components/schemas/Phone' description: 'The home phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' mobilePhone: $ref: '#/components/schemas/Phone' description: 'The mobile phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' threeDSRequestorChallengeInd: type: string description: "Indicates whether a challenge is requested for this transaction.\ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\ \ \u2014 No challenge (transactional risk analysis is already performed)\n\ * **06** \u2014 Data Only" enum: - '01' - '02' - '03' - '04' - '05' - '06' workPhone: $ref: '#/components/schemas/Phone' description: 'The work phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' CheckoutThreeDS2Action: type: object additionalProperties: false properties: authorisationToken: type: string description: A token needed to authorise a payment. paymentData: type: string description: Encoded payment data. paymentMethodType: type: string description: Specifies the payment method. subtype: type: string description: A subtype of the token. token: type: string description: A token to pass to the 3DS2 Component to get the fingerprint. type: type: string description: '**threeDS2**' enum: - threeDS2 url: type: string description: Specifies the URL to redirect to. required: - type CheckoutVoucherAction: type: object additionalProperties: false properties: alternativeReference: type: string description: The voucher alternative reference code. collectionInstitutionNumber: type: string description: A collection institution number (store number) for Econtext Pay-Easy ATM. downloadUrl: type: string description: The URL to download the voucher. entity: type: string description: An entity number of Multibanco. expiresAt: type: string description: The date time of the voucher expiry. initialAmount: $ref: '#/components/schemas/Amount' description: The initial amount. instructionsUrl: type: string description: The URL to the detailed instructions to make payment using the voucher. issuer: type: string description: The issuer of the voucher. maskedTelephoneNumber: type: string description: The shopper telephone number (partially masked). merchantName: type: string description: The merchant name. merchantReference: type: string description: The merchant reference. passCreationToken: type: string description: A Base64-encoded token containing all properties of the voucher. For iOS, you can use this to pass a voucher to Apple Wallet. x-addedInVersion: '68' paymentData: type: string description: Encoded payment data. paymentMethodType: type: string description: Specifies the payment method. reference: type: string description: The voucher reference code. shopperEmail: type: string description: The shopper email. shopperName: type: string description: The shopper name. surcharge: $ref: '#/components/schemas/Amount' description: The surcharge amount. totalAmount: $ref: '#/components/schemas/Amount' description: The total amount (initial plus surcharge amount). type: type: string description: '**voucher**' enum: - voucher url: type: string description: Specifies the URL to redirect to. required: - type CommonField: type: object additionalProperties: false properties: name: type: string description: Name of the field. For example, Name of External Platform. version: type: string description: Version of the field. For example, Version of External Platform. Company: type: object additionalProperties: false properties: homepage: type: string description: The company website's home page. name: type: string description: The company name. registrationNumber: type: string description: Registration number of the company. registryLocation: type: string description: Registry location of the company. taxId: type: string description: Tax ID of the company. type: type: string description: The company type. ConfidenceScore: type: object additionalProperties: false properties: errors: type: array items: type: string score: type: number format: double CreateCheckoutSessionRequest: type: object additionalProperties: false properties: accountInfo: $ref: '#/components/schemas/AccountInfo' 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.' additionalAmount: $ref: '#/components/schemas/Amount' 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`. ' additionalData: type: object additionalProperties: type: string 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.' 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' allowedPaymentMethods: type: array 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","applepay"]`' items: type: string amount: $ref: '#/components/schemas/Amount' description: The amount of the payment. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). authenticationData: $ref: '#/components/schemas/AuthenticationData' description: Configuration data for 3DS payments. x-addedInVersion: '69' billingAddress: $ref: '#/components/schemas/BillingAddress' description: The address where to send the invoice. blockedPaymentMethods: type: array 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","applepay"]`' items: type: string captureDelayHours: type: integer format: int32 description: The delay between the authorisation and scheduled auto-capture, specified in hours. channel: type: string 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 company: $ref: '#/components/schemas/Company' description: Information regarding the company. countryCode: type: string description: The shopper's two-letter country code. dateOfBirth: type: string format: date description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' deliverAt: type: string format: date-time 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**.' deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' description: The address where the purchased goods should be delivered. enableOneClick: type: boolean description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition). enablePayOut: type: boolean description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. enableRecurring: type: boolean description: When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments. expiresAt: type: string format: date-time description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation. fundOrigin: $ref: '#/components/schemas/FundOrigin' description: The person or entity funding the money. fundRecipient: $ref: '#/components/schemas/FundRecipient' description: the person or entity receiving the money installmentOptions: type: object additionalProperties: $ref: '#/components/schemas/CheckoutSessionInstallmentOption' 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. lineItems: type: array 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 Riverty.' items: $ref: '#/components/schemas/LineItem' mandate: $ref: '#/components/schemas/Mandate' description: The mandate details to initiate recurring transaction. mcc: type: string 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. merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. merchantOrderReference: type: string 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`.' metadata: type: object 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. * Maximum 20 characters per key. * Maximum 80 characters per value. ' mode: type: string default: embedded description: 'Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration' enum: - embedded - hosted x-addedInVersion: '69' mpiData: $ref: '#/components/schemas/ThreeDSecureData' description: Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires). platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). x-addedInVersion: '70' recurringExpiry: type: string description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. recurringFrequency: type: string description: Minimum number of days between authorisations. Only for 3D Secure 2. recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\ \ A transaction for a fixed or variable amount, which follows a fixed\ \ schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile`\ \ \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile redirectFromIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. redirectToIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting to the issuer. reference: type: string description: The reference to uniquely identify a payment. returnUrl: type: string 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.example.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).\n\ Example: `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).\n\ Example: `my-app://your.package.name`\n\nIf the URL to return to includes\ \ non-ASCII characters, like spaces or special letters, URL encode the\ \ value.\n\nWe strongly recommend that you use a maximum of 1024 characters.\n\ \n> The URL must not include personally identifiable information (PII),\ \ for example name or email address." maxLength: 8000 riskData: $ref: '#/components/schemas/RiskData' description: Any risk-related settings to apply to the payment. shopperConversionId: type: string description: 'Use this if you made a `/paymentMethods` request to get the payment methods for the shopper''s checkout session. A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates.' maxLength: 256 shopperEmail: type: string description: The shopper's email address. shopperIP: type: string description: 'The shopper''s IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).' shopperInteraction: type: string 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 shopperLocale: type: string description: 'The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.' shopperName: $ref: '#/components/schemas/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. shopperReference: type: string description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.' maxLength: 256 minLength: 3 shopperStatement: type: string 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 **. , ' _ - ? + * /**." showInstallmentAmount: type: boolean description: Set to true to show the payment amount per installment. showRemovePaymentMethodButton: type: boolean description: Set to **true** to show a button that lets the shopper remove a stored payment method. socialSecurityNumber: type: string description: The shopper's social security number. splitCardFundingSources: type: boolean default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. splits: type: array description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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. storeFiltrationMode: type: string description: "Specifies how payment methods should be filtered based on\ \ the 'store' parameter:\n - 'exclusive': Only payment methods belonging\ \ to the specified 'store' are returned.\n - 'inclusive': Payment methods\ \ from the 'store' and those not associated with any other store are returned." enum: - exclusive - inclusive - skipFilter storePaymentMethod: type: boolean description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). storePaymentMethodMode: type: string description: "Indicates if the details of the payment method will be stored\ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\ \ is provided, the Drop-in/Component shows a checkbox where the shopper\ \ can select to store their payment details for card payments.\n* **enabled**\ \ \u2013 If the `shopperReference` is provided, the details will be stored\ \ without asking the shopper for consent." enum: - askForConsent - disabled - enabled x-addedInVersion: '70' telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." themeId: type: string description: Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout). The value can be any of the **Theme ID** values from your Customer Area. x-addedInVersion: '69' thirdPartyTokenRedundancyInfo: $ref: '#/components/schemas/ThirdPartyTokenRedundancyInfo' description: Configuration for creating redundant payment tokens with third-party token vaults using the Adyen Forward API. This feature requires Forward API webhook integration and pre-configured templates in your Adyen account. Contact your Adyen account manager for setup and availability. threeDS2RequestData: $ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData' 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). threeDSAuthenticationOnly: type: boolean default: false deprecated: true description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.' x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. trustedShopper: type: boolean description: Set to true if the payment should be routed to a trusted MID. required: - amount - merchantAccount - reference - returnUrl CreateCheckoutSessionResponse: type: object additionalProperties: false properties: accountInfo: $ref: '#/components/schemas/AccountInfo' 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.' additionalAmount: $ref: '#/components/schemas/Amount' 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`. ' additionalData: type: object additionalProperties: type: string 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.' 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' allowedPaymentMethods: type: array 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","applepay"]`' items: type: string amount: $ref: '#/components/schemas/Amount' description: The amount of the payment. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). authenticationData: $ref: '#/components/schemas/AuthenticationData' description: Configuration data for 3DS payments. x-addedInVersion: '69' billingAddress: $ref: '#/components/schemas/BillingAddress' description: The address where to send the invoice. blockedPaymentMethods: type: array 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","applepay"]`' items: type: string captureDelayHours: type: integer format: int32 description: The delay between the authorisation and scheduled auto-capture, specified in hours. channel: type: string 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 company: $ref: '#/components/schemas/Company' description: Information regarding the company. countryCode: type: string description: The shopper's two-letter country code. dateOfBirth: type: string format: date-time description: The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. deliverAt: type: string format: date-time 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**.' deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' description: The address where the purchased goods should be delivered. enableOneClick: type: boolean description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition). enablePayOut: type: boolean description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. enableRecurring: type: boolean description: When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments. expiresAt: type: string format: date-time description: The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation. fundOrigin: $ref: '#/components/schemas/FundOrigin' description: The person or entity funding the money. fundRecipient: $ref: '#/components/schemas/FundRecipient' description: the person or entity receiving the money id: type: string description: A unique identifier of the session. readOnly: true installmentOptions: type: object additionalProperties: $ref: '#/components/schemas/CheckoutSessionInstallmentOption' 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. lineItems: type: array 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 Riverty.' items: $ref: '#/components/schemas/LineItem' mandate: $ref: '#/components/schemas/Mandate' description: The mandate details to initiate recurring transaction. mcc: type: string 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. merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. merchantOrderReference: type: string 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`.' metadata: type: object 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. * Maximum 20 characters per key. * Maximum 80 characters per value. ' mode: type: string default: embedded description: 'Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration' enum: - embedded - hosted x-addedInVersion: '70' mpiData: $ref: '#/components/schemas/ThreeDSecureData' description: Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires). platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). x-addedInVersion: '70' recurringExpiry: type: string description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. recurringFrequency: type: string description: Minimum number of days between authorisations. Only for 3D Secure 2. recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\ \ A transaction for a fixed or variable amount, which follows a fixed\ \ schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile`\ \ \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile redirectFromIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. redirectToIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting to the issuer. reference: type: string description: The reference to uniquely identify a payment. returnUrl: type: string 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.example.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).\n\ Example: `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).\n\ Example: `my-app://your.package.name`\n\nIf the URL to return to includes\ \ non-ASCII characters, like spaces or special letters, URL encode the\ \ value.\n\nWe strongly recommend that you use a maximum of 1024 characters.\n\ \n> The URL must not include personally identifiable information (PII),\ \ for example name or email address." maxLength: 8000 riskData: $ref: '#/components/schemas/RiskData' description: Any risk-related settings to apply to the payment. sessionData: type: string description: The payment session data you need to pass to your front end. shopperEmail: type: string description: The shopper's email address. shopperIP: type: string description: 'The shopper''s IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).' shopperInteraction: type: string 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 shopperLocale: type: string description: 'The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.' shopperName: $ref: '#/components/schemas/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. shopperReference: type: string description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.' maxLength: 256 minLength: 3 shopperStatement: type: string 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 **. , ' _ - ? + * /**." showInstallmentAmount: type: boolean description: Set to true to show the payment amount per installment. showRemovePaymentMethodButton: type: boolean description: Set to **true** to show a button that lets the shopper remove a stored payment method. socialSecurityNumber: type: string description: The shopper's social security number. splitCardFundingSources: type: boolean default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. splits: type: array description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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. storeFiltrationMode: type: string description: "Specifies how payment methods should be filtered based on\ \ the 'store' parameter:\n - 'exclusive': Only payment methods belonging\ \ to the specified 'store' are returned.\n - 'inclusive': Payment methods\ \ from the 'store' and those not associated with any other store are returned." enum: - exclusive - inclusive - skipFilter storePaymentMethod: type: boolean description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). storePaymentMethodMode: type: string description: "Indicates if the details of the payment method will be stored\ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\ \ is provided, the Drop-in/Component shows a checkbox where the shopper\ \ can select to store their payment details for card payments.\n* **enabled**\ \ \u2013 If the `shopperReference` is provided, the details will be stored\ \ without asking the shopper for consent." enum: - askForConsent - disabled - enabled x-addedInVersion: '70' telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." themeId: type: string description: Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout). The value can be any of the **Theme ID** values from your Customer Area. x-addedInVersion: '69' thirdPartyTokenRedundancyInfo: $ref: '#/components/schemas/ThirdPartyTokenRedundancyInfo' description: Configuration for creating redundant payment tokens with third-party token vaults using the Adyen Forward API. This feature requires Forward API webhook integration and pre-configured templates in your Adyen account. Contact your Adyen account manager for setup and availability. threeDS2RequestData: $ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData' 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). threeDSAuthenticationOnly: type: boolean default: false deprecated: true description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.' x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. trustedShopper: type: boolean description: Set to true if the payment should be routed to a trusted MID. url: type: string description: The URL for the Hosted Checkout page. Redirect the shopper to this URL so they can make the payment. x-addedInVersion: '69' required: - amount - expiresAt - id - merchantAccount - reference - returnUrl CreateOrderRequest: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The total amount of the order. expiresAt: type: string description: 'The date when the order should expire. If not provided, the default expiry duration is 1 day. [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**.' merchantAccount: type: string description: The merchant account identifier, with which you want to process the order. reference: type: string description: A custom reference identifying the order. required: - amount - merchantAccount - reference CreateOrderResponse: type: object additionalProperties: false properties: additionalData: type: object 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**.' 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' - $ref: '#/components/schemas/ResponseAdditionalDataSwish' amount: $ref: '#/components/schemas/Amount' description: The initial amount of the order. x-addedInVersion: '68' expiresAt: type: string description: The date that the order will expire. fraudResult: $ref: '#/components/schemas/FraudResult' description: The fraud result properties of the payment. orderData: type: string description: The encrypted data that will be used by merchant for adding payments to the order. pspReference: type: string 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. reference: type: string description: The reference provided by merchant for creating the order. refusalReason: type: string 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).' remainingAmount: $ref: '#/components/schemas/Amount' description: The remaining amount in the order. resultCode: type: string description: "The result of the order creation request.\n The value is always\ \ **Success**." enum: - Success required: - amount - expiresAt - orderData - remainingAmount - resultCode DBaraiDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: dbarai description: '**dbarai**' enum: - dbarai title: DBarai DeliveryAddress: type: object additionalProperties: false properties: city: type: string description: 'The name of the city. Maximum length: 3000 characters.' maxLength: 3000 country: type: string 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`.' firstName: type: string houseNumberOrName: type: string description: 'The number or name of the house. Maximum length: 3000 characters.' maxLength: 3000 lastName: type: string postalCode: type: string 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. stateOrProvince: type: string 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.' maxLength: 1000 street: type: string 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 required: - city - country - houseNumberOrName - postalCode - street DeliveryMethod: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The cost of this delivery method. description: type: string description: The name of the delivery method as shown to the shopper. reference: type: string description: The reference of the delivery method. selected: type: boolean description: If you display the PayPal lightbox with delivery methods, set to **true** for the delivery method that is selected. Only one delivery method can be selected at a time. type: type: string description: The type of the delivery method. enum: - Shipping Destination: type: object additionalProperties: false properties: countryCode: type: string description: 'The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) or 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 * Min length: 2 characters * Max length: 3 characters * **additionalData key:** `enhancedSchemeData.destinationCountryCode`' postalCode: type: string description: 'The postal code of the destination address. * Encoding: ASCII * Max length: 10 characters * Must not start with a space. * For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000. * For Canada, it must be in 6 digits format. For example, M4B 1G5. * **additionalData key:** `enhancedSchemeData.destinationPostalCode`' stateOrProvince: type: string description: 'The state or province code of the destination address. * Encoding: ASCII * Max length: 3 characters * Must not start with a space. * **additionalData key:** `enhancedSchemeData.destinationStateProvinceCode`' DetailsRequestAuthenticationData: type: object additionalProperties: false properties: authenticationOnly: type: boolean default: false description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.' x-addedInVersion: '69' DeviceRenderOptions: type: object additionalProperties: false properties: sdkInterface: type: string default: both description: 'Supported SDK interface types. Allowed values: * native * html * both' enum: - native - html - both sdkUiType: type: array description: 'UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect' items: type: string enum: - multiSelect - otherHtml - outOfBand - singleSelect - text DirectDebitAuDetails: type: object additionalProperties: false properties: bankAccountNumber: type: string description: The shopper's banking account number used to complete payment. bankBranchCode: type: string description: The shopper's BSB (their bank's branch code) number used to complete payment. checkoutAttemptId: type: string description: The checkout attempt identifier. holderName: type: string description: The name of the bank account holder. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: directdebit_AU description: '**directdebit_AU**' enum: - directdebit_AU title: DirectDebitAu DokuDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. firstName: type: string description: The shopper's first name. lastName: type: string description: The shopper's last name. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperEmail: type: string description: The shopper's email. type: type: string 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 required: - firstName - lastName - shopperEmail - type title: Doku Donation: type: object additionalProperties: false properties: currency: type: string description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/). donationType: type: string description: 'The [type of donation](https://docs.adyen.com/online-payments/donations/#donation-types). Possible values: * **roundup**: a donation where the original transaction amount is rounded up as a donation. * **fixedAmounts**: a donation where you show fixed donations amounts that the shopper can select from.' maxRoundupAmount: type: integer format: int64 description: The maximum amount a transaction can be rounded up to make a donation. This field is only present when `donationType` is **roundup**. type: type: string description: 'The [type of donation](https://docs.adyen.com/online-payments/donations/#donation-types). Possible values: * **roundup**: a donation where the original transaction amount is rounded up as a donation. * **fixedAmounts**: a donation where you show fixed donation amounts that the shopper can select from.' values: type: array description: The fixed donation amounts in [minor units](https://docs.adyen.com/development-resources/currency-codes//#minor-units). This field is only present when `donationType` is **fixedAmounts**. items: type: integer format: int64 required: - currency - donationType - type DonationCampaign: type: object additionalProperties: false properties: amounts: $ref: '#/components/schemas/Amounts' description: The object that contains the fixed donation amounts that the shopper can select from. bannerUrl: type: string description: The URL for the banner of the nonprofit or campaign. campaignName: type: string description: The name of the donation campaign.. causeName: type: string description: The cause of the nonprofit. donation: $ref: '#/components/schemas/Donation' description: The object that contains the details of the donation. id: type: string description: The unique campaign ID of the donation campaign. logoUrl: type: string description: The URL for the logo of the nonprofit. nonprofitDescription: type: string description: The description of the nonprofit. nonprofitName: type: string description: The name of the nonprofit organization that receives the donation. nonprofitUrl: type: string description: The website URL of the nonprofit. termsAndConditionsUrl: type: string description: The URL of the terms and conditions page of the nonprofit and the campaign. DonationCampaignsRequest: type: object additionalProperties: false properties: currency: type: string description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes/). locale: type: string description: Locale on the shopper interaction device. merchantAccount: type: string description: Your merchant account identifier. store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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. required: - currency - merchantAccount DonationCampaignsResponse: type: object additionalProperties: false properties: donationCampaigns: type: array description: List of active donation campaigns for your merchant account. items: $ref: '#/components/schemas/DonationCampaign' DonationPaymentRequest: type: object additionalProperties: false properties: accountInfo: $ref: '#/components/schemas/AccountInfo' 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.' x-addedInVersion: '40' additionalData: type: object additionalProperties: type: string 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.' 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' amount: $ref: '#/components/schemas/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). applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). x-addedInVersion: '40' authenticationData: $ref: '#/components/schemas/AuthenticationData' description: Data for 3DS authentication. x-addedInVersion: '69' billingAddress: $ref: '#/components/schemas/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.' browserInfo: $ref: '#/components/schemas/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 2 redirect.' channel: type: string 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 checkoutAttemptId: type: string description: Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. conversionId: type: string deprecated: true description: Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. x-addedInVersion: '49' x-deprecatedInVersion: '68' x-deprecatedMessage: Use `checkoutAttemptId` instead countryCode: type: string description: 'The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE' maxLength: 100 dateOfBirth: type: string format: date-time description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' deliverAt: type: string format: date-time 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' x-addedInVersion: '70' deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' description: The address where the purchased goods should be delivered. deviceFingerprint: type: string 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 donationAccount: type: string description: Donation account to which the transaction is credited. donationCampaignId: type: string description: The donation campaign ID received in the `/donationCampaigns` call. x-addedInVersion: '67' donationOriginalPspReference: type: string description: PSP reference of the transaction from which the donation token is generated. Required when `donationToken` is provided. donationToken: type: string description: Donation token received in the `/payments` call. lineItems: type: array 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 Riverty.' items: $ref: '#/components/schemas/LineItem' x-addedInVersion: '32' merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. merchantRiskIndicator: $ref: '#/components/schemas/MerchantRiskIndicator' 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.' x-addedInVersion: '40' metadata: type: object 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. ' mpiData: $ref: '#/components/schemas/ThreeDSecureData' description: Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires). origin: type: string description: '> Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.' maxLength: 80 x-addedInVersion: '40' paymentMethod: description: 'The type and required details of a payment method to use. When `donationToken` is provided, the payment method is derived from the token and this field becomes optional. If you are [PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide), and make donations using raw card details, you must explicitly provide the payment method details.' discriminator: propertyName: type mapping: applepay: '#/components/schemas/ApplePayDonations' paywithgoogle: '#/components/schemas/PayWithGoogleDonations' googlepay: '#/components/schemas/GooglePayDonations' scheme: '#/components/schemas/CardDonations' networkToken: '#/components/schemas/CardDonations' ideal: '#/components/schemas/IdealDonations' sepadirectdebit: '#/components/schemas/SepaDirectDebitDonations' card: '#/components/schemas/CardDonations' oneOf: - $ref: '#/components/schemas/ApplePayDonations' - $ref: '#/components/schemas/CardDonations' - $ref: '#/components/schemas/GooglePayDonations' - $ref: '#/components/schemas/IdealDonations' - $ref: '#/components/schemas/PayWithGoogleDonations' - $ref: '#/components/schemas/SepaDirectDebitDonations' recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ \ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile` \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile x-addedInVersion: '32' redirectFromIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. x-addedInVersion: '32' redirectToIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting to the issuer. x-addedInVersion: '32' reference: type: string 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.' returnUrl: type: string 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.example.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).\n\ Example: `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).\n\ Example: `my-app://your.package.name`\n\nIf the URL to return to includes\ \ non-ASCII characters, like spaces or special letters, URL encode the\ \ value.\n\nWe strongly recommend that you use a maximum of 1024 characters.\n\ \n> The URL must not include personally identifiable information (PII),\ \ for example name or email address." maxLength: 8000 sessionValidity: type: string 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' shopperEmail: type: string description: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. shopperIP: type: string description: 'The shopper''s IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).' maxLength: 1000 shopperInteraction: type: string 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 authorization 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 authorization (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 shopperLocale: type: string description: 'The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.' shopperName: $ref: '#/components/schemas/ShopperName' description: The shopper's full name. shopperReference: type: string 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 socialSecurityNumber: type: string description: The shopper's social security number. store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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 telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." threeDS2RequestData: $ref: '#/components/schemas/ThreeDS2RequestFields' 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. x-addedInVersion: '40' threeDSAuthenticationOnly: type: boolean default: false deprecated: true description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**.' x-addedInVersion: '50' x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. required: - amount - merchantAccount - reference - returnUrl DonationPaymentResponse: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: Authorised amount in the transaction. donationAccount: type: string description: The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding). id: type: string description: Your unique resource identifier. merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. payment: $ref: '#/components/schemas/PaymentResponse' description: Action to be taken for completing the payment. reference: type: string 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.' status: type: string description: 'The status of the donation transaction. Possible values: * **completed** * **pending** * **refused**' enum: - completed - pending - refused DragonpayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperEmail: type: string description: "The shopper\u2019s email address." type: type: string description: '**dragonpay**' enum: - dragonpay_ebanking - dragonpay_otc_banking - dragonpay_otc_non_banking - dragonpay_otc_philippines required: - issuer - type title: Dragonpay EBankingFinlandDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The Ebanking Finland issuer value of the shopper's selected bank. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: ebanking_FI description: '**ebanking_FI**' enum: - ebanking_FI required: - type title: E-Banking Finland EcontextVoucherDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. firstName: type: string description: The shopper's first name. lastName: type: string description: The shopper's last name. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperEmail: type: string description: The shopper's email. telephoneNumber: type: string 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: type: string description: '**econtextvoucher**' enum: - econtext_seven_eleven - econtext_online - econtext - econtext_stores - econtext_atm required: - firstName - lastName - shopperEmail - telephoneNumber - type title: Voucher EftDetails: type: object additionalProperties: false properties: bankAccountNumber: type: string description: The bank account number (without separators). bankCode: type: string description: The financial institution code. bankLocationId: type: string description: The bank routing number of the account. checkoutAttemptId: type: string description: The checkout attempt identifier. ownerName: type: string description: "The name of the bank account holder.\nIf 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:\n* \u03C712 is converted to ch12.\n* \xFCA is converted to\ \ euA.\n* Peter M\xF8ller is converted to Peter Mller, because banks don't\ \ accept '\xF8'.\nAfter 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:\n* John17 -\ \ allowed.\n* J17 - allowed.\n* 171 - not allowed.\n* John-7 - allowed.\n\ > If provided details don't match the required format, the response returns\ \ the error message: 203 'Invalid bank account holder name'." recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: eft_directdebit_CA description: '**eft**' enum: - eft_directdebit_CA title: EFT Direct Debit EncryptedOrderData: type: object additionalProperties: false properties: orderData: type: string description: The encrypted order data. maxLength: 5000 pspReference: type: string description: The `pspReference` that belongs to the order. required: - orderData - pspReference EnhancedSchemeData: type: object additionalProperties: false properties: airline: $ref: '#/components/schemas/Airline' description: '[Airline enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/airline/) that may be required for processing the transaction and/or for interchange savings.' carRental: $ref: '#/components/schemas/CarRental' description: '[Car rental enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/car-rental/) that may be required for processing the transaction and/or for interchange savings.' levelTwoThree: $ref: '#/components/schemas/LevelTwoThree' description: '[Level 2 and Level 3 enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/l2-l3/) that may be required for processing the transaction and/or for interchange savings.' lodging: $ref: '#/components/schemas/Lodging' description: '[Lodging enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/lodging/) that may be required for processing the transaction and/or for interchange savings.' temporaryServices: $ref: '#/components/schemas/TemporaryServices' description: '[Temporary services enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/temporary-services/) that may be required for processing the transaction and/or for interchange savings.' ExternalPlatform: type: object additionalProperties: false properties: integrator: type: string description: External platform integrator. name: type: string description: Name of the field. For example, Name of External Platform. version: type: string description: Version of the field. For example, Version of External Platform. ExternalTokenDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. expiryMonth: type: string 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). expiryYear: type: string 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). holderName: type: string description: The name of the card holder. maxLength: 15000 number: type: string 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). storedPaymentMethodId: type: string description: Identifier used to fetch the token from the external service maxLength: 64 x-addedInVersion: '49' subtype: type: string description: The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature. enum: - hilton type: type: string default: externalToken description: 'The type of token. Allowed value: **externalToken**.' enum: - externalToken required: - storedPaymentMethodId - subtype - type title: Details of tokens that are not stored with Adyen. FastlaneDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fastlaneData: type: string description: The encoded fastlane data blob recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: fastlane description: '**fastlane**' enum: - fastlane required: - fastlaneData - type title: Fastlane Folio: type: object additionalProperties: false properties: cashAdvances: type: integer format: int64 description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `lodging.folioCashAdvances`' number: type: string description: 'The card acceptor''s internal invoice or billing ID reference number. * Format: Alphanumeric * Must not start with a space * Must not contain any special characters * Must not be all zeros. * **additionalData key:** `lodging.folioNumber`' ForexQuote: type: object additionalProperties: false properties: account: type: string description: The account name. accountType: type: string description: The account type. baseAmount: $ref: '#/components/schemas/Amount' description: The base amount. basePoints: type: integer format: int32 description: The base points. buy: $ref: '#/components/schemas/Amount' description: The buy rate. interbank: $ref: '#/components/schemas/Amount' description: The interbank amount. reference: type: string description: The reference assigned to the forex quote request. sell: $ref: '#/components/schemas/Amount' description: The sell rate. signature: type: string description: The signature to validate the integrity. source: type: string description: The source of the forex quote. type: type: string description: The type of forex. validTill: type: string format: date-time description: The date until which the forex quote is valid. required: - basePoints - validTill FraudCheckResult: type: object additionalProperties: false properties: accountScore: type: integer format: int32 description: The fraud score generated by the risk check. checkId: type: integer format: int32 description: The ID of the risk check. name: type: string description: The name of the risk check. required: - accountScore - checkId - name FraudResult: type: object additionalProperties: false properties: accountScore: type: integer format: int32 description: The total fraud score generated by the risk checks. results: type: array description: The result of the individual risk checks. items: $ref: '#/components/schemas/FraudCheckResult' required: - accountScore FundOrigin: type: object additionalProperties: false properties: billingAddress: $ref: '#/components/schemas/Address' description: The address where to send the invoice. shopperEmail: type: string description: The email address of the person funding the money. shopperName: $ref: '#/components/schemas/Name' description: The name of the person funding the money. telephoneNumber: type: string description: The phone number of the person funding the money. walletIdentifier: type: string description: The unique identifier of the wallet where the funds are coming from. FundRecipient: type: object additionalProperties: false properties: IBAN: type: string description: The IBAN of the bank account where the funds are being transferred to. billingAddress: $ref: '#/components/schemas/Address' description: The address where to send the invoice. paymentMethod: $ref: '#/components/schemas/CardDetails' description: The payment method used by the shopper. shopperEmail: type: string description: The email address of the shopper. shopperName: $ref: '#/components/schemas/Name' description: The name of the shopper. shopperReference: type: string description: "Required for recurring payments. \nYour reference to uniquely\ \ identify this shopper, for example user ID or account ID. The value\ \ is case-sensitive and must be at least three characters.\n> Your reference\ \ must not include personally identifiable information (PII) such as name\ \ or email address." maxLength: 256 minLength: 3 storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 subMerchant: $ref: '#/components/schemas/SubMerchant' description: 'Required for back-to-back/purchase-driven-load transactions, where the funds are taken from the shopper''s stored card when the wallet balance is insufficient. The final merchant who will receive the money, also known as a [sub-merchant](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#submerchant).' telephoneNumber: type: string description: The telephone number of the shopper. walletIdentifier: type: string description: The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. walletOwnerTaxId: type: string description: The tax identifier of the person receiving the funds. walletPurpose: type: string description: The purpose of a digital wallet transaction. enum: - identifiedBoleto - transferDifferentWallet - transferOwnWallet - transferSameWallet - unidentifiedBoleto GenericIssuerPaymentMethodDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The issuer id of the shopper's selected bank. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string description: '**genericissuer**' enum: - onlineBanking_PL - eps - onlineBanking_SK - onlineBanking_CZ - onlinebanking_IN required: - issuer - type title: Stored Payment Method GooglePayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid googlePayCardNetwork: type: string description: 'The selected payment card network. ' googlePayToken: type: string description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. maxLength: 10000 recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' threeDS2SdkVersion: type: string description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. maxLength: 12 type: type: string default: googlepay description: '**googlepay**, **paywithgoogle**' enum: - googlepay required: - googlePayToken title: Google Pay GooglePayDonations: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid googlePayCardNetwork: type: string description: 'The selected payment card network. ' googlePayToken: type: string description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. maxLength: 10000 recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' threeDS2SdkVersion: type: string description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. maxLength: 12 type: type: string default: googlepay description: '**googlepay**, **paywithgoogle**' enum: - googlepay required: - googlePayToken title: Google Pay IdealDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: ideal description: '**ideal**' enum: - ideal title: iDEAL IdealDonations: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: ideal description: '**ideal**' enum: - ideal title: iDEAL InputDetail: type: object additionalProperties: false properties: configuration: type: object additionalProperties: type: string description: Configuration parameters for the required input. details: type: array description: Input details can also be provided recursively. items: $ref: '#/components/schemas/SubInputDetail' inputDetails: type: array deprecated: true description: Input details can also be provided recursively (deprecated). items: $ref: '#/components/schemas/SubInputDetail' itemSearchUrl: type: string description: In case of a select, the URL from which to query the items. items: type: array description: In case of a select, the items to choose from. items: $ref: '#/components/schemas/Item' key: type: string description: The value to provide in the result. optional: type: boolean description: True if this input value is optional. type: type: string description: The type of the required input. value: type: string description: The value can be pre-filled, if available. InstallmentOption: type: object additionalProperties: false properties: maxValue: type: integer format: int32 description: The maximum number of installments offered for this payment method. plans: type: array description: 'Defines the type of installment plan. If not set, defaults to **regular**. Possible values: * **regular** * **revolving**' items: type: string enum: - bonus - buynow_paylater - interes_refund_prctg - interest_bonus - nointeres_refund_prctg - nointerest_bonus - refund_prctg - regular - revolving - with_interest x-addedInVersion: '64' preselectedValue: type: integer format: int32 description: Preselected number of installments offered for this payment method. x-addedInVersion: '64' values: type: array 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: type: integer format: int32 x-addedInVersion: '64' Installments: type: object additionalProperties: false properties: extra: type: integer format: int32 description: 'Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for [card installments in Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico) ' x-addedInVersion: '68' plan: type: string description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico). By default, this is set to **regular**. ' enum: - bonus - buynow_paylater - interes_refund_prctg - interest_bonus - nointeres_refund_prctg - nointerest_bonus - refund_prctg - regular - revolving - with_interest x-addedInVersion: '64' value: type: integer format: int32 description: 'Defines the number of installments. 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. This value can be zero for Installments processed in Mexico.' required: - value Item: type: object additionalProperties: false properties: id: type: string description: The value to provide in the result. name: type: string description: The display name. ItemDetailLine: type: object additionalProperties: false properties: commodityCode: type: string description: 'The code that identifies the item in a standardized commodity coding scheme. There are different commodity coding schemes: * [UNSPSC commodity codes](https://www.ungm.org/public/unspsc) * [HS commodity codes](https://www.wcoomd.org/en/topics/nomenclature/overview.aspx) * [NAICS commodity codes](https://www.census.gov/naics/) * [NAPCS commodity codes](https://www.census.gov/naics/napcs/) * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `enhancedSchemeData.itemDetailLine[N].commodityCode`' description: type: string description: "A description of the item, that provides details about the\ \ purchase.\n\n For Visa transactions with level 3 ESD, the description\ \ must not be the same or very similar to your merchant name, or, consist\ \ only of common words like \"product\", or \"service\".\n* Encoding:\ \ ASCII\n* Max length: 26 characters\n* Must not be a single character.\n\ * Must not be blank.\n* Must not be all special characters.\n* Must not\ \ start with a space or be all spaces.\n* Must not be all zeros.\n* **additionalData\ \ key:** `enhancedSchemeData.itemDetailLine[N].description`" discountAmount: type: integer format: int64 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 value: 10000000000 * **additionalData key:** `enhancedSchemeData.itemDetailLine[N].discountAmount`' productCode: type: string description: "The product code. Must be a unique product code associated\ \ with the item or service. This can be your unique code for the item,\ \ or the manufacturer's product code. \n* Encoding: ASCII.\n* Max length:\ \ 12 characters\n* **additionalData key:** `enhancedSchemeData.itemDetailLine[N].productCode`" quantity: type: integer format: int64 description: 'The number of items. Must be an integer greater than zero. * Encoding: Numeric * Max value: 9999 * **additionalData key:** `enhancedSchemeData.itemDetailLine[N].quantity`' totalAmount: type: integer format: int64 description: 'The total amount for the line item, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 See [Amount requirements for level 2/3 ESD](https://docs.adyen.com//payment-methods/cards/enhanced-scheme-data/l2-l3#amount-requirements) to learn more about how to calculate the line item total. * **additionalData key:** `enhancedSchemeData.itemDetailLine[N].totalAmount`' unitOfMeasure: type: string description: 'The unit of measurement for an item. * Encoding: ASCII * Max length: 3 characters * **additionalData key:** `enhancedSchemeData.itemDetailLine[N].unitOfMeasure`' unitPrice: type: integer format: int64 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 value: 10000000000 * **additionalData key:** `enhancedSchemeData.itemDetailLine[N].unitPrice`' KlarnaDetails: type: object additionalProperties: false properties: billingAddress: type: string description: The address where to send the invoice. checkoutAttemptId: type: string description: The checkout attempt identifier. deliveryAddress: type: string description: The address where the goods should be delivered. personalDetails: type: string description: Shopper name, date of birth, phone number, and email address. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' subtype: type: string description: The type of flow to initiate. type: type: string default: klarna description: '**klarna**' enum: - klarna - klarnapayments - klarnapayments_account - klarnapayments_b2b - klarna_paynow - klarna_account - klarna_b2b required: - type title: Klarna KlarnaNetworkDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. klarnaNetworkData: type: string description: A string containing a structured JSON object. This is a passthrough field used to enable custom features or data exchange with Klarna. maxLength: 10240 klarnaNetworkSessionToken: type: string description: The token obtained from the Klarna SDK during an Express Checkout flow. maxLength: 10240 recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: klarna_network description: '**klarna_network**' enum: - klarna_network required: - type title: KlarnaNetwork Leg: type: object additionalProperties: false properties: carrierCode: type: string 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 start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.leg[N].carrier_code`' classOfTravel: type: string 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 start with a space or be all spaces.\n\ * Must not be all zeros.\n* **additionalData key:** `airline.leg[N].class_of_travel`" dateOfTravel: type: string format: date-time description: 'Date and time of travel in format `yyyy-MM-ddTHH:mm`. * Use local time of departure airport. * minLength: 16 characters * maxLength: 16 characters * **additionalData key:** `airline.leg[N].date_of_travel`' departureAirportCode: type: string 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 start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.leg[N].depart_airport`' departureTax: type: integer format: int64 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: 11 * Must not be all zeros. * **additionalData key:** `airline.leg[N].depart_tax`' destinationAirportCode: type: string 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 start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.leg[N].destination_code`' fareBasisCode: type: string description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric. * minLength: 1 character * maxLength: 15 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.leg[N].fare_base_code`' flightNumber: type: string description: 'The flight identifier. * minLength: 1 character * maxLength: 5 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.leg[N].flight_number`' stopOverCode: type: string 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 * **additionalData key:** `airline.leg[N].stop_over_code`' LevelTwoThree: type: object additionalProperties: false properties: customerReferenceNumber: type: string description: 'The reference number to identify the customer and their order. * Format: ASCII * Max length: 25 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `enhancedSchemeData.customerReference`' destination: $ref: '#/components/schemas/Destination' description: The destination address information. dutyAmount: type: integer format: int64 description: 'The duty tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `enhancedSchemeData.dutyAmount`' freightAmount: type: integer format: int64 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 value: 10000000000 * **additionalData key:** `enhancedSchemeData.freightAmount`' itemDetailLines: type: array description: The list of item detail lines. items: $ref: '#/components/schemas/ItemDetailLine' orderDate: type: string format: date description: 'The date of the order. * Min Length: 10 characters * Max Length: 10 characters * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `enhancedSchemeData.orderDate`' shipFromPostalCode: type: string description: 'The postal code of the address where the item is shipped from. * Encoding: ASCII * Max length: 10 characters * For the US, it must be in five or nine digits format. For example, 10001 or 10001-0000. * For Canada, it must be in 6 digits format. For example, M4B 1G5. * **additionalData key:** `enhancedSchemeData.shipFromPostalCode`' totalTaxAmount: type: integer format: int64 description: "The amount of state or provincial [tax included in the total\ \ transaction amount](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/l2-l3#requirements-to-send-level-2-3-esd),\ \ in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\ * For example, 2000 means USD 20.00.\n* Encoding: Numeric\n* Max value:\ \ 10000000000\n* For L2 data: must not be all zeroes. \n* For L3 data:\ \ can be zero.\n* **additionalData key:** `enhancedSchemeData.totalTaxAmount`" LineItem: type: object additionalProperties: false properties: amountExcludingTax: type: integer format: int64 description: Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). amountIncludingTax: type: integer format: int64 description: Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). brand: type: string description: Brand of the item. x-addedInVersion: '70' color: type: string description: Color of the item. x-addedInVersion: '70' description: type: string description: Description of the line item. maxLength: 10000 id: type: string description: ID of the line item. imageUrl: type: string description: Link to the picture of the purchased item. itemCategory: type: string description: Item category, used by the payment methods PayPal and Ratepay. manufacturer: type: string description: Manufacturer of the item. x-addedInVersion: '70' marketplaceSellerId: type: string description: Marketplace seller id. x-addedInVersion: '70' productUrl: type: string description: Link to the purchased item. quantity: type: integer format: int64 description: Number of items. receiverEmail: type: string description: Email associated with the given product in the basket (usually in electronic gift cards). x-addedInVersion: '70' size: type: string description: Size of the item. x-addedInVersion: '70' sku: type: string description: Stock keeping unit. x-addedInVersion: '70' taxAmount: type: integer format: int64 description: Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). taxPercentage: type: integer format: int64 description: "Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point)\ \ integer. For example:\n - **530** for 5.3% (five point three percent)\ \ \n - **2100** for 21% (twenty-one percent)" upc: type: string description: Universal Product Code. x-addedInVersion: '70' ListStoredPaymentMethodsResponse: type: object additionalProperties: false properties: merchantAccount: type: string description: Your merchant account. shopperReference: 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.' storedPaymentMethods: type: array description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethodResource' Lodging: type: object additionalProperties: false properties: checkInDate: type: string format: date description: 'The check-in date. * Min Length: 10 characters * Max Length: 10 characters * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `lodging.checkInDate`' checkOutDate: type: string format: date description: 'The check-out date. * Min Length: 10 characters * Max Length: 10 characters * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `lodging.checkOutDate`' customerServicePhoneNumber: type: string description: 'The toll-free phone number for the lodging customer service. * Format: Alphanumeric * 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. * **additionalData key:** `lodging.customerServiceTollFreeNumber`' fireSafetyCompliance: type: boolean description: 'Indicates that the facility complies with the Hotel and Motel Fire Safety Act of 1990. * **additionalData key:** `lodging.fireSafetyActIndicator`' folio: $ref: '#/components/schemas/Folio' description: The folio information for the booking. foodBeverageCharges: type: integer format: int64 description: 'Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `lodging.foodBeverageCharges`' lodgingChargeType: type: string description: 'The category of lodging charges for the payment. * **additionalData key:** `lodging.specialProgramCode`' enum: - advanceDeposit - noShow - stay noShow: type: boolean description: 'Indicates if the customer didn''t check in for their booking. * **additionalData key:** `lodging.noShowIndicator`' prepaidExpenses: type: integer format: int64 description: 'The prepaid expenses for the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `lodging.prepaidExpenses`' propertyPhoneNumber: type: string description: 'The lodging property location''s phone number. * Format: Alphanumeric * Min length: 10 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. * **additionalData key:** `lodging.propertyPhoneNumber`' renterName: type: string description: 'The name of the person renting the room. * Format: ASCII * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `lodging.renterName`' rooms: type: array description: The list of rooms booked. items: $ref: '#/components/schemas/Room' totalRoomTax: type: integer format: int64 description: 'The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `lodging.totalRoomTax`' totalTax: type: integer format: int64 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 value: 10000000000 * **additionalData key:** `lodging.totalTax`' Mandate: type: object additionalProperties: false properties: amount: type: string description: The billing amount (in minor units) of the recurring transactions. amountRule: type: string 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 billingAttemptsRule: type: string 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 billingDay: type: string 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`.' count: type: string description: The number of transactions that can be performed within the given frequency. endsAt: type: string description: End date of the billing plan, in YYYY-MM-DD format. frequency: type: string description: 'The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.' enum: - adhoc - daily - weekly - biWeekly - monthly - quarterly - halfYearly - yearly remarks: type: string description: The message shown by UPI to the shopper on the approval screen. startsAt: type: string description: Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. required: - amount - endsAt - frequency MasterpassDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid masterpassTransactionId: type: string description: The Masterpass transaction ID. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: masterpass description: '**masterpass**' enum: - masterpass required: - masterpassTransactionId title: Masterpass MbwayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperEmail: type: string description: '' telephoneNumber: type: string description: '' type: type: string default: mbway description: '**mbway**' enum: - mbway required: - shopperEmail - telephoneNumber title: MBWay MerchantDevice: type: object additionalProperties: false properties: os: type: string description: Operating system running on the merchant device. osVersion: type: string description: Version of the operating system on the merchant device. reference: type: string description: Merchant device reference. MerchantRiskIndicator: type: object additionalProperties: false properties: addressMatch: type: boolean description: Whether the chosen delivery address is identical to the billing address. deliveryAddressIndicator: type: string description: 'Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other`' enum: - shipToBillingAddress - shipToVerifiedAddress - shipToNewAddress - shipToStore - digitalGoods - goodsNotShipped - other deliveryEmail: type: string deprecated: true description: The delivery email address (for digital goods). x-deprecatedInVersion: '68' x-deprecatedMessage: Use `deliveryEmailAddress` instead. deliveryEmailAddress: type: string description: 'For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters.' maxLength: 254 x-addedInVersion: '68' deliveryTimeframe: type: string description: 'The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping`' enum: - electronicDelivery - sameDayShipping - overnightShipping - twoOrMoreDaysShipping giftCardAmount: $ref: '#/components/schemas/Amount' description: For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s). giftCardCount: type: integer format: int32 description: For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. giftCardCurr: type: string 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. x-addedInVersion: '68' preOrderDate: type: string format: date-time description: For pre-order purchases, the expected date this product will be available to the shopper. preOrderPurchase: type: boolean description: Indicator for whether this transaction is for pre-ordering a product. preOrderPurchaseInd: type: string description: Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. x-addedInVersion: '68' reorderItems: type: boolean description: Indicator for whether the shopper has already purchased the same items in the past. reorderItemsInd: type: string description: Indicates whether the cardholder is reordering previously purchased merchandise. x-addedInVersion: '68' shipIndicator: type: string description: Indicates shipping method chosen for the transaction. x-addedInVersion: '68' MobilePayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: mobilepay description: '**mobilepay**' enum: - mobilepay title: MobilePay MolPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The shopper's bank. Specify this with the issuer value that corresponds to this bank. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string description: '**molpay**' enum: - molpay_ebanking_fpx_MY - molpay_ebanking_TH required: - issuer - type title: MOLPay Name: type: object additionalProperties: false properties: firstName: type: string description: The first name. maxLength: 80 lastName: type: string description: The last name. maxLength: 80 required: - firstName - lastName OpenInvoiceDetails: type: object additionalProperties: false properties: billingAddress: type: string description: The address where to send the invoice. checkoutAttemptId: type: string description: The checkout attempt identifier. deliveryAddress: type: string description: The address where the goods should be delivered. personalDetails: type: string description: Shopper name, date of birth, phone number, and email address. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: openinvoice description: '**openinvoice**' enum: - openinvoice - afterpay_directdebit - atome_pos title: Open Invoice Passenger: type: object additionalProperties: false properties: dateOfBirth: type: string format: date description: 'The passenger''s date of birth. * Format `yyyy-MM-dd` * minLength: 10 * maxLength: 10 * **additionalData key:** `airline.passenger[N].date_of_birth`' firstName: type: string description: 'The passenger''s first name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII * **additionalData key:** `airline.passenger[N].first_name`' lastName: type: string description: 'The passenger''s last name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII * **additionalData key:** `airline.passenger[N].last_name`' phoneNumber: type: string description: 'The passenger''s phone number, including country code. This is an alphanumeric field that can include the ''+'' and ''-'' signs. * Encoding: ASCII * minLength: 3 characters * maxLength: 30 characters * **additionalData key:** `airline.passenger[N].phone_number`' travellerType: type: string description: 'The IATA passenger type code (PTC). * Encoding: ASCII * minLength: 3 characters * maxLength: 6 characters * **additionalData key:** `airline.passenger[N].traveller_type`' PayByBankAISDirectDebitDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: paybybank_AIS_DD description: '**paybybank_AIS_DD**' enum: - paybybank_AIS_DD required: - type title: Pay By Bank AIS Direct Debit PayByBankDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. issuer: type: string description: The PayByBank issuer value of the shopper's selected bank. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: paybybank description: '**paybybank**' enum: - paybybank required: - type title: PayByBank PayPalDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. orderID: type: string description: The unique ID associated with the order. payeePreferred: type: string description: IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED payerID: type: string description: The unique ID associated with the payer. payerSelected: type: string description: PAYPAL or PAYPAL_CREDIT recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' subtype: type: string description: The type of flow to initiate. enum: - express - redirect - sdk type: type: string default: paypal description: '**paypal**' enum: - paypal required: - type title: PayPal PayPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: paypay description: '**paypay**' enum: - paypay title: PayPay PayToDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperAccountIdentifier: type: string description: The shopper's banking details or payId reference, used to complete payment. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: payto description: '**payto**' enum: - payto title: PayTo PayUUpiDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperNotificationReference: type: string description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: payu_IN_upi description: '**payu_IN_upi**' enum: - payu_IN_upi virtualPaymentAddress: type: string description: The virtual payment address for UPI. required: - type title: PayU PayWithGoogleDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid googlePayToken: type: string description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. maxLength: 5000 recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' threeDS2SdkVersion: type: string description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. maxLength: 12 type: type: string default: paywithgoogle description: '**paywithgoogle**' enum: - paywithgoogle required: - googlePayToken title: Google Pay PayWithGoogleDonations: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid googlePayToken: type: string description: The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. maxLength: 5000 recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' threeDS2SdkVersion: type: string description: Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. maxLength: 12 type: type: string default: paywithgoogle description: '**paywithgoogle**' enum: - paywithgoogle required: - googlePayToken title: Google Pay Payment: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: Authorised amount in the transaction. paymentMethod: $ref: '#/components/schemas/ResponsePaymentMethod' description: "Only returned for `resultCode`: **Authorised**. \nDetails\ \ about the payment method used in the transaction." pspReference: type: string description: Adyen's 16-character reference associated with the transaction/request. This value is globally unique. Use this reference when you communicate with us about this request. resultCode: type: string description: "The result of the payment. For more information, see [Result\ \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ \nPossible values:\n\n* **Authorised** \u2013 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.\n* **Received** \u2013\ \ Indicates the payment request was successfully received by Adyen, and\ \ will be processed. This is the initial state for all payments.\n* **Pending**\ \ \u2013 The payment order was successfully received but the final status\ \ of the payment is not available yet. This is common for payment methods\ \ with an asynchronous flow." enum: - Authorised - Received - Pending PaymentAmountUpdateRequest: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The updated amount. The `currency` must match the currency used in authorisation. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: Enhanced scheme data that may be required for processing the payment. For example, airline information. x-addedInVersion: '70' industryUsage: type: string description: "The reason for the amount update. Possible values: \n* **delayedCharge**\ \ \n* **noShow** \n* **installment**" enum: - delayedCharge - installment - noShow x-addedInVersion: '70' lineItems: type: array 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' x-addedInVersion: '70' merchantAccount: type: string description: The merchant account that is used to process the payment. reference: type: string description: 'Your reference for the amount update request. Maximum length: 80 characters.' splits: type: array description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/process-payments) or [platforms](https://docs.adyen.com/platforms/process-payments). items: $ref: '#/components/schemas/Split' required: - amount - merchantAccount PaymentAmountUpdateResponse: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The updated amount. industryUsage: type: string description: "The reason for the amount update. Possible values: \n* **delayedCharge**\ \ \n* **noShow** \n* **installment**" enum: - delayedCharge - installment - noShow x-addedInVersion: '70' lineItems: type: array 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' x-addedInVersion: '71' merchantAccount: type: string description: The merchant account that is used to process the payment. paymentPspReference: type: string description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to update. ' pspReference: type: string description: Adyen's 16-character reference associated with the amount update request. reference: type: string description: 'Your reference for the amount update request. Maximum length: 80 characters.' splits: type: array description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/process-payments) or [platforms](https://docs.adyen.com/platforms/process-payments). items: $ref: '#/components/schemas/Split' status: type: string description: The status of your request. This will always have the value **received**. enum: - received required: - amount - merchantAccount - paymentPspReference - pspReference - reference - status PaymentCancelRequest: type: object additionalProperties: false properties: applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: Enhanced scheme data that may be required for processing the payment. For example, airline information. x-addedInVersion: '70' merchantAccount: type: string description: The merchant account that is used to process the payment. reference: type: string description: 'Your reference for the cancel request. Maximum length: 80 characters.' required: - merchantAccount PaymentCancelResponse: type: object additionalProperties: false properties: merchantAccount: type: string description: The merchant account that is used to process the payment. paymentPspReference: type: string description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to cancel. ' pspReference: type: string description: Adyen's 16-character reference associated with the cancel request. reference: type: string description: Your reference for the cancel request. status: type: string description: The status of your request. This will always have the value **received**. enum: - received required: - merchantAccount - paymentPspReference - pspReference - status PaymentCaptureRequest: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/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. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: Enhanced scheme data that may be required for processing the payment. For example, airline information. x-addedInVersion: '70' lineItems: type: array 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' merchantAccount: type: string description: The merchant account that is used to process the payment. platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). x-addedInVersion: '70' reference: type: string description: 'Your reference for the capture request. Maximum length: 80 characters.' splits: type: array description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/). items: $ref: '#/components/schemas/Split' subMerchants: type: array description: A List of sub-merchants. items: $ref: '#/components/schemas/SubMerchantInfo' x-addedInVersion: '70' required: - amount - merchantAccount PaymentCaptureResponse: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The captured amount. lineItems: type: array 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' merchantAccount: type: string description: The merchant account that is used to process the payment. paymentPspReference: type: string description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to capture. ' platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). x-addedInVersion: '70' pspReference: type: string description: Adyen's 16-character reference associated with the capture request. reference: type: string description: Your reference for the capture request. splits: type: array description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/). items: $ref: '#/components/schemas/Split' status: type: string description: The status of your request. This will always have the value **received**. enum: - received subMerchants: type: array description: List of sub-merchants. items: $ref: '#/components/schemas/SubMerchantInfo' x-addedInVersion: '70' required: - amount - merchantAccount - paymentPspReference - pspReference - status PaymentCompletionDetails: type: object additionalProperties: false properties: MD: type: string description: A payment session identifier returned by the card issuer. maxLength: 20000 PaReq: type: string description: (3D) Payment Authentication Request data for the card issuer. maxLength: 20000 PaRes: type: string description: (3D) Payment Authentication Response data by the card issuer. maxLength: 20000 authorization_token: type: string billingToken: type: string description: PayPal-generated token for recurring payments. cupsecureplus.smscode: type: string description: The SMS verification code collected from the shopper. facilitatorAccessToken: type: string description: PayPal-generated third party access token. oneTimePasscode: type: string description: A random number sent to the mobile phone number of the shopper to verify the payment. orderID: type: string description: PayPal-assigned ID for the order. payerID: type: string description: PayPal-assigned ID for the payer (shopper). payload: type: string description: Payload appended to the `returnURL` as a result of the redirect. maxLength: 20000 paymentID: type: string description: PayPal-generated ID for the payment. paymentStatus: type: string description: 'Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`.' redirectResult: type: string description: The result of the redirect as appended to the `returnURL`. maxLength: 20000 resultCode: type: string description: Value you received from the WeChat Pay SDK. returnUrlQueryString: type: string description: The query string as appended to the `returnURL` when using direct issuer links . maxLength: 20000 threeDSResult: type: string description: 'Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.' maxLength: 50000 threeds2.challengeResult: type: string description: 'Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.' maxLength: 50000 threeds2.fingerprint: type: string description: 'Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.' maxLength: 100000 vaultToken: type: string description: PayPalv2-generated token for recurring payments. PaymentDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string description: The payment method type. enum: - alipay - multibanco - bankTransfer - bankTransfer_IBAN - paynow - affirm_pos - iris - wero - 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 - paytm - molpay_ebanking_VN - molpay_ebanking_MY - molpay_ebanking_direct_MY - swish - bizum - walley - walley_b2b - paypo - scalapay - scalapay_3x - scalapay_4x - molpay_fpx - payme - payme_pos - konbini - directEbanking - boletobancario - cashticket - ikano - karenmillen - oasis - warehouse - primeiropay_boleto - mada - benefit - knet - omannet - kcp_naverpay - fawry - atome - 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 title: Payment Details PaymentDetailsRequest: type: object additionalProperties: false properties: authenticationData: $ref: '#/components/schemas/DetailsRequestAuthenticationData' description: Data for 3DS authentication. x-addedInVersion: '69' details: $ref: '#/components/schemas/PaymentCompletionDetails' description: Use this collection to submit the details that were returned as a result of the `/payments` call. paymentData: type: string 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 threeDSAuthenticationOnly: type: boolean deprecated: true 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. x-addedInVersion: '40' x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. required: - details PaymentDetailsResponse: type: object additionalProperties: false properties: action: description: Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases. discriminator: propertyName: type mapping: threeDS2: '#/components/schemas/CheckoutThreeDS2Action' oneOf: - $ref: '#/components/schemas/CheckoutThreeDS2Action' x-addedInVersion: '49' additionalData: type: object 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**.' 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' - $ref: '#/components/schemas/ResponseAdditionalDataSwish' amount: $ref: '#/components/schemas/Amount' description: Authorised amount in the transaction. x-addedInVersion: '52' donationToken: type: string description: Donation Token containing payment details for Adyen Giving. x-addedInVersion: '66' fraudResult: $ref: '#/components/schemas/FraudResult' description: The fraud result properties of the payment. merchantReference: type: string description: The reference used during the /payments request. x-addedInVersion: '49' order: $ref: '#/components/schemas/CheckoutOrderResponse' description: Contains updated information regarding the order in case order information was provided in the request. paymentMethod: $ref: '#/components/schemas/ResponsePaymentMethod' description: "Details about the payment method used in the transaction.\ \ \nOnly returned if `resultCode` is **Authorised**." x-addedInVersion: '69' paymentValidations: $ref: '#/components/schemas/PaymentValidationsResponse' description: 'The object that contains the validation outcomes. Only returned if `resultCode` is **Authorised** and if you have requested a payment validation in the request.' x-addedInVersion: '69' pspReference: type: string 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. refusalReason: type: string 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).' refusalReasonCode: type: string description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). x-addedInVersion: '40' resultCode: type: string description: "The result of the payment. For more information, see [Result\ \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ \ \u2013 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).\n\ * **Authorised** \u2013 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.\n* **Cancelled** \u2013 Indicates the\ \ payment has been cancelled (either by the shopper or the merchant) before\ \ processing was completed. This is a final state.\n* **ChallengeShopper**\ \ \u2013 The issuer requires further shopper interaction before the payment\ \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ \ \u2013 There was an error when the payment was being processed. The\ \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ \ has been authorised for a partial amount.\nThis happens for card payments\ \ when the merchant supports Partial Authorisations and the cardholder\ \ has insufficient funds.\n* **Pending** \u2013 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.\n* **PresentToShopper** \u2013 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.\n* **Received** \u2013\ \ Indicates the payment has successfully been received by Adyen, and will\ \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ \ \u2013 Indicates the shopper should be redirected to an external web\ \ page or app to complete the authorisation.\n* **Refused** \u2013 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 shopperLocale: type: string description: The shopperLocale. threeDS2ResponseData: $ref: '#/components/schemas/ThreeDS2ResponseData' description: Response of the 3D Secure 2 authentication. x-addedInVersion: '67' threeDS2Result: $ref: '#/components/schemas/ThreeDS2Result' description: Result of the 3D Secure 2 authentication. x-addedInVersion: '41' threeDSPaymentData: type: string description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. x-addedInVersion: '67' PaymentLinkRequest: type: object additionalProperties: false properties: allowedPaymentMethods: type: array 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","applepay"]`' items: type: string amount: $ref: '#/components/schemas/Amount' description: The payment amount and currency. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). billingAddress: $ref: '#/components/schemas/Address' description: The address where to send the invoice. blockedPaymentMethods: type: array 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","applepay"]`' items: type: string captureDelayHours: type: integer format: int32 description: The delay between the authorisation and scheduled auto-capture, specified in hours. x-addedInVersion: '69' countryCode: type: string description: The shopper's two-letter country code. maxLength: 100 dateOfBirth: type: string format: date description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' x-addedInVersion: '69' deliverAt: type: string format: date-time 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**.' deliveryAddress: $ref: '#/components/schemas/Address' description: The address where the purchased goods should be delivered. description: type: string description: 'A short description visible on the payment page. Maximum length: 280 characters.' expiresAt: type: string format: date-time 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.' x-addedInVersion: '71' fundOrigin: $ref: '#/components/schemas/FundOrigin' description: The person or entity funding the money. fundRecipient: $ref: '#/components/schemas/FundRecipient' description: the person or entity receiving the money installmentOptions: type: object 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. lineItems: type: array 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 Riverty.' items: $ref: '#/components/schemas/LineItem' manualCapture: type: boolean description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). mcc: type: string 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. maxLength: 16 x-addedInVersion: '69' merchantAccount: type: string description: The merchant account identifier for which the payment link is created. merchantOrderReference: type: string 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. maxLength: 1000 metadata: type: object 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 platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Dictates the behavior of how a potential chargeback should be booked when using Adyen Platforms. recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when `storePaymentMethodMode`\ \ is set to **askForConsent** or **enabled**.\nPossible values:\n* **Subscription**\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* **CardOnFile** \u2013 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.\n* **UnscheduledCardOnFile**\ \ \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile maxLength: 50 reference: type: string description: A reference that is used to uniquely identify the payment in future communications about the payment status. requiredShopperFields: type: array 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).\n\ \nPossible values:\n* **billingAddress** \u2013 The address where to send\ \ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\ \ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\ \ email address.\n* **shopperName** \u2013 The shopper's full name.\n\ * **telephoneNumber** \u2013 The shopper's phone number.\n" items: type: string enum: - billingAddress - deliveryAddress - shopperEmail - shopperName - telephoneNumber x-addedInVersion: '67' returnUrl: type: string 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.' maxLength: 8000 reusable: type: boolean 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. riskData: $ref: '#/components/schemas/RiskData' description: Any risk-related settings to apply to the payment. x-addedInVersion: '65' shopperEmail: type: string description: The shopper's email address. maxLength: 500 shopperLocale: type: string 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).' maxLength: 32 shopperName: $ref: '#/components/schemas/Name' 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. shopperReference: type: string description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.' maxLength: 256 minLength: 3 shopperStatement: type: string 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 **. , ' _ - ? + * /**." maxLength: 10000 x-addedInVersion: '69' showRemovePaymentMethodButton: type: boolean default: true description: Set to **false** to hide the button that lets the shopper remove a stored payment method. socialSecurityNumber: type: string description: The shopper's social security number. maxLength: 32 x-addedInVersion: '69' splitCardFundingSources: type: boolean default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. x-addedInVersion: '69' splits: type: array description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' store: type: string description: The physical store, for which this payment is processed. storePaymentMethodMode: type: string description: "Indicates if the details of the payment method will be stored\ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\ \ is provided, the Drop-in/Component shows a checkbox where the shopper\ \ can select to store their payment details for card payments.\n* **enabled**\ \ \u2013 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 x-addedInVersion: '68' telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." maxLength: 32 x-addedInVersion: '68' themeId: type: string 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. x-addedInVersion: '67' threeDS2RequestData: $ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData' description: The cardholder phone number need to be part of the authentication message for payment data. It is a requirement for Visa Secure Authentication Data Field Mandate effective August 2024. required: - amount - merchantAccount - reference PaymentLinkResponse: type: object additionalProperties: false properties: allowedPaymentMethods: type: array 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","applepay"]`' items: type: string amount: $ref: '#/components/schemas/Amount' description: The payment amount and currency. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). billingAddress: $ref: '#/components/schemas/Address' description: The address where to send the invoice. blockedPaymentMethods: type: array 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","applepay"]`' items: type: string captureDelayHours: type: integer format: int32 description: The delay between the authorisation and scheduled auto-capture, specified in hours. x-addedInVersion: '69' countryCode: type: string description: The shopper's two-letter country code. maxLength: 100 dateOfBirth: type: string format: date description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' x-addedInVersion: '69' deliverAt: type: string format: date-time 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**.' deliveryAddress: $ref: '#/components/schemas/Address' description: The address where the purchased goods should be delivered. description: type: string description: 'A short description visible on the payment page. Maximum length: 280 characters.' expiresAt: type: string format: date-time 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.' x-addedInVersion: '71' fundOrigin: $ref: '#/components/schemas/FundOrigin' description: The person or entity funding the money. fundRecipient: $ref: '#/components/schemas/FundRecipient' description: the person or entity receiving the money id: type: string description: A unique identifier of the payment link. readOnly: true x-addedInVersion: '51' installmentOptions: type: object 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. lineItems: type: array 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 Riverty.' items: $ref: '#/components/schemas/LineItem' manualCapture: type: boolean description: Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). mcc: type: string 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. maxLength: 16 x-addedInVersion: '69' merchantAccount: type: string description: The merchant account identifier for which the payment link is created. merchantOrderReference: type: string 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. maxLength: 1000 metadata: type: object 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 platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Dictates the behavior of how a potential chargeback should be booked when using Adyen Platforms. recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when `storePaymentMethodMode`\ \ is set to **askForConsent** or **enabled**.\nPossible values:\n* **Subscription**\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* **CardOnFile** \u2013 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.\n* **UnscheduledCardOnFile**\ \ \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile maxLength: 50 reference: type: string description: A reference that is used to uniquely identify the payment in future communications about the payment status. requiredShopperFields: type: array 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).\n\ \nPossible values:\n* **billingAddress** \u2013 The address where to send\ \ the invoice.\n* **deliveryAddress** \u2013 The address where the purchased\ \ goods should be delivered.\n* **shopperEmail** \u2013 The shopper's\ \ email address.\n* **shopperName** \u2013 The shopper's full name.\n\ * **telephoneNumber** \u2013 The shopper's phone number.\n" items: type: string enum: - billingAddress - deliveryAddress - shopperEmail - shopperName - telephoneNumber x-addedInVersion: '67' returnUrl: type: string 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.' maxLength: 8000 reusable: type: boolean 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. riskData: $ref: '#/components/schemas/RiskData' description: Any risk-related settings to apply to the payment. x-addedInVersion: '65' shopperEmail: type: string description: The shopper's email address. maxLength: 500 shopperLocale: type: string 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).' maxLength: 32 shopperName: $ref: '#/components/schemas/Name' 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. shopperReference: type: string description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.' maxLength: 256 minLength: 3 shopperStatement: type: string 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 **. , ' _ - ? + * /**." maxLength: 10000 x-addedInVersion: '69' showRemovePaymentMethodButton: type: boolean default: true description: Set to **false** to hide the button that lets the shopper remove a stored payment method. socialSecurityNumber: type: string description: The shopper's social security number. maxLength: 32 x-addedInVersion: '69' splitCardFundingSources: type: boolean default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. x-addedInVersion: '69' splits: type: array description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' status: type: string 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 store: type: string description: The physical store, for which this payment is processed. storePaymentMethodMode: type: string description: "Indicates if the details of the payment method will be stored\ \ for the shopper. Possible values:\n* **disabled** \u2013 No details\ \ will be stored (default).\n* **askForConsent** \u2013 If the `shopperReference`\ \ is provided, the Drop-in/Component shows a checkbox where the shopper\ \ can select to store their payment details for card payments.\n* **enabled**\ \ \u2013 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 x-addedInVersion: '68' telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." maxLength: 32 x-addedInVersion: '68' themeId: type: string 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. x-addedInVersion: '67' threeDS2RequestData: $ref: '#/components/schemas/CheckoutSessionThreeDS2RequestData' description: The cardholder phone number need to be part of the authentication message for payment data. It is a requirement for Visa Secure Authentication Data Field Mandate effective August 2024. updatedAt: type: string format: date-time 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**.' url: type: string description: The URL at which the shopper can complete the payment. readOnly: true required: - amount - id - merchantAccount - reference - status - url PaymentMethod: type: object additionalProperties: false properties: apps: type: array description: A list of apps for this payment method. items: $ref: '#/components/schemas/PaymentMethodUPIApps' brand: type: string description: 'Brand for the selected gift card. For example: plastix, hmclub.' x-addedInVersion: '65' brands: type: array description: 'List of possible brands. For example: visa, mc.' items: type: string x-addedInVersion: '49' configuration: type: object additionalProperties: type: string description: The configuration of the payment method. fundingSource: type: string description: The funding source of the payment method. enum: - credit - debit - prepaid x-addedInVersion: '53' group: $ref: '#/components/schemas/PaymentMethodGroup' description: The group where this payment method belongs to. inputDetails: type: array deprecated: true description: All input details to be provided to complete the payment with this payment method. items: $ref: '#/components/schemas/InputDetail' issuers: type: array description: A list of issuers for this payment method. items: $ref: '#/components/schemas/PaymentMethodIssuer' x-addedInVersion: '68' name: type: string description: The displayable name of this payment method. promoted: type: boolean description: Indicates whether this payment method should be promoted or not. type: type: string description: The unique payment method code. PaymentMethodGroup: type: object additionalProperties: false properties: name: type: string description: The name of the group. paymentMethodData: type: string description: Echo data to be used if the payment method is displayed as part of this group. type: type: string description: The unique code of the group. PaymentMethodIssuer: type: object additionalProperties: false properties: disabled: type: boolean default: false description: A boolean value indicating whether this issuer is unavailable. Can be `true` whenever the issuer is offline. id: type: string description: The unique identifier of this issuer, to submit in requests to /payments. name: type: string description: A localized name of the issuer. required: - id - name PaymentMethodToStore: type: object additionalProperties: false properties: brand: type: string description: 'Secondary brand of the card. For example: **plastix**, **hmclub**.' cvc: type: string 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). encryptedCard: type: string description: The encrypted card. maxLength: 40000 encryptedCardNumber: type: string description: The encrypted card number. maxLength: 15000 encryptedExpiryMonth: type: string description: The encrypted card expiry month. maxLength: 15000 encryptedExpiryYear: type: string description: The encrypted card expiry year. maxLength: 15000 encryptedSecurityCode: type: string description: The encrypted card verification code. maxLength: 15000 expiryMonth: type: string 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). expiryYear: type: string 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). holderName: type: string description: The name of the card holder. number: type: string 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: type: string description: Set to **scheme**. PaymentMethodUPIApps: type: object additionalProperties: false properties: appIdentifierInfo: $ref: '#/components/schemas/AppIdentifierInfo' description: The app identifier information containing iOS scheme and Android package ID. x-addedInVersion: '68' id: type: string description: The unique identifier of this app, to submit in requests to /payments. name: type: string description: A localized name of the app. required: - id - name PaymentMethodsRequest: type: object additionalProperties: false properties: additionalData: type: object additionalProperties: type: string 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.' 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' allowedPaymentMethods: type: array 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","applepay"]`' items: type: string x-addedInVersion: '40' amount: $ref: '#/components/schemas/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). blockedPaymentMethods: type: array 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","applepay"]`' items: type: string x-addedInVersion: '40' browserInfo: $ref: '#/components/schemas/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 2 redirect.' channel: type: string 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 countryCode: type: string description: The shopper's country code. merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. order: $ref: '#/components/schemas/EncryptedOrderData' description: The order information required for partial payments. x-addedInVersion: '64' shopperConversionId: type: string description: A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates. maxLength: 256 shopperEmail: type: string description: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. shopperIP: type: string description: 'The shopper''s IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).' shopperLocale: type: string description: 'The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.' x-addedInVersion: '7' shopperReference: type: string description: "Required for recurring payments. \nYour reference to uniquely\ \ identify this shopper, for example user ID or account ID. The value\ \ is case-sensitive and must be at least three characters.\n> Your reference\ \ must not include personally identifiable information (PII) such as name\ \ or email address." splitCardFundingSources: type: boolean default: false description: Boolean value indicating whether the card payment method should be split into separate debit and credit options. x-addedInVersion: '53' store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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 x-addedInVersion: '23' storeFiltrationMode: type: string description: "Specifies how payment methods should be filtered based on\ \ the `store` parameter:\n - **exclusive**: Only payment methods belonging\ \ to the specified `store` are returned.\n - **inclusive**: Payment methods\ \ from the `store` and those not associated with any other store are returned." enum: - exclusive - inclusive - skipFilter telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." x-addedInVersion: '7' required: - merchantAccount PaymentMethodsResponse: type: object additionalProperties: false properties: paymentMethods: type: array description: Detailed list of payment methods required to generate payment forms. items: $ref: '#/components/schemas/PaymentMethod' storedPaymentMethods: type: array description: List of all stored payment methods. items: $ref: '#/components/schemas/StoredPaymentMethod' x-addedInVersion: '49' PaymentRefundRequest: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/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. applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). capturePspReference: type: string description: This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund. enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: Enhanced scheme data that may be required for processing the payment. For example, airline information. x-addedInVersion: '70' lineItems: type: array 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' merchantAccount: type: string description: The merchant account that is used to process the payment. merchantRefundReason: type: string description: 'The reason for the refund request. Possible values: * **FRAUD** * **CUSTOMER REQUEST** * **RETURN** * **DUPLICATE** * **OTHER** ' enum: - FRAUD - CUSTOMER REQUEST - RETURN - DUPLICATE - OTHER nullable: true reference: type: string description: 'Your reference for the refund request. Maximum length: 80 characters.' splits: type: array description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/). items: $ref: '#/components/schemas/Split' store: type: string 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. required: - amount - merchantAccount PaymentRefundResponse: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The refund amount. capturePspReference: type: string description: This is only available for PayPal refunds. The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the specific capture to refund. lineItems: type: array 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' merchantAccount: type: string description: The merchant account that is used to process the payment. merchantRefundReason: type: string description: Your reason for the refund request. enum: - FRAUD - CUSTOMER REQUEST - RETURN - DUPLICATE - OTHER nullable: true paymentPspReference: type: string description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to refund. ' pspReference: type: string description: Adyen's 16-character reference associated with the refund request. reference: type: string description: Your reference for the refund request. splits: type: array description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For more information, see how to process payments for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/online-payments/split-payments/). items: $ref: '#/components/schemas/Split' status: type: string description: The status of your request. This will always have the value **received**. enum: - received store: type: string 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. required: - amount - merchantAccount - paymentPspReference - pspReference - status PaymentRequest: type: object additionalProperties: false properties: accountInfo: $ref: '#/components/schemas/AccountInfo' 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.' x-addedInVersion: '40' additionalAmount: $ref: '#/components/schemas/Amount' 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`. ' additionalData: type: object additionalProperties: type: string 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.' 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' amount: $ref: '#/components/schemas/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). applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). x-addedInVersion: '40' authenticationData: $ref: '#/components/schemas/AuthenticationData' description: Data for 3DS authentication. x-addedInVersion: '69' bankAccount: $ref: '#/components/schemas/CheckoutBankAccount' description: 'The details of the bank account, from which the payment should be made. > Either `bankAccount` or `card` field must be provided in a payment request.' billingAddress: $ref: '#/components/schemas/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.' browserInfo: $ref: '#/components/schemas/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 2 redirect.' captureDelayHours: type: integer format: int32 description: 'The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days).' channel: type: string 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 checkoutAttemptId: type: string description: Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. maxLength: 256 company: $ref: '#/components/schemas/Company' description: Information regarding the company. x-addedInVersion: '32' conversionId: type: string deprecated: true description: Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. x-addedInVersion: '49' x-deprecatedInVersion: '68' x-deprecatedMessage: Use `checkoutAttemptId` instead countryCode: type: string description: 'The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE' maxLength: 100 dateOfBirth: type: string format: date-time description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' dccQuote: $ref: '#/components/schemas/ForexQuote' description: The forex quote as returned in the response of the forex service. deliverAt: type: string format: date-time 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' x-addedInVersion: '70' deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' description: The address where the purchased goods should be delivered. deliveryDate: type: string format: date-time deprecated: true 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' x-deprecatedInVersion: '70' x-deprecatedMessage: Use `deliverAt` instead. deviceFingerprint: type: string 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 enableOneClick: type: boolean description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition). x-addedInVersion: '32' enablePayOut: type: boolean description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. x-addedInVersion: '32' enableRecurring: type: boolean description: When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments. x-addedInVersion: '32' enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: '[Enhanced scheme data](https://docs.adyen.com/payment-methods/cards/enhanced-scheme-data/) that may be required for processing the payment and/or interchange savings can apply.' x-addedInVersion: '70' entityType: type: string description: The type of the entity the payment is processed for. enum: - NaturalPerson - CompanyName fraudOffset: type: integer format: int32 description: An integer value that is added to the normal fraud score. The value can be either positive or negative. fundOrigin: $ref: '#/components/schemas/FundOrigin' description: The person or entity funding the money. fundRecipient: $ref: '#/components/schemas/FundRecipient' description: the person or entity receiving the money industryUsage: type: string description: "The reason for the amount update. Possible values: \n* **delayedCharge**\ \ \n* **noShow** \n* **installment**" enum: - delayedCharge - installment - noShow x-addedInVersion: '70' installments: $ref: '#/components/schemas/Installments' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). lineItems: type: array 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 Riverty.' items: $ref: '#/components/schemas/LineItem' x-addedInVersion: '32' localizedShopperStatement: type: object additionalProperties: type: string description: 'The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric.' x-addedInVersion: '68' mandate: $ref: '#/components/schemas/Mandate' description: The mandate details to initiate recurring transaction. mcc: type: string 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. merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. merchantOrderReference: type: string description: "You can use this reference to link multiple transactions to\ \ one another (for example, to track order authorization rate).For each\ \ billing cycle, this reference should be unique. After the first authorized\ \ payment attempt, do not reuse the reference. If you use this parameter,\ \ include it in all of the payment requests that you make. \n We strongly\ \ recommend that you:\n* Always include this parameter, so that you can\ \ benefit from linking payment requests to one another, in case of authorization\ \ retries. \n* Additionally include the following parameters in the `additionalData`\ \ object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber),\ \ [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber),\ \ and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry)" maxLength: 1000 merchantRiskIndicator: $ref: '#/components/schemas/MerchantRiskIndicator' 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.' x-addedInVersion: '40' metadata: type: object 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. ' mpiData: $ref: '#/components/schemas/ThreeDSecureData' description: Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires). order: $ref: '#/components/schemas/EncryptedOrderData' description: The order information required for partial payments. orderReference: type: string 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. origin: type: string description: '> Required for browser-based (`channel` **Web**) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.' maxLength: 80 x-addedInVersion: '40' paymentMethod: description: The type and required details of a payment method to use. discriminator: propertyName: type mapping: applepay: '#/components/schemas/ApplePayDetails' samsungpay: '#/components/schemas/SamsungPayDetails' androidpay: '#/components/schemas/AndroidPayDetails' visacheckout: '#/components/schemas/VisaCheckoutDetails' paywithgoogle: '#/components/schemas/PayWithGoogleDetails' amazonpay: '#/components/schemas/AmazonPayDetails' masterpass: '#/components/schemas/MasterpassDetails' googlepay: '#/components/schemas/GooglePayDetails' fastlane: '#/components/schemas/FastlaneDetails' alipay: '#/components/schemas/PaymentDetails' alipay_plus: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_alipay_cn: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_alipay_hk: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_dana: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_gcash: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_kakaopay: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_kplus: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_naverpay: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_rabbitlinepay: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_tosspay: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_touchngo: '#/components/schemas/StoredPaymentMethodDetails' alipay_plus_truemoney: '#/components/schemas/StoredPaymentMethodDetails' bcmc: '#/components/schemas/CardDetails' bcmc_mobile: '#/components/schemas/StoredPaymentMethodDetails' bcmc_mobile_QR: '#/components/schemas/StoredPaymentMethodDetails' bcmc_mobile_app: '#/components/schemas/StoredPaymentMethodDetails' scheme: '#/components/schemas/CardDetails' networkToken: '#/components/schemas/CardDetails' altId: '#/components/schemas/CardDetails' externalToken: '#/components/schemas/ExternalTokenDetails' multibanco: '#/components/schemas/PaymentDetails' ach: '#/components/schemas/AchDetails' ach_plaid: '#/components/schemas/AchDetails' eft_directdebit_CA: '#/components/schemas/EftDetails' bankTransfer: '#/components/schemas/PaymentDetails' bankTransfer_IBAN: '#/components/schemas/PaymentDetails' klarna: '#/components/schemas/KlarnaDetails' klarnapayments: '#/components/schemas/KlarnaDetails' klarnapayments_account: '#/components/schemas/KlarnaDetails' klarnapayments_b2b: '#/components/schemas/KlarnaDetails' klarna_paynow: '#/components/schemas/KlarnaDetails' klarna_account: '#/components/schemas/KlarnaDetails' klarna_b2b: '#/components/schemas/KlarnaDetails' klarna_network: '#/components/schemas/KlarnaNetworkDetails' paynow: '#/components/schemas/PaymentDetails' afterpay_default: '#/components/schemas/AfterpayDetails' afterpaytouch: '#/components/schemas/AfterpayDetails' afterpaytouch_pos: '#/components/schemas/AfterpayDetails' clearpay: '#/components/schemas/AfterpayDetails' afterpay_b2b: '#/components/schemas/AfterpayDetails' zip: '#/components/schemas/ZipDetails' zip_pos: '#/components/schemas/ZipDetails' ratepay: '#/components/schemas/RatepayDetails' ratepay_directdebit: '#/components/schemas/RatepayDetails' affirm: '#/components/schemas/AffirmDetails' affirm_pos: '#/components/schemas/PaymentDetails' riverty_account: '#/components/schemas/RivertyDetails' ideal: '#/components/schemas/IdealDetails' iris: '#/components/schemas/PaymentDetails' wero: '#/components/schemas/PaymentDetails' paypal: '#/components/schemas/PayPalDetails' paypay: '#/components/schemas/PayPayDetails' rakutenpay: '#/components/schemas/RakutenPayDetails' aupay: '#/components/schemas/AuPayDetails' dbarai: '#/components/schemas/DBaraiDetails' trustly: '#/components/schemas/PaymentDetails' trustlyvector: '#/components/schemas/PaymentDetails' oney: '#/components/schemas/PaymentDetails' facilypay: '#/components/schemas/PaymentDetails' facilypay_3x: '#/components/schemas/PaymentDetails' facilypay_4x: '#/components/schemas/PaymentDetails' facilypay_6x: '#/components/schemas/PaymentDetails' facilypay_10x: '#/components/schemas/PaymentDetails' facilypay_12x: '#/components/schemas/PaymentDetails' sepadirectdebit: '#/components/schemas/SepaDirectDebitDetails' sepadirectdebit_amazonpay: '#/components/schemas/SepaDirectDebitDetails' momo_wallet: '#/components/schemas/StoredPaymentMethodDetails' momo_wallet_app: '#/components/schemas/StoredPaymentMethodDetails' doku: '#/components/schemas/DokuDetails' doku_wallet: '#/components/schemas/DokuDetails' doku_ovo: '#/components/schemas/DokuDetails' doku_permata_lite_atm: '#/components/schemas/DokuDetails' doku_permata_atm: '#/components/schemas/DokuDetails' doku_alfamart: '#/components/schemas/DokuDetails' doku_indomaret: '#/components/schemas/DokuDetails' doku_sinarmas_va: '#/components/schemas/DokuDetails' doku_bca_va: '#/components/schemas/DokuDetails' doku_mandiri_va: '#/components/schemas/DokuDetails' doku_cimb_va: '#/components/schemas/DokuDetails' doku_danamon_va: '#/components/schemas/DokuDetails' doku_bri_va: '#/components/schemas/DokuDetails' doku_bni_va: '#/components/schemas/DokuDetails' doku_bni: '#/components/schemas/DokuDetails' vipps: '#/components/schemas/VippsDetails' mobilepay: '#/components/schemas/MobilePayDetails' cellulant: '#/components/schemas/CellulantDetails' unionpay: '#/components/schemas/PaymentDetails' kcp_banktransfer: '#/components/schemas/PaymentDetails' kcp_payco: '#/components/schemas/PaymentDetails' kcp_creditcard: '#/components/schemas/PaymentDetails' wechatpay: '#/components/schemas/WeChatPayDetails' wechatpay_pos: '#/components/schemas/WeChatPayDetails' wechatpaySDK: '#/components/schemas/PaymentDetails' wechatpayQR: '#/components/schemas/PaymentDetails' wechatpayWeb: '#/components/schemas/PaymentDetails' wechatpayMiniProgram: '#/components/schemas/WeChatPayMiniProgramDetails' molpay_ebanking_fpx_MY: '#/components/schemas/MolPayDetails' molpay_ebanking_TH: '#/components/schemas/MolPayDetails' molpay_krungsribank: '#/components/schemas/MolPayDetails' molpay_krungthaibank: '#/components/schemas/MolPayDetails' molpay_siamcommercialbank: '#/components/schemas/MolPayDetails' molpay_bangkokbank: '#/components/schemas/MolPayDetails' molpay_kbank: '#/components/schemas/MolPayDetails' molpay_boost: '#/components/schemas/PaymentDetails' billdesk_online: '#/components/schemas/BillDeskDetails' billdesk_wallet: '#/components/schemas/BillDeskDetails' wallet_IN: '#/components/schemas/PaymentDetails' payu_IN_cashcard: '#/components/schemas/PaymentDetails' payu_IN_nb: '#/components/schemas/PaymentDetails' payu_IN_upi: '#/components/schemas/PayUUpiDetails' pse_payulatam: '#/components/schemas/PseDetails' upi_collect: '#/components/schemas/UpiCollectDetails' upi_intent: '#/components/schemas/UpiIntentDetails' upi_qr: '#/components/schemas/UpiQrDetails' paytm: '#/components/schemas/PaymentDetails' molpay_ebanking_VN: '#/components/schemas/PaymentDetails' onlineBanking_PL: '#/components/schemas/GenericIssuerPaymentMethodDetails' eps: '#/components/schemas/GenericIssuerPaymentMethodDetails' paybybank: '#/components/schemas/PayByBankDetails' paybybank_AIS_DD: '#/components/schemas/PayByBankAISDirectDebitDetails' onlineBanking_SK: '#/components/schemas/GenericIssuerPaymentMethodDetails' onlineBanking_CZ: '#/components/schemas/GenericIssuerPaymentMethodDetails' openinvoice: '#/components/schemas/OpenInvoiceDetails' afterpay_directdebit: '#/components/schemas/OpenInvoiceDetails' atome_pos: '#/components/schemas/OpenInvoiceDetails' doku_paymentmethods: '#/components/schemas/DokuDetails' doku_atm_mandiri_va: '#/components/schemas/DokuDetails' doku_briepay: '#/components/schemas/DokuDetails' doku_mandiri_multipayment_lite: '#/components/schemas/DokuDetails' doku_card: '#/components/schemas/DokuDetails' doku_atm_mandiri_va_lite: '#/components/schemas/DokuDetails' doku_bca_klikpay: '#/components/schemas/DokuDetails' doku_mandiri_multipayment: '#/components/schemas/DokuDetails' doku_mandiri_clickpay: '#/components/schemas/DokuDetails' ebanking_FI: '#/components/schemas/EBankingFinlandDetails' molpay_ebanking_MY: '#/components/schemas/PaymentDetails' molpay_ebanking_direct_MY: '#/components/schemas/PaymentDetails' swish: '#/components/schemas/PaymentDetails' twint: '#/components/schemas/TwintDetails' pix: '#/components/schemas/PixDetails' paybybank_pix: '#/components/schemas/PixPayByBankDetails' bizum: '#/components/schemas/PaymentDetails' walley: '#/components/schemas/PaymentDetails' walley_b2b: '#/components/schemas/PaymentDetails' alma: '#/components/schemas/AlmaDetails' ancv: '#/components/schemas/AncvDetails' paypo: '#/components/schemas/PaymentDetails' scalapay: '#/components/schemas/PaymentDetails' scalapay_3x: '#/components/schemas/PaymentDetails' scalapay_4x: '#/components/schemas/PaymentDetails' riverty: '#/components/schemas/RivertyDetails' riverty_installments: '#/components/schemas/RivertyDetails' sepadirectdebit_riverty: '#/components/schemas/RivertyDetails' payto: '#/components/schemas/PayToDetails' directdebit_AU: '#/components/schemas/DirectDebitAuDetails' molpay_fpx: '#/components/schemas/PaymentDetails' payme: '#/components/schemas/PaymentDetails' payme_pos: '#/components/schemas/PaymentDetails' econtext_seven_eleven: '#/components/schemas/EcontextVoucherDetails' econtext_online: '#/components/schemas/EcontextVoucherDetails' econtext: '#/components/schemas/EcontextVoucherDetails' econtext_stores: '#/components/schemas/EcontextVoucherDetails' econtext_atm: '#/components/schemas/EcontextVoucherDetails' konbini: '#/components/schemas/PaymentDetails' dragonpay_ebanking: '#/components/schemas/DragonpayDetails' dragonpay_otc_banking: '#/components/schemas/DragonpayDetails' dragonpay_otc_non_banking: '#/components/schemas/DragonpayDetails' dragonpay_otc_philippines: '#/components/schemas/DragonpayDetails' directEbanking: '#/components/schemas/PaymentDetails' directdebit_GB: '#/components/schemas/BacsDirectDebitDetails' boletobancario: '#/components/schemas/PaymentDetails' giftcard: '#/components/schemas/CardDetails' paymaya_wallet: '#/components/schemas/StoredPaymentMethodDetails' grabpay_SG: '#/components/schemas/StoredPaymentMethodDetails' grabpay_MY: '#/components/schemas/StoredPaymentMethodDetails' grabpay_TH: '#/components/schemas/StoredPaymentMethodDetails' grabpay_ID: '#/components/schemas/StoredPaymentMethodDetails' grabpay_VN: '#/components/schemas/StoredPaymentMethodDetails' grabpay_PH: '#/components/schemas/StoredPaymentMethodDetails' oxxo: '#/components/schemas/StoredPaymentMethodDetails' blik: '#/components/schemas/BlikDetails' gcash: '#/components/schemas/StoredPaymentMethodDetails' dana: '#/components/schemas/StoredPaymentMethodDetails' kakaopay: '#/components/schemas/StoredPaymentMethodDetails' truemoney: '#/components/schemas/StoredPaymentMethodDetails' mbway: '#/components/schemas/MbwayDetails' alliancedata: '#/components/schemas/CardDetails' paysafecard: '#/components/schemas/StoredPaymentMethodDetails' cashticket: '#/components/schemas/PaymentDetails' ikano: '#/components/schemas/PaymentDetails' karenmillen: '#/components/schemas/PaymentDetails' oasis: '#/components/schemas/PaymentDetails' warehouse: '#/components/schemas/PaymentDetails' primeiropay_boleto: '#/components/schemas/PaymentDetails' mada: '#/components/schemas/PaymentDetails' benefit: '#/components/schemas/PaymentDetails' knet: '#/components/schemas/PaymentDetails' omannet: '#/components/schemas/PaymentDetails' gopay_wallet: '#/components/schemas/StoredPaymentMethodDetails' kcp_naverpay: '#/components/schemas/PaymentDetails' onlinebanking_IN: '#/components/schemas/GenericIssuerPaymentMethodDetails' fawry: '#/components/schemas/PaymentDetails' atome: '#/components/schemas/PaymentDetails' naps: '#/components/schemas/PaymentDetails' nordea: '#/components/schemas/PaymentDetails' boletobancario_bradesco: '#/components/schemas/PaymentDetails' boletobancario_itau: '#/components/schemas/PaymentDetails' boletobancario_santander: '#/components/schemas/PaymentDetails' boletobancario_bancodobrasil: '#/components/schemas/PaymentDetails' boletobancario_hsbc: '#/components/schemas/PaymentDetails' molpay_maybank2u: '#/components/schemas/PaymentDetails' molpay_cimb: '#/components/schemas/PaymentDetails' molpay_rhb: '#/components/schemas/PaymentDetails' molpay_amb: '#/components/schemas/PaymentDetails' molpay_hlb: '#/components/schemas/PaymentDetails' molpay_affin_epg: '#/components/schemas/PaymentDetails' molpay_bankislam: '#/components/schemas/PaymentDetails' molpay_publicbank: '#/components/schemas/PaymentDetails' fpx_agrobank: '#/components/schemas/PaymentDetails' touchngo: '#/components/schemas/PaymentDetails' maybank2u_mae: '#/components/schemas/PaymentDetails' duitnow: '#/components/schemas/PaymentDetails' promptpay: '#/components/schemas/PaymentDetails' twint_pos: '#/components/schemas/PaymentDetails' alipay_hk: '#/components/schemas/PaymentDetails' alipay_hk_web: '#/components/schemas/PaymentDetails' alipay_hk_wap: '#/components/schemas/PaymentDetails' alipay_wap: '#/components/schemas/PaymentDetails' balanceplatform: '#/components/schemas/PaymentDetails' cashapp: '#/components/schemas/CashAppDetails' card: '#/components/schemas/CardDetails' oneOf: - $ref: '#/components/schemas/AchDetails' - $ref: '#/components/schemas/AffirmDetails' - $ref: '#/components/schemas/AfterpayDetails' - $ref: '#/components/schemas/AlmaDetails' - $ref: '#/components/schemas/AmazonPayDetails' - $ref: '#/components/schemas/AncvDetails' - $ref: '#/components/schemas/AndroidPayDetails' - $ref: '#/components/schemas/ApplePayDetails' - $ref: '#/components/schemas/AuPayDetails' - $ref: '#/components/schemas/BacsDirectDebitDetails' - $ref: '#/components/schemas/BillDeskDetails' - $ref: '#/components/schemas/BlikDetails' - $ref: '#/components/schemas/CardDetails' - $ref: '#/components/schemas/CashAppDetails' - $ref: '#/components/schemas/CellulantDetails' - $ref: '#/components/schemas/DBaraiDetails' - $ref: '#/components/schemas/DirectDebitAuDetails' - $ref: '#/components/schemas/DokuDetails' - $ref: '#/components/schemas/DragonpayDetails' - $ref: '#/components/schemas/EBankingFinlandDetails' - $ref: '#/components/schemas/EcontextVoucherDetails' - $ref: '#/components/schemas/EftDetails' - $ref: '#/components/schemas/ExternalTokenDetails' - $ref: '#/components/schemas/FastlaneDetails' - $ref: '#/components/schemas/GenericIssuerPaymentMethodDetails' - $ref: '#/components/schemas/GooglePayDetails' - $ref: '#/components/schemas/IdealDetails' - $ref: '#/components/schemas/KlarnaDetails' - $ref: '#/components/schemas/KlarnaNetworkDetails' - $ref: '#/components/schemas/MasterpassDetails' - $ref: '#/components/schemas/MbwayDetails' - $ref: '#/components/schemas/MobilePayDetails' - $ref: '#/components/schemas/MolPayDetails' - $ref: '#/components/schemas/OpenInvoiceDetails' - $ref: '#/components/schemas/PayByBankAISDirectDebitDetails' - $ref: '#/components/schemas/PayByBankDetails' - $ref: '#/components/schemas/PayPalDetails' - $ref: '#/components/schemas/PayPayDetails' - $ref: '#/components/schemas/PayToDetails' - $ref: '#/components/schemas/PayUUpiDetails' - $ref: '#/components/schemas/PayWithGoogleDetails' - $ref: '#/components/schemas/PaymentDetails' - $ref: '#/components/schemas/PixDetails' - $ref: '#/components/schemas/PixPayByBankDetails' - $ref: '#/components/schemas/PseDetails' - $ref: '#/components/schemas/RakutenPayDetails' - $ref: '#/components/schemas/RatepayDetails' - $ref: '#/components/schemas/RivertyDetails' - $ref: '#/components/schemas/SamsungPayDetails' - $ref: '#/components/schemas/SepaDirectDebitDetails' - $ref: '#/components/schemas/StoredPaymentMethodDetails' - $ref: '#/components/schemas/TwintDetails' - $ref: '#/components/schemas/UpiCollectDetails' - $ref: '#/components/schemas/UpiIntentDetails' - $ref: '#/components/schemas/UpiQrDetails' - $ref: '#/components/schemas/VippsDetails' - $ref: '#/components/schemas/VisaCheckoutDetails' - $ref: '#/components/schemas/WeChatPayDetails' - $ref: '#/components/schemas/WeChatPayMiniProgramDetails' - $ref: '#/components/schemas/ZipDetails' paymentValidations: $ref: '#/components/schemas/PaymentValidations' description: The object that you can use to enable payment validations for a transaction. x-addedInVersion: '69' platformChargebackLogic: $ref: '#/components/schemas/PlatformChargebackLogic' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/adyen-for-platforms-model). x-addedInVersion: '68' recurringExpiry: type: string description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. recurringFrequency: type: string description: Minimum number of days between authorisations. Only for 3D Secure 2. recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details or using stored payment details.\nAllowed\ \ values:\n* `Subscription` \u2013 A transaction for a fixed or variable\ \ amount, which follows a fixed schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile` \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile x-addedInVersion: '32' redirectFromIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting back from the issuer. x-addedInVersion: '32' redirectToIssuerMethod: type: string description: Specifies the redirect method (GET or POST) when redirecting to the issuer. x-addedInVersion: '32' reference: type: string description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters.' returnUrl: type: string 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.example.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).\n\ Example: `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).\n\ Example: `my-app://your.package.name`\n\nIf the URL to return to includes\ \ non-ASCII characters, like spaces or special letters, URL encode the\ \ value.\n\nWe strongly recommend that you use a maximum of 1024 characters.\n\ \n> The URL must not include personally identifiable information (PII),\ \ for example name or email address." maxLength: 8000 riskData: $ref: '#/components/schemas/RiskData' description: Contains risk data, such as client-side data, used to identify risk for a transaction. sessionValidity: type: string 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' shopperConversionId: type: string description: A unique ID to [connect the shopper to a single checkout session](https://docs.adyen.com/online-payments/checkout-settings#checkout-shopper-conversion-id) that uses multiple API requests. You can use this to get insights into conversion rates. maxLength: 256 shopperEmail: type: string description: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. shopperIP: type: string description: 'The shopper''s IP address. 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). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. 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).' maxLength: 1000 shopperInteraction: type: string 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 shopperLocale: type: string description: 'The language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`.' shopperName: $ref: '#/components/schemas/ShopperName' description: The shopper's full name. shopperReference: type: string 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 shopperStatement: type: string 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 **. , ' _ - ? + * /**." maxLength: 10000 shopperTaxInfo: $ref: '#/components/schemas/ShopperTaxInfo' description: The tax info of the shopper x-addedInVersion: '68' socialSecurityNumber: type: string description: The shopper's social security number. splits: type: array description: An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' x-addedInVersion: '40' store: type: string description: Required for Adyen for Platforms integrations if you are a platform model. 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/platforms)) 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/classic-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 storePaymentMethod: type: boolean description: When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types). x-addedInVersion: '49' subMerchants: type: array description: This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator items: $ref: '#/components/schemas/SubMerchantInfo' surcharge: $ref: '#/components/schemas/Surcharge' description: 'The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.' telephoneNumber: type: string description: "The shopper's telephone number.\n The phone number must include\ \ a plus sign (+) and a country code (1-3 digits), followed by the number\ \ (4-15 digits). If the value you provide does not follow the guidelines,\ \ we do not submit it for authentication.\n> Required for Visa and JCB\ \ transactions that require 3D Secure 2 authentication, if you did not\ \ include the `shopperEmail`." thirdPartyTokenRedundancyInfo: $ref: '#/components/schemas/ThirdPartyTokenRedundancyInfo' description: Configuration for creating redundant payment tokens with third-party token vaults using the Adyen Forward API. This feature requires Forward API webhook integration and pre-configured templates in your Adyen account. Contact your Adyen account manager for setup and availability. threeDS2RequestData: $ref: '#/components/schemas/ThreeDS2RequestFields' 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. x-addedInVersion: '40' threeDSAuthenticationOnly: type: boolean default: false deprecated: true description: 'Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorisation.Default: **false**.' x-addedInVersion: '50' x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. trustedShopper: type: boolean description: Set to true if the payment should be routed to a trusted MID. x-addedInVersion: '40' required: - amount - merchantAccount - paymentMethod - reference - returnUrl PaymentResponse: type: object additionalProperties: false properties: action: description: Action to be taken for completing the payment. discriminator: propertyName: type mapping: bankTransfer: '#/components/schemas/CheckoutBankTransferAction' qrCode: '#/components/schemas/CheckoutQrCodeAction' nativeRedirect: '#/components/schemas/CheckoutNativeRedirectAction' redirect: '#/components/schemas/CheckoutRedirectAction' sdk: '#/components/schemas/CheckoutSDKAction' wechatpaySDK: '#/components/schemas/CheckoutSDKAction' threeDS2: '#/components/schemas/CheckoutThreeDS2Action' delegatedAuthentication: '#/components/schemas/CheckoutDelegatedAuthenticationAction' await: '#/components/schemas/CheckoutAwaitAction' voucher: '#/components/schemas/CheckoutVoucherAction' oneOf: - $ref: '#/components/schemas/CheckoutAwaitAction' - $ref: '#/components/schemas/CheckoutBankTransferAction' - $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' x-addedInVersion: '49' additionalData: type: object 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**.' 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' - $ref: '#/components/schemas/ResponseAdditionalDataSwish' amount: $ref: '#/components/schemas/Amount' description: Authorised amount in the transaction. x-addedInVersion: '52' donationToken: type: string description: Donation Token containing payment details for Adyen Giving. x-addedInVersion: '66' fraudResult: $ref: '#/components/schemas/FraudResult' description: The fraud result properties of the payment. merchantReference: type: string 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.' x-addedInVersion: '49' order: $ref: '#/components/schemas/CheckoutOrderResponse' description: Contains updated information regarding the order in case order information was provided in the request. paymentMethod: $ref: '#/components/schemas/ResponsePaymentMethod' description: "Details about the payment method used in the transaction.\ \ \nOnly returned if `resultCode` is **Authorised**." x-addedInVersion: '69' paymentValidations: $ref: '#/components/schemas/PaymentValidationsResponse' description: 'The object that contains the validation outcomes. Only returned if `resultCode` is **Authorised** and if you have requested a payment validation in the request.' x-addedInVersion: '69' pspReference: type: string 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.' refusalReason: type: string 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).' refusalReasonCode: type: string description: Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). x-addedInVersion: '40' resultCode: type: string description: "The result of the payment. For more information, see [Result\ \ codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\ \nPossible values:\n\n* **AuthenticationFinished** \u2013 The payment\ \ has been successfully authenticated with 3D Secure 2. Returned for 3D\ \ Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired**\ \ \u2013 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).\n\ * **Authorised** \u2013 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.\n* **Cancelled** \u2013 Indicates the\ \ payment has been cancelled (either by the shopper or the merchant) before\ \ processing was completed. This is a final state.\n* **ChallengeShopper**\ \ \u2013 The issuer requires further shopper interaction before the payment\ \ can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error**\ \ \u2013 There was an error when the payment was being processed. The\ \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ \ has been authorised for a partial amount.\nThis happens for card payments\ \ when the merchant supports Partial Authorisations and the cardholder\ \ has insufficient funds.\n* **Pending** \u2013 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.\n* **PresentToShopper** \u2013 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.\n* **Received** \u2013\ \ Indicates the payment has successfully been received by Adyen, and will\ \ be processed. This is the initial state for all payments.\n* **RedirectShopper**\ \ \u2013 Indicates the shopper should be redirected to an external web\ \ page or app to complete the authorisation.\n* **Refused** \u2013 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 threeDS2ResponseData: $ref: '#/components/schemas/ThreeDS2ResponseData' description: Response of the 3D Secure 2 authentication. x-addedInVersion: '67' threeDS2Result: $ref: '#/components/schemas/ThreeDS2Result' description: Result of the 3D Secure 2 authentication. x-addedInVersion: '41' threeDSPaymentData: type: string description: When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. x-addedInVersion: '67' PaymentReversalRequest: type: object additionalProperties: false properties: applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: Enhanced scheme data that may be required for processing the payment. For example, airline information. x-addedInVersion: '70' merchantAccount: type: string description: The merchant account that is used to process the payment. reference: type: string description: 'Your reference for the reversal request. Maximum length: 80 characters.' required: - merchantAccount PaymentReversalResponse: type: object additionalProperties: false properties: merchantAccount: type: string description: The merchant account that is used to process the payment. paymentPspReference: type: string description: 'The [`pspReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-pspReference) of the payment to reverse. ' pspReference: type: string description: Adyen's 16-character reference associated with the reversal request. reference: type: string description: Your reference for the reversal request. status: type: string description: The status of your request. This will always have the value **received**. enum: - received required: - merchantAccount - paymentPspReference - pspReference - status PaymentValidations: type: object additionalProperties: false properties: name: $ref: '#/components/schemas/PaymentValidationsNameRequest' PaymentValidationsNameRequest: type: object additionalProperties: false properties: status: type: string description: Set to **requested** to request a [name validation](https://docs.adyen.com/payment-methods/cards/name-validation) to verify if the cardholder name provided by the shopper matches the cardholder name on file at the issuing bank. required: - status title: Name PaymentValidationsNameResponse: type: object additionalProperties: false properties: rawResponse: $ref: '#/components/schemas/PaymentValidationsNameResultRawResponse' description: Contains the raw response(s) returned by the scheme for the name validation. result: $ref: '#/components/schemas/PaymentValidationsNameResultResponse' description: Contains the scheme-agnostic match values returned by Adyen. status: type: string description: 'Informs you if the name validation was performed. Possible values: **performed**, **notPerformed**, **notSupported**' enum: - notPerformed - notSupported - performed PaymentValidationsNameResultRawResponse: type: object additionalProperties: false properties: firstName: type: string description: The raw first name validation result that Adyen received from the scheme. First name validation result is only returned for Visa. fullName: type: string description: The raw full name validation result that Adyen received from the scheme. Full name is the only field that is validated for Mastercard lastName: type: string description: The raw last name validation result that Adyen received from the scheme. Last name validation result is only returned for Visa. middleName: type: string description: The raw middle name validation result that Adyen received from the scheme. Middle name validation result is only returned for Visa. status: type: string description: The raw name validation status value that Adyen received from the scheme. Only returned for Visa. PaymentValidationsNameResultResponse: type: object additionalProperties: false properties: firstName: type: string description: 'Informs you if the first name your shopper provided matches the cardholder first name on file at the issuing bank. The first name is only validated for Visa. Possible values: **match**, **partialMatch**, **noMatch**' fullName: type: string description: 'Informs you if the full name your shopper provided matches the cardholder name on file at the issuing bank. The full name is the only field that is validated for Mastercard. Possible values: **match**, **partialMatch**, **noMatch** ' lastName: type: string description: 'Informs you if the last name your shopper provided matches the cardholder last name on file at the issuing bank. The last name is only validated for Visa. Possible values: **match**, **partialMatch**, **noMatch**' middleName: type: string description: 'Informs you if the middle name your shopper provided matches the cardholder middle name on file at the issuing bank. The middle name is only validated for Visa. Possible values: **match**, **partialMatch**, **noMatch**' PaymentValidationsResponse: type: object additionalProperties: false properties: name: $ref: '#/components/schemas/PaymentValidationsNameResponse' description: Object that contains the status and outcomes of the [name validation](https://docs.adyen.com/payment-methods/cards/name-validation). title: paymentResponse PaypalUpdateOrderRequest: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' description: The updated final payment amount. This amount is the item total plus the shipping costs of the selected `deliveryMethod`. deliveryAddress: $ref: '#/components/schemas/DeliveryAddress' description: The delivery address for this order. deliveryMethods: type: array description: The list of new delivery methods and the cost of each. items: $ref: '#/components/schemas/DeliveryMethod' discountAmount: $ref: '#/components/schemas/Amount' description: The discount amount for this order. paymentData: type: string description: The `paymentData` from the client side. This value changes every time you make a `/paypal/updateOrder` request. pspReference: type: string description: The original `pspReference` from the `/payments` response. sessionId: type: string description: The original `sessionId` from the `/sessions` response. shippingAmount: $ref: '#/components/schemas/Amount' description: The shipping amount for this order. taxTotal: $ref: '#/components/schemas/TaxTotal' description: 'Total tax amount from the order. ' PaypalUpdateOrderResponse: type: object additionalProperties: false properties: paymentData: type: string description: The updated paymentData. status: type: string description: The status of the request. This indicates whether the order was successfully updated with PayPal. enum: - error - success required: - paymentData - status Phone: type: object additionalProperties: false properties: cc: type: string description: "Country code. Length: 1\u20133 digits." maxLength: 3 minLength: 1 subscriber: type: string description: 'Subscriber number. Length: 4-15 digits.' maxLength: 15 PickupInfo: type: object additionalProperties: false properties: city: type: string description: 'The city where the car is rented. * Format: ASCII * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.locationCity`' countryCode: type: string 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. * maxLength: 2 characters * **additionalData key:** `carRental.locationCountry`' date: type: string format: date description: 'The pick-up date. * minLength: 10 characters * maxLength: 10 characters * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `carRental.checkOutDate`' stateOrProvince: type: string description: 'The state or province where the car is rented. * maxLength: 3 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.locationStateProvince`' PixDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. pixRecurring: $ref: '#/components/schemas/PixRecurring' recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string description: The payment method type. enum: - pix title: Stored Payment Method PixPayByBankDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. deviceId: type: string maxLength: 36 issuer: type: string recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. riskSignals: $ref: '#/components/schemas/PixPayByBankRiskSignals' sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: paybybank_pix description: '**paybybank_pix**' enum: - paybybank_pix title: Stored Payment Method PixPayByBankRiskSignals: type: object additionalProperties: false properties: confidenceScore: $ref: '#/components/schemas/ConfidenceScore' elapsedTimeSinceBoot: type: integer format: int64 isRootedDevice: type: boolean language: type: string osVersion: type: string maxLength: 32 screenBrightness: type: integer format: int32 screenDimensions: $ref: '#/components/schemas/ScreenDimensions' userTimeZoneOffset: type: integer format: int32 PixRecurring: type: object additionalProperties: false properties: billingDate: type: string description: The date on which the shopper's payment method will be charged, in YYYY-MM-DD format. businessDayOnly: type: boolean description: Flag used to define whether liquidation can happen only on business days endsAt: type: string description: End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper. frequency: type: string description: The frequency at which the shopper will be charged. enum: - weekly - monthly - quarterly - half-yearly - yearly minAmount: $ref: '#/components/schemas/Amount' description: For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app. originalPspReference: type: string description: The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date. recurringAmount: $ref: '#/components/schemas/Amount' description: For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment. recurringStatement: type: string description: 'The text that that will be shown on the shopper''s bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.' retryPolicy: type: boolean description: When set to true, you can retry for failed recurring payments. The default value is true. startsAt: type: string description: Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date. title: pixRecurring PlatformChargebackLogic: type: object additionalProperties: false properties: behavior: type: string description: 'The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.' enum: - deductFromOneBalanceAccount - deductAccordingToSplitRatio - deductFromLiableAccount costAllocationAccount: type: string 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. targetAccount: type: string description: 'The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**.' PseDetails: type: object additionalProperties: false properties: bank: type: string description: The shopper's bank. checkoutAttemptId: type: string description: The checkout attempt identifier. clientType: type: string description: The client type. identification: type: string description: The identification code. identificationType: type: string description: The identification type. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string description: The payment method type. enum: - pse_payulatam required: - bank - clientType - identification - identificationType title: PSE Latam RakutenPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: rakutenpay description: '**rakutenpay**' enum: - rakutenpay title: RakutenPay RatepayDetails: type: object additionalProperties: false properties: billingAddress: type: string description: The address where to send the invoice. checkoutAttemptId: type: string description: The checkout attempt identifier. deliveryAddress: type: string description: The address where the goods should be delivered. personalDetails: type: string description: Shopper name, date of birth, phone number, and email address. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: ratepay description: '**ratepay**' enum: - ratepay - ratepay_directdebit required: - type title: Ratepay Recurring: type: object additionalProperties: false properties: contract: type: string description: "The type of recurring contract to be used.\nPossible values:\n\ * `ONECLICK` \u2013 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).\n\ * `RECURRING` \u2013 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).\n\ * `ONECLICK,RECURRING` \u2013 Payment details can be used regardless of\ \ whether the shopper is on your site or not.\n* `PAYOUT` \u2013 Payment\ \ details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).\n\ * `EXTERNAL` - Use this when you store payment details and send the raw\ \ card number or network token directly in your API request.\n" enum: - ONECLICK - ONECLICK,RECURRING - RECURRING - PAYOUT - EXTERNAL recurringDetailName: type: string description: A descriptive name for this detail. recurringExpiry: type: string format: date-time description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. x-addedInVersion: '40' recurringFrequency: type: string description: Minimum number of days between authorisations. Only for 3D Secure 2. x-addedInVersion: '40' tokenService: type: string description: The name of the token service. enum: - VISATOKENSERVICE - MCTOKENSERVICE - AMEXTOKENSERVICE - TOKEN_SHARING x-addedInVersion: '25' RentalSurcharges: type: object additionalProperties: false properties: fuel: type: integer format: int64 description: 'The fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `carRental.fuelCharges`' insurance: type: integer format: int64 description: 'Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `carRental.insuranceCharges`' oneWayDropOff: type: integer format: int64 description: 'The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `carRental.oneWayDropOffCharges`' ResponseAdditionalData3DSecure: type: object additionalProperties: false properties: cardHolderInfo: type: string description: 'Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. ' cavv: type: string description: The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array. cavvAlgorithm: type: string description: The CAVV algorithm used. scaExemptionRequested: type: string 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** " threeds2.cardEnrolled: type: boolean description: Indicates whether a card is enrolled for 3D Secure 2. ResponseAdditionalDataBillingAddress: type: object additionalProperties: false properties: billingAddress.city: type: string description: The billing address city passed in the payment request. billingAddress.country: type: string description: 'The billing address country passed in the payment request. Example: NL' billingAddress.houseNumberOrName: type: string description: The billing address house number or name passed in the payment request. billingAddress.postalCode: type: string description: 'The billing address postal code passed in the payment request. Example: 1011 DJ' billingAddress.stateOrProvince: type: string description: 'The billing address state or province passed in the payment request. Example: NH' billingAddress.street: type: string description: The billing address street passed in the payment request. ResponseAdditionalDataCard: type: object additionalProperties: false properties: cardAltID: type: string description: 'This is an ALT ID (alternate ID) mapped to the Card PAN. > Returned only in case of Ecommerce Card Payment in India' cardBin: type: string 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' cardHolderName: type: string description: The cardholder name passed in the payment request. cardIssuingBank: type: string description: The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available. cardIssuingCountry: type: string description: 'The country where the card was issued. Example: US' cardIssuingCurrency: type: string 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" cardPaymentMethod: type: string description: 'The card payment method used for the transaction. Example: amex' cardProductId: type: string description: 'The Card Product ID represents the type of card following card scheme product definitions and can be returned for Adyen Acquiring service level payments. Example values Visa: * **A** - Visa Traditional * **B** - Visa Traditional Rewards * **C** - Visa Signature * **D** - Visa Signature Preferred * **F** - Visa Classic Example values Mastercard: * **MCC** - Mastercard Card * **MCE** - Mastercard Electronic Card * **MCF** - Mastercard Corporate Fleet Card * **MCG** - Gold Mastercard Card * **MCH** - Mastercard Premium Charge * **MCI** - Mastercard Select Debit ' cardSummary: type: string description: 'The last four digits of a card number. > Returned only in case of a card payment.' issuerBin: type: string 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' ResponseAdditionalDataCommon: type: object additionalProperties: false properties: acquirerAccountCode: type: string description: 'The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions.' acquirerCode: type: string description: 'The name of the acquirer processing the payment request. Example: TestPmmAcquirer' acquirerReference: type: string description: 'The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9' alias: type: string description: 'The Adyen alias of the card. Example: H167852639363479' aliasType: type: string description: 'The type of the card alias. Example: Default' authCode: type: string 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' authorisationMid: type: string description: Merchant ID known by the acquirer. authorisedAmountCurrency: type: string description: The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). authorisedAmountValue: type: string 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).' avsResult: type: string 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).' avsResultRaw: type: string description: 'Raw AVS result received from the acquirer, where available. Example: D' bic: type: string description: 'BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions.' coBrandedWith: type: string description: Includes the co-branded card information. cvcResult: type: string description: The result of CVC verification. example: 1 Matches cvcResultRaw: type: string description: The raw result of CVC verification. example: M dsTransID: type: string description: Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction. eci: type: string description: 'The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02' expiryDate: type: string description: 'The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment.' extraCostsCurrency: type: string description: 'The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR' extraCostsValue: type: string 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. fraudCheck-[itemNr]-[FraudCheckname]: type: string description: The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. fraudManualReview: type: string description: Indicates if the payment is sent to manual review. fraudResultType: type: string description: 'The fraud result properties of the payment. Possible values: * AMBER * GREEN * RED ' enum: - AMBER - GREEN - RED fraudRiskLevel: type: string description: 'The risk level of the transaction as classified by the [machine learning](https://docs.adyen.com/risk-management/configure-your-risk-profile/machine-learning-rules/) fraud risk rule. The risk level indicates the likelihood that a transaction will result in a fraudulent dispute. Possible values: * veryLow * low * medium * high * veryHigh ' enum: - veryLow - low - medium - high - veryHigh fundingSource: type: string 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**.' fundsAvailability: type: string 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".' inferredRefusalReason: type: string 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' isCardCommercial: type: string description: Indicates if the card is used for business purposes only. issuerCountry: type: string description: 'The issuing country of the card based on the BIN list that Adyen maintains. Example: JP' liabilityShift: type: string description: A Boolean value indicating whether a liability shift was offered for this payment. mcBankNetReferenceNumber: type: string description: 'The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field.' merchantAdviceCode: type: string 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).' merchantReference: type: string description: The reference provided for the transaction. networkProcessingMode: type: string description: "Indicates the processing flow.\n\nPossible values:\n* **sale**:\ \ You do not need to separately capture the funds, because capture happens\ \ automatically as part of the transaction. \n* **auth**: If you have\ \ not [configured automatic capture for the transaction](https://docs.adyen.com/online-payments/capture#types-of-capture),\ \ you must manually capture the funds." networkTxReference: type: string 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.' ownerName: type: string description: 'The owner name of a bank account. Only relevant for SEPA Direct Debit transactions.' paymentAccountReference: type: string 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. paymentMethod: type: string description: The payment method used in the transaction. paymentMethodVariant: type: string 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' payoutEligible: type: string 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)' realtimeAccountUpdaterStatus: type: string description: 'The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder' receiptFreeText: type: string description: Message to be displayed on the terminal. recurring.contractTypes: type: string description: The recurring contract types applicable to the transaction. x-addedInVersion: '40' recurring.firstPspReference: type: string 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.' recurring.recurringDetailReference: type: string deprecated: true description: The reference that uniquely identifies the recurring transaction. x-deprecatedInVersion: '68' x-deprecatedMessage: Use tokenization.storedPaymentMethodId instead. recurring.shopperReference: type: string deprecated: true description: The provided reference of the shopper for a recurring transaction. x-addedInVersion: '40' x-deprecatedInVersion: '68' x-deprecatedMessage: Use tokenization.shopperReference instead. recurringProcessingModel: type: string description: The processing model used for the recurring transaction. enum: - CardOnFile - Subscription - UnscheduledCardOnFile x-addedInVersion: '40' referred: type: string 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' refusalReasonRaw: type: string description: 'Raw refusal reason received from the acquirer, where available. Example: AUTHORISED' requestAmount: type: string description: The amount of the payment request. requestCurrencyCode: type: string description: The currency of the payment request. shopperInteraction: type: string description: 'The shopper interaction type of the payment request. Example: Ecommerce' shopperReference: type: string description: 'The shopperReference passed in the payment request. Example: AdyenTestShopperXX' terminalId: type: string description: 'The terminal ID used in a point-of-sale payment. Example: 06022622' threeDAuthenticated: type: string description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true' threeDAuthenticatedResponse: type: string description: 'The raw 3DS authentication result from the card issuer. Example: N' threeDOffered: type: string description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true' threeDOfferedResponse: type: string description: 'The raw enrollment result from the 3DS directory services of the card schemes. Example: Y' threeDSVersion: type: string description: The 3D Secure 2 version. tokenization.shopperReference: type: string description: The reference for the shopper that you sent when tokenizing the payment details. tokenization.store.operationType: type: string description: 'The operation performed on the token. Possible values: * **created**: the token has been created. * **updated**: the existing token has been updated. * **alreadyExisting**: the details have already been stored. ' enum: - created - updated - alreadyExisting tokenization.storedPaymentMethodId: type: string description: The reference that uniquely identifies tokenized payment details. transactionLinkId: type: string description: 'Returned in the response for Mastercard payments. This contains the Mastercard Transaction Link Identifier (TLID).' visaTransactionId: type: string description: 'The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field.' xid: type: string 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'. \n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=" ResponseAdditionalDataDomesticError: type: object additionalProperties: false properties: domesticRefusalReasonRaw: type: string description: "The reason the transaction was declined, given by the local\ \ issuer. \nCurrently available for merchants in Japan." domesticShopperAdvice: type: string description: "The action the shopper should take, in a local language. \n\ Currently available in Japanese, for merchants in Japan." ResponseAdditionalDataInstallments: type: object additionalProperties: false properties: installmentPaymentData.installmentType: type: string description: Type of installment. The value of `installmentType` should be **IssuerFinanced**. installmentPaymentData.option[itemNr].annualPercentageRate: type: string description: Annual interest rate. installmentPaymentData.option[itemNr].firstInstallmentAmount: type: string description: First Installment Amount in minor units. installmentPaymentData.option[itemNr].installmentFee: type: string description: Installment fee amount in minor units. installmentPaymentData.option[itemNr].interestRate: type: string description: Interest rate for the installment period. installmentPaymentData.option[itemNr].maximumNumberOfInstallments: type: string description: Maximum number of installments possible for this payment. installmentPaymentData.option[itemNr].minimumNumberOfInstallments: type: string description: Minimum number of installments possible for this payment. installmentPaymentData.option[itemNr].numberOfInstallments: type: string description: Total number of installments possible for this payment. installmentPaymentData.option[itemNr].subsequentInstallmentAmount: type: string description: Subsequent Installment Amount in minor units. installmentPaymentData.option[itemNr].totalAmountDue: type: string description: Total amount in minor units. installmentPaymentData.paymentOptions: type: string description: 'Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments' installments.value: type: string 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.' ResponseAdditionalDataNetworkTokens: type: object additionalProperties: false properties: networkToken.available: type: string description: Indicates whether a network token is available for the specified card. networkToken.bin: type: string description: The Bank Identification Number of a tokenized card, which is the first six digits of a card number. networkToken.tokenSummary: type: string description: The last four digits of a network token. ResponseAdditionalDataOpi: type: object additionalProperties: false properties: opi.transToken: type: string 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).' ResponseAdditionalDataSepa: type: object additionalProperties: false properties: sepadirectdebit.dateOfSignature: type: string description: 'The transaction signature date. Format: yyyy-MM-dd' sepadirectdebit.mandateId: type: string description: Its value corresponds to the pspReference value of the transaction. sepadirectdebit.sepadirectdebit.dueDate: type: string description: The date that the the shopper's bank account is charged. sepadirectdebit.sequenceType: type: string 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' ResponseAdditionalDataSwish: type: object additionalProperties: false properties: swish.payerAlias: type: string description: A Swish shopper's telephone number. ResponsePaymentMethod: type: object additionalProperties: false properties: brand: type: string description: The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**. type: type: string description: The `paymentMethod.type` value used in the request. title: paymentResponse ReturnInfo: type: object additionalProperties: false properties: city: type: string description: 'The city where the car must be returned. * Format: ASCII * maxLength: 18 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.returnCity`' countryCode: type: string 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. * maxLength: 2 characters * **additionalData key:** `carRental.returnCountry`' date: type: string format: date description: 'The date by which the car must be returned. * minLength: 10 characters * maxLength: 10 characters * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `carRental.returnDate`' locationId: type: string description: 'The agency code, phone number, or address abbreviation. * Format: ASCII * maxLength: 10 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.returnLocationId`' stateOrProvince: type: string description: 'The state or province where the car must be returned. * Format: ASCII * maxLength: 3 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `carRental.returnStateProvince`' RiskData: type: object additionalProperties: false properties: clientData: type: string description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. maxLength: 5000 customFields: type: object additionalProperties: type: string description: Any custom fields used as part of the input to configured risk rules. x-addedInVersion: '65' fraudOffset: type: integer format: int32 description: An integer value that is added to the normal fraud score. The value can be either positive or negative. x-addedInVersion: '65' profileReference: type: string description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. x-addedInVersion: '65' RivertyDetails: type: object additionalProperties: false properties: billingAddress: type: string description: The address where to send the invoice. checkoutAttemptId: type: string description: The checkout attempt identifier. deliveryAddress: type: string description: The address where the goods should be delivered. deviceFingerprint: type: string 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 iban: type: string description: 'The iban number of the customer ' maxLength: 34 personalDetails: type: string description: Shopper name, date of birth, phone number, and email address. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' subtype: type: string description: The payment method subtype. type: type: string default: riverty description: '**riverty**' enum: - riverty - riverty_account - riverty_installments - sepadirectdebit_riverty required: - type title: Riverty Room: type: object additionalProperties: false properties: numberOfNights: type: integer format: int32 description: 'The total number of nights the room is booked for. * Format: Numeric * Must be a number between 1 and 99 * **additionalData key:** `lodging.room[N].numberOfNights`' rate: type: integer format: int64 description: 'Room rate per night, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `lodging.room[N].rate`' SDKEphemPubKey: type: object additionalProperties: false properties: crv: type: string description: The `crv` value as received from the 3D Secure 2 SDK. kty: type: string description: The `kty` value as received from the 3D Secure 2 SDK. x: type: string description: The `x` value as received from the 3D Secure 2 SDK. y: type: string description: The `y` value as received from the 3D Secure 2 SDK. SamsungPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. samsungPayToken: type: string description: The payload you received from the Samsung Pay SDK response. maxLength: 10000 sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: samsungpay description: '**samsungpay**' enum: - samsungpay required: - samsungPayToken title: Samsung Pay ScreenDimensions: type: object additionalProperties: false properties: height: type: integer format: int32 width: type: integer format: int32 SepaDirectDebitDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. dueDate: type: string description: The date that the the shopper's bank account is charged. iban: type: string description: The International Bank Account Number (IBAN). ownerName: type: string description: The name of the bank account holder. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' transferInstrumentId: type: string description: The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts. type: type: string default: sepadirectdebit description: '**sepadirectdebit**' enum: - sepadirectdebit - sepadirectdebit_amazonpay required: - iban - ownerName title: SEPA Direct Debit SepaDirectDebitDonations: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: sepadirectdebit description: '**sepadirectdebit**' enum: - sepadirectdebit title: Stored Payment Method ServiceError: type: object additionalProperties: false properties: additionalData: type: object 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**. x-addedInVersion: '46' errorCode: type: string description: The error code mapped to the error message. errorType: type: string description: The category of the error. message: type: string description: A short explanation of the issue. pspReference: type: string description: The PSP reference of the payment. status: type: integer format: int32 description: The HTTP response status. SessionResultResponse: type: object additionalProperties: false properties: additionalData: type: object additionalProperties: type: string description: Contains additional information about the payment. Some fields are included only if you enable them. To enable these fields in your Customer Area, go to **Developers** > **Additional data**. 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' - $ref: '#/components/schemas/ResponseAdditionalDataSwish' id: type: string description: A unique identifier of the session. payments: type: array description: A list of all authorised payments done for this session. items: $ref: '#/components/schemas/Payment' reference: type: string description: The unique reference that you provided in the original `/sessions` request. This identifies the payment and is used in all communication with you about the payment status. status: type: string description: 'The status of the session. The status included in the response doesn''t get updated. Don''t make the request again to check for payment status updates. Possible values: * **completed**: the shopper completed the payment, and the payment was authorized. * **paymentPending**: the shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow, like voucher payments where the shopper completes the payment in a physical shop. * **refused**: the session has been refused, because of too many refused payment attempts. The shopper can no longer complete the payment with this session. * **canceled**: the shopper canceled the payment. * **expired**: the session expired. The shopper can no longer complete the payment with this session. By default, the session expires one hour after it is created.' enum: - active - canceled - completed - expired - paymentPending - refused ShopperInteractionDevice: type: object additionalProperties: false properties: locale: type: string description: Locale on the shopper interaction device. os: type: string description: Operating system running on the shopper interaction device. osVersion: type: string description: Version of the operating system on the shopper interaction device. ShopperName: type: object additionalProperties: false properties: firstName: type: string description: The first name. maxLength: 80 lastName: type: string description: The last name. maxLength: 80 required: - firstName - lastName ShopperTaxInfo: type: object additionalProperties: false properties: taxCountryCode: type: string description: 'The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code associated with the provided tax identification number. Currently used only for Indian PA-CB tax verification, when applicable.' maxLength: 2 taxIdentificationNumber: type: string description: "The shopper\u2019s tax identification number." maxLength: 20 required: - taxCountryCode - taxIdentificationNumber Split: type: object additionalProperties: false properties: account: type: string 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/classic-platforms): 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/adyen-for-platforms-model): 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.' amount: $ref: '#/components/schemas/SplitAmount' description: 'The amount of the split item. * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/classic-platforms). * Required if `type` is **BalanceAccount**, **Commission**, **Surcharge**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model) integration.' description: type: string description: Your description for the split item. reference: type: string description: 'Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). 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: type: string description: "The part of the payment you want to book to the specified\ \ `account`.\n\nPossible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model):\n\ * **BalanceAccount**: Books part of the payment (specified in `amount`)\ \ to the specified `account`.\n* Transaction fees types that you can book\ \ to the specified `account`:\n * **AcquiringFees**: The aggregated\ \ amount of the interchange and scheme fees.\n * **PaymentFee**: The\ \ aggregated amount of all transaction fees.\n * **AdyenFees**: The\ \ aggregated amount of Adyen's commission and markup fees.\n * **AdyenCommission**:\ \ The transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ \ * **AdyenMarkup**: The transaction fees due to Adyen under [Interchange\ \ ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained).\n\ \ * **Interchange**: The fees paid to the issuer for each payment made\ \ with the card network.\n * **SchemeFee**: The fees paid to the card\ \ scheme for using their network. \n* **Commission**: Your platform's\ \ commission on the payment (specified in `amount`), booked to your liable\ \ balance account.\n* **Remainder**: The amount left over after a currency\ \ conversion, booked to the specified `account`.\n* **Surcharge**: The\ \ payment acceptance fee imposed by the card scheme or debit network provider,\ \ paid by your user's customer.\n* **TopUp**: Allows you and your users\ \ to top up balance accounts using direct debit, card payments, or other\ \ payment methods.\n* **VAT**: The value-added tax charged on the payment,\ \ booked to your platforms liable balance account.\n* **Default**: In\ \ very specific use cases, allows you to book the specified `amount` to\ \ the specified `account`. For more information, contact Adyen support.\n\ \nPossible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms):\ \ **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**." enum: - AcquiringFees - AdyenCommission - AdyenFees - AdyenMarkup - BalanceAccount - Commission - Default - Interchange - MarketPlace - PaymentFee - Remainder - SchemeFee - Surcharge - Tip - TopUp - VAT required: - type SplitAmount: type: object additionalProperties: false properties: currency: type: string 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 value: type: integer format: int64 description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). required: - value StandalonePaymentCancelRequest: type: object additionalProperties: false properties: applicationInfo: $ref: '#/components/schemas/ApplicationInfo' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). enhancedSchemeData: $ref: '#/components/schemas/EnhancedSchemeData' description: Enhanced scheme data that may be required for processing the payment. For example, airline information. x-addedInVersion: '70' merchantAccount: type: string description: The merchant account that is used to process the payment. paymentReference: type: string description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment that you want to cancel. reference: type: string description: 'Your reference for the cancel request. Maximum length: 80 characters.' required: - merchantAccount - paymentReference StandalonePaymentCancelResponse: type: object additionalProperties: false properties: merchantAccount: type: string description: The merchant account that is used to process the payment. paymentReference: type: string description: The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment to cancel. pspReference: type: string description: Adyen's 16-character reference associated with the cancel request. reference: type: string description: Your reference for the cancel request. status: type: string description: The status of your request. This will always have the value **received**. enum: - received required: - merchantAccount - paymentReference - pspReference - status StoredPaymentMethod: type: object additionalProperties: false properties: bankAccountNumber: type: string description: The bank account number (without separators). bankLocationId: type: string description: The location id of the bank. The field value is `nil` in most cases. brand: type: string description: The brand of the card. cashtag: type: string description: "The shopper\u2019s Cash App Pay Cashtag." x-addedInVersion: '70' expiryMonth: type: string description: The two-digit month when the card expires expiryYear: type: string description: The last two digits of the year the card expires. For example, **22** for the year 2022. holderName: type: string description: The name of the payment method holder. iban: type: string description: The IBAN of the bank account. x-addedInVersion: '67' id: type: string description: A unique identifier of this stored payment method. label: type: string description: "The shopper\u2019s issuer account label" x-addedInVersion: '70' lastFour: type: string description: The last four digits of the PAN. name: type: string description: The display name of the stored payment method. networkTxReference: type: string 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.' x-addedInVersion: '68' ownerName: type: string description: The name of the bank account holder. x-addedInVersion: '67' shopperEmail: type: string description: "The shopper\u2019s email address." supportedRecurringProcessingModels: type: array description: The supported recurring processing models for this stored payment method. items: type: string x-addedInVersion: '70' supportedShopperInteractions: type: array description: The supported shopper interactions for this stored payment method. items: type: string type: type: string description: The type of payment method. StoredPaymentMethodDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string description: The payment method type. enum: - alipay_plus - alipay_plus_alipay_cn - alipay_plus_alipay_hk - alipay_plus_dana - alipay_plus_gcash - alipay_plus_kakaopay - alipay_plus_kplus - alipay_plus_naverpay - alipay_plus_rabbitlinepay - alipay_plus_tosspay - alipay_plus_touchngo - alipay_plus_truemoney - bcmc_mobile - bcmc_mobile_QR - bcmc_mobile_app - momo_wallet - momo_wallet_app - paymaya_wallet - grabpay_SG - grabpay_MY - grabpay_TH - grabpay_ID - grabpay_VN - grabpay_PH - oxxo - gcash - dana - kakaopay - truemoney - paysafecard - gopay_wallet title: Stored Payment Method StoredPaymentMethodRequest: type: object additionalProperties: false properties: merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. paymentMethod: $ref: '#/components/schemas/PaymentMethodToStore' description: Contains the information required to store a payment method. recurringProcessingModel: type: string description: "Defines a recurring payment type. Required when creating a\ \ token to store payment details.\nAllowed values:\n* `Subscription` \u2013\ \ A transaction for a fixed or variable amount, which follows a fixed\ \ schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile`\ \ \u2013 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.\n" enum: - CardOnFile - Subscription - UnscheduledCardOnFile x-addedInVersion: '70' shopperEmail: type: string description: The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. shopperIP: type: string description: The IP address of a shopper. shopperReference: type: string description: A unique identifier for the shopper (for example, user ID or account ID). required: - merchantAccount - paymentMethod - recurringProcessingModel - shopperReference StoredPaymentMethodResource: type: object additionalProperties: false properties: alias: type: string description: 'The alias of the credit card number. Applies only to recurring contracts storing credit card details' aliasType: type: string description: 'The alias type of the credit card number. Applies only to recurring contracts storing credit card details.' brand: type: string description: The brand of the card. cardBin: type: string description: The bank identification number (BIN) of the card. expiryMonth: type: string description: The month the card expires. expiryYear: type: string description: The last two digits of the year the card expires. For example, **22** for the year 2022. externalResponseCode: type: string description: The response code returned by an external system (for example after a provisioning operation). x-addedInVersion: '68' externalTokenReference: type: string description: The token reference of a linked token in an external system (for example a network token reference). x-addedInVersion: '68' holderName: type: string description: The unique payment method code. iban: type: string description: The IBAN of the bank account. id: type: string description: A unique identifier of this stored payment method. issuerName: type: string description: The name of the issuer of token or card. x-addedInVersion: '68' lastFour: type: string description: The last four digits of the PAN. mandate: $ref: '#/components/schemas/TokenMandate' description: Mandate details for the stored payment method. x-addedInVersion: '71' name: type: string description: The display name of the stored payment method. networkTxReference: type: string 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.' ownerName: type: string description: The name of the bank account holder. x-addedInVersion: '67' shopperEmail: type: string description: "The shopper\u2019s email address." shopperReference: type: string description: 'Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address.' maxLength: 256 minLength: 3 supportedRecurringProcessingModels: type: array description: "Defines a recurring payment type.\nAllowed values:\n* `Subscription`\ \ \u2013 A transaction for a fixed or variable amount, which follows a\ \ fixed schedule.\n* `CardOnFile` \u2013 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.\n* `UnscheduledCardOnFile`\ \ \u2013 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 x-addedInVersion: '70' type: type: string description: The type of payment method. SubInputDetail: type: object additionalProperties: false properties: configuration: type: object additionalProperties: type: string description: Configuration parameters for the required input. items: type: array description: In case of a select, the items to choose from. items: $ref: '#/components/schemas/Item' key: type: string description: The value to provide in the result. optional: type: boolean description: True if this input is optional to provide. type: type: string description: The type of the required input. value: type: string description: The value can be pre-filled, if available. SubMerchant: type: object additionalProperties: false properties: city: type: string description: 'The city of the sub-merchant''s address. * Format: Alphanumeric * Maximum length: 13 characters' country: type: string 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" mcc: type: string description: "The sub-merchant's 4-digit Merchant Category Code (MCC). \n\ * Format: Numeric\n* Fixed length: 4 digits" name: type: string 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' taxId: type: string description: 'The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' SubMerchantInfo: type: object additionalProperties: false properties: address: $ref: '#/components/schemas/BillingAddress' description: 'Required for transactions performed by registered payment facilitators. The sub-merchant''s address. ' amount: $ref: '#/components/schemas/Amount' description: Required for transactions performed by registered payment facilitators. The amount of the payment corresponding to each sub-merchant. This value will be different than the request amount if shopper is purchasing items at different sub-merchants' shops. email: type: string description: Required for transactions performed by registered payment facilitators. The email associated with the sub-merchant's account. maxLength: 320 id: type: string 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" mcc: type: string 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" name: type: string 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. Exception: for acquirers in Brazil, this value does not overwrite the shopper statement. * Format: Alphanumeric * Maximum length: 22 characters' phoneNumber: type: string description: Required for transactions performed by registered payment facilitators. The phone number associated with the sub-merchant's account. maxLength: 20 registeredSince: type: string taxId: type: string 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' url: type: string description: Required for transactions performed by registered payment facilitators. The sub-merchant's URL on the platform, i.e. the sub-merchant's shop. maxLength: 320 Surcharge: type: object additionalProperties: false properties: value: type: integer format: int64 description: 'The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge.' required: - value TaxTotal: type: object additionalProperties: false properties: amount: $ref: '#/components/schemas/Amount' TemporaryServices: type: object additionalProperties: false properties: employeeName: type: string description: 'The name or ID of the person working in a temporary capacity. * Format: ASCII * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `enhancedSchemeData.employeeName`' endDate: type: string format: date description: 'The billing period end date. * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `enhancedSchemeData.tempWeekEnding`' hourRate: type: integer format: int32 description: 'The hourly rate for the temporary services, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max value: 10000000000 * **additionalData key:** `enhancedSchemeData.regularHoursRate`' hoursWorked: type: integer format: int32 description: 'The number of hours worked during the billing period. * Format: Numeric * **additionalData key:** `enhancedSchemeData.regularHoursWorked`' jobDescription: type: string description: 'The job description of the person working in a temporary capacity. * Format: ASCII * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `enhancedSchemeData.jobDescription`' serviceRequestor: type: string description: 'The name of the person requesting the temporary services. * Format: ASCII * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `enhancedSchemeData.requestName`' startDate: type: string format: date description: 'The billing period start date. * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `enhancedSchemeData.tempStartDate`' ThirdPartyTokenRedundancyInfo: type: object additionalProperties: false properties: requestParameters: type: object additionalProperties: type: string description: Request-specific parameter values to populate the template placeholders. Each key must match a placeholder defined in the template referenced by `requestTemplateCode`. requestTemplateCode: type: string description: Identifier for the third-party token request template configured in your Adyen account. This template defines the structure and endpoint for token requests. required: - requestTemplateCode ThreeDS2RequestData: type: object additionalProperties: false properties: acctInfo: $ref: '#/components/schemas/AcctInfo' description: "Additional information about the cardholder\u2019s account\ \ provided by the 3DS Requestor." x-addedInVersion: '68' acctType: type: string description: "Indicates the type of account. For example, for a multi-account\ \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\ \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit" enum: - '01' - '02' - '03' maxLength: 2 minLength: 2 x-addedInVersion: '68' acquirerBIN: type: string 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. x-addedInVersion: '49' acquirerMerchantID: type: string 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. x-addedInVersion: '49' addrMatch: type: string description: "Indicates whether the cardholder shipping address and cardholder\ \ billing address are the same. Allowed values:\n* **Y** \u2014 Shipping\ \ address matches billing address.\n* **N** \u2014 Shipping address does\ \ not match billing address." enum: - Y - N maxLength: 1 minLength: 1 x-addedInVersion: '68' authenticationOnly: type: boolean default: false deprecated: true 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. x-deprecatedInVersion: '50' x-deprecatedMessage: Use `threeDSAuthenticationOnly` instead. challengeIndicator: type: string deprecated: true description: 'Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` ' enum: - noPreference - requestNoChallenge - requestChallenge - requestChallengeAsMandate x-deprecatedInVersion: '68' x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead. deviceChannel: type: string description: 'The environment of the shopper. Allowed values: * `app` * `browser`' deviceRenderOptions: $ref: '#/components/schemas/DeviceRenderOptions' description: 'Display options for the 3D Secure 2 SDK. Optional and only for `deviceChannel` **app**.' homePhone: $ref: '#/components/schemas/Phone' description: 'The home phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' x-addedInVersion: '68' mcc: type: string 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. x-addedInVersion: '49' merchantName: type: string 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.' x-addedInVersion: '49' messageVersion: type: string description: The `messageVersion` value indicating the 3D Secure 2 protocol version. mobilePhone: $ref: '#/components/schemas/Phone' description: 'The mobile phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' x-addedInVersion: '68' notificationURL: type: string 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**. payTokenInd: type: boolean description: Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. x-addedInVersion: '68' paymentAuthenticationUseCase: type: string description: Indicates the type of payment for which an authentication is requested (message extension) x-addedInVersion: '68' purchaseInstalData: type: string description: "Indicates the maximum number of authorisations permitted for\ \ instalment payments. Length: 1\u20133 characters." maxLength: 3 minLength: 1 x-addedInVersion: '68' recurringExpiry: type: string description: 'Date after which no further authorisations shall be performed. Format: YYYYMMDD' x-addedInVersion: '68' recurringFrequency: type: string description: 'Indicates the minimum number of days between authorisations. Maximum length: 4 characters.' maxLength: 4 x-addedInVersion: '68' sdkAppID: type: string description: 'The `sdkAppID` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**.' sdkEncData: type: string description: 'The `sdkEncData` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**.' sdkEphemPubKey: $ref: '#/components/schemas/SDKEphemPubKey' description: 'The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**.' sdkMaxTimeout: type: integer format: int32 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.' sdkReferenceNumber: type: string description: 'The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**.' sdkTransID: type: string description: 'The `sdkTransID` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**.' sdkVersion: type: string description: "Version of the 3D Secure 2 mobile SDK. \nOnly for `deviceChannel`\ \ set to **app**." x-addedInVersion: '40' threeDSCompInd: type: string description: Completion indicator for the device fingerprinting. threeDSRequestorAuthenticationInd: type: string description: Indicates the type of Authentication request. x-addedInVersion: '68' threeDSRequestorAuthenticationInfo: $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' description: Information about how the 3DS Requestor authenticated the cardholder before or during the transaction x-addedInVersion: '68' threeDSRequestorChallengeInd: type: string description: "Indicates whether a challenge is requested for this transaction.\ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\ \ \u2014 No challenge (transactional risk analysis is already performed)\n\ * **06** \u2014 Data Only" enum: - '01' - '02' - '03' - '04' - '05' - '06' x-addedInVersion: '68' threeDSRequestorID: type: string 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. threeDSRequestorName: type: string 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. threeDSRequestorPriorAuthenticationInfo: $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo' description: Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction. x-addedInVersion: '68' threeDSRequestorURL: type: string 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. transType: type: string description: "Identifies the type of transaction being authenticated. Length:\ \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\ * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\ \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\ \ Load" enum: - '01' - '03' - '10' - '11' - '28' maxLength: 2 minLength: 2 x-addedInVersion: '68' transactionType: type: string description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase - checkAcceptance - accountFunding - quasiCashTransaction - prepaidActivationAndLoad x-addedInVersion: '50' whiteListStatus: type: string description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. x-addedInVersion: '49' workPhone: $ref: '#/components/schemas/Phone' description: 'The work phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' x-addedInVersion: '68' required: - deviceChannel ThreeDS2RequestFields: type: object additionalProperties: false properties: acctInfo: $ref: '#/components/schemas/AcctInfo' description: "Additional information about the cardholder\u2019s account\ \ provided by the 3DS Requestor." x-addedInVersion: '68' acctType: type: string description: "Indicates the type of account. For example, for a multi-account\ \ card product. Length: 2 characters. Allowed values:\n* **01** \u2014\ \ Not applicable\n* **02** \u2014 Credit\n* **03** \u2014 Debit" enum: - '01' - '02' - '03' maxLength: 2 minLength: 2 x-addedInVersion: '68' acquirerBIN: type: string 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. x-addedInVersion: '49' acquirerMerchantID: type: string 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. x-addedInVersion: '49' addrMatch: type: string description: "Indicates whether the cardholder shipping Address and cardholder\ \ billing address are the same. Allowed values:\n* **Y** \u2014 Shipping\ \ Address matches Billing Address.\n* **N** \u2014 Shipping Address does\ \ not match Billing Address." enum: - Y - N maxLength: 1 minLength: 1 x-addedInVersion: '68' authenticationOnly: type: boolean default: false deprecated: true 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. x-deprecatedInVersion: '50' x-deprecatedMessage: '- If your version is between 50 and 69, use `threeDSAuthenticationOnly` instead. - If your version is 70 or later, use `authenticationData.authenticationOnly` instead.' challengeIndicator: type: string deprecated: true description: 'Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` ' enum: - noPreference - requestNoChallenge - requestChallenge - requestChallengeAsMandate x-deprecatedInVersion: '68' x-deprecatedMessage: Use `threeDSRequestorChallengeInd` instead. deviceRenderOptions: $ref: '#/components/schemas/DeviceRenderOptions' description: 'Display options for the 3D Secure 2 SDK. Optional and only for `deviceChannel` **app**.' homePhone: $ref: '#/components/schemas/Phone' description: 'The home phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' x-addedInVersion: '68' mcc: type: string 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. x-addedInVersion: '49' merchantName: type: string 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.' x-addedInVersion: '49' messageVersion: type: string description: The `messageVersion` value indicating the 3D Secure 2 protocol version. mobilePhone: $ref: '#/components/schemas/Phone' description: 'The mobile phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' x-addedInVersion: '68' notificationURL: type: string 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**. payTokenInd: type: boolean description: Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. x-addedInVersion: '68' paymentAuthenticationUseCase: type: string description: Indicates the type of payment for which an authentication is requested (message extension) x-addedInVersion: '68' purchaseInstalData: type: string description: "Indicates the maximum number of authorisations permitted for\ \ instalment payments. Length: 1\u20133 characters." maxLength: 3 minLength: 1 x-addedInVersion: '68' recurringExpiry: type: string description: 'Date after which no further authorisations shall be performed. Format: YYYYMMDD' x-addedInVersion: '68' recurringFrequency: type: string description: 'Indicates the minimum number of days between authorisations. Maximum length: 4 characters.' maxLength: 4 x-addedInVersion: '68' sdkAppID: type: string description: The `sdkAppID` value as received from the 3D Secure 2 SDK. sdkEphemPubKey: $ref: '#/components/schemas/SDKEphemPubKey' description: The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK. sdkMaxTimeout: type: integer format: int32 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.' sdkReferenceNumber: type: string description: The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. sdkTransID: type: string description: The `sdkTransID` value as received from the 3D Secure 2 SDK. threeDSCompInd: type: string description: Completion indicator for the device fingerprinting. threeDSRequestorAuthenticationInd: type: string description: Indicates the type of Authentication request. x-addedInVersion: '68' threeDSRequestorAuthenticationInfo: $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' description: Information about how the 3DS Requestor authenticated the cardholder before or during the transaction x-addedInVersion: '68' threeDSRequestorChallengeInd: type: string description: "Indicates whether a challenge is requested for this transaction.\ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\ \ \u2014 No challenge (transactional risk analysis is already performed)\n\ * **06** \u2014 Data Only" enum: - '01' - '02' - '03' - '04' - '05' - '06' x-addedInVersion: '68' threeDSRequestorID: type: string 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. threeDSRequestorName: type: string 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. threeDSRequestorPriorAuthenticationInfo: $ref: '#/components/schemas/ThreeDSRequestorPriorAuthenticationInfo' description: Information about how the 3DS Requestor authenticated the cardholder as part of a previous 3DS transaction. x-addedInVersion: '68' threeDSRequestorURL: type: string 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. transType: type: string description: "Identifies the type of transaction being authenticated. Length:\ \ 2 characters. Allowed values:\n* **01** \u2014 Goods/Service Purchase\n\ * **03** \u2014 Check Acceptance\n* **10** \u2014 Account Funding\n* **11**\ \ \u2014 Quasi-Cash Transaction\n* **28** \u2014 Prepaid Activation and\ \ Load" enum: - '01' - '03' - '10' - '11' - '28' maxLength: 2 minLength: 2 x-addedInVersion: '68' transactionType: type: string description: Identify the type of the transaction being authenticated. enum: - goodsOrServicePurchase - checkAcceptance - accountFunding - quasiCashTransaction - prepaidActivationAndLoad x-addedInVersion: '50' whiteListStatus: type: string description: The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. x-addedInVersion: '49' workPhone: $ref: '#/components/schemas/Phone' description: 'The work phone number provided by the cardholder. The phone number must consist of a country code, followed by the number. If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`, and did not send the shopper''s phone number in `telephoneNumber`.' x-addedInVersion: '68' ThreeDS2ResponseData: type: object additionalProperties: false 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 ThreeDS2Result: type: object additionalProperties: false properties: authenticationValue: type: string description: The `authenticationValue` value as defined in the 3D Secure 2 specification. cavvAlgorithm: type: string description: The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations. x-addedInVersion: '50' challengeCancel: type: string 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' x-addedInVersion: '67' dsTransID: type: string description: The `dsTransID` value as defined in the 3D Secure 2 specification. eci: type: string description: The `eci` value as defined in the 3D Secure 2 specification. exemptionIndicator: type: string 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 x-addedInVersion: '67' messageVersion: type: string description: The `messageVersion` value as defined in the 3D Secure 2 specification. x-addedInVersion: '49' riskScore: type: string description: Risk score calculated by Cartes Bancaires Directory Server (DS). x-addedInVersion: '67' threeDSRequestorChallengeInd: type: string description: "Indicates whether a challenge is requested for this transaction.\ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\ \ \u2014 No challenge (transactional risk analysis is already performed)\n\ * **06** \u2014 Data Only" enum: - '01' - '02' - '03' - '04' - '05' - '06' x-addedInVersion: '68' threeDSServerTransID: type: string description: The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. timestamp: type: string description: The `timestamp` value of the 3D Secure 2 authentication. transStatus: type: string description: The `transStatus` value as defined in the 3D Secure 2 specification. transStatusReason: type: string 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). whiteListStatus: type: string description: The `whiteListStatus` value as defined in the 3D Secure 2 specification. x-addedInVersion: '49' ThreeDSRequestData: type: object additionalProperties: false properties: challengeWindowSize: type: string 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' x-addedInVersion: '69' dataOnly: type: string description: 'Required to trigger the [data-only flow](https://docs.adyen.com/online-payments/3d-secure/data-only/). When set to **true**, forces the 3D Secure 2 data-only flow for all transactions where it is possible. ' enum: - 'false' - 'true' x-addedInVersion: '69' nativeThreeDS: type: string description: 'Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be triggered when available. Adyen can still select to fallback to the redirect flow to optimize authorization rates and improve the shopper''s experience. Possible values: * **preferred**: Use native 3D Secure authentication when available. * **disabled**: Use the redirect 3D Secure authentication flow.' enum: - preferred - disabled x-addedInVersion: '69' threeDSVersion: type: string description: 'The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0**' enum: - 2.1.0 - 2.2.0 x-addedInVersion: '69' ThreeDSRequestorAuthenticationInfo: type: object additionalProperties: false properties: threeDSReqAuthData: type: string description: 'Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.' threeDSReqAuthMethod: type: string description: "Mechanism used by the Cardholder to authenticate to the 3DS\ \ Requestor. Allowed values:\n* **01** \u2014 No 3DS Requestor authentication\ \ occurred (for example, cardholder \u201Clogged in\u201D as guest).\n\ * **02** \u2014 Login to the cardholder account at the 3DS Requestor system\ \ using 3DS Requestor\u2019s own credentials.\n* **03** \u2014 Login to\ \ the cardholder account at the 3DS Requestor system using federated ID.\n\ * **04** \u2014 Login to the cardholder account at the 3DS Requestor system\ \ using issuer credentials.\n* **05** \u2014 Login to the cardholder account\ \ at the 3DS Requestor system using third-party authentication.\n* **06**\ \ \u2014 Login to the cardholder account at the 3DS Requestor system using\ \ FIDO Authenticator." enum: - '01' - '02' - '03' - '04' - '05' - '06' maxLength: 2 minLength: 2 threeDSReqAuthTimestamp: type: string description: 'Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM' maxLength: 12 minLength: 12 ThreeDSRequestorPriorAuthenticationInfo: type: object additionalProperties: false properties: threeDSReqPriorAuthData: type: string description: 'Data that documents and supports a specific authentication process. Maximum length: 2048 bytes.' threeDSReqPriorAuthMethod: type: string description: "Mechanism used by the Cardholder to previously authenticate\ \ to the 3DS Requestor. Allowed values:\n* **01** \u2014 Frictionless\ \ authentication occurred by ACS.\n* **02** \u2014 Cardholder challenge\ \ occurred by ACS.\n* **03** \u2014 AVS verified.\n* **04** \u2014 Other\ \ issuer methods." enum: - '01' - '02' - '03' - '04' maxLength: 2 minLength: 2 threeDSReqPriorAuthTimestamp: type: string description: 'Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM' maxLength: 12 minLength: 12 threeDSReqPriorRef: type: string 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 ThreeDSecureData: type: object additionalProperties: false properties: authenticationResponse: type: string description: '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 cavv: type: string format: byte description: The cardholder authentication value (base64 encoded, 20 bytes in a decoded form). cavvAlgorithm: type: string description: The CAVV algorithm used. Include this only for 3D Secure 1. challengeCancel: type: string 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' x-addedInVersion: '67' directoryResponse: type: string description: 'In 3D Secure 2, this is the `transStatus` from the `ARes`. ' enum: - A - C - D - I - N - R - U - Y dsTransID: type: string description: Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. x-addedInVersion: '40' eci: type: string description: The electronic commerce indicator. riskScore: type: string description: Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations. x-addedInVersion: '67' threeDSVersion: type: string description: The version of the 3D Secure protocol. x-addedInVersion: '40' tokenAuthenticationVerificationValue: type: string format: byte description: Network token authentication verification value (TAVV). The network token cryptogram. x-addedInVersion: '68' transStatusReason: type: string 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). x-addedInVersion: '67' xid: type: string format: byte description: Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form). Ticket: type: object additionalProperties: false properties: issueAddress: type: string description: 'The address of the organization that issued the ticket. * minLength: 0 characters * maxLength: 16 characters * **additionalData key:** `airline.ticket_issue_address`' issueDate: type: string format: date description: 'The date that the ticket was issued to the passenger. * minLength: 10 characters * maxLength: 10 characters * Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): yyyy-MM-dd * **additionalData key:** `airline.issue_date`' number: type: string description: 'The ticket''s unique identifier. * minLength: 1 character * maxLength: 15 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.ticket_number`' TokenMandate: type: object additionalProperties: false properties: accountIdType: type: string description: The type of account identifier for the masked account number. amount: type: string description: The billing amount (in minor units) of the recurring transactions. amountRule: type: string 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 billingAttemptsRule: type: string 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 billingDay: type: string 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`.' count: type: string description: The number of transactions that can be performed within the given frequency. currency: type: string description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). endsAt: type: string description: End date of the billing plan, in YYYY-MM-DD format. frequency: type: string description: 'The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.' enum: - adhoc - daily - weekly - biWeekly - monthly - quarterly - halfYearly - yearly mandateId: type: string description: The unique identifier of the mandate. maskedAccountId: type: string description: The masked account number associated with the mandate. minAmount: type: string description: For a billing plan where the payment amounts are variable, the minimum amount to charge the shopper for each recurring payment. When a shopper approves the billing plan, they can also specify a maximum amount in their banking app. providerId: type: string description: The provider-specific identifier for this mandate. recurringAmount: type: string description: For a billing plan where the payment amount is fixed, the amount the shopper will be charged for each recurring payment. recurringStatement: type: string description: 'The text that will be shown on the shopper''s bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters.' maxLength: 35 remarks: type: string description: Additional remarks or notes about the mandate. retryPolicy: type: string description: When set to true, you can retry for failed recurring payments. The default value is true. enum: - 'true' - 'false' startsAt: type: string description: Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. status: type: string description: 'The status of the mandate. Examples : active, revoked, completed, expired' txVariant: type: string description: The transaction variant used for this mandate. required: - amount - currency - endsAt - frequency - mandateId - providerId - status - txVariant TravelAgency: type: object additionalProperties: false properties: code: type: string 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 start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.travel_agency_code`' name: type: string description: 'The name of the travel agency. * Encoding: ASCII * minLength: 1 character * maxLength: 25 characters * Must not start with a space or be all spaces. * Must not be all zeros. * **additionalData key:** `airline.travel_agency_name`' TwintDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' subtype: type: string description: The type of flow to initiate. type: type: string description: The payment method type. enum: - twint title: Twint UpdatePaymentLinkRequest: type: object additionalProperties: false properties: status: type: string description: 'Status of the payment link. Possible values: * **expired**' enum: - expired required: - status UpiCollectDetails: type: object additionalProperties: false properties: billingSequenceNumber: type: string 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. checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperNotificationReference: type: string description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: upi_collect description: '**upi_collect**' enum: - upi_collect virtualPaymentAddress: type: string description: The virtual payment address for UPI. required: - type title: UPI Collect UpiIntentDetails: type: object additionalProperties: false properties: appId: type: string description: TPAP (Third Party Application) Id that is being used to make the UPI payment billingSequenceNumber: type: string 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. checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperNotificationReference: type: string description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: upi_intent description: '**upi_intent**' enum: - upi_intent required: - type title: UPI Intent UpiQrDetails: type: object additionalProperties: false properties: billingSequenceNumber: type: string 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. checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' shopperNotificationReference: type: string description: The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: upi_qr description: '**upi_qr**' enum: - upi_qr required: - type title: UPI QR UtilityRequest: type: object additionalProperties: false properties: originDomains: type: array description: The list of origin domains, for which origin keys are requested. items: type: string required: - originDomains UtilityResponse: type: object additionalProperties: false properties: originKeys: type: object additionalProperties: type: string description: The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. x-addedInVersion: '1' VippsDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' telephoneNumber: type: string description: '' type: type: string default: vipps description: '**vipps**' enum: - vipps required: - telephoneNumber title: Vipps VisaCheckoutDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. fundingSource: type: string 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 - prepaid sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: visacheckout description: '**visacheckout**' enum: - visacheckout visaCheckoutCallId: type: string 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. required: - visaCheckoutCallId title: Visa Checkout WeChatPayDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' type: type: string default: wechatpay description: '**wechatpay**' enum: - wechatpay - wechatpay_pos title: WeChat Pay WeChatPayMiniProgramDetails: type: object additionalProperties: false properties: appId: type: string checkoutAttemptId: type: string description: The checkout attempt identifier. openid: type: string recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: wechatpayMiniProgram description: '**wechatpayMiniProgram**' enum: - wechatpayMiniProgram title: WeChat Pay - Mini Program ZipDetails: type: object additionalProperties: false properties: checkoutAttemptId: type: string description: The checkout attempt identifier. clickAndCollect: type: string 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. recurringDetailReference: type: string deprecated: true description: This is the `recurringDetailReference` returned in the response when you created the token. x-deprecatedInVersion: '49' x-deprecatedMessage: Use `storedPaymentMethodId` instead. sdkData: type: string description: Base64-encoded JSON object containing SDK related parameters required by the SDK maxLength: 50000 x-addedInVersion: '67' storedPaymentMethodId: type: string description: This is the `recurringDetailReference` returned in the response when you created the token. maxLength: 64 x-addedInVersion: '49' type: type: string default: zip description: '**zip**' enum: - zip - zip_pos title: Zip CheckoutErrorResponseEntity: type: object properties: errorCode: type: string errorType: type: string message: type: string pspReference: type: string status: type: integer format: int32 required: - errorCode - errorType - message PayToPaymentMethod: type: object allOf: - $ref: '#/components/schemas/ShopperIdPaymentMethod' - type: object properties: shopperReference: type: string maxLength: 256 minLength: 0 required: - type Result: type: string enum: - VALID - INVALID - UNKNOWN - NOT_REQUIRED ShopperIdPaymentMethod: type: object discriminator: propertyName: type mapping: payTo: '#/components/schemas/PayToPaymentMethod' upi_collect: '#/components/schemas/UPIPaymentMethod' properties: type: type: string maxLength: 50 minLength: 0 pattern: payTo|upi_collect required: - type UPIPaymentMethod: type: object allOf: - $ref: '#/components/schemas/ShopperIdPaymentMethod' - type: object properties: virtualPaymentAddress: type: string maxLength: 256 minLength: 1 required: - type ValidateShopperIdRequest: type: object properties: merchantAccount: type: string description: The merchant account identifier, with which you want to process the transaction. maxLength: 1000 minLength: 0 paymentMethod: $ref: '#/components/schemas/ShopperIdPaymentMethod' description: paymentMethod shopperEmail: type: string maxLength: 300 minLength: 0 shopperIP: type: string maxLength: 15 minLength: 0 shopperReference: type: string maxLength: 256 minLength: 0 required: - merchantAccount - paymentMethod ValidateShopperIdResponse: type: object properties: reason: type: string description: Reason for the result. result: $ref: '#/components/schemas/Result' description: 'Result of the validation. Ex: valid, invalid, unknown' parameters: Idempotency-Key: name: Idempotency-Key in: header description: A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). required: false style: simple explode: false schema: type: string example: 37ca9c97-d1d1-4c62-89e8-706891a563ed examples: generic-400: summary: Response code 400. Bad request. value: status: 400 errorCode: '702' message: 'Unexpected input: ", expected: }' errorType: validation generic-401: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security generic-403: summary: Response code 403. Forbidden. value: status: 403 errorCode: '901' message: Invalid Merchant Account errorType: security pspReference: 881611827877203B generic-422: summary: Response code 422. Unprocessable entity. value: status: 422 errorCode: '14_030' message: Return URL is missing. errorType: validation pspReference: '8816118280275544' generic-500: summary: Response code 500. Internal server error. value: status: 500 errorCode: '905' message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' get-paymentLinks-linkId-basic-200: summary: Payment link details 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 get-sessions-sessionId-success-200: summary: 'Response code: 200 - Success' description: The status of the session with the specified ID. value: id: CS12345678 status: completed 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 patch-paymentLinks-linkId-basic: summary: Update the status of a payment link value: status: expired patch-paymentLinks-linkId-basic-200: summary: Payment link status updated 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 post-applePay-sessions-basic: summary: Get payment session for Apple Pay value: displayName: YOUR_MERCHANT_NAME domainName: YOUR_DOMAIN_NAME merchantIdentifier: YOUR_MERCHANT_ID post-applePay-sessions-basic-200: summary: Payment session data for Apple Pay value: data: eyJ2Z... post-cancels-cancel-with-own-reference: summary: Cancel a payment using your own reference description: Example cancel request with your own reference value: paymentReference: YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT reference: YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION merchantAccount: YOUR_MERCHANT_ACCOUNT post-cancels-cancel-with-own-reference-201: summary: Payment cancellation requested description: Example response when a payment cancellation was requested value: merchantAccount: YOUR_MERCHANT_ACCOUNT paymentReference: YOUR_UNIQUE_REFERENCE_FOR_THE_PAYMENT reference: YOUR_UNIQUE_REFERENCE_FOR_THE_CANCELLATION pspReference: 993617894906488A status: received post-cardDetails-basic: summary: Get a list of brands on a card with the unencrypted card number description: Example request for getting a list of brands on a card using the first 6 digits of the card number. value: merchantAccount: YOUR_MERCHANT_ACCOUNT cardNumber: '411111' post-cardDetails-basic-200: summary: List of brands on the card description: Example response when the card is co-branded. value: brands: - type: visa supported: true - type: cartebancaire supported: true fundingSource: CREDIT isCardCommercial: false issuingCountryCode: FR post-cardDetails-supported-brands: summary: Get a list of brands on a card specifying your supported card brands description: Example request for getting a list of brands on a card using the first 6 digits of the card number and including the card brands you support. value: merchantAccount: YOUR_MERCHANT_ACCOUNT cardNumber: '411111' supportedBrands: - visa - mc - amex post-cardDetails-supported-brands-200: summary: List of brands on the card when you specify your supported card brands description: Example response when the card is co-branded, and you only support Visa. value: brands: - type: visa supported: true - type: cartebancaire supported: false fundingSource: CREDIT isCardCommercial: false issuingCountryCode: FR post-donationCampaigns-donation-campaigns: summary: Get a list of active donation campaigns value: merchantAccount: YOUR_MERCHANT_ACCOUNT currency: EUR post-donationCampaigns-donation-campaigns-200: summary: List of active donation campaigns value: donationCampaigns: - id: DONATION_CAMPAIGN_ID campaignName: DONATION_CAMPAIGN_NAME donation: currency: EUR type: fixedAmounts donationType: fixedAmounts values: - 100 - 200 - 300 nonprofitName: NONPROFIT_NAME causeName: NONPROFIT_CAUSE nonprofitDescription: NONPROFIT_DESCRIPTION. nonprofitUrl: NONPROFIT_WEBSITE_URL logoUrl: NONPROFIT_LOGO_URL bannerUrl: NONPROFIT_BANNER_URL termsAndConditionsUrl: NONPROFIT_TERMS_AND_CONDITIONS_URL - id: DONATION_CAMPAIGN_ID campaignName: DONATION_CAMPAIGN_NAME donation: currency: EUR type: roundup donationType: roundup maxRoundupAmount: 100 nonprofitName: NONPROFIT_NAME causeName: NONPROFIT_CAUSE nonprofitDescription: NONPROFIT_DESCRIPTION. nonprofitUrl: NONPROFIT_WEBSITE_URL logoUrl: NONPROFIT_LOGO_URL bannerUrl: NONPROFIT_BANNER_URL termsAndConditionsUrl: NONPROFIT_TERMS_AND_CONDITIONS_URL post-donations-donations-campaigns: summary: Make a donation to a campaign value: amount: currency: EUR value: 1000 reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationCampaignId: DONATION_CAMPAIGN_ID returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-donations-donations-campaigns-200: summary: Successful donation to a campaign value: id: UNIQUE_RESOURCE_ID status: completed merchantAccount: YOUR_MERCHANT_ACCOUNT amount: currency: EUR value: 1000 reference: YOUR_DONATION_REFERENCE payment: pspReference: '8535762347980628' resultCode: Authorised amount: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-classic: summary: Make a donation to a donation account value: amount: currency: EUR value: 1000 reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme donationToken: YOUR_DONATION_TOKEN donationOriginalPspReference: 991559660454807J donationAccount: NONPROFIT_ACCOUNT returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth post-donations-donations-classic-200: summary: Successful donation transaction value: id: UNIQUE_RESOURCE_ID status: completed donationAccount: NONPROFIT_ACCOUNT merchantAccount: YOUR_MERCHANT_ACCOUNT amount: currency: EUR value: 1000 reference: YOUR_DONATION_REFERENCE payment: pspReference: '8535762347980628' resultCode: Authorised amount: currency: EUR value: 1000 merchantReference: YOUR_DONATION_REFERENCE post-donations-donations-with-token: summary: Make a donation to a donation account with a token value: amount: currency: EUR value: 1000 reference: YOUR_DONATION_REFERENCE paymentMethod: type: scheme recurringDetailReference: '7219687191761347' returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT donationAccount: NONPROFIT_ACCOUNT shopperInteraction: ContAuth shopperReference: YOUR_SHOPPER_REFERENCE recurringProcessingModel: CardOnFile post-donations-donations-with-token-200: summary: Successful donation transaction with a token value: amount: currency: EUR value: 500 donationAccount: NONPROFIT_ACCOUNT id: UNIQUE_RESOURCE_ID merchantAccount: YOUR_MERCHANT_ACCOUNT payment: pspReference: FJM726V375BV9D82 resultCode: Authorised amount: currency: EUR value: 500 merchantReference: YOUR_DONATION_REFERENCE reference: '1412563167350061' status: completed post-donations-donations-with-token-422: summary: Example error response when the donation account isn't valid value: status: 422 errorCode: '187' message: Field 'additionalData.donationAccount' is not valid. errorType: validation post-forward-forward-card: summary: Forward stored payment details value: merchantAccount: YOUR_MERCHANT_ACCOUNT shopperReference: YOUR_SHOPPER_REFERENCE storedPaymentMethodId: M5N7TQ4TG5PFWR50 baseUrl: http://thirdparty.example.com request: httpMethod: post urlSuffix: /payments credentials: YOUR_CREDENTIALS_FOR_THE_THIRD_PARTY headers: Authorization: Basic {{credentials}} body: '{"amount":{"value":100,"currency":"USD"},"paymentMethod":{"creditCard":{"holderName":"{{holderName}}","number":"{{number}}","expiryMonth":"{{expiryMonth}}","expiryYear":"{{expiryYear}}"}}}' post-forward-forward-card-200: summary: Outcome of the forward request value: storedPaymentMethodId: M5N7TQ4TG5PFWR50 pspReference: XB7XNCQ8HXSKGK82 response: status: 200 headers: thirdparty-version: '2023-10-16' body: '{"success": "ok","data": {"tokenizeCreditCard": {"paymentMethod": {"id": "PAYMENT_METHOD_ID"}}}}' post-orders-basic: summary: Create an order value: reference: YOUR_ORDER_REFERENCE amount: value: 2500 currency: EUR merchantAccount: YOUR_MERCHANT_ACCOUNT post-orders-basic-200: summary: Order created value: pspReference: '8616178914061985' resultCode: Success expiresAt: '2021-04-09T14:16:46Z' orderData: Ab02b4c0!BQABAgCxXvknCldOcRElkxY8Za7iyym4Wv8aDzyNwmj/3nh4G6YtwnUIJHaK62NlN4oIsACdkn1FEjBwKlheG40jvXcYGBk4KFV5WvOhTVCpv/KXnkrI7xQv/u2lE7U4wA+HPB6K4Zj2L8xO/ogZi+zGZqFs5m16jmkH7ku6FzXygXLNuUCuOlmlXSZhdkHHTNVQSq1MELDK9OL74y532ETRPTCNxx8WlEiZB+LDqYrPvH9GgigtD5kw8Do45jfFfG72kWBEgfYqp4mbUmBB9ebXFYZKfF0qvW1x7A2Y9+/MFlTIdXfKW484bJeDBCTTrmKGXIj+U4r5imr5fXTyNLcrxyUqwrb9jg+5B4qg1XB6Cgj5UPlSI4O62I7v0s5TTj69dzLwUQRxSQbwLrZVGYavXzeVKI54BVLRV3d/+BbPvTqnTo34UhfZbPlOx9F2eyaS0ZXdOKnHw89uGUgxUpLsMqnbRysi/pxpZaulel+0mExb68wVxb/7Teob5eRG4gp7cfZVZs6tLXOYWL+W0TqIlsa3hWsfM0LeaovzkoDtW/pK5JABXwMtLig9tsxoEh9ONYtIzkXC21LZ8ebiuSIMaPizjF8yca+QxrCZalQsu6uKnBz/mm8nnsflaGU2QS5zcoxk1RudL1Bl36LM9UZGPpFEYWiYA4sUsnNLw7peJjWCGhDepnwMv4TlgsEtoDtz1T54AEp7ImtleSI6IkFGMEFBQTEwM0NBNTM3RUFFRDg3QzI0REQ1MzkwOUI4MEE3OEE5MjNFMzgyM0Q2OERBQ0M5NEI5RkY4MzA1REMifRslOdmfgUHTXl66WPD9xoW2whIeRx/jR++2MqNE16x6zQy+KtDN8/h60crZwmqkjVTQYqQlsYSYDHSIyb4wnnay16/5il1yS7vN3UCLaTXjYBIAyyx6Wr9j4P3CI/etB+PpviHoESC4mV6ZN4whMDQyziQ8s230GtboXbh42qND7rk9phySBogowQlXrtF+l2n2F46nyif0owEgik5fGARfvjZtY2w23s30KMLNwU4gWSvX4H6RMVS8TfZH2fKfNrwB3tZUXwYkELs5ntaHysswq5Mn5aq2BKAMHu/Rh/wureMSI73Qi0avjrzWCwzt3JH4wnzErMnOZwSdgA== reference: shopper-reference-ekvL83 remainingAmount: currency: EUR value: 2500 amount: currency: EUR value: 300 post-orders-cancel-basic: summary: Cancel an order value: order: pspReference: '8815517812932012' orderData: 823fh892f8f18f4...148f13f9f3f merchantAccount: YOUR_MERCHANT_ACCOUNT post-orders-cancel-basic-200: summary: Order cancelled value: pspReference: '8816178914079738' resultCode: Received post-originKeys-basic: summary: Get origin keys value: originDomains: - https://www.your-domain1.com - https://www.your-domain2.com - https://www.your-domain3.com post-originKeys-basic-200: summary: Example response for request 'basic' value: originKeys: https://www.your-domain1.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4xLmNvbQ.pvbYlrXz0ICP4kwMJXDGDLVMqALhwXr1MSRjT-fkhvw https://www.your-domain3.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4zLmNvbQ.FrTpVz7_RzAywKasM0kXCRoMfoMkKIKaxjFymRGORIc https://www.your-domain2.com: pub.v2.8116178901076090.aHR0cHM6Ly93d3cueW91ci1kb21haW4yLmNvbQ.LdN9kvJ35fYFFiBSJA4idMnwwxJ5_yXpeNS__Ap5wkg 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: "S\xE3o Paulo" houseNumberOrName: '999' country: BR stateOrProvince: SP deliveryAddress: street: Roque Petroni Jr postalCode: '59000060' city: "S\xE3o Paulo" houseNumberOrName: '999' country: BR stateOrProvince: SP post-paymentLinks-basic-201: summary: Payment link created value: amount: currency: BRL value: 1250 billingAddress: city: "S\xE3o Paulo" country: BR houseNumberOrName: '999' postalCode: '59000060' stateOrProvince: SP street: Roque Petroni Jr countryCode: BR deliveryAddress: city: "S\xE3o 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 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-paymentMethods-balance-basic-200: summary: Gift card balance greater than amount specified in request value: pspReference: KHQC5N7G84BLNK43 resultCode: Success balance: currency: EUR value: 5000 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-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-paymentMethods-basic: summary: Get available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentMethods-basic-200: summary: List of available payment methods 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: 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\xAE 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: "Korea\u2013issued 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-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 post-paymentMethods-filtered-200: summary: List of available payment methods, based on the specified country and amount value: paymentMethods: - name: iDEAL type: ideal - name: "Hitelk\xE1rtya" 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-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-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' lastFour: '1111' name: VISA shopperEmail: john.smith@example.com supportedRecurringProcessingModels: - CardOnFile - Subscription - UnscheduledCardOnFile type: scheme 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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT 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.example.com returnUrl: https://your-company.example.com/checkout/ merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-2-web-200: summary: Successful payment with 3D Secure 2 native authentication, using encrypted card details value: resultCode: IdentifyShopper action: paymentData: Ab02b4c0!BQABAgCuZFJrQOjSsl\/zt+... paymentMethodType: scheme authorisationToken: Ab02b4c0!BQABAgAvrX03p... subtype: fingerprint token: eyJ0aHJlZURTTWV0aG9kTm90aWZpY... type: threeDS2 post-payments-card-3d-secure-redirect: 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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-3d-secure-redirect-200: summary: Successful payment with 3D Secure redirect authentication value: additionalData: cardSummary: '5454' threeds2.threeDS2ResponseData.messageVersion: 2.1.0 threeds2.threeDS2Token: R5CZ2NWPJTGV9D82... threeds2.threeDSServerTransID: 8835538461311270... cardBin: '545454' threeds2.cardEnrolled: 'true' paymentMethod: mc cardPaymentMethod: mc fundingSource: CREDIT merchantReference: Your order number issuerBin: '54545454' threeds2.threeDSMethodURL: https://pal-test.adyen.com/threeds2simulator/acs/startMethod.shtml cardIssuingCountry: PL pspReference: JLCMPCQ8HXSKGK82 resultCode: RedirectShopper action: paymentMethodType: scheme url: https://checkoutshopper-test.adyen.com/checkoutshopper/threeDS/redirect... method: GET type: redirect 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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-direct-200: summary: Successful card payment with unencrypted card details value: additionalData: cvcResult: 1 Matches authCode: 044925 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-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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-card-securedfields-200: summary: Successful card payment value: additionalData: cvcResult: 1 Matches authCode: 065696 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-payments-details-00.redirect: summary: Submit the redirect result description: Example request when submitting a redirect result value: details: redirectResult: X6XtfGC3!Y... post-payments-details-00.redirect-200: summary: Payment authorised description: Example response when submitting the redirect result value: resultCode: Authorised pspReference: V4HZ4RBFJGXXGN82 post-payments-details-3d-secure-2-native: summary: Submit 3D Secure 2 authentication result value: details: threeDSResult: eyJ0cmFuc1N0YXR1cyI6IlkifQ== post-payments-enableOneClick-SF: summary: Tokenize card details for one-click 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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-enableOneClick-SF-200: summary: Card details tokenized for one-click payments value: additionalData: cvcResult: 1 Matches authCode: 082338 avsResult: 4 AVS not supported for this card type avsResultRaw: '4' cvcResultRaw: M refusalReasonRaw: AUTHORISED acquirerCode: TestPmmAcquirer acquirerReference: 8PQMP9VC172 tokenization.shopperReference: YOUR_SHOPPER_REFERENCE tokenization.storedPaymentMethodId: M5N7TQ4TG5PFWR50 tokenization.store.operationType: created pspReference: 993617895195570C resultCode: Authorised merchantReference: string 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.example.com/... merchantAccount: YourMerchantAccount post-payments-ideal: summary: Make an iDEAL payment value: amount: currency: EUR value: 1000 reference: Your order number paymentMethod: type: ideal returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT 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 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.example.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-payments-on-demand-top-up-from-transfer-instrument: summary: Top up your balance account on-demand from your transfer instrument value: paymentMethod: type: sepadirectdebit transferInstrumentId: SE00000000000000000000001 iban: IBAN_OF_TRANSFER_INSTRUMENT ownerName: John Smith amount: value: 10000 currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT returnUrl: https://your-company.example.com/... splits: - amount: value: 10000 type: TopUp account: BA00000000000000000000001 reference: Your reference for the top-up. description: Your description for the top-up. - type: PaymentFee account: BA00000000000000000000001 reference: Your reference for the transaction fees. description: Your description for the transaction fees. post-payments-on-demand-top-up-from-transfer-instrument-200: summary: Successful top-up to your balance account from your transfer instrument value: additionalData: sepadirectdebit.dateOfSignature: '2024-05-02' sepadirectdebit.mandateId: FJM726V375BV9D82 sepadirectdebit.sequenceType: Recurring pspReference: QFQTPCQ8HXSKGK82 resultCode: Authorised post-payments-on-demand-top-up-visa: summary: Top up your balance account on-demand using a Visa credit card value: paymentMethod: type: scheme number: '4111111111111111' cvc: '737' expiryMonth: '03' expiryYear: '2030' holderName: John Smith amount: value: 10000 currency: EUR reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT returnUrl: https://your-company.example.com/... splits: - amount: value: 10000 type: TopUp account: BA00000000000000000000001 reference: Your reference for the top-up. description: Your description for the top-up. - type: PaymentFee account: BA00000000000000000000001 reference: Your reference for the transaction fees. description: Your description for the transaction fees. post-payments-on-demand-top-up-visa-200: summary: Successful top-up to your balance account using a Visa credit card value: additionalData: cardBin: '411111' cardHolderName: John Smith cardIssuingCountry: NL cardIssuingCurrency: EUR cardPaymentMethod: visa cardProductId: A cardSummary: '1111' issuerBin: '41111111' pspReference: WNV97K8PPLC52VT5 resultCode: Authorised post-payments-oneclick-securedfields: summary: Make a one-click 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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: CardOnFile post-payments-paymentPspReference-amountUpdates-amount-update: summary: Update the amount of an authorized 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 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 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-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-payments-paymentPspReference-captures-capture: summary: Capture an authorized payment description: Example capture request value: reference: YOUR_UNIQUE_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT amount: value: 2000 currency: EUR 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 post-payments-paymentPspReference-captures-split-balanceplatform: summary: Capture and split an authorized payment between balance accounts description: Example capture request value: reference: YOUR_UNIQUE_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT amount: value: 2000 currency: USD platformChargebackLogic: behavior: deductFromOneBalanceAccount targetAccount: BA00000000000000000000001 costAllocationAccount: BA00000000000000000000001 splits: - amount: value: 1500 type: BalanceAccount account: BA00000000000000000000001 reference: Your reference for the sale amount description: Your description for the sale amount - amount: value: 500 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 post-payments-paymentPspReference-captures-split-balanceplatform-201: summary: Capture requested and split between balance accounts description: Example response when a capture was requested and split between balance accounts value: merchantAccount: YOUR_MERCHANT_ACCOUNT paymentPspReference: 993617894903480A reference: YOUR_UNIQUE_REFERENCE pspReference: 993617894906488A status: received amount: value: 2000 currency: USD platformChargebackLogic: behavior: deductFromOneBalanceAccount costAllocationAccount: BA00000000000000000000001 targetAccount: BA00000000000000000000001 splits: - amount: value: 1500 type: BalanceAccount account: BA00000000000000000000001 reference: Your reference for the sale amount description: Your description for the sale amount - amount: value: 500 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 post-payments-paymentPspReference-captures-split-classic: summary: Capture and split an authorized payment in the Classic Platforms integration description: Example capture request value: reference: YOUR_UNIQUE_REFERENCE merchantAccount: YOUR_MERCHANT_ACCOUNT amount: value: 2000 currency: USD splits: - account: '8816080397613514' amount: value: 1500 reference: Your reference for the sale amount. type: MarketPlace - amount: value: 500 reference: Your reference for the commission. type: Commission post-payments-paymentPspReference-captures-split-classic-201: summary: Capture requested and split in the Classic Platforms integration description: Example response when a capture was requested in the Classic Platforms integration value: merchantAccount: YOUR_MERCHANT_ACCOUNT paymentPspReference: 993617894903480A reference: YOUR_UNIQUE_REFERENCE pspReference: 993617894906488A status: received amount: value: 2000 currency: USD splits: - account: '8816080397613514' amount: value: 1500 reference: Your reference for the sale amount. type: MarketPlace - amount: value: 500 reference: Your reference for the commission. type: Commission 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-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-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 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-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.example.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 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 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.example.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-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.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT post-payments-subscription-first-transaction-200: summary: Card details tokenized for a subscription value: additionalData: cvcResult: 1 Matches authCode: 098871 avsResult: 4 AVS not supported for this card type avsResultRaw: '4' cvcResultRaw: M refusalReasonRaw: AUTHORISED acquirerCode: TestPmmAcquirer acquirerReference: 8PQMP9VD896 tokenization.shopperReference: YOUR_SHOPPER_REFERENCE tokenization.storedPaymentMethodId: M5N7TQ4TG5PFWR50 tokenization.store.operationType: created pspReference: 993617895199574A resultCode: Authorised merchantReference: string post-payments-subscription-payment: summary: Make a subscription payment with a token value: amount: currency: USD value: 1000 reference: Your order number paymentMethod: type: scheme storedPaymentMethodId: M5N7TQ4TG5PFWR50 shopperReference: YOUR_SHOPPER_REFERENCE returnUrl: https://your-company.example.com/... merchantAccount: YOUR_MERCHANT_ACCOUNT shopperInteraction: ContAuth recurringProcessingModel: Subscription post-paypal-updateOrder-advanced-with-delivery: summary: Update a PayPal order with delivery methods in an Advanced flow integration value: pspReference: DZ4DPSHB4WD2WN82 paymentData: po7XZ... amount: currency: EUR value: 12000 deliveryMethods: - reference: '1' description: Express Shipping type: Shipping amount: currency: EUR value: 1000 selected: true - reference: '2' description: Standard Ground type: Shipping amount: currency: EUR value: 500 selected: false post-paypal-updateOrder-advanced-with-delivery-200: summary: Order updated with delivery methods in an Advanced flow integration value: paymentData: po7XZ... status: success post-paypal-updateOrder-advanced-without-delivery: summary: Update a PayPal order in an Advanced flow integration value: pspReference: HWL5D5BDLSGLNK82 paymentData: kly45P... amount: currency: EUR value: 1200 post-paypal-updateOrder-advanced-without-delivery-200: summary: Order updated with delivery methods in an Advanced flow integration value: paymentData: kly45P... status: success post-paypal-updateOrder-sessions-with-delivery: summary: Update a PayPal order with delivery methods in a Sessions flow integration value: sessionId: CS12345679 paymentData: ey4YZ... amount: currency: EUR value: 12000 deliveryMethods: - reference: '1' description: Express Shipping type: Shipping amount: currency: EUR value: 1000 selected: true - reference: '2' description: Standard Ground type: Shipping amount: currency: EUR value: 500 selected: false post-paypal-updateOrder-sessions-with-delivery-200: summary: Order updated with delivery methods in a Sessions flow integration value: paymentData: ey4YZ... status: success post-paypal-updateOrder-sessions-without-delivery: summary: Update a PayPal order in a Sessions flow integration value: sessionId: CS12345679 paymentData: em9YZ... amount: currency: EUR value: 8700 post-paypal-updateOrder-sessions-without-delivery-200: summary: Order updated in a Sessions flow integration value: paymentData: em9YZ... status: success post-sessions-00.success: summary: Create a payment session description: Example request for creating a payment session value: merchantAccount: YOUR_MERCHANT_ACCOUNT amount: value: 100 currency: EUR returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. reference: YOUR_PAYMENT_REFERENCE countryCode: NL post-sessions-00.success-201: summary: Payment session created Success. description: Example response for creating a payment session value: amount: currency: EUR value: 100 countryCode: NL expiresAt: '2022-01-11T13:53:18+01:00' id: CS451F2AB1ED897A94 merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_PAYMENT_REFERENCE returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. sessionData: Ab02b4c0!BQABAgBfYI29... post-sessions-01.klarna: summary: Create a payment session including Klarna fields description: Example request for creating a payment session when Klarna is one of the available payment methods value: merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_ORDER_REFERENCE 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_SHOPPER_REFERENCE billingAddress: city: Ankeborg country: SE houseNumberOrName: '1' postalCode: '12345' street: Stargatan deliveryAddress: city: Ankeborg country: SE houseNumberOrName: '1' postalCode: '12345' street: Stargatan dateOfBirth: '1996-09-04' socialSecurityNumber: 0108 returnUrl: https://example.org 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-sessions-01.klarna-201: summary: Payment session created for a Klarna payment Success. description: 'Example ' value: amount: currency: SEK value: 1000 billingAddress: city: Ankeborg country: SE houseNumberOrName: '1' postalCode: '12345' street: Stargatan countryCode: SE dateOfBirth: '1996-09-04T02:00:00+02:00' deliveryAddress: city: Ankeborg country: SE houseNumberOrName: '1' postalCode: '12345' street: Stargatan expiresAt: '2022-01-11T13:57:52+01:00' id: CSC52E9932D39ADAF3 lineItems: - amountExcludingTax: 331 amountIncludingTax: 400 description: Shoes id: 'Item #1' imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM productUrl: URL_TO_PURCHASED_ITEM quantity: 1 taxAmount: 69 taxPercentage: 2100 - amountExcludingTax: 248 amountIncludingTax: 300 description: Socks id: 'Item #2' imageUrl: URL_TO_PICTURE_OF_PURCHASED_ITEM productUrl: URL_TO_PURCHASED_ITEM quantity: 2 taxAmount: 52 taxPercentage: 2100 merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_ORDER_REFERENCE returnUrl: https://example.org shopperEmail: youremail@email.com shopperLocale: en_US shopperName: firstName: Testperson-se lastName: Approved shopperReference: YOUR_SHOPPER_REFERENCE socialSecurityNumber: 0108 telephoneNumber: +46 840 839 298 sessionData: Ab02b4c0!BQABAgBfYI29... post-sessions-enableOneClick: summary: Tokenize card details for one-click payments without asking shopper description: Example request for tokenizing card details for one-click payments without asking shopper value: merchantAccount: TestMerchantCheckout amount: value: 100 currency: EUR shopperReference: YOUR_SHOPPER_REFERENCE returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. reference: YOUR_PAYMENT_REFERENCE countryCode: NL storePaymentMethodMode: enabled shopperInteraction: Ecommerce recurringProcessingModel: CardOnFile post-sessions-enableOneClick-201: summary: Shopper's payment details tokenized description: Example response for tokenizing the shopper's payment details value: amount: currency: EUR value: 100 shopperReference: YOUR_SHOPPER_REFERENCE countryCode: NL expiresAt: '2022-01-11T13:56:05+01:00' id: FJM726V375BV9D82 merchantAccount: YOUR_MERCHANT_ACCOUNT recurringProcessingModel: CardOnFile reference: YOUR_PAYMENT_REFERENCE returnUrl: https://your-company.example.com/checkout?shopperOrder=12xy.. shopperInteraction: Ecommerce storePaymentMethod: true sessionData: Ab02b4c0!BQABAgBfYI29... post-sessions-split: summary: Split a payment between balance accounts value: amount: value: 40000 currency: USD reference: YOUR_ORDER_NUMBER merchantAccount: YOUR_MERCHANT_ACCOUNT returnUrl: https://your-company.example.com/... splits: - amount: value: 39200 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 - amount: value: 400 account: BA00000000000000000000001 reference: Your reference for the fees description: Your description for the fees type: PaymentFee post-sessions-split-201: summary: Payment split between balance accounts value: amount: currency: USD value: 40000 expiresAt: '2023-06-26T11:01:55+02:00' id: CSFCBC80570618EF2C merchantAccount: YOUR_MERCHANT_ACCOUNT reference: YOUR_ORDER_NUMBER returnUrl: https://your-company.example.com/... shopperLocale: en-US splits: - account: BA00000000000000000000001 amount: value: 39200 description: Your description for the sale amount reference: Your reference for the sale amount type: BalanceAccount - amount: value: 400 description: Your description for the commission reference: Your reference for the commission type: Commission - amount: value: 400 account: BA00000000000000000000001 description: Your description for the fees reference: Your reference for the fees type: PaymentFee mode: embedded sessionData: Ab02b4c0!BQABAgCjTErwAztqXSFTiZtxZMjRLYkoGbPkmvCvDX1 post-storedPaymentMethods-encrypted-card-details: summary: Store encrypted card details for subscription payments description: Example request for storing encrypted card details for subscription payments value: merchantAccount: YOUR_MERCHANT_ACCOUNT shopperReference: YOUR_SHOPPER_REFERENCE paymentMethod: type: scheme encryptedCardNumber: test_4111111111111111 encryptedExpiryMonth: test_03 encryptedExpiryYear: test_2030 encryptedSecurityCode: test_737 holderName: John Smith recurringProcessingModel: Subscription shopperEmail: s.hopper@test.com shopperIP: 192.0.2.1 post-storedPaymentMethods-encrypted-card-details-201: summary: Card details stored description: Example for a successful response to store encrypted card details value: expiryMonth: '03' expiryYear: '2030' holderName: John Smith id: KHQC5N7G84BLNK43 lastFour: '1111' shopperReference: YOUR_SHOPPER_REFERENCE type: scheme post-storedPaymentMethods-unencrypted-card-details: summary: Store unencrypted card details for subscription payments description: Example request for storing encrypted card details for subscription payments value: merchantAccount: YOUR_MERCHANT_ACCOUNT shopperReference: YOUR_SHOPPER_REFERENCE paymentMethod: type: scheme number: '4111111111111111' expiryMonth: '03' expiryYear: '2030' cvc: '737' holderName: John Smith recurringProcessingModel: Subscription shopperEmail: s.hopper@test.com shopperIP: 192.0.2.1 post-storedPaymentMethods-unencrypted-card-details-201: summary: Card details stored description: Example for a successful response to store unencrypted card details value: expiryMonth: '03' expiryYear: '2030' holderName: John Smith id: KHQC5N7G84BLNK43 lastFour: '1111' shopperReference: YOUR_SHOPPER_REFERENCE type: scheme headers: Idempotency-Key: description: The idempotency key used for processing the request. Present if the key was provided in the request. style: simple explode: false schema: type: string securitySchemes: ApiKeyAuth: type: apiKey name: X-API-Key in: header BasicAuth: type: http scheme: basic