jlengrand/adyen-openapi
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-openapi.git synced 2026-03-10 08:01:24 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
019c4d38ca00eff55000ee7a3e51b01781c0ffe4
adyen-openapi/json/CheckoutService-v51.json
aleksei 0554d920c8 Updated JSON specs
2021-04-24 11:51:59 +02:00

13173 lines
592 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"openapi" : "3.0.3",
"servers" : [
{
"url" : "https://checkout-test.adyen.com/v51"
}
],
"info" : {
"version" : "51",
"x-publicVersion" : true,
"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 [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then 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_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through 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/v51/payments\n```",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
"url" : "https://www.adyen.help/hc/en-us/community/topics",
"email" : "developer-experience@adyen.com"
}
},
"x-groups" : [
"Payments",
"Payment links",
"Orders",
"Classic Checkout SDK",
"Utility"
],
"paths" : {
"/orders" : {
"post" : {
"summary" : "Creates an order for the given amount.",
"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",
"x-groupName" : "Orders",
"x-sortIndex" : 2,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/post-orders-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutCreateOrderRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/post-orders-basic-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutCreateOrderResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/orders/cancel" : {
"post" : {
"summary" : "Cancels the given 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",
"x-groupName" : "Orders",
"x-sortIndex" : 3,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/post-orders-cancel-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutCancelOrderRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/post-orders-cancel-basic-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutCancelOrderResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/originKeys" : {
"post" : {
"summary" : "Create originKey values for one or more merchant 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",
"x-groupName" : "Utility",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/post-originKeys-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutUtilityRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/post-originKeys-basic-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutUtilityResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentLinks" : {
"post" : {
"summary" : "Creates a payment link.",
"description" : "Creates a payment link to our hosted payment form where shoppers can pay. The list of payment methods presented to the shopper depends on the `currency` and `country` parameters sent in the request.\n\nFor more information, refer to [Pay by Link documentation](https://docs.adyen.com/online-payments/pay-by-link#create-payment-links-through-api).",
"operationId" : "post-paymentLinks",
"x-groupName" : "Payment links",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/post-paymentLinks-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/CreatePaymentLinkRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/post-paymentLinks-basic-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentLinkResource"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"201" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentLinkResource"
}
}
},
"description" : "Created - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentLinks/{linkId}" : {
"get" : {
"summary" : "Retrieve a payment link.",
"description" : "Retrieves the payment link details using the payment link `id`.",
"operationId" : "get-paymentLinks-linkId",
"x-groupName" : "Payment links",
"x-sortIndex" : 2,
"parameters" : [
{
"description" : "Unique identifier of the payment link.",
"name" : "linkId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/get-paymentLinks-linkId-basic-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentLinkResource"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
},
"patch" : {
"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",
"x-groupName" : "Payment links",
"x-sortIndex" : 3,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/patch-paymentLinks-linkId-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/UpdatePaymentLinkRequest"
}
}
}
},
"parameters" : [
{
"description" : "Unique identifier of the payment link.",
"name" : "linkId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
}
},
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/patch-paymentLinks-linkId-basic-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentLinkResource"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentMethods" : {
"post" : {
"summary" : "Returns available payment methods.",
"description" : "Queries the available payment methods for a transaction based on the transaction context (like amount, country, and currency). Besides giving back a list of the available payment methods, the response also returns which input details you need to collect from the shopper (to be submitted to `/payments`).\n\nAlthough we highly recommend using this endpoint to ensure you are always offering the most up-to-date list of payment methods, its usage is optional. You can, for example, also cache the `/paymentMethods` response and update it once a week.",
"operationId" : "post-paymentMethods",
"x-groupName" : "Payments",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"filtered" : {
"$ref" : "#/components/examples/post-paymentMethods-filtered"
},
"include-oneclick" : {
"$ref" : "#/components/examples/post-paymentMethods-include-oneclick"
},
"basic" : {
"$ref" : "#/components/examples/post-paymentMethods-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodsRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"basic-200" : {
"$ref" : "#/components/examples/post-paymentMethods-basic-200"
},
"include-oneclick-200" : {
"$ref" : "#/components/examples/post-paymentMethods-include-oneclick-200"
},
"filtered-200" : {
"$ref" : "#/components/examples/post-paymentMethods-filtered-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentMethodsResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentMethods/balance" : {
"post" : {
"summary" : "Returns the available balance on gift card.",
"description" : "Retrieves the balance remaining on a shopper's gift card. To check a gift card's balance, make a POST `/paymentMethods/balance` call and include the gift card's details inside a `paymentMethod` object.",
"operationId" : "post-paymentMethods-balance",
"x-groupName" : "Orders",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"plastix" : {
"$ref" : "#/components/examples/post-paymentMethods-balance-plastix"
},
"basic" : {
"$ref" : "#/components/examples/post-paymentMethods-balance-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutBalanceCheckRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"plastix-200" : {
"$ref" : "#/components/examples/post-paymentMethods-balance-plastix-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/CheckoutBalanceCheckResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/paymentSession" : {
"post" : {
"summary" : "Creates a payment session.",
"description" : "Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).",
"operationId" : "post-paymentSession",
"x-groupName" : "Classic Checkout SDK",
"x-sortIndex" : 1,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"android" : {
"$ref" : "#/components/examples/post-paymentSession-android"
},
"ios" : {
"$ref" : "#/components/examples/post-paymentSession-ios"
},
"enableOneClick" : {
"$ref" : "#/components/examples/post-paymentSession-enableOneClick"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentSetupRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"web-200" : {
"$ref" : "#/components/examples/post-paymentSession-web-200"
},
"enableOneClick-200" : {
"$ref" : "#/components/examples/post-paymentSession-enableOneClick-200"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentSetupResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"examples" : {
"generic-422" : {
"$ref" : "#/components/examples/generic-422"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/payments" : {
"post" : {
"summary" : "Starts a transaction.",
"description" : "Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). \nThe response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow):\n* For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. \n* For a redirect or additional action, the response contains an `action` object. ",
"operationId" : "post-payments",
"x-groupName" : "Payments",
"x-sortIndex" : 2,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"card-3d-secure-direct" : {
"$ref" : "#/components/examples/post-payments-card-3d-secure-direct"
},
"klarna" : {
"$ref" : "#/components/examples/post-payments-klarna"
},
"oneclick-direct" : {
"$ref" : "#/components/examples/post-payments-oneclick-direct"
},
"card-3d-secure-2-web" : {
"$ref" : "#/components/examples/post-payments-card-3d-secure-2-web"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/payments/details" : {
"post" : {
"summary" : "Submits 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.\n\n",
"operationId" : "post-payments-details",
"x-groupName" : "Payments",
"x-sortIndex" : 3,
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DetailsRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentDetailsResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
},
"/payments/result" : {
"post" : {
"summary" : "Verifies payment result.",
"description" : "Verifies the payment result using the payload returned from the Checkout SDK.\n\nFor more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).",
"operationId" : "post-payments-result",
"x-groupName" : "Classic Checkout SDK",
"x-sortIndex" : 2,
"requestBody" : {
"content" : {
"application/json" : {
"examples" : {
"basic" : {
"$ref" : "#/components/examples/post-payments-result-basic"
}
},
"schema" : {
"$ref" : "#/components/schemas/PaymentVerificationRequest"
}
}
}
},
"parameters" : [
{
"$ref" : "#/components/parameters/Idempotency-Key"
}
],
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentVerificationResponse"
}
}
},
"description" : "OK - the request has succeeded.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"400" : {
"content" : {
"application/json" : {
"examples" : {
"generic-400" : {
"$ref" : "#/components/examples/generic-400"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Bad Request - a problem reading or understanding the request."
},
"401" : {
"content" : {
"application/json" : {
"examples" : {
"generic-401" : {
"$ref" : "#/components/examples/generic-401"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unauthorized - authentication required."
},
"403" : {
"content" : {
"application/json" : {
"examples" : {
"generic-403" : {
"$ref" : "#/components/examples/generic-403"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Forbidden - insufficient permissions to process the request."
},
"422" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Unprocessable Entity - a request validation error.",
"headers" : {
"Idempotency-Key" : {
"$ref" : "#/components/headers/Idempotency-Key"
}
}
},
"500" : {
"content" : {
"application/json" : {
"examples" : {
"generic-500" : {
"$ref" : "#/components/examples/generic-500"
}
},
"schema" : {
"$ref" : "#/components/schemas/ServiceError"
}
}
},
"description" : "Internal Server Error - the server could not process the request."
}
}
}
}
},
"components" : {
"schemas" : {
"AccountInfo" : {
"properties" : {
"accountAgeIndicator" : {
"description" : "Indicator for the length of time since this shopper account was created in the merchant's environment.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"notApplicable",
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"accountChangeDate" : {
"description" : "Date when the shopper's account was last changed.",
"format" : "date-time",
"type" : "string"
},
"accountChangeIndicator" : {
"description" : "Indicator for the length of time since the shopper's account was last updated.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"accountCreationDate" : {
"description" : "Date when the shopper's account was created.",
"format" : "date-time",
"type" : "string"
},
"accountType" : {
"x-addedInVersion" : 50,
"description" : "Indicates the type of account. For example, for a multi-account card product.\nAllowed values:\n* notApplicable\n* credit\n* debit",
"enum" : [
"notApplicable",
"credit",
"debit"
],
"type" : "string"
},
"addCardAttemptsDay" : {
"description" : "Number of attempts the shopper tried to add a card to their account in the last day.",
"format" : "int32",
"type" : "integer"
},
"deliveryAddressUsageDate" : {
"description" : "Date the selected delivery address was first used.",
"format" : "date-time",
"type" : "string"
},
"deliveryAddressUsageIndicator" : {
"description" : "Indicator for the length of time since this delivery address was first used.\nAllowed values:\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"homePhone" : {
"description" : "Shopper's home phone number (including the country code).",
"type" : "string"
},
"mobilePhone" : {
"description" : "Shopper's mobile phone number (including the country code).",
"type" : "string"
},
"passwordChangeDate" : {
"description" : "Date when the shopper last changed their password.",
"format" : "date-time",
"type" : "string"
},
"passwordChangeIndicator" : {
"description" : "Indicator when the shopper has changed their password.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"notApplicable",
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"pastTransactionsDay" : {
"description" : "Number of all transactions (successful and abandoned) from this shopper in the past 24 hours.",
"format" : "int32",
"type" : "integer"
},
"pastTransactionsYear" : {
"description" : "Number of all transactions (successful and abandoned) from this shopper in the past year.",
"format" : "int32",
"type" : "integer"
},
"paymentAccountAge" : {
"description" : "Date this payment method was added to the shopper's account.",
"format" : "date-time",
"type" : "string"
},
"paymentAccountIndicator" : {
"description" : "Indicator for the length of time since this payment method was added to this shopper's account.\nAllowed values:\n* notApplicable\n* thisTransaction\n* lessThan30Days\n* from30To60Days\n* moreThan60Days",
"enum" : [
"notApplicable",
"thisTransaction",
"lessThan30Days",
"from30To60Days",
"moreThan60Days"
],
"type" : "string"
},
"purchasesLast6Months" : {
"description" : "Number of successful purchases in the last six months.",
"format" : "int32",
"type" : "integer"
},
"suspiciousActivity" : {
"description" : "Whether suspicious activity was recorded on this account.",
"type" : "boolean"
},
"workPhone" : {
"description" : "Shopper's work phone number (including the country code).",
"type" : "string"
}
}
},
"AchDetails" : {
"additionalProperties" : false,
"properties" : {
"bankAccountNumber" : {
"description" : "The bank account number (without separators).",
"type" : "string"
},
"bankLocationId" : {
"description" : "The bank routing number of the account. The field value is `nil` in most cases.",
"type" : "string"
},
"encryptedBankAccountNumber" : {
"description" : "Encrypted bank account number. The bank account number (without separators).",
"type" : "string"
},
"encryptedBankLocationId" : {
"description" : "Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases.",
"type" : "string"
},
"ownerName" : {
"description" : "The name of the bank account holder.\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* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\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'.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "ach",
"description" : "**ach**",
"enum" : [
"ach"
],
"type" : "string"
}
},
"required" : [
"bankAccountNumber"
],
"title" : "ACH Direct Debit"
},
"AdditionalData3DSecure" : {
"properties" : {
"allow3DS2" : {
"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 still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n",
"type" : "string"
},
"executeThreeD" : {
"description" : "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** – Perform 3D Secure authentication.\n* **false** – Don't perform 3D Secure authentication.\n",
"type" : "string"
},
"mpiImplementationType" : {
"description" : "In case of Secure+, this field must be set to **CUPSecurePlus**.",
"type" : "string"
},
"scaExemption" : {
"description" : "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ",
"type" : "string"
},
"threeDSVersion" : {
"description" : "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n",
"type" : "string"
}
}
},
"AdditionalDataAirline" : {
"properties" : {
"airline.agency_invoice_number" : {
"description" : "Reference number for the invoice, issued by the agency.\n* minLength: 1\n* maxLength: 6",
"type" : "string"
},
"airline.agency_plan_name" : {
"description" : "2-letter agency plan identifier; alphabetical.\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.airline_code" : {
"description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX); numeric. It identifies the carrier.\n* Format: IATA 3-digit accounting code (PAX)\n* Example: KLM = 074\n* minLength: 3\n* maxLength: 3",
"type" : "string"
},
"airline.airline_designator_code" : {
"description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.boarding_fee" : {
"description" : "Chargeable amount for boarding the plane.\nThe transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 18",
"type" : "string"
},
"airline.computerized_reservation_system" : {
"description" : "The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket.\n* Format: alphanumeric.\n* minLength: 4\n* maxLength: 4",
"type" : "string"
},
"airline.customer_reference_number" : {
"description" : "Reference number; alphanumeric.\n* minLength: 0\n* maxLength: 20",
"type" : "string"
},
"airline.document_type" : {
"description" : "Optional 2-digit code; alphanumeric. It identifies the type of product of the transaction. The description of the code may appear on credit card statements.\n* Format: 2-digit code\n* Example: Passenger ticket = 01\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.flight_date" : {
"description" : "Flight departure date. Local time `(HH:mm)` is optional.\n* Date format: `yyyy-MM-dd`\n* Date and time format: `yyyy-MM-dd HH:mm`\n* minLength: 10\n* maxLength: 16",
"type" : "string"
},
"airline.leg.carrier_code" : {
"description" : "[IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX); alphabetical. It identifies the carrier.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: IATA 2-letter airline code\n* Example: KLM = KL\n* minLength: 2\n* maxLength: 2",
"type" : "string"
},
"airline.leg.class_of_travel" : {
"description" : "1-letter travel class identifier; alphabetical. There is no standard; however, the following codes are used rather consistently:\n* F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\nLimitations:\n* minLength: 1\n* maxLength: 1",
"type" : "string"
},
"airline.leg.date_of_travel" : {
"description" : "\t\nDate and time of travel. [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-compliant.\n* Format: `yyyy-MM-dd HH:mm`\n* minLength: 16\n* maxLength: 16",
"type" : "string"
},
"airline.leg.depart_airport" : {
"description" : "Alphabetical identifier of the departure airport.\nThis field is required if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3",
"type" : "string"
},
"airline.leg.depart_tax" : {
"description" : "[Departure tax](https://en.wikipedia.org/wiki/Departure_tax). Amount charged by a country to an individual upon their leaving. The transaction amount needs to be represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).\n* minLength: 1\n* maxLength: 12",
"type" : "string"
},
"airline.leg.destination_code" : {
"description" : "Alphabetical identifier of the destination/arrival airport.\nThis field is required/mandatory if the airline data includes leg details.\n* Format: [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code.\n* Example: Amsterdam = AMS\n* minLength: 3\n* maxLength: 3",
"type" : "string"
},
"airline.leg.fare_base_code" : {
"description" : "[Fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code); alphanumeric.\n* minLength: 1\n* maxLength: 7",
"type" : "string"
},
"airline.leg.flight_number" : {
"description" : "The flight identifier.\n* minLength: 1\n* maxLength: 5",
"type" : "string"
},
"airline.leg.stop_over_code" : {
"description" : "1-letter code that indicates whether the passenger is entitled to make a stopover. Only two types of characters are allowed:\n* O: Stopover allowed\n* X: Stopover not allowed\n\nLimitations:\n* minLength: 1\n* maxLength: 1",
"type" : "string"
},
"airline.passenger.date_of_birth" : {
"description" : "Date of birth of the passenger.\n\nDate format: `yyyy-MM-dd`\n* minLength: 10\n* maxLength: 10",
"type" : "string"
},
"airline.passenger.first_name" : {
"description" : "Passenger first name/given name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.",
"type" : "string"
},
"airline.passenger.last_name" : {
"description" : "Passenger last name/family name.\n> This field is required/mandatory if the airline data includes passenger details or leg details.",
"type" : "string"
},
"airline.passenger.telephone_number" : {
"description" : "Telephone number of the passenger, including country code. This is an alphanumeric field that can include the '+' and '-' signs.\n* minLength: 3\n* maxLength: 30",
"type" : "string"
},
"airline.passenger.traveller_type" : {
"description" : "Passenger type code (PTC). IATA PTC values are 3-letter alphabetical. Example: ADT, SRC, CNN, INS.\n\nHowever, several carriers use non-standard codes that can be up to 5 alphanumeric characters.\n* minLength: 3\n* maxLength: 6",
"type" : "string"
},
"airline.passenger_name" : {
"description" : "Passenger name, initials, and a title.\n* Format: last name + first name or initials + title.\n* Example: *FLYER / MARY MS*.\n* minLength: 1\n* maxLength: 49",
"type" : "string"
},
"airline.ticket_issue_address" : {
"description" : "Address of the place/agency that issued the ticket.\n* minLength: 0\n* maxLength: 16",
"type" : "string"
},
"airline.ticket_number" : {
"description" : "The ticket's unique identifier.\n* minLength: 1\n* maxLength: 150",
"type" : "string"
},
"airline.travel_agency_code" : {
"description" : "IATA number, also ARC number or ARC/IATA number. Unique identifier number for travel agencies.\n* minLength: 1\n* maxLength: 8",
"type" : "string"
},
"airline.travel_agency_name" : {
"description" : "The name of the travel agency.\n* minLength: 1\n* maxLength: 25",
"type" : "string"
}
},
"required" : [
"airline.passenger_name"
]
},
"AdditionalDataCarRental" : {
"properties" : {
"carRental.checkOutDate" : {
"description" : "Pick-up date.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"carRental.customerServiceTollFreeNumber" : {
"description" : "The customer service phone number of the car rental company.\n* Format: Alphanumeric\n* maxLength: 17",
"type" : "string"
},
"carRental.daysRented" : {
"description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 19",
"type" : "string"
},
"carRental.fuelCharges" : {
"description" : "Any fuel charges associated with the rental.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"carRental.insuranceCharges" : {
"description" : "Any insurance charges associated with the rental.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"carRental.locationCity" : {
"description" : "The city from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.locationCountry" : {
"description" : "The country from which the car is rented.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.locationStateProvince" : {
"description" : "The state or province from where the car is rented.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n* Y - Customer was a no show.\n* N - Not applicable.",
"type" : "string"
},
"carRental.oneWayDropOffCharges" : {
"description" : "Charge associated with not returning a vehicle to the original rental location.",
"type" : "string"
},
"carRental.rate" : {
"description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12",
"type" : "string"
},
"carRental.rateIndicator" : {
"description" : "Specifies whether the given rate is applied daily or weekly.\n* D - Daily rate.\n* W - Weekly rate.",
"type" : "string"
},
"carRental.rentalAgreementNumber" : {
"description" : "The rental agreement number associated with this car rental.\n* Format: Alphanumeric\n* maxLength: 9",
"type" : "string"
},
"carRental.rentalClassId" : {
"description" : "Daily rental rate.\n* Format: Alphanumeric\n* maxLength: 12",
"type" : "string"
},
"carRental.renterName" : {
"description" : "The name of the person renting the car.\n* Format: Alphanumeric\n* maxLength: 26",
"type" : "string"
},
"carRental.returnCity" : {
"description" : "The city where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 18",
"type" : "string"
},
"carRental.returnCountry" : {
"description" : "The country where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 2",
"type" : "string"
},
"carRental.returnDate" : {
"description" : "The last date to return the car by.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"carRental.returnLocationId" : {
"description" : "Agency code, phone number, or address abbreviation\n* Format: Alphanumeric\n* maxLength: 10",
"type" : "string"
},
"carRental.returnStateProvince" : {
"description" : "The state or province where the car must be returned.\n* Format: Alphanumeric\n* maxLength: 3",
"type" : "string"
},
"carRental.taxExemptIndicator" : {
"description" : "Indicates whether the goods or services were tax-exempt, or tax was not collected.\n\nValues:\n* Y - Goods or services were tax exempt\n* N - Tax was not collected",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
"description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2",
"type" : "string"
},
"travelEntertainmentAuthData.market" : {
"description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"A\" for Car rental. This should be included in the auth message.\n* Format: Alphanumeric\n* maxLength: 1",
"type" : "string"
}
}
},
"AdditionalDataCommon" : {
"properties" : {
"RequestedTestErrorResponseCode" : {
"description" : "Triggers test scenarios that allow to replicate certain communication errors.\n\nAllowed values:\n* **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication.\nThis 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** – Something went wrong during transmission of the message or receiving the response.\nThis is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.",
"type" : "string"
},
"authorisationType" : {
"description" : "Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types).\n\nAllowed values:\n* **PreAuth** – flags the payment request to be handled as a pre-authorisation.\n* **FinalAuth** – flags the payment request to be handled as a final authorisation.",
"type" : "string"
},
"customRoutingFlag" : {
"description" : "Allows you to determine or override the acquirer account that should be used for the transaction.\n\nIf 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.\n\nTo enable this functionality, contact [Support](https://support.adyen.com/hc/en-us/requests/new).",
"type" : "string"
},
"industryUsage" : {
"description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.",
"enum" : [
"NoShow",
"DelayedCharge"
],
"type" : "string"
},
"networkTxReference" : {
"description" : "Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card.\n\nTransaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID.\n\nSubmit 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.\n\nMake sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.",
"type" : "string"
},
"overwriteBrand" : {
"description" : "Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction.",
"type" : "string"
},
"subMerchantCity" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 13 characters.",
"type" : "string"
},
"subMerchantCountry" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address.\n* Format: alpha-numeric.\n* Fixed length: 3 characters.",
"type" : "string"
},
"subMerchantID" : {
"description" : "This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID.\n\nA unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator.\n* Format: alpha-numeric.\n* Fixed length: 15 characters.",
"type" : "string"
},
"subMerchantName" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant.\n* Format: alpha-numeric.\n* Maximum length: 22 characters.",
"type" : "string"
},
"subMerchantPostalCode" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 10 characters.",
"type" : "string"
},
"subMerchantState" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 3 characters.",
"type" : "string"
},
"subMerchantStreet" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address.\n* Format: alpha-numeric.\n* Maximum length: 60 characters.",
"type" : "string"
},
"subMerchantTaxId" : {
"description" : "This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant.\n* Format: alpha-numeric.\n* Fixed length: 11 or 14 characters.",
"type" : "string"
}
}
},
"AdditionalDataLevel23" : {
"properties" : {
"enhancedSchemeData.customerReference" : {
"description" : "Customer code, if supplied by a customer.\n\nEncoding: ASCII.\n\nMax length: 25 characters.\n\n> Required for Level 2 and Level 3 data.",
"type" : "string"
},
"enhancedSchemeData.destinationCountryCode" : {
"description" : "Destination country code.\n\nEncoding: ASCII.\n\nMax length: 3 characters.",
"type" : "string"
},
"enhancedSchemeData.destinationPostalCode" : {
"description" : "The postal code of a destination address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.\n\n> Required for American Express.",
"type" : "string"
},
"enhancedSchemeData.destinationStateProvinceCode" : {
"description" : "Destination state or province code.\n\nEncoding: ASCII.Max length: 3 characters.",
"type" : "string"
},
"enhancedSchemeData.dutyAmount" : {
"description" : "Duty amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.freightAmount" : {
"description" : "Shipping amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].commodityCode" : {
"description" : "Item commodity code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].description" : {
"description" : "Item description.\n\nEncoding: ASCII.\n\nMax length: 26 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].discountAmount" : {
"description" : "Discount amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].productCode" : {
"description" : "Product code.\n\nEncoding: ASCII.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].quantity" : {
"description" : "Quantity, specified as an integer value.\n\nValue must be greater than 0.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].totalAmount" : {
"description" : "Total amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure" : {
"description" : "Item unit of measurement.\n\nEncoding: ASCII.\n\nMax length: 3 characters.",
"type" : "string"
},
"enhancedSchemeData.itemDetailLine[itemNr].unitPrice" : {
"description" : "Unit price, specified in [minor units](https://docs.adyen.com/development-resources/currency-codes).\n\nMax length: 12 characters.",
"type" : "string"
},
"enhancedSchemeData.orderDate" : {
"description" : "Order date.\n* Format: `ddMMyy`\n\nEncoding: ASCII.\n\nMax length: 6 characters.",
"type" : "string"
},
"enhancedSchemeData.shipFromPostalCode" : {
"description" : "The postal code of a \"ship-from\" address.\n\nEncoding: ASCII.\n\nMax length: 10 characters.",
"type" : "string"
},
"enhancedSchemeData.totalTaxAmount" : {
"description" : "Total tax amount, in minor units.\n\nFor example, 2000 means USD 20.00.\n\nMax length: 12 characters.\n\n> Required for Level 2 and Level 3 data.",
"type" : "string"
}
}
},
"AdditionalDataLodging" : {
"properties" : {
"lodging.checkInDate" : {
"description" : "The arrival date.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"lodging.checkOutDate" : {
"description" : "The departure date.\n* Date format: `yyyyMMdd`",
"type" : "string"
},
"lodging.customerServiceTollFreeNumber" : {
"description" : "The toll free phone number for the hotel/lodgings.\n* Format: Alphanumeric\n* maxLength: 17",
"type" : "string"
},
"lodging.fireSafetyActIndicator" : {
"description" : "Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Values can be: 'Y' or 'N'.\n* Format: Alphabetic\n* maxLength: 1",
"type" : "string"
},
"lodging.folioCashAdvances" : {
"description" : "The folio cash advances.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"lodging.folioNumber" : {
"description" : "Card acceptor’s internal invoice or billing ID reference number.\n* Format: Alphanumeric\n* maxLength: 25",
"type" : "string"
},
"lodging.foodBeverageCharges" : {
"description" : "Any charges for food and beverages associated with the booking.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"lodging.noShowIndicator" : {
"description" : "Indicates if the customer was a \"no-show\" (neither keeps nor cancels their booking).\n\nValue should be Y or N.\n* Format: Numeric\n* maxLength: 1",
"type" : "string"
},
"lodging.prepaidExpenses" : {
"description" : "Prepaid expenses for the booking.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"lodging.propertyPhoneNumber" : {
"description" : "Identifies specific lodging property location by its local phone number.\n* Format: Alphanumeric\n* maxLength: 17",
"type" : "string"
},
"lodging.room1.numberOfNights" : {
"description" : "Total number of nights the room will be rented.\n* Format: Numeric\n* maxLength: 4",
"type" : "string"
},
"lodging.room1.rate" : {
"description" : "The rate of the room.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"lodging.room1.tax" : {
"description" : "The total amount of tax to be paid.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"lodging.totalRoomTax" : {
"description" : "Total room tax amount.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"lodging.totalTax" : {
"description" : "Total tax amount.\n* Format: Numeric\n* maxLength: 12",
"type" : "string"
},
"travelEntertainmentAuthData.duration" : {
"description" : "Number of nights. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2",
"type" : "string"
},
"travelEntertainmentAuthData.market" : {
"description" : "Indicates what market-specific dataset will be submitted or is being submitted. Value should be \"H\" for Hotel. This should be included in the auth message.\n\n* Format: Alphanumeric\n* maxLength: 1",
"type" : "string"
}
}
},
"AdditionalDataOpenInvoice" : {
"properties" : {
"openinvoicedata.merchantData" : {
"description" : "Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string.\n\nThe `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end.\n\nSince the field is optional, if it's not included it does not impact computing the merchant signature.\n\nApplies only to Klarna.\n\nYou can contact Klarna for the format and structure of the string.",
"type" : "string"
},
"openinvoicedata.numberOfLines" : {
"description" : "The number of invoice lines included in `openinvoicedata`.\n\nThere needs to be at least one line, so `numberOfLines` needs to be at least 1.",
"type" : "string"
},
"openinvoicedataLine[itemNr].currencyCode" : {
"description" : "The three-character ISO currency code.",
"type" : "string"
},
"openinvoicedataLine[itemNr].description" : {
"description" : "A text description of the product the invoice line refers to.",
"type" : "string"
},
"openinvoicedataLine[itemNr].itemAmount" : {
"description" : "The price for one item in the invoice line, represented in minor units.\n\nThe due amount for the item, VAT excluded.",
"type" : "string"
},
"openinvoicedataLine[itemNr].itemId" : {
"description" : "A unique id for this item. Required for RatePay if the description of each item is not unique.",
"type" : "string"
},
"openinvoicedataLine[itemNr].itemVatAmount" : {
"description" : "The VAT due for one item in the invoice line, represented in minor units.",
"type" : "string"
},
"openinvoicedataLine[itemNr].itemVatPercentage" : {
"description" : "The VAT percentage for one item in the invoice line, represented in minor units.\n\nFor example, 19% VAT is specified as 1900.",
"type" : "string"
},
"openinvoicedataLine[itemNr].numberOfItems" : {
"description" : "The number of units purchased of a specific product.",
"type" : "string"
},
"openinvoicedataLine[itemNr].returnShippingCompany" : {
"description" : "Name of the shipping company handling the the return shipment.",
"type" : "string"
},
"openinvoicedataLine[itemNr].returnTrackingNumber" : {
"description" : "The tracking number for the return of the shipment.",
"type" : "string"
},
"openinvoicedataLine[itemNr].returnTrackingUri" : {
"description" : "URI where the customer can track the return of their shipment.",
"type" : "string"
},
"openinvoicedataLine[itemNr].shippingCompany" : {
"description" : "Name of the shipping company handling the delivery.",
"type" : "string"
},
"openinvoicedataLine[itemNr].shippingMethod" : {
"description" : "Shipping method.",
"type" : "string"
},
"openinvoicedataLine[itemNr].trackingNumber" : {
"description" : "The tracking number for the shipment.",
"type" : "string"
},
"openinvoicedataLine[itemNr].trackingUri" : {
"description" : "URI where the customer can track their shipment.",
"type" : "string"
},
"openinvoicedataLine[itemNr].vatCategory" : {
"description" : "Required for AfterPay. The country-specific VAT category a product falls under.\n\nAllowed values:\n* High\n* Low\n* None.",
"type" : "string"
}
}
},
"AdditionalDataOpi" : {
"properties" : {
"opi.includeTransToken" : {
"description" : "Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response.\n\nYou can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"AdditionalDataRatepay" : {
"properties" : {
"ratepay.installmentAmount" : {
"description" : "Amount the customer has to pay each month.",
"type" : "string"
},
"ratepay.interestRate" : {
"description" : "Interest rate of this installment.",
"type" : "string"
},
"ratepay.lastInstallmentAmount" : {
"description" : "Amount of the last installment.",
"type" : "string"
},
"ratepay.paymentFirstday" : {
"description" : "Calendar day of the first payment.",
"type" : "string"
},
"ratepaydata.deliveryDate" : {
"description" : "Date the merchant delivered the goods to the customer.",
"type" : "string"
},
"ratepaydata.dueDate" : {
"description" : "Date by which the customer must settle the payment.",
"type" : "string"
},
"ratepaydata.invoiceDate" : {
"description" : "Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date.",
"type" : "string"
},
"ratepaydata.invoiceId" : {
"description" : "Identification name or number for the invoice, defined by the merchant.",
"type" : "string"
}
}
},
"AdditionalDataRetry" : {
"properties" : {
"retry.chainAttemptNumber" : {
"description" : "The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
"type" : "string"
},
"retry.orderAttemptNumber" : {
"description" : "The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
"type" : "string"
},
"retry.skipRetry" : {
"description" : "The Boolean value indicating whether Adyen should skip or retry this transaction, if possible.\n\n> If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.",
"type" : "string"
}
}
},
"AdditionalDataRisk" : {
"properties" : {
"riskdata.[customFieldName]" : {
"description" : "The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields).",
"type" : "string"
},
"riskdata.basket.item[itemNr].amountPerItem" : {
"description" : "The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"type" : "string"
},
"riskdata.basket.item[itemNr].brand" : {
"description" : "Brand of the item.",
"type" : "string"
},
"riskdata.basket.item[itemNr].category" : {
"description" : "Category of the item.",
"type" : "string"
},
"riskdata.basket.item[itemNr].color" : {
"description" : "Color of the item.",
"type" : "string"
},
"riskdata.basket.item[itemNr].currency" : {
"description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
"type" : "string"
},
"riskdata.basket.item[itemNr].itemID" : {
"description" : "ID of the item.",
"type" : "string"
},
"riskdata.basket.item[itemNr].manufacturer" : {
"description" : "Manufacturer of the item.",
"type" : "string"
},
"riskdata.basket.item[itemNr].productTitle" : {
"description" : "A text description of the product the invoice line refers to.",
"type" : "string"
},
"riskdata.basket.item[itemNr].quantity" : {
"description" : "Quantity of the item purchased.",
"type" : "string"
},
"riskdata.basket.item[itemNr].receiverEmail" : {
"description" : "Email associated with the given product in the basket (usually in electronic gift cards).",
"type" : "string"
},
"riskdata.basket.item[itemNr].size" : {
"description" : "Size of the item.",
"type" : "string"
},
"riskdata.basket.item[itemNr].sku" : {
"description" : "[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).",
"type" : "string"
},
"riskdata.basket.item[itemNr].upc" : {
"description" : "[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).",
"type" : "string"
},
"riskdata.promotions.promotion[itemNr].promotionCode" : {
"description" : "Code of the promotion.",
"type" : "string"
},
"riskdata.promotions.promotion[itemNr].promotionDiscountAmount" : {
"description" : "The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"type" : "string"
},
"riskdata.promotions.promotion[itemNr].promotionDiscountCurrency" : {
"description" : "The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217).",
"type" : "string"
},
"riskdata.promotions.promotion[itemNr].promotionDiscountPercentage" : {
"description" : "Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign.\n\ne.g. for a promotion discount of 30%, the value of the field should be 30.",
"type" : "string"
},
"riskdata.promotions.promotion[itemNr].promotionName" : {
"description" : "Name of the promotion.",
"type" : "string"
},
"riskdata.riskProfileReference" : {
"description" : "Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment).",
"type" : "string"
}
}
},
"AdditionalDataRiskStandalone" : {
"properties" : {
"PayPal.CountryCode" : {
"description" : "Shopper's country of residence in the form of ISO standard 3166 2-character country codes.",
"type" : "string"
},
"PayPal.EmailId" : {
"description" : "Shopper's email.",
"type" : "string"
},
"PayPal.FirstName" : {
"description" : "Shopper's first name.",
"type" : "string"
},
"PayPal.LastName" : {
"description" : "Shopper's last name.",
"type" : "string"
},
"PayPal.PayerId" : {
"description" : "Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.",
"type" : "string"
},
"PayPal.Phone" : {
"description" : "Shopper's phone number.",
"type" : "string"
},
"PayPal.ProtectionEligibility" : {
"description" : "Allowed values:\n* **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.\n\n* **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.\n\n* **Ineligible** — Merchant is not protected under the Seller Protection Policy.",
"type" : "string"
},
"PayPal.TransactionId" : {
"description" : "Unique transaction ID of the payment.",
"type" : "string"
},
"avsResultRaw" : {
"description" : "Raw AVS result received from the acquirer, where available. Example: D",
"type" : "string"
},
"bin" : {
"description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request).",
"type" : "string"
},
"cvcResultRaw" : {
"description" : "Raw CVC result received from the acquirer, where available. Example: 1",
"type" : "string"
},
"riskToken" : {
"description" : "Unique identifier or token for the shopper's card details.",
"type" : "string"
},
"threeDAuthenticated" : {
"description" : "A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true",
"type" : "string"
},
"threeDOffered" : {
"description" : "A Boolean value indicating whether 3DS was offered for this payment. Example: true",
"type" : "string"
},
"tokenDataType" : {
"description" : "Required for PayPal payments only. The only supported value is: **paypal**.",
"type" : "string"
}
}
},
"AdditionalDataSubMerchant" : {
"properties" : {
"subMerchant.numberOfSubSellers" : {
"description" : "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].city" : {
"description" : "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].country" : {
"description" : "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].creditSettlementAccount" : {
"description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].creditSettlementAccountType" : {
"description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].creditSettlementAgency" : {
"description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].creditSettlementBank" : {
"description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].debitSettlementAccount" : {
"description" : "The sub-merchant's bank account number with the check digit number and without punctuations or dashes.\n* Format: Numeric\n* Maximum length: 12 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].debitSettlementAccountType" : {
"description" : "A two-letter indicator of the type of the sub-merchant's bank account.\nPossible values:\n - **CC** - Checking account\n - **CD** - Deposit account\n - **PG** - Payments account\n - **PP** - Savings account\n",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].debitSettlementAgency" : {
"description" : "The four-digit branch code of the sub-merchant's bank, without the check digit, slashes, or dashes.\n* Format: Numeric\n* Fixed length: 4 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].debitSettlementBank" : {
"description" : "The identifier of the sub-merchant's bank. In Brazil, this is the three-digit bank number format specified by the Central Bank of Brazil (BACEN).\n* Format: Numeric\n* Fixed length: 3 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].id" : {
"description" : "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].mcc" : {
"description" : "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].name" : {
"description" : "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].postalCode" : {
"description" : "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].state" : {
"description" : "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].street" : {
"description" : "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters",
"type" : "string"
},
"subMerchant.subSeller[subSellerNr].taxId" : {
"description" : "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ",
"type" : "string"
}
}
},
"AdditionalDataTemporaryServices" : {
"properties" : {
"enhancedSchemeData.customerReference" : {
"description" : "Customer code, if supplied by a customer.\n* Encoding: ASCII\n* maxLength: 25",
"type" : "string"
},
"enhancedSchemeData.employeeName" : {
"description" : "Name or ID associated with the individual working in a temporary capacity.\n* maxLength: 40",
"type" : "string"
},
"enhancedSchemeData.jobDescription" : {
"description" : "Description of the job or task of the individual working in a temporary capacity.\n* maxLength: 40",
"type" : "string"
},
"enhancedSchemeData.regularHoursRate" : {
"description" : "Amount paid per regular hours worked, minor units.\n* maxLength: 7",
"type" : "string"
},
"enhancedSchemeData.regularHoursWorked" : {
"description" : "Amount of time worked during a normal operation for the task or job.\n* maxLength: 7",
"type" : "string"
},
"enhancedSchemeData.requestName" : {
"description" : "Name of the individual requesting temporary services.\n* maxLength: 40",
"type" : "string"
},
"enhancedSchemeData.tempStartDate" : {
"description" : "Date for the beginning of the pay period.\n* Format: ddMMyy\n* maxLength: 6",
"type" : "string"
},
"enhancedSchemeData.tempWeekEnding" : {
"description" : "Date of the end of the billing cycle.\n* Format: ddMMyy\n* maxLength: 6",
"type" : "string"
},
"enhancedSchemeData.totalTaxAmount" : {
"description" : "Total tax amount, in minor units. For example, 2000 means USD 20.00\n* maxLength: 12",
"type" : "string"
}
}
},
"AdditionalDataWallets" : {
"properties" : {
"androidpay.token" : {
"description" : "The Android Pay token retrieved from the SDK.",
"type" : "string"
},
"masterpass.transactionId" : {
"description" : "The Mastercard Masterpass Transaction ID retrieved from the SDK.",
"type" : "string"
},
"payment.token" : {
"description" : "The Apple Pay token retrieved from the SDK.",
"type" : "string"
},
"paywithgoogle.token" : {
"description" : "The Google Pay token retrieved from the SDK.",
"type" : "string"
},
"samsungpay.token" : {
"description" : "The Samsung Pay token retrieved from the SDK.",
"type" : "string"
},
"visacheckout.callId" : {
"description" : "The Visa Checkout Call ID retrieved from the SDK.",
"type" : "string"
}
}
},
"Address" : {
"properties" : {
"city" : {
"description" : "The name of the city.",
"type" : "string"
},
"country" : {
"description" : "The two-character country code as defined in ISO-3166-1 alpha-2. For example, **US**.\n> If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.",
"type" : "string"
},
"houseNumberOrName" : {
"description" : "The number or name of the house.",
"type" : "string"
},
"postalCode" : {
"description" : "A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries.",
"type" : "string"
},
"stateOrProvince" : {
"description" : "State or province codes as defined in ISO 3166-2. For example, **CA** in the US or **ON** in Canada.\n> Required for the US and Canada.",
"type" : "string"
},
"street" : {
"description" : "The name of the street.\n> The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.",
"type" : "string"
}
},
"required" : [
"street",
"houseNumberOrName",
"city",
"postalCode",
"country"
]
},
"AfterpayDetails" : {
"additionalProperties" : false,
"properties" : {
"billingAddress" : {
"description" : "The address where to send the invoice.",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the goods should be delivered.",
"type" : "string"
},
"personalDetails" : {
"description" : "Shopper name, date of birth, phone number, and email address.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "afterpay_default",
"description" : "**afterpay_default**",
"enum" : [
"afterpay_default",
"afterpaytouch",
"afterpay_b2b"
],
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "Afterpay"
},
"AmazonPayDetails" : {
"additionalProperties" : false,
"properties" : {
"amazonPayToken" : {
"description" : "This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response.",
"type" : "string"
},
"type" : {
"default" : "amazonpay",
"description" : "**amazonpay**",
"enum" : [
"amazonpay"
],
"type" : "string"
}
},
"title" : "Amazon Pay"
},
"Amount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"value",
"currency"
]
},
"AndroidPayDetails" : {
"additionalProperties" : false,
"properties" : {
"type" : {
"default" : "androidpay",
"description" : "**androidpay**",
"enum" : [
"androidpay"
],
"type" : "string"
}
},
"title" : "Android Pay"
},
"ApplePayDetails" : {
"additionalProperties" : false,
"properties" : {
"applePayToken" : {
"description" : "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.",
"maxLength" : 10000,
"type" : "string"
},
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"debit"
],
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "applepay",
"description" : "**applepay**",
"enum" : [
"applepay"
],
"type" : "string"
}
},
"required" : [
"applePayToken"
],
"title" : "Apple Pay"
},
"ApplicationInfo" : {
"properties" : {
"adyenLibrary" : {
"description" : "Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc.",
"$ref" : "#/components/schemas/CommonField"
},
"adyenPaymentSource" : {
"description" : "Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc.",
"$ref" : "#/components/schemas/CommonField"
},
"externalPlatform" : {
"description" : "Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc.",
"$ref" : "#/components/schemas/ExternalPlatform"
},
"merchantApplication" : {
"description" : "Merchant developed software, such as cashier application, used to interact with the Adyen API.",
"$ref" : "#/components/schemas/CommonField"
},
"merchantDevice" : {
"description" : "Merchant device information.",
"$ref" : "#/components/schemas/MerchantDevice"
},
"shopperInteractionDevice" : {
"description" : "Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests.",
"$ref" : "#/components/schemas/ShopperInteractionDevice"
}
}
},
"Avs" : {
"properties" : {
"addressEditable" : {
"description" : "Indicates whether the shopper is allowed to modify the billing address for the current payment request.",
"type" : "boolean"
},
"enabled" : {
"description" : "Specifies whether the shopper should enter their billing address during checkout.\n\nAllowed values:\n* yes — Perform AVS checks for every card payment.\n* automatic — Perform AVS checks only when required to optimize the conversion rate.\n* no — Do not perform AVS checks.",
"enum" : [
"yes",
"no",
"automatic"
],
"type" : "string"
}
}
},
"BacsDirectDebitDetails" : {
"additionalProperties" : false,
"properties" : {
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "directdebit_GB",
"description" : "**directdebit_GB**",
"enum" : [
"directdebit_GB"
],
"type" : "string"
}
},
"title" : "BACS Direct Debit"
},
"BankAccount" : {
"properties" : {
"bankAccountNumber" : {
"description" : "The bank account number (without separators).",
"type" : "string"
},
"bankCity" : {
"x-addedInVersion" : 18,
"description" : "The bank city.",
"type" : "string"
},
"bankLocationId" : {
"description" : "The location id of the bank. The field value is `nil` in most cases.",
"type" : "string"
},
"bankName" : {
"description" : "The name of the bank.",
"type" : "string"
},
"bic" : {
"description" : "The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases.",
"type" : "string"
},
"countryCode" : {
"description" : "Country code where the bank is located.\n\nA valid value is an ISO two-character country code (e.g. 'NL').",
"type" : "string"
},
"iban" : {
"description" : "The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN).",
"type" : "string"
},
"ownerName" : {
"description" : "The name of the bank account holder.\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* χ12 is converted to ch12.\n* üA is converted to euA.\n* Peter Møller is converted to Peter Mller, because banks don't accept 'ø'.\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'.",
"type" : "string"
},
"taxId" : {
"x-addedInVersion" : 18,
"description" : "The bank account holder's tax ID.",
"type" : "string"
}
}
},
"BillDeskDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The issuer id of the shopper's selected bank.",
"type" : "string"
},
"type" : {
"description" : "**billdesk**",
"enum" : [
"billdesk_online",
"billdesk_wallet"
],
"type" : "string"
}
},
"required" : [
"type",
"issuer"
],
"title" : "BillDesk"
},
"BlikDetails" : {
"additionalProperties" : false,
"properties" : {
"blikCode" : {
"description" : "BLIK code consisting of 6 digits.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"description" : "**blik**",
"enum" : [
"blik"
],
"type" : "string"
}
},
"title" : "BLIK"
},
"BrowserInfo" : {
"properties" : {
"acceptHeader" : {
"description" : "The accept header value of the shopper's browser.",
"maxLength" : 50,
"minLength" : 10,
"type" : "string"
},
"colorDepth" : {
"x-addedInVersion" : 40,
"description" : "The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth.",
"format" : "int32",
"type" : "integer"
},
"javaEnabled" : {
"x-addedInVersion" : 40,
"description" : "Boolean value indicating if the shopper's browser is able to execute Java.",
"type" : "boolean"
},
"javaScriptEnabled" : {
"x-addedInVersion" : 40,
"default" : true,
"description" : "Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present.",
"type" : "boolean"
},
"language" : {
"x-addedInVersion" : 40,
"description" : "The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47).",
"type" : "string"
},
"screenHeight" : {
"x-addedInVersion" : 40,
"description" : "The total height of the shopper's device screen in pixels.",
"format" : "int32",
"type" : "integer"
},
"screenWidth" : {
"x-addedInVersion" : 40,
"description" : "The total width of the shopper's device screen in pixels.",
"format" : "int32",
"type" : "integer"
},
"timeZoneOffset" : {
"x-addedInVersion" : 40,
"description" : "Time difference between UTC time and the shopper's browser local time, in minutes.",
"format" : "int32",
"type" : "integer"
},
"userAgent" : {
"description" : "The user agent value of the shopper's browser.",
"maxLength" : 50,
"minLength" : 10,
"type" : "string"
}
},
"required" : [
"userAgent",
"acceptHeader",
"javaEnabled",
"colorDepth",
"screenHeight",
"screenWidth",
"timeZoneOffset",
"language"
]
},
"Card" : {
"properties" : {
"cvc" : {
"description" : "The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as:\n* CVV2/CVC2 – length: 3 digits\n* CID – length: 4 digits\n> If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server.\n> This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments).\n> When this value is returned in a response, it is always empty because it is not stored.",
"maxLength" : 20,
"minLength" : 1,
"type" : "string"
},
"expiryMonth" : {
"description" : "The card expiry month.\nFormat: 2 digits, zero-padded for single digits. For example:\n* 03 = March\n* 11 = November",
"maxLength" : 2,
"minLength" : 1,
"type" : "string"
},
"expiryYear" : {
"description" : "The card expiry year.\nFormat: 4 digits. For example: 2020",
"maxLength" : 4,
"minLength" : 4,
"type" : "string"
},
"holderName" : {
"description" : "The name of the cardholder, as printed on the card.",
"maxLength" : 50,
"minLength" : 1,
"type" : "string"
},
"issueNumber" : {
"description" : "The issue number of the card (for some UK debit cards only).",
"maxLength" : 2,
"minLength" : 1,
"type" : "string"
},
"number" : {
"description" : "The card number (4-19 characters). Do not use any separators.\nWhen this value is returned in a response, only the last 4 digits of the card number are returned.",
"maxLength" : 19,
"minLength" : 4,
"type" : "string"
},
"startMonth" : {
"description" : "The month component of the start date (for some UK debit cards only).",
"maxLength" : 2,
"minLength" : 1,
"type" : "string"
},
"startYear" : {
"description" : "The year component of the start date (for some UK debit cards only).",
"maxLength" : 4,
"minLength" : 4,
"type" : "string"
}
},
"required" : [
"number",
"expiryMonth",
"expiryYear",
"holderName"
]
},
"CardDetails" : {
"additionalProperties" : false,
"properties" : {
"cupsecureplus.smscode" : {
"deprecated" : true,
"type" : "string"
},
"cvc" : {
"description" : "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"encryptedCardNumber" : {
"description" : "The encrypted card number.",
"maxLength" : 10000,
"type" : "string"
},
"encryptedExpiryMonth" : {
"description" : "The encrypted card expiry month.",
"maxLength" : 10000,
"type" : "string"
},
"encryptedExpiryYear" : {
"description" : "The encrypted card expiry year.",
"maxLength" : 10000,
"type" : "string"
},
"encryptedSecurityCode" : {
"description" : "The encrypted card verification code.",
"maxLength" : 10000,
"type" : "string"
},
"expiryMonth" : {
"description" : "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"expiryYear" : {
"description" : "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"debit"
],
"type" : "string"
},
"holderName" : {
"description" : "The name of the card holder.",
"type" : "string"
},
"number" : {
"description" : "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "scheme",
"description" : "Default payment method details. Common for scheme payment methods, and for simple payment method details.",
"enum" : [
"scheme",
"networkToken",
"giftcard",
"alliancedata",
"card",
"moneybookers",
"alipay_hk",
"alipay_hk_wap",
"alipay_hk_web",
"alipay_wap",
"upi",
"primeiropay_boleto",
"gopay_wallet",
"poli",
"mada",
"naps",
"benefit",
"knet",
"fawry",
"omannet"
],
"type" : "string"
}
},
"required" : [
"encryptedCardNumber",
"encryptedExpiryMonth",
"encryptedExpiryYear"
],
"title" : "Card"
},
"CellulantDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The Cellulant issuer.",
"type" : "string"
},
"type" : {
"default" : "cellulant",
"description" : "**Cellulant**",
"enum" : [
"cellulant"
],
"type" : "string"
}
},
"title" : "Cellulant"
},
"CheckoutAwaitAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"type" : {
"description" : "**await**",
"enum" : [
"await"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutBalanceCheckRequest" : {
"properties" : {
"accountInfo" : {
"x-addedInVersion" : 40,
"description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.",
"$ref" : "#/components/schemas/AccountInfo"
},
"additionalAmount" : {
"description" : "If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification).\nRequired to be in the same currency as the `amount`. ",
"$ref" : "#/components/schemas/Amount"
},
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/AdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/AdditionalDataAirline"
},
{
"$ref" : "#/components/schemas/AdditionalDataCarRental"
},
{
"$ref" : "#/components/schemas/AdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/AdditionalDataLevel23"
},
{
"$ref" : "#/components/schemas/AdditionalDataLodging"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
{
"$ref" : "#/components/schemas/AdditionalDataRetry"
},
{
"$ref" : "#/components/schemas/AdditionalDataRisk"
},
{
"$ref" : "#/components/schemas/AdditionalDataRiskStandalone"
},
{
"$ref" : "#/components/schemas/AdditionalDataSubMerchant"
},
{
"$ref" : "#/components/schemas/AdditionalDataTemporaryServices"
},
{
"$ref" : "#/components/schemas/AdditionalDataWallets"
}
],
"description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.",
"type" : "object"
},
"amount" : {
"description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).",
"$ref" : "#/components/schemas/Amount"
},
"applicationInfo" : {
"x-addedInVersion" : 40,
"description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
"$ref" : "#/components/schemas/ApplicationInfo"
},
"billingAddress" : {
"x-addedInVersion" : 4,
"description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.",
"$ref" : "#/components/schemas/Address"
},
"browserInfo" : {
"description" : "The shopper's browser information.\n> For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.",
"$ref" : "#/components/schemas/BrowserInfo"
},
"captureDelayHours" : {
"x-addedInVersion" : 2,
"description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.",
"format" : "int32",
"type" : "integer"
},
"dateOfBirth" : {
"x-addedInVersion" : 7,
"description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD",
"format" : "date-time",
"type" : "string"
},
"dccQuote" : {
"description" : "The forex quote as returned in the response of the forex service.",
"$ref" : "#/components/schemas/ForexQuote"
},
"deliveryAddress" : {
"description" : "The address where the purchased goods should be delivered.",
"$ref" : "#/components/schemas/Address"
},
"deliveryDate" : {
"x-addedInVersion" : 8,
"description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00",
"format" : "date-time",
"type" : "string"
},
"deviceFingerprint" : {
"x-addedInVersion" : 2,
"description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).",
"maxLength" : 5000,
"type" : "string"
},
"enableRealTimeUpdate" : {
"x-addedInVersion" : 51,
"deprecated" : true,
"description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.",
"type" : "boolean"
},
"fraudOffset" : {
"description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.",
"format" : "int32",
"type" : "integer"
},
"installments" : {
"x-addedInVersion" : 4,
"description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).",
"$ref" : "#/components/schemas/Installments"
},
"mcc" : {
"x-addedInVersion" : 12,
"description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account identifier, with which you want to process the transaction.",
"type" : "string"
},
"merchantOrderReference" : {
"x-addedInVersion" : 9,
"description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.",
"type" : "string"
},
"merchantRiskIndicator" : {
"x-addedInVersion" : 40,
"description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.",
"$ref" : "#/components/schemas/MerchantRiskIndicator"
},
"metadata" : {
"x-addedInVersion" : 17,
"additionalProperties" : {
"type" : "string"
},
"description" : "Metadata consists of entries, each of which includes a key and a value.\nLimits:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\".\n* Maximum 20 characters per key.\n* Maximum 80 characters per value. ",
"type" : "object"
},
"orderReference" : {
"description" : "When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.",
"type" : "string"
},
"paymentMethod" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "The collection that contains the type of the payment method and its specific information.",
"type" : "object"
},
"recurring" : {
"description" : "The recurring settings for the payment. Use this property when you want to enable [recurring payments](https://docs.adyen.com/classic-integration/recurring-payments).",
"$ref" : "#/components/schemas/Recurring"
},
"recurringProcessingModel" : {
"x-addedInVersion" : 30,
"description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n",
"enum" : [
"CardOnFile",
"Subscription",
"UnscheduledCardOnFile"
],
"type" : "string"
},
"reference" : {
"description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
"type" : "string"
},
"selectedBrand" : {
"description" : "Some payment methods require defining a value for this field to specify how to process the transaction.\n\nFor the Bancontact payment method, it can be set to:\n* `maestro` (default), to be processed like a Maestro card, or\n* `bcmc`, to be processed like a Bancontact card.",
"type" : "string"
},
"selectedRecurringDetailReference" : {
"description" : "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.",
"type" : "string"
},
"sessionId" : {
"description" : "A session ID used to identify a payment session.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.",
"type" : "string"
},
"shopperIP" : {
"description" : "The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).\n> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.\nThis field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).",
"type" : "string"
},
"shopperInteraction" : {
"description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `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.\n* `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).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
"enum" : [
"Ecommerce",
"ContAuth",
"Moto",
"POS"
],
"type" : "string"
},
"shopperLocale" : {
"x-addedInVersion" : 7,
"description" : "The combination of a language code and a country code to specify the language to be used in the payment.",
"type" : "string"
},
"shopperName" : {
"x-addedInVersion" : 7,
"description" : "The shopper's full name.",
"$ref" : "#/components/schemas/Name"
},
"shopperReference" : {
"description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.",
"type" : "string"
},
"shopperStatement" : {
"description" : "The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n We recommend sending a maximum of 25 characters, otherwise banks might truncate the string.",
"type" : "string"
},
"socialSecurityNumber" : {
"x-addedInVersion" : 4,
"description" : "The shopper's social security number.",
"type" : "string"
},
"splits" : {
"x-addedInVersion" : 37,
"description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).",
"items" : {
"$ref" : "#/components/schemas/Split"
},
"type" : "array"
},
"store" : {
"x-addedInVersion" : 23,
"description" : "The physical store, for which this payment is processed.",
"maxLength" : 16,
"minLength" : 1,
"type" : "string"
},
"telephoneNumber" : {
"x-addedInVersion" : 7,
"description" : "The shopper's telephone number.",
"type" : "string"
},
"threeDS2RequestData" : {
"x-addedInVersion" : 40,
"description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.",
"$ref" : "#/components/schemas/ThreeDS2RequestData"
},
"threeDSAuthenticationOnly" : {
"x-addedInVersion" : 50,
"default" : false,
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},
"totalsGroup" : {
"x-addedInVersion" : 23,
"description" : "The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).",
"maxLength" : 16,
"minLength" : 1,
"type" : "string"
},
"trustedShopper" : {
"x-addedInVersion" : 37,
"description" : "Set to true if the payment should be routed to a trusted MID.",
"type" : "boolean"
}
},
"required" : [
"merchantAccount",
"reference",
"amount",
"paymentMethod"
]
},
"CheckoutBalanceCheckResponse" : {
"properties" : {
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataDeliveryAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.",
"type" : "object"
},
"balance" : {
"description" : "The balance for the payment method.",
"$ref" : "#/components/schemas/Amount"
},
"fraudResult" : {
"description" : "The fraud result properties of the payment.",
"$ref" : "#/components/schemas/FraudResult"
},
"pspReference" : {
"description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
},
"refusalReason" : {
"description" : "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"resultCode" : {
"description" : "The result of the cancellation request.\n\nPossible values:\n\n* **Success** – Indicates that the balance check was successful.\n* **NotEnoughBalance** – Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount.\n* **Failed** – Indicates that the balance check failed.",
"enum" : [
"Success",
"NotEnoughBalance",
"Failed"
],
"type" : "string"
}
},
"required" : [
"balance",
"resultCode"
]
},
"CheckoutBankTransferAction" : {
"additionalProperties" : false,
"properties" : {
"beneficiary" : {
"description" : "The name of the account holder.",
"type" : "string"
},
"bic" : {
"description" : "The BIC of the IBAN.",
"type" : "string"
},
"downloadUrl" : {
"description" : "The url to download payment details with.",
"type" : "string"
},
"iban" : {
"description" : "The IBAN of the bank transfer.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"reference" : {
"description" : "The transfer reference.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The e-mail of the shopper, included if an e-mail was sent to the shopper.",
"type" : "string"
},
"totalAmount" : {
"description" : "The amount of the bank transfer.",
"$ref" : "#/components/schemas/Amount"
},
"type" : {
"description" : "The type of the action.",
"enum" : [
"bankTransfer"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutCancelOrderRequest" : {
"properties" : {
"merchantAccount" : {
"description" : "The merchant account identifier that orderData belongs to.",
"type" : "string"
},
"order" : {
"description" : "The order request object that contains a pspReference that represents the order and the matching encrypted order data.",
"$ref" : "#/components/schemas/CheckoutOrder"
}
},
"required" : [
"order",
"merchantAccount"
]
},
"CheckoutCancelOrderResponse" : {
"properties" : {
"pspReference" : {
"description" : "A unique reference of the cancellation request.",
"type" : "string"
},
"resultCode" : {
"description" : "The result of the cancellation request.\n\nPossible values:\n\n* **Received** – Indicates the cancellation has successfully been received by Adyen, and will be processed.",
"enum" : [
"Received"
],
"type" : "string"
}
},
"required" : [
"pspReference",
"resultCode"
]
},
"CheckoutCreateOrderRequest" : {
"properties" : {
"amount" : {
"description" : "The total amount of the order.",
"$ref" : "#/components/schemas/Amount"
},
"expiresAt" : {
"description" : "The date that order expires; e.g. 2019-03-23T12:25:28Z. If not provided, the default expiry duration is 1 day.",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account identifier, with which you want to process the order.",
"type" : "string"
},
"reference" : {
"description" : "A custom reference identifying the order.",
"type" : "string"
}
},
"required" : [
"merchantAccount",
"amount",
"reference"
]
},
"CheckoutCreateOrderResponse" : {
"properties" : {
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataDeliveryAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.",
"type" : "object"
},
"expiresAt" : {
"description" : "The date that the order will expire.",
"type" : "string"
},
"fraudResult" : {
"description" : "The fraud result properties of the payment.",
"$ref" : "#/components/schemas/FraudResult"
},
"orderData" : {
"description" : "The encrypted data that will be used by merchant for adding payments to the order.",
"type" : "string"
},
"pspReference" : {
"description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
},
"reference" : {
"description" : "The reference provided by merchant for creating the order.",
"type" : "string"
},
"refusalReason" : {
"description" : "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"remainingAmount" : {
"description" : "The remaining amount in the order.",
"$ref" : "#/components/schemas/Amount"
},
"resultCode" : {
"description" : "The result of the order creation request.\n The value is always **Success**.",
"enum" : [
"Success"
],
"type" : "string"
}
},
"required" : [
"remainingAmount",
"expiresAt",
"orderData",
"resultCode"
]
},
"CheckoutDonationAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"type" : {
"description" : "The type of the action.",
"enum" : [
"donate"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutOneTimePasscodeAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"redirect" : {
"description" : "When the payment flow requires a redirect as fallback, this object contains information about the redirect.",
"$ref" : "#/components/schemas/Redirect"
},
"resendInterval" : {
"description" : "The interval in second between OTP resend.",
"format" : "int32",
"type" : "integer"
},
"resendMaxAttempts" : {
"description" : "The maximum number of OTP resend attempts.",
"format" : "int32",
"type" : "integer"
},
"resendUrl" : {
"description" : "The URL, to which you make POST request to trigger OTP resend.",
"type" : "string"
},
"type" : {
"description" : "The type of the action.",
"enum" : [
"oneTimePasscode"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutOrder" : {
"properties" : {
"orderData" : {
"description" : "The encrypted order data.",
"type" : "string"
},
"pspReference" : {
"description" : "The `pspReference` that belongs to the order.",
"type" : "string"
}
},
"required" : [
"pspReference",
"orderData"
]
},
"CheckoutOrderResponse" : {
"properties" : {
"amount" : {
"description" : "The initial amount of the order.",
"$ref" : "#/components/schemas/Amount"
},
"expiresAt" : {
"description" : "The expiry date for the order.",
"type" : "string"
},
"orderData" : {
"description" : "The encrypted order data.",
"type" : "string"
},
"pspReference" : {
"description" : "The `pspReference` that belongs to the order.",
"type" : "string"
},
"reference" : {
"description" : "The merchant reference for the order.",
"type" : "string"
},
"remainingAmount" : {
"description" : "The updated remaining amount.",
"$ref" : "#/components/schemas/Amount"
}
},
"required" : [
"pspReference"
]
},
"CheckoutQrCodeAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"qrCodeData" : {
"description" : "The contents of the QR code as a UTF8 string.",
"type" : "string"
},
"type" : {
"description" : "**qrCode**",
"enum" : [
"qrCode"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutRedirectAction" : {
"additionalProperties" : false,
"properties" : {
"data" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.",
"type" : "object"
},
"method" : {
"description" : "Specifies the HTTP method, for example GET or POST.",
"type" : "string"
},
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"type" : {
"description" : "**redirect**",
"enum" : [
"redirect"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutSDKAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"sdkData" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "The data to pass to the SDK.",
"type" : "object"
},
"type" : {
"description" : "The type of the action.",
"enum" : [
"sdk",
"wechatpaySDK"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutThreeDS2ChallengeAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"token" : {
"description" : "A token to pass to the 3DS2 Component to get the challenge.",
"type" : "string"
},
"type" : {
"description" : "**threeDS2Challenge**",
"enum" : [
"threeDS2Challenge"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutThreeDS2FingerPrintAction" : {
"additionalProperties" : false,
"properties" : {
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"token" : {
"description" : "A token to pass to the 3DS2 Component to get the fingerprint.",
"type" : "string"
},
"type" : {
"description" : "**threeDS2Fingerprint**",
"enum" : [
"threeDS2Fingerprint"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CheckoutUtilityRequest" : {
"properties" : {
"originDomains" : {
"description" : "The list of origin domains, for which origin keys are requested.",
"items" : {
"type" : "string"
},
"type" : "array"
}
},
"required" : [
"originDomains"
]
},
"CheckoutUtilityResponse" : {
"properties" : {
"originKeys" : {
"x-addedInVersion" : 1,
"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.",
"type" : "object"
}
}
},
"CheckoutVoucherAction" : {
"additionalProperties" : false,
"properties" : {
"alternativeReference" : {
"description" : "The voucher alternative reference code.",
"type" : "string"
},
"collectionInstitutionNumber" : {
"description" : "A collection institution number (store number) for Econtext Pay-Easy ATM.",
"type" : "string"
},
"downloadUrl" : {
"description" : "The URL to download the voucher.",
"type" : "string"
},
"entity" : {
"description" : "An entity number of Multibanco.",
"type" : "string"
},
"expiresAt" : {
"description" : "The date time of the voucher expiry.",
"type" : "string"
},
"initialAmount" : {
"description" : "The initial amount.",
"$ref" : "#/components/schemas/Amount"
},
"instructionsUrl" : {
"description" : "The URL to the detailed instructions to make payment using the voucher.",
"type" : "string"
},
"issuer" : {
"description" : "The issuer of the voucher.",
"type" : "string"
},
"maskedTelephoneNumber" : {
"description" : "The shopper telephone number (partially masked).",
"type" : "string"
},
"merchantName" : {
"description" : "The merchant name.",
"type" : "string"
},
"merchantReference" : {
"description" : "The merchant reference.",
"type" : "string"
},
"paymentData" : {
"description" : "A value that must be submitted to the `/payments/details` endpoint to verify this payment.",
"type" : "string"
},
"paymentMethodType" : {
"description" : "Specifies the payment method.",
"type" : "string"
},
"reference" : {
"description" : "The voucher reference code.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper email.",
"type" : "string"
},
"shopperName" : {
"description" : "The shopper name.",
"type" : "string"
},
"surcharge" : {
"description" : "The surcharge amount.",
"$ref" : "#/components/schemas/Amount"
},
"totalAmount" : {
"description" : "The total amount (initial plus surcharge amount).",
"$ref" : "#/components/schemas/Amount"
},
"type" : {
"description" : "**voucher**",
"enum" : [
"voucher"
],
"type" : "string"
},
"url" : {
"description" : "Specifies the URL to redirect to.",
"type" : "string"
}
},
"required" : [
"type"
]
},
"CommonField" : {
"properties" : {
"name" : {
"description" : "Name of the field. For example, Name of External Platform.",
"type" : "string"
},
"version" : {
"description" : "Version of the field. For example, Version of External Platform.",
"type" : "string"
}
}
},
"Company" : {
"properties" : {
"homepage" : {
"description" : "The company website's home page.",
"type" : "string"
},
"name" : {
"description" : "The company name.",
"type" : "string"
},
"registrationNumber" : {
"description" : "Registration number of the company.",
"type" : "string"
},
"registryLocation" : {
"description" : "Registry location of the company.",
"type" : "string"
},
"taxId" : {
"description" : "Tax ID of the company.",
"type" : "string"
},
"type" : {
"description" : "The company type.",
"type" : "string"
}
}
},
"Configuration" : {
"properties" : {
"avs" : {
"description" : "Describes the configuration for AVS ([Address Verification System](https://en.wikipedia.org/wiki/Address_Verification_System)).",
"$ref" : "#/components/schemas/Avs"
},
"cardHolderName" : {
"x-addedInVersion" : 37,
"description" : "Determines whether the cardholder name should be provided or not.\n\nPermitted values:\n* NONE\n* OPTIONAL\n* REQUIRED",
"enum" : [
"NONE",
"OPTIONAL",
"REQUIRED"
],
"type" : "string"
},
"installments" : {
"description" : "Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).",
"$ref" : "#/components/schemas/Installments2"
},
"shopperInput" : {
"x-addedInVersion" : 37,
"description" : "Determines how to display the details fields.",
"$ref" : "#/components/schemas/ShopperInput"
}
}
},
"CreatePaymentLinkRequest" : {
"properties" : {
"allowedPaymentMethods" : {
"description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"amount" : {
"description" : "The payment amount and currency.",
"$ref" : "#/components/schemas/Amount"
},
"applicationInfo" : {
"description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
"$ref" : "#/components/schemas/ApplicationInfo"
},
"billingAddress" : {
"description" : "The address where to send the invoice.",
"$ref" : "#/components/schemas/Address"
},
"blockedPaymentMethods" : {
"description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"countryCode" : {
"description" : "The shopper's two-letter country code.",
"type" : "string"
},
"deliverAt" : {
"description" : "The date and time the purchased goods should be delivered.",
"format" : "date-time",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the purchased goods should be delivered.",
"$ref" : "#/components/schemas/Address"
},
"description" : {
"description" : "A short description visible on the payment page.\nMaximum length: 280 characters.",
"type" : "string"
},
"expiresAt" : {
"description" : "The date that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 70 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created.",
"type" : "string"
},
"installmentOptions" : {
"additionalProperties" : {
"$ref" : "#/components/schemas/InstallmentOption"
},
"description" : "A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options.",
"type" : "object"
},
"lineItems" : {
"description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.",
"items" : {
"$ref" : "#/components/schemas/LineItem"
},
"type" : "array"
},
"merchantAccount" : {
"description" : "The merchant account identifier for which the payment link is created.",
"type" : "string"
},
"merchantOrderReference" : {
"description" : "This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.",
"type" : "string"
},
"metadata" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Metadata consists of entries, each of which includes a key and a value.\nLimitations:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\"\n* Maximum 20 characters per key. When exceeding, the \"178\" error occurs: \"Metadata key size exceeds limit\"\n* A key cannot have the name `checkout.linkId`. Whatever value is present under that key is going to be replaced by the real link id",
"type" : "object"
},
"recurringProcessingModel" : {
"description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n",
"enum" : [
"CardOnFile",
"Subscription",
"UnscheduledCardOnFile"
],
"type" : "string"
},
"reference" : {
"description" : "A reference that is used to uniquely identify the payment in future communications about the payment status.",
"type" : "string"
},
"returnUrl" : {
"description" : "Website URL used for redirection after payment is completed.\nIf provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.",
"type" : "string"
},
"reusable" : {
"description" : "Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.",
"type" : "boolean"
},
"shopperEmail" : {
"description" : "The shopper's email address.",
"type" : "string"
},
"shopperLocale" : {
"description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).",
"type" : "string"
},
"shopperName" : {
"description" : "The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.",
"$ref" : "#/components/schemas/Name"
},
"shopperReference" : {
"description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.",
"type" : "string"
},
"splits" : {
"description" : "An array of objects specifying how the payment should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).",
"items" : {
"$ref" : "#/components/schemas/Split"
},
"type" : "array"
},
"store" : {
"description" : "The physical store, for which this payment is processed.",
"type" : "string"
},
"storePaymentMethod" : {
"x-addedInVersion" : 50,
"description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.",
"type" : "boolean"
}
},
"required" : [
"amount",
"reference",
"merchantAccount"
]
},
"DetailsRequest" : {
"properties" : {
"details" : {
"description" : "Use this collection to submit the details that were returned as a result of the `/payments` call.",
"$ref" : "#/components/schemas/PaymentCompletionDetails"
},
"paymentData" : {
"description" : "The `paymentData` value from the `/payments` response. Required if the `/payments` response returns this value. In v67 and later, you will always get this value from the Component.",
"maxLength" : 100000,
"type" : "string"
},
"threeDSAuthenticationOnly" : {
"x-addedInVersion" : 40,
"description" : "Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously.",
"type" : "boolean"
}
},
"required" : [
"details"
]
},
"DeviceRenderOptions" : {
"properties" : {
"sdkInterface" : {
"default" : "both",
"description" : "Supported SDK interface types.\nAllowed values:\n* native\n* html\n* both",
"enum" : [
"native",
"html",
"both"
],
"type" : "string"
},
"sdkUiType" : {
"default" : [
"<all available types>"
],
"description" : "UI types supported for displaying specific challenges.\nAllowed values:\n* text\n* singleSelect\n* outOfBand\n* otherHtml\n* multiSelect",
"items" : {
"enum" : [
"multiSelect",
"otherHtml",
"outOfBand",
"singleSelect",
"text"
],
"type" : "string"
},
"type" : "array"
}
}
},
"DokuDetails" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The shopper's first name.",
"type" : "string"
},
"lastName" : {
"description" : "The shopper's last name.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper's email.",
"type" : "string"
},
"type" : {
"description" : "**doku**",
"enum" : [
"doku_mandiri_va",
"doku_cimb_va",
"doku_danamon_va",
"doku_bni_va",
"doku_permata_lite_atm",
"doku_bri_va",
"doku_bca_va",
"doku_alfamart",
"doku_indomaret"
],
"type" : "string"
}
},
"required" : [
"type",
"firstName",
"lastName",
"shopperEmail"
],
"title" : "Doku"
},
"DotpayDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it.",
"type" : "string"
},
"type" : {
"default" : "dotpay",
"description" : "**dotpay**",
"enum" : [
"dotpay"
],
"type" : "string"
}
},
"required" : [
"issuer"
],
"title" : "Dotpay"
},
"DragonpayDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper’s email address.",
"type" : "string"
},
"type" : {
"description" : "**dragonpay**",
"enum" : [
"dragonpay_ebanking",
"dragonpay_otc_banking",
"dragonpay_otc_non_banking",
"dragonpay_otc_philippines"
],
"type" : "string"
}
},
"required" : [
"type",
"issuer"
],
"title" : "Dragonpay"
},
"EcontextVoucherDetails" : {
"additionalProperties" : false,
"properties" : {
"firstName" : {
"description" : "The shopper's first name.",
"type" : "string"
},
"lastName" : {
"description" : "The shopper's last name.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper's email.",
"type" : "string"
},
"telephoneNumber" : {
"description" : "The shopper's contact number. It must have an international number format, for example **+31 20 779 1846**. Formats like **+31 (0)20 779 1846** or **0031 20 779 1846** are not accepted.",
"type" : "string"
},
"type" : {
"description" : "**econtextvoucher**",
"enum" : [
"econtext_seveneleven",
"econtext_stores"
],
"type" : "string"
}
},
"required" : [
"type",
"firstName",
"lastName",
"shopperEmail",
"telephoneNumber"
],
"title" : "Voucher"
},
"EntercashDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The issuer id of the shopper's selected bank.",
"type" : "string"
},
"type" : {
"default" : "entercash",
"description" : "**entercash**",
"enum" : [
"entercash"
],
"type" : "string"
}
},
"required" : [
"type",
"issuer"
],
"title" : "Entercash"
},
"ExternalPlatform" : {
"properties" : {
"integrator" : {
"description" : "External platform integrator.",
"type" : "string"
},
"name" : {
"description" : "Name of the field. For example, Name of External Platform.",
"type" : "string"
},
"version" : {
"description" : "Version of the field. For example, Version of External Platform.",
"type" : "string"
}
}
},
"ForexQuote" : {
"properties" : {
"account" : {
"description" : "The account name.",
"type" : "string"
},
"accountType" : {
"description" : "The account type.",
"type" : "string"
},
"baseAmount" : {
"description" : "The base amount.",
"$ref" : "#/components/schemas/Amount"
},
"basePoints" : {
"description" : "The base points.",
"format" : "int32",
"type" : "integer"
},
"buy" : {
"description" : "The buy rate.",
"$ref" : "#/components/schemas/Amount"
},
"interbank" : {
"description" : "The interbank amount.",
"$ref" : "#/components/schemas/Amount"
},
"reference" : {
"description" : "The reference assigned to the forex quote request.",
"type" : "string"
},
"sell" : {
"description" : "The sell rate.",
"$ref" : "#/components/schemas/Amount"
},
"signature" : {
"description" : "The signature to validate the integrity.",
"type" : "string"
},
"source" : {
"description" : "The source of the forex quote.",
"type" : "string"
},
"type" : {
"description" : "The type of forex.",
"type" : "string"
},
"validTill" : {
"description" : "The date until which the forex quote is valid.",
"format" : "date-time",
"type" : "string"
}
},
"required" : [
"validTill",
"basePoints"
]
},
"FraudCheckResult" : {
"properties" : {
"accountScore" : {
"description" : "The fraud score generated by the risk check.",
"format" : "int32",
"type" : "integer"
},
"checkId" : {
"description" : "The ID of the risk check.",
"format" : "int32",
"type" : "integer"
},
"name" : {
"description" : "The name of the risk check.",
"type" : "string"
}
},
"required" : [
"checkId",
"name",
"accountScore"
]
},
"FraudResult" : {
"properties" : {
"accountScore" : {
"description" : "The total fraud score generated by the risk checks.",
"format" : "int32",
"type" : "integer"
},
"results" : {
"description" : "The result of the individual risk checks.",
"items" : {
"$ref" : "#/components/schemas/FraudCheckResult"
},
"type" : "array"
}
},
"required" : [
"accountScore"
]
},
"GenericIssuerPaymentMethodDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The issuer id of the shopper's selected bank.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"description" : "**genericissuer**",
"enum" : [
"eps"
],
"type" : "string"
}
},
"required" : [
"type",
"issuer"
],
"title" : "Stored Payment Method"
},
"GiropayDetails" : {
"additionalProperties" : false,
"properties" : {
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "giropay",
"description" : "**giropay**",
"enum" : [
"giropay"
],
"type" : "string"
}
},
"title" : "Giropay"
},
"GooglePayDetails" : {
"additionalProperties" : false,
"properties" : {
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"debit"
],
"type" : "string"
},
"googlePayToken" : {
"description" : "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "paywithgoogle",
"description" : "**paywithgoogle**",
"enum" : [
"paywithgoogle"
],
"type" : "string"
}
},
"required" : [
"googlePayToken"
],
"title" : "Google Pay"
},
"IdealDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "ideal",
"description" : "**ideal**",
"enum" : [
"ideal"
],
"type" : "string"
}
},
"required" : [
"issuer"
],
"title" : "iDEAL"
},
"InputDetail" : {
"properties" : {
"configuration" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Configuration parameters for the required input.",
"type" : "object"
},
"details" : {
"description" : "Input details can also be provided recursively.",
"items" : {
"$ref" : "#/components/schemas/SubInputDetail"
},
"type" : "array"
},
"inputDetails" : {
"deprecated" : true,
"description" : "Input details can also be provided recursively (deprecated).",
"items" : {
"$ref" : "#/components/schemas/SubInputDetail"
},
"type" : "array"
},
"itemSearchUrl" : {
"description" : "In case of a select, the URL from which to query the items.",
"type" : "string"
},
"items" : {
"description" : "In case of a select, the items to choose from.",
"items" : {
"$ref" : "#/components/schemas/Item"
},
"type" : "array"
},
"key" : {
"description" : "The value to provide in the result.",
"type" : "string"
},
"optional" : {
"description" : "True if this input value is optional.",
"type" : "boolean"
},
"type" : {
"description" : "The type of the required input.",
"type" : "string"
},
"value" : {
"description" : "The value can be pre-filled, if available.",
"type" : "string"
}
}
},
"InstallmentOption" : {
"properties" : {
"maxValue" : {
"description" : "The maximum number of installments offered for this payment method.",
"format" : "int32",
"type" : "integer"
}
}
},
"Installments" : {
"properties" : {
"value" : {
"description" : "Defines the number of installments. Its value needs to be greater than zero.\n\nUsually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.",
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"value"
]
},
"Installments2" : {
"properties" : {
"maxNumberOfInstallments" : {
"description" : "Maximum number of installments",
"format" : "int32",
"type" : "integer"
}
},
"required" : [
"maxNumberOfInstallments"
]
},
"Item" : {
"properties" : {
"id" : {
"description" : "The value to provide in the result.",
"type" : "string"
},
"name" : {
"description" : "The display name.",
"type" : "string"
}
}
},
"KlarnaDetails" : {
"additionalProperties" : false,
"properties" : {
"billingAddress" : {
"description" : "The address where to send the invoice.",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the goods should be delivered.",
"type" : "string"
},
"personalDetails" : {
"description" : "Shopper name, date of birth, phone number, and email address.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "klarna",
"description" : "**klarna**",
"enum" : [
"klarna",
"klarnapayments",
"klarnapayments_account",
"klarnapayments_b2b",
"klarna_paynow",
"klarna_account",
"klarna_b2b"
],
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "Klarna"
},
"LianLianPayDetails" : {
"additionalProperties" : false,
"properties" : {
"telephoneNumber" : {
"description" : "",
"type" : "string"
},
"type" : {
"description" : "**lianlianpay**",
"enum" : [
"lianlianpay_ebanking_enterprise",
"lianlianpay_ebanking_credit",
"lianlianpay_ebanking_debit"
],
"type" : "string"
}
},
"required" : [
"type",
"telephoneNumber"
],
"title" : "Lianlian Pay"
},
"LineItem" : {
"properties" : {
"amountExcludingTax" : {
"description" : "Item amount excluding the tax, in minor units.",
"format" : "int64",
"type" : "integer"
},
"amountIncludingTax" : {
"description" : "Item amount including the tax, in minor units.",
"format" : "int64",
"type" : "integer"
},
"description" : {
"description" : "Description of the line item.",
"type" : "string"
},
"id" : {
"description" : "ID of the line item.",
"type" : "string"
},
"imageUrl" : {
"description" : "Link to the picture of the purchased item.",
"type" : "string"
},
"productUrl" : {
"description" : "Link to the purchased item.",
"type" : "string"
},
"quantity" : {
"description" : "Number of items.",
"format" : "int64",
"type" : "integer"
},
"taxAmount" : {
"description" : "Tax amount, in minor units.",
"format" : "int64",
"type" : "integer"
},
"taxCategory" : {
"description" : "Required for AfterPay. Tax category: High, Low, None, Zero",
"enum" : [
"High",
"Low",
"None",
"Zero"
],
"type" : "string"
},
"taxPercentage" : {
"description" : "Tax percentage, in minor units.",
"format" : "int64",
"type" : "integer"
}
}
},
"Mandate" : {
"properties" : {
"amount" : {
"description" : "The billing amount of the recurring transactions.",
"type" : "string"
},
"amountRule" : {
"description" : "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n",
"enum" : [
"max",
"exact"
],
"type" : "string"
},
"billingAttemptsRule" : {
"description" : "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n",
"enum" : [
"on",
"before",
"after"
],
"type" : "string"
},
"billingDay" : {
"description" : "The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date.\n\nPossible values: 1-31 based on the `frequency`.",
"type" : "string"
},
"endsAt" : {
"description" : "End date of the billing plan, in YYYY-MM-DD format.",
"type" : "string"
},
"frequency" : {
"description" : "The frequency with which a shopper should be charged.\n\nPossible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.",
"enum" : [
"adhoc",
"daily",
"weekly",
"biWeekly",
"monthly",
"quarterly",
"halfYearly",
"yearly"
],
"type" : "string"
},
"remarks" : {
"description" : "The message shown by UPI to the shopper on the approval screen.",
"type" : "string"
},
"startsAt" : {
"description" : "Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date.",
"type" : "string"
}
},
"required" : [
"frequency",
"amount",
"endsAt"
]
},
"MasterpassDetails" : {
"additionalProperties" : false,
"properties" : {
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"debit"
],
"type" : "string"
},
"masterpassTransactionId" : {
"description" : "The Masterpass transaction ID.",
"type" : "string"
},
"type" : {
"default" : "masterpass",
"description" : "**masterpass**",
"enum" : [
"masterpass"
],
"type" : "string"
}
},
"required" : [
"masterpassTransactionId"
],
"title" : "Masterpass"
},
"MbwayDetails" : {
"additionalProperties" : false,
"properties" : {
"shopperEmail" : {
"description" : "",
"type" : "string"
},
"telephoneNumber" : {
"description" : "",
"type" : "string"
},
"type" : {
"default" : "mbway",
"description" : "**mbway**",
"enum" : [
"mbway"
],
"type" : "string"
}
},
"required" : [
"telephoneNumber",
"shopperEmail"
],
"title" : "MBWay"
},
"MerchantDevice" : {
"properties" : {
"os" : {
"description" : "Operating system running on the merchant device.",
"type" : "string"
},
"osVersion" : {
"description" : "Version of the operating system on the merchant device.",
"type" : "string"
},
"reference" : {
"description" : "Merchant device reference.",
"type" : "string"
}
}
},
"MerchantRiskIndicator" : {
"properties" : {
"addressMatch" : {
"description" : "Whether the chosen delivery address is identical to the billing address.",
"type" : "boolean"
},
"deliveryAddressIndicator" : {
"description" : "Indicator regarding the delivery address.\nAllowed values:\n* `shipToBillingAddress`\n* `shipToVerifiedAddress`\n* `shipToNewAddress`\n* `shipToStore`\n* `digitalGoods`\n* `goodsNotShipped`\n* `other`",
"enum" : [
"shipToBillingAddress",
"shipToVerifiedAddress",
"shipToNewAddress",
"shipToStore",
"digitalGoods",
"goodsNotShipped",
"other"
],
"type" : "string"
},
"deliveryEmail" : {
"description" : "The delivery email address (for digital goods).",
"type" : "string"
},
"deliveryTimeframe" : {
"description" : "The estimated delivery time for the shopper to receive the goods.\nAllowed values:\n* `electronicDelivery`\n* `sameDayShipping`\n* `overnightShipping`\n* `twoOrMoreDaysShipping`",
"enum" : [
"electronicDelivery",
"sameDayShipping",
"overnightShipping",
"twoOrMoreDaysShipping"
],
"type" : "string"
},
"giftCardAmount" : {
"description" : "For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s).",
"$ref" : "#/components/schemas/Amount"
},
"giftCardCount" : {
"description" : "For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.",
"format" : "int32",
"type" : "integer"
},
"preOrderDate" : {
"description" : "For pre-order purchases, the expected date this product will be available to the shopper.",
"format" : "date-time",
"type" : "string"
},
"preOrderPurchase" : {
"description" : "Indicator for whether this transaction is for pre-ordering a product.",
"type" : "boolean"
},
"reorderItems" : {
"description" : "Indicator for whether the shopper has already purchased the same items in the past.",
"type" : "boolean"
}
}
},
"MobilePayDetails" : {
"additionalProperties" : false,
"properties" : {
"type" : {
"default" : "mobilepay",
"description" : "**mobilepay**",
"enum" : [
"mobilepay"
],
"type" : "string"
}
},
"title" : "MobilePay"
},
"MolPayDetails" : {
"additionalProperties" : false,
"properties" : {
"issuer" : {
"description" : "The shopper's bank. Specify this with the issuer value that corresponds to this bank.",
"type" : "string"
},
"type" : {
"description" : "**molpay**",
"enum" : [
"molpay_ebanking_fpx_MY",
"molpay_ebanking_TH"
],
"type" : "string"
}
},
"required" : [
"type",
"issuer"
],
"title" : "MOLPay"
},
"Name" : {
"properties" : {
"firstName" : {
"description" : "The first name.",
"type" : "string"
},
"infix" : {
"description" : "The name's infix, if applicable.\n>A maximum length of twenty (20) characters is imposed.",
"type" : "string"
},
"lastName" : {
"description" : "The last name.",
"type" : "string"
}
},
"required" : [
"firstName",
"lastName"
]
},
"OpenInvoiceDetails" : {
"additionalProperties" : false,
"properties" : {
"billingAddress" : {
"description" : "The address where to send the invoice.",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the goods should be delivered.",
"type" : "string"
},
"personalDetails" : {
"description" : "Shopper name, date of birth, phone number, and email address.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "openinvoice",
"description" : "**openinvoice**",
"enum" : [
"openinvoice"
],
"type" : "string"
}
},
"title" : "Open Invoice"
},
"PayPalDetails" : {
"additionalProperties" : false,
"properties" : {
"orderID" : {
"description" : "The unique ID associated with the order.",
"type" : "string"
},
"payerID" : {
"description" : "The unique ID associated with the payer.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"subtype" : {
"description" : "The type of flow to initiate.",
"enum" : [
"redirect",
"sdk"
],
"type" : "string"
},
"type" : {
"default" : "paypal",
"description" : "**paypal**",
"enum" : [
"paypal"
],
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "PayPal"
},
"PayUUpiDetails" : {
"additionalProperties" : false,
"properties" : {
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"shopperNotificationReference" : {
"description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "payu_IN_upi",
"description" : "**payu_IN_upi**",
"enum" : [
"payu_IN_upi"
],
"type" : "string"
},
"virtualPaymentAddress" : {
"description" : "The virtual payment address for UPI.",
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "PayU"
},
"PaymentCompletionDetails" : {
"properties" : {
"MD" : {
"description" : "A payment session identifier returned by the card issuer.",
"maxLength" : 5000,
"type" : "string"
},
"PaReq" : {
"description" : "(3D) Payment Authentication Request data for the card issuer.",
"type" : "string"
},
"PaRes" : {
"description" : "(3D) Payment Authentication Response data by the card issuer.",
"maxLength" : 10000,
"type" : "string"
},
"billingToken" : {
"description" : "PayPal-generated token for recurring payments.",
"type" : "string"
},
"cupsecureplus.smscode" : {
"description" : "The SMS verification code collected from the shopper.",
"type" : "string"
},
"facilitatorAccessToken" : {
"description" : "PayPal-generated third party access token.",
"type" : "string"
},
"oneTimePasscode" : {
"description" : "A random number sent to the mobile phone number of the shopper to verify the payment.",
"type" : "string"
},
"orderID" : {
"description" : "PayPal-assigned ID for the order.",
"type" : "string"
},
"payerID" : {
"description" : "PayPal-assigned ID for the payer (shopper).",
"type" : "string"
},
"payload" : {
"description" : "Payload appended to the `returnURL` as a result of the redirect.",
"maxLength" : 10000,
"type" : "string"
},
"paymentID" : {
"description" : "PayPal-generated ID for the payment.",
"type" : "string"
},
"paymentStatus" : {
"description" : "Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`.",
"type" : "string"
},
"redirectResult" : {
"description" : "The result of the redirect as appended to the `returnURL`.",
"maxLength" : 5000,
"type" : "string"
},
"threeDSResult" : {
"description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.",
"maxLength" : 10000,
"type" : "string"
},
"threeds2.challengeResult" : {
"description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`.",
"maxLength" : 50000,
"type" : "string"
},
"threeds2.fingerprint" : {
"description" : "Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`.",
"maxLength" : 100000,
"type" : "string"
}
}
},
"PaymentDetails" : {
"additionalProperties" : false,
"properties" : {
"type" : {
"description" : "The payment method type.",
"enum" : [
"alipay",
"multibanco",
"bankTransfer_IBAN",
"paybright",
"affirm",
"oney",
"facilypay",
"facilypay_3x",
"facilypay_4x",
"facilypay_6x",
"facilypay_10x",
"facilypay_12x",
"unionpay",
"kcp_banktransfer",
"kcp_payco",
"kcp_creditcard",
"wechatpaySDK",
"wechatpayQR",
"wechatpayWeb",
"payu_IN_cashcard",
"payu_IN_nb",
"molpay_ebanking_VN",
"openbanking_UK",
"ebanking_FI",
"molpay_ebanking_MY",
"molpay_ebanking_direct_MY",
"swish",
"twint",
"pix",
"molpay_fpx",
"konbini",
"directEbanking",
"boletobancario",
"neteller",
"dana",
"paysafecard",
"cashticket",
"isracard",
"ikano",
"karenmillen",
"oasis",
"warehouse"
],
"type" : "string"
}
},
"title" : "Payment Details"
},
"PaymentDetailsResponse" : {
"properties" : {
"action" : {
"x-addedInVersion" : 49,
"description" : "Action to be taken for completing the payment. When returned, only the 3D Secure action is needed in most cases.",
"oneOf" : [
{
"$ref" : "#/components/schemas/CheckoutRedirectAction"
}
]
},
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataDeliveryAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.",
"type" : "object"
},
"authentication" : {
"x-addedInVersion" : 40,
"additionalProperties" : {
"type" : "string"
},
"description" : "Contains `threeds2.fingerprint` or `threeds2.challengeToken` values to be used in further calls to `/payments/details` endpoint. ",
"type" : "object"
},
"details" : {
"description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.",
"items" : {
"$ref" : "#/components/schemas/InputDetail"
},
"type" : "array"
},
"fraudResult" : {
"description" : "The fraud result properties of the payment.",
"$ref" : "#/components/schemas/FraudResult"
},
"merchantReference" : {
"x-addedInVersion" : 49,
"description" : "The reference used during the /payments request.",
"type" : "string"
},
"order" : {
"description" : "Contains updated information regarding the order in case order information was provided in the request.",
"$ref" : "#/components/schemas/CheckoutOrderResponse"
},
"outputDetails" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Contains the details that will be presented to the shopper.",
"type" : "object"
},
"paymentData" : {
"description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.",
"type" : "string"
},
"paymentMethod" : {
"description" : "The payment method used in the transaction.",
"type" : "string"
},
"pspReference" : {
"description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
},
"redirect" : {
"description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.",
"$ref" : "#/components/schemas/Redirect"
},
"refusalReason" : {
"description" : "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"refusalReasonCode" : {
"x-addedInVersion" : 37,
"description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"resultCode" : {
"description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – 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** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.",
"enum" : [
"AuthenticationFinished",
"Authorised",
"Cancelled",
"ChallengeShopper",
"Error",
"IdentifyShopper",
"Pending",
"PresentToShopper",
"Received",
"RedirectShopper",
"Refused",
"Success"
],
"type" : "string"
},
"shopperLocale" : {
"description" : "The shopperLocale.",
"type" : "string"
},
"threeDS2Result" : {
"x-addedInVersion" : 41,
"description" : "Result of the 3D Secure 2 authentication.",
"$ref" : "#/components/schemas/ThreeDS2Result"
}
}
},
"PaymentLinkResource" : {
"properties" : {
"allowedPaymentMethods" : {
"description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"amount" : {
"description" : "The payment amount and currency.",
"$ref" : "#/components/schemas/Amount"
},
"applicationInfo" : {
"description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
"$ref" : "#/components/schemas/ApplicationInfo"
},
"billingAddress" : {
"description" : "The address where to send the invoice.",
"$ref" : "#/components/schemas/Address"
},
"blockedPaymentMethods" : {
"description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"countryCode" : {
"description" : "The shopper's two-letter country code.",
"type" : "string"
},
"deliverAt" : {
"description" : "The date and time the purchased goods should be delivered. In ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`.",
"format" : "date-time",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the purchased goods should be delivered.",
"$ref" : "#/components/schemas/Address"
},
"description" : {
"description" : "A short description visible on the payment page.\nMaximum length: 280 characters.",
"type" : "string"
},
"expiresAt" : {
"description" : "The date that the payment link expires, in ISO 8601 format. For example `2019-11-23T12:25:28Z`, or `2020-05-27T20:25:28+08:00`. Maximum expiry date should be 70 days from when the payment link is created. If not provided, the default expiry is set to 24 hours after the payment link is created.",
"type" : "string"
},
"id" : {
"x-addedInVersion" : 51,
"description" : "A unique identifier of the payment link.",
"readOnly" : true,
"type" : "string"
},
"lineItems" : {
"description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\nThis parameter is required for open invoice (_buy now, pay later_) payment methods such AfterPay, Klarna, RatePay, and Zip.",
"items" : {
"$ref" : "#/components/schemas/LineItem"
},
"type" : "array"
},
"merchantAccount" : {
"description" : "The merchant account identifier for which the payment link is created.",
"type" : "string"
},
"merchantOrderReference" : {
"description" : "This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle.",
"type" : "string"
},
"recurringProcessingModel" : {
"description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n",
"enum" : [
"CardOnFile",
"Subscription",
"UnscheduledCardOnFile"
],
"type" : "string"
},
"reference" : {
"description" : "A reference that is used to uniquely identify the payment in future communications about the payment status.",
"type" : "string"
},
"returnUrl" : {
"description" : "Website URL used for redirection after payment is completed.\nIf provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL.",
"type" : "string"
},
"reusable" : {
"description" : "Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only.",
"type" : "boolean"
},
"shopperEmail" : {
"description" : "The shopper's email address.",
"type" : "string"
},
"shopperLocale" : {
"description" : "The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`.\n\nFor a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/online-payments/pay-by-link#language-and-localization).",
"type" : "string"
},
"shopperName" : {
"description" : "The shopper's full name. This object is required for some payment methods such as AfterPay, Klarna, or if you're enrolled in the PayPal Seller Protection program.",
"$ref" : "#/components/schemas/Name"
},
"shopperReference" : {
"description" : "A unique identifier for the shopper (for example, user ID or account ID).",
"type" : "string"
},
"splits" : {
"description" : "An array of objects specifying how the payment should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).",
"items" : {
"$ref" : "#/components/schemas/Split"
},
"type" : "array"
},
"status" : {
"description" : "Status of the payment link. Possible values:\n* **active** \n* **expired**\n* **completed** (v66 and above) \n* **paid** (v65 and below)",
"enum" : [
"active",
"completed",
"expired",
"paymentPending"
],
"type" : "string"
},
"store" : {
"description" : "The physical store, for which this payment is processed.",
"type" : "string"
},
"storePaymentMethod" : {
"x-addedInVersion" : 50,
"description" : "When this is set to **true** and the `shopperReference` is provided, the payment details will be stored.",
"type" : "boolean"
},
"url" : {
"description" : "The URL at which the shopper can complete the payment.",
"readOnly" : true,
"type" : "string"
}
},
"required" : [
"amount",
"reference",
"merchantAccount",
"id",
"url",
"status"
]
},
"PaymentMethod" : {
"properties" : {
"brands" : {
"x-addedInVersion" : 49,
"description" : "List of possible brands. For example: visa, mc.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"configuration" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "The configuration of the payment method.",
"type" : "object"
},
"details" : {
"description" : "All input details to be provided to complete the payment with this payment method.",
"items" : {
"$ref" : "#/components/schemas/InputDetail"
},
"type" : "array"
},
"group" : {
"description" : "The group where this payment method belongs to.",
"$ref" : "#/components/schemas/PaymentMethodGroup"
},
"inputDetails" : {
"deprecated" : true,
"description" : "All input details to be provided to complete the payment with this payment method.",
"items" : {
"$ref" : "#/components/schemas/InputDetail"
},
"type" : "array"
},
"name" : {
"description" : "The displayable name of this payment method.",
"type" : "string"
},
"supportsRecurring" : {
"description" : "Indicates whether this payment method supports tokenization or not.",
"type" : "boolean"
},
"type" : {
"description" : "The unique payment method code.",
"type" : "string"
}
}
},
"PaymentMethodGroup" : {
"properties" : {
"name" : {
"description" : "The name of the group.",
"type" : "string"
},
"paymentMethodData" : {
"description" : "Echo data to be used if the payment method is displayed as part of this group.",
"type" : "string"
},
"type" : {
"description" : "The unique code of the group.",
"type" : "string"
}
}
},
"PaymentMethodsGroup" : {
"properties" : {
"groupType" : {
"description" : "The type to submit for any payment method in this group.",
"type" : "string"
},
"name" : {
"description" : "The human-readable name of this group.",
"type" : "string"
},
"types" : {
"description" : "The types of payment methods that belong in this group.",
"items" : {
"type" : "string"
},
"type" : "array"
}
}
},
"PaymentMethodsRequest" : {
"properties" : {
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/AdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/AdditionalDataAirline"
},
{
"$ref" : "#/components/schemas/AdditionalDataCarRental"
},
{
"$ref" : "#/components/schemas/AdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/AdditionalDataLevel23"
},
{
"$ref" : "#/components/schemas/AdditionalDataLodging"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
{
"$ref" : "#/components/schemas/AdditionalDataRetry"
},
{
"$ref" : "#/components/schemas/AdditionalDataRisk"
},
{
"$ref" : "#/components/schemas/AdditionalDataRiskStandalone"
},
{
"$ref" : "#/components/schemas/AdditionalDataSubMerchant"
},
{
"$ref" : "#/components/schemas/AdditionalDataTemporaryServices"
},
{
"$ref" : "#/components/schemas/AdditionalDataWallets"
}
],
"description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.",
"type" : "object"
},
"allowedPaymentMethods" : {
"x-addedInVersion" : 33,
"description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"amount" : {
"description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).",
"$ref" : "#/components/schemas/Amount"
},
"blockedPaymentMethods" : {
"x-addedInVersion" : 33,
"description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type` from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"channel" : {
"description" : "The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values:\n* iOS\n* Android\n* Web",
"enum" : [
"iOS",
"Android",
"Web"
],
"type" : "string"
},
"countryCode" : {
"description" : "The shopper's country code.",
"type" : "string"
},
"enableRealTimeUpdate" : {
"x-addedInVersion" : 51,
"deprecated" : true,
"description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.",
"type" : "boolean"
},
"merchantAccount" : {
"description" : "The merchant account identifier, with which you want to process the transaction.",
"type" : "string"
},
"shopperLocale" : {
"x-addedInVersion" : 7,
"description" : "The combination of a language code and a country code to specify the language to be used in the payment.",
"type" : "string"
},
"shopperReference" : {
"description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.",
"type" : "string"
},
"store" : {
"x-addedInVersion" : 23,
"description" : "The physical store, for which this payment is processed.",
"maxLength" : 16,
"minLength" : 1,
"type" : "string"
}
},
"required" : [
"merchantAccount"
]
},
"PaymentMethodsResponse" : {
"properties" : {
"groups" : {
"description" : "Groups of payment methods.",
"items" : {
"$ref" : "#/components/schemas/PaymentMethodsGroup"
},
"type" : "array"
},
"oneClickPaymentMethods" : {
"description" : "Detailed list of one-click payment methods.",
"items" : {
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : "array"
},
"paymentMethods" : {
"description" : "Detailed list of payment methods required to generate payment forms.",
"items" : {
"$ref" : "#/components/schemas/PaymentMethod"
},
"type" : "array"
},
"storedPaymentMethods" : {
"x-addedInVersion" : 49,
"description" : "List of all stored payment methods.",
"items" : {
"$ref" : "#/components/schemas/StoredPaymentMethod"
},
"type" : "array"
}
}
},
"PaymentRequest" : {
"properties" : {
"accountInfo" : {
"x-addedInVersion" : 40,
"description" : "Shopper account information for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.",
"$ref" : "#/components/schemas/AccountInfo"
},
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/AdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/AdditionalDataAirline"
},
{
"$ref" : "#/components/schemas/AdditionalDataCarRental"
},
{
"$ref" : "#/components/schemas/AdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/AdditionalDataLevel23"
},
{
"$ref" : "#/components/schemas/AdditionalDataLodging"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
{
"$ref" : "#/components/schemas/AdditionalDataRetry"
},
{
"$ref" : "#/components/schemas/AdditionalDataRisk"
},
{
"$ref" : "#/components/schemas/AdditionalDataRiskStandalone"
},
{
"$ref" : "#/components/schemas/AdditionalDataSubMerchant"
},
{
"$ref" : "#/components/schemas/AdditionalDataTemporaryServices"
},
{
"$ref" : "#/components/schemas/AdditionalDataWallets"
}
],
"description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.",
"type" : "object"
},
"amount" : {
"description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).",
"$ref" : "#/components/schemas/Amount"
},
"applicationInfo" : {
"x-addedInVersion" : 40,
"description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
"$ref" : "#/components/schemas/ApplicationInfo"
},
"billingAddress" : {
"x-addedInVersion" : 4,
"description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.",
"$ref" : "#/components/schemas/Address"
},
"browserInfo" : {
"description" : "The shopper's browser information.\n> For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the `userAgent` and `acceptHeader` fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 1.",
"$ref" : "#/components/schemas/BrowserInfo"
},
"captureDelayHours" : {
"x-addedInVersion" : 2,
"description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.",
"format" : "int32",
"type" : "integer"
},
"channel" : {
"description" : "The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`.\n\nPossible values:\n* iOS\n* Android\n* Web",
"enum" : [
"iOS",
"Android",
"Web"
],
"type" : "string"
},
"company" : {
"x-addedInVersion" : 32,
"description" : "Information regarding the company.",
"$ref" : "#/components/schemas/Company"
},
"conversionId" : {
"x-addedInVersion" : 49,
"description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.",
"type" : "string"
},
"countryCode" : {
"description" : "The shopper country.\n\nFormat: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\nExample: NL or DE",
"type" : "string"
},
"dateOfBirth" : {
"x-addedInVersion" : 7,
"description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD",
"format" : "date-time",
"type" : "string"
},
"dccQuote" : {
"description" : "The forex quote as returned in the response of the forex service.",
"$ref" : "#/components/schemas/ForexQuote"
},
"deliveryAddress" : {
"description" : "The address where the purchased goods should be delivered.",
"$ref" : "#/components/schemas/Address"
},
"deliveryDate" : {
"x-addedInVersion" : 8,
"description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00",
"format" : "date-time",
"type" : "string"
},
"deviceFingerprint" : {
"x-addedInVersion" : 2,
"description" : "A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).",
"maxLength" : 5000,
"type" : "string"
},
"enableOneClick" : {
"x-addedInVersion" : 32,
"description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.",
"type" : "boolean"
},
"enablePayOut" : {
"x-addedInVersion" : 32,
"description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.",
"type" : "boolean"
},
"enableRealTimeUpdate" : {
"x-addedInVersion" : 51,
"deprecated" : true,
"description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.",
"type" : "boolean"
},
"enableRecurring" : {
"x-addedInVersion" : 32,
"description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.",
"type" : "boolean"
},
"entityType" : {
"x-addedInVersion" : 24,
"description" : "The type of the entity the payment is processed for.",
"enum" : [
"NaturalPerson",
"CompanyName"
],
"type" : "string"
},
"fraudOffset" : {
"description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.",
"format" : "int32",
"type" : "integer"
},
"installments" : {
"x-addedInVersion" : 4,
"description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).",
"$ref" : "#/components/schemas/Installments"
},
"lineItems" : {
"x-addedInVersion" : 32,
"description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.",
"items" : {
"$ref" : "#/components/schemas/LineItem"
},
"type" : "array"
},
"mandate" : {
"description" : "The mandate details to initiate recurring transaction.",
"$ref" : "#/components/schemas/Mandate"
},
"mcc" : {
"x-addedInVersion" : 12,
"description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account identifier, with which you want to process the transaction.",
"type" : "string"
},
"merchantOrderReference" : {
"x-addedInVersion" : 9,
"description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.",
"type" : "string"
},
"merchantRiskIndicator" : {
"x-addedInVersion" : 40,
"description" : "Additional risk fields for 3D Secure 2.\n> For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.",
"$ref" : "#/components/schemas/MerchantRiskIndicator"
},
"metadata" : {
"x-addedInVersion" : 17,
"additionalProperties" : {
"type" : "string"
},
"description" : "Metadata consists of entries, each of which includes a key and a value.\nLimits:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\".\n* Maximum 20 characters per key.\n* Maximum 80 characters per value. ",
"type" : "object"
},
"mpiData" : {
"description" : "Authentication data produced by an MPI (Mastercard SecureCode or Visa Secure).",
"$ref" : "#/components/schemas/ThreeDSecureData"
},
"order" : {
"description" : "Contains the order information which is required for partial payments.",
"$ref" : "#/components/schemas/CheckoutOrder"
},
"orderReference" : {
"description" : "When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.",
"type" : "string"
},
"origin" : {
"x-addedInVersion" : 40,
"description" : "Required for the 3D Secure 2 `channel` **Web** integration.\n\nSet this parameter to the origin URL of the page that you are loading the 3D Secure Component from.",
"maxLength" : 8000,
"type" : "string"
},
"paymentMethod" : {
"description" : "The type and required details of a payment method to use.",
"oneOf" : [
{
"$ref" : "#/components/schemas/AchDetails"
},
{
"$ref" : "#/components/schemas/AfterpayDetails"
},
{
"$ref" : "#/components/schemas/AmazonPayDetails"
},
{
"$ref" : "#/components/schemas/AndroidPayDetails"
},
{
"$ref" : "#/components/schemas/ApplePayDetails"
},
{
"$ref" : "#/components/schemas/BacsDirectDebitDetails"
},
{
"$ref" : "#/components/schemas/BillDeskDetails"
},
{
"$ref" : "#/components/schemas/BlikDetails"
},
{
"$ref" : "#/components/schemas/CardDetails"
},
{
"$ref" : "#/components/schemas/CellulantDetails"
},
{
"$ref" : "#/components/schemas/DokuDetails"
},
{
"$ref" : "#/components/schemas/DotpayDetails"
},
{
"$ref" : "#/components/schemas/DragonpayDetails"
},
{
"$ref" : "#/components/schemas/EcontextVoucherDetails"
},
{
"$ref" : "#/components/schemas/EntercashDetails"
},
{
"$ref" : "#/components/schemas/GenericIssuerPaymentMethodDetails"
},
{
"$ref" : "#/components/schemas/GiropayDetails"
},
{
"$ref" : "#/components/schemas/GooglePayDetails"
},
{
"$ref" : "#/components/schemas/IdealDetails"
},
{
"$ref" : "#/components/schemas/KlarnaDetails"
},
{
"$ref" : "#/components/schemas/LianLianPayDetails"
},
{
"$ref" : "#/components/schemas/MasterpassDetails"
},
{
"$ref" : "#/components/schemas/MbwayDetails"
},
{
"$ref" : "#/components/schemas/MobilePayDetails"
},
{
"$ref" : "#/components/schemas/MolPayDetails"
},
{
"$ref" : "#/components/schemas/OpenInvoiceDetails"
},
{
"$ref" : "#/components/schemas/PayPalDetails"
},
{
"$ref" : "#/components/schemas/PayUUpiDetails"
},
{
"$ref" : "#/components/schemas/PaymentDetails"
},
{
"$ref" : "#/components/schemas/QiwiWalletDetails"
},
{
"$ref" : "#/components/schemas/RatepayDetails"
},
{
"$ref" : "#/components/schemas/SamsungPayDetails"
},
{
"$ref" : "#/components/schemas/SepaDirectDebitDetails"
},
{
"$ref" : "#/components/schemas/StoredPaymentMethodDetails"
},
{
"$ref" : "#/components/schemas/UpiDetails"
},
{
"$ref" : "#/components/schemas/VippsDetails"
},
{
"$ref" : "#/components/schemas/VisaCheckoutDetails"
},
{
"$ref" : "#/components/schemas/WeChatPayDetails"
},
{
"$ref" : "#/components/schemas/WeChatPayMiniProgramDetails"
},
{
"$ref" : "#/components/schemas/ZipDetails"
}
]
},
"recurringExpiry" : {
"description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.",
"type" : "string"
},
"recurringFrequency" : {
"description" : "Minimum number of days between authorisations. Only for 3D Secure 2.",
"type" : "string"
},
"recurringProcessingModel" : {
"x-addedInVersion" : 30,
"description" : "Defines a recurring payment type.\nAllowed values:\n* `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule.\n* `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction.\n* `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount.\n",
"enum" : [
"CardOnFile",
"Subscription",
"UnscheduledCardOnFile"
],
"type" : "string"
},
"redirectFromIssuerMethod" : {
"x-addedInVersion" : 32,
"description" : "Specifies the redirect method (GET or POST) when redirecting back from the issuer.",
"type" : "string"
},
"redirectToIssuerMethod" : {
"x-addedInVersion" : 32,
"description" : "Specifies the redirect method (GET or POST) when redirecting to the issuer.",
"type" : "string"
},
"reference" : {
"description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
"type" : "string"
},
"returnUrl" : {
"description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`",
"maxLength" : 8000,
"type" : "string"
},
"riskData" : {
"description" : "Contains risk data, such as client-side data, used to identify risk for a transaction.",
"$ref" : "#/components/schemas/RiskData"
},
"sessionValidity" : {
"description" : "The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.\n\nFor example: 2020-07-18T15:42:40.428+01:00",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.",
"type" : "string"
},
"shopperIP" : {
"description" : "The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).\n> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.\nThis field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).",
"type" : "string"
},
"shopperInteraction" : {
"description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `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.\n* `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).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
"enum" : [
"Ecommerce",
"ContAuth",
"Moto",
"POS"
],
"type" : "string"
},
"shopperLocale" : {
"x-addedInVersion" : 7,
"description" : "The combination of a language code and a country code to specify the language to be used in the payment.",
"type" : "string"
},
"shopperName" : {
"x-addedInVersion" : 7,
"description" : "The shopper's full name.",
"$ref" : "#/components/schemas/Name"
},
"shopperReference" : {
"description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.",
"type" : "string"
},
"shopperStatement" : {
"description" : "The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n We recommend sending a maximum of 25 characters, otherwise banks might truncate the string.",
"type" : "string"
},
"socialSecurityNumber" : {
"x-addedInVersion" : 4,
"description" : "The shopper's social security number.",
"type" : "string"
},
"splits" : {
"x-addedInVersion" : 37,
"description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).",
"items" : {
"$ref" : "#/components/schemas/Split"
},
"type" : "array"
},
"store" : {
"x-addedInVersion" : 23,
"description" : "The physical store, for which this payment is processed.",
"maxLength" : 16,
"minLength" : 1,
"type" : "string"
},
"storePaymentMethod" : {
"x-addedInVersion" : 49,
"description" : "When true and `shopperReference` is provided, the payment details will be stored.",
"type" : "boolean"
},
"telephoneNumber" : {
"x-addedInVersion" : 7,
"description" : "The shopper's telephone number.",
"type" : "string"
},
"threeDS2RequestData" : {
"x-addedInVersion" : 40,
"description" : "Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to [Online payments](https://docs.adyen.com/online-payments) or [Classic integration](https://docs.adyen.com/classic-integration) documentation.",
"$ref" : "#/components/schemas/ThreeDS2RequestData"
},
"threeDSAuthenticationOnly" : {
"x-addedInVersion" : 50,
"default" : false,
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},
"trustedShopper" : {
"x-addedInVersion" : 37,
"description" : "Set to true if the payment should be routed to a trusted MID.",
"type" : "boolean"
}
},
"required" : [
"merchantAccount",
"reference",
"amount",
"returnUrl",
"paymentMethod"
]
},
"PaymentResponse" : {
"properties" : {
"action" : {
"x-addedInVersion" : 49,
"description" : "Action to be taken for completing the payment.",
"oneOf" : [
{
"$ref" : "#/components/schemas/CheckoutAwaitAction"
},
{
"$ref" : "#/components/schemas/CheckoutBankTransferAction"
},
{
"$ref" : "#/components/schemas/CheckoutDonationAction"
},
{
"$ref" : "#/components/schemas/CheckoutOneTimePasscodeAction"
},
{
"$ref" : "#/components/schemas/CheckoutQrCodeAction"
},
{
"$ref" : "#/components/schemas/CheckoutRedirectAction"
},
{
"$ref" : "#/components/schemas/CheckoutSDKAction"
},
{
"$ref" : "#/components/schemas/CheckoutThreeDS2ChallengeAction"
},
{
"$ref" : "#/components/schemas/CheckoutThreeDS2FingerPrintAction"
},
{
"$ref" : "#/components/schemas/CheckoutVoucherAction"
}
]
},
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataDeliveryAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.",
"type" : "object"
},
"authentication" : {
"x-addedInVersion" : 40,
"additionalProperties" : {
"type" : "string"
},
"description" : "Contains `threeds2.fingerprint` or `threeds2.challengeToken` values to be used in further calls to `/payments/details` endpoint. ",
"type" : "object"
},
"details" : {
"description" : "When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint.",
"items" : {
"$ref" : "#/components/schemas/InputDetail"
},
"type" : "array"
},
"fraudResult" : {
"description" : "The fraud result properties of the payment.",
"$ref" : "#/components/schemas/FraudResult"
},
"merchantReference" : {
"x-addedInVersion" : 49,
"description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
"type" : "string"
},
"order" : {
"description" : "Contains updated information regarding the order in case order information was provided in the request.",
"$ref" : "#/components/schemas/CheckoutOrderResponse"
},
"outputDetails" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Contains the details that will be presented to the shopper.",
"type" : "object"
},
"paymentData" : {
"description" : "When non-empty, contains a value that you must submit to the `/payments/details` endpoint.",
"type" : "string"
},
"pspReference" : {
"description" : "Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.\n\n> For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response.",
"type" : "string"
},
"redirect" : {
"description" : "When the payment flow requires a redirect, this object contains information about the redirect URL.",
"$ref" : "#/components/schemas/Redirect"
},
"refusalReason" : {
"description" : "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"refusalReasonCode" : {
"x-addedInVersion" : 37,
"description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"resultCode" : {
"description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – 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** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.",
"enum" : [
"AuthenticationFinished",
"Authorised",
"Cancelled",
"ChallengeShopper",
"Error",
"IdentifyShopper",
"Pending",
"PresentToShopper",
"Received",
"RedirectShopper",
"Refused",
"Success"
],
"type" : "string"
},
"threeDS2Result" : {
"x-addedInVersion" : 41,
"description" : "Result of the 3D Secure 2 authentication.",
"$ref" : "#/components/schemas/ThreeDS2Result"
}
}
},
"PaymentSetupRequest" : {
"properties" : {
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/AdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/AdditionalDataAirline"
},
{
"$ref" : "#/components/schemas/AdditionalDataCarRental"
},
{
"$ref" : "#/components/schemas/AdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/AdditionalDataLevel23"
},
{
"$ref" : "#/components/schemas/AdditionalDataLodging"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpenInvoice"
},
{
"$ref" : "#/components/schemas/AdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/AdditionalDataRatepay"
},
{
"$ref" : "#/components/schemas/AdditionalDataRetry"
},
{
"$ref" : "#/components/schemas/AdditionalDataRisk"
},
{
"$ref" : "#/components/schemas/AdditionalDataRiskStandalone"
},
{
"$ref" : "#/components/schemas/AdditionalDataSubMerchant"
},
{
"$ref" : "#/components/schemas/AdditionalDataTemporaryServices"
},
{
"$ref" : "#/components/schemas/AdditionalDataWallets"
}
],
"description" : "This field contains additional data, which may be required for a particular payment request.\n\nThe `additionalData` object consists of entries, each of which includes the key and value.",
"type" : "object"
},
"allowedPaymentMethods" : {
"x-addedInVersion" : 33,
"description" : "List of payment methods to be presented to the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"amount" : {
"description" : "The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero).",
"$ref" : "#/components/schemas/Amount"
},
"applicationInfo" : {
"x-addedInVersion" : 40,
"description" : "Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions).",
"$ref" : "#/components/schemas/ApplicationInfo"
},
"billingAddress" : {
"x-addedInVersion" : 4,
"description" : "The address where to send the invoice.\n> For 3D Secure 2 transactions, schemes require `billingAddress` for all browser-based and mobile implementations. Include all of the fields within this object.",
"$ref" : "#/components/schemas/Address"
},
"blockedPaymentMethods" : {
"x-addedInVersion" : 33,
"description" : "List of payment methods to be hidden from the shopper. To refer to payment methods, use their `paymentMethod.type`from [Payment methods overview](https://docs.adyen.com/payment-methods).\n\nExample: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`",
"items" : {
"type" : "string"
},
"type" : "array"
},
"captureDelayHours" : {
"x-addedInVersion" : 2,
"description" : "The delay between the authorisation and scheduled auto-capture, specified in hours.",
"format" : "int32",
"type" : "integer"
},
"channel" : {
"description" : "The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`.\n\nPossible values:\n* iOS\n* Android\n* Web",
"enum" : [
"iOS",
"Android",
"Web"
],
"type" : "string"
},
"company" : {
"x-addedInVersion" : 32,
"description" : "Information regarding the company.",
"$ref" : "#/components/schemas/Company"
},
"configuration" : {
"description" : "Specify configurations to enable additional features.",
"$ref" : "#/components/schemas/Configuration"
},
"conversionId" : {
"x-addedInVersion" : 49,
"description" : "Conversion ID that corresponds to the Id generated for tracking user payment journey.",
"type" : "string"
},
"countryCode" : {
"description" : "The shopper country.\n\nFormat: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\nExample: NL or DE",
"type" : "string"
},
"dateOfBirth" : {
"x-addedInVersion" : 7,
"description" : "The shopper's date of birth.\n\nFormat [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD",
"format" : "date-time",
"type" : "string"
},
"dccQuote" : {
"description" : "The forex quote as returned in the response of the forex service.",
"$ref" : "#/components/schemas/ForexQuote"
},
"deliveryAddress" : {
"description" : "The address where the purchased goods should be delivered.",
"$ref" : "#/components/schemas/Address"
},
"deliveryDate" : {
"x-addedInVersion" : 8,
"description" : "The date and time the purchased goods should be delivered.\n\nFormat [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD\n\nExample: 2017-07-17T13:42:40.428+01:00",
"format" : "date-time",
"type" : "string"
},
"enableOneClick" : {
"x-addedInVersion" : 32,
"description" : "When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.",
"type" : "boolean"
},
"enablePayOut" : {
"x-addedInVersion" : 32,
"description" : "When true and `shopperReference` is provided, the payment details will be tokenized for payouts.",
"type" : "boolean"
},
"enableRealTimeUpdate" : {
"x-addedInVersion" : 51,
"deprecated" : true,
"description" : "Choose if a specific transaction should use the Real-time Account Updater, regardless of other settings.",
"type" : "boolean"
},
"enableRecurring" : {
"x-addedInVersion" : 32,
"description" : "When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.",
"type" : "boolean"
},
"entityType" : {
"x-addedInVersion" : 24,
"description" : "The type of the entity the payment is processed for.",
"enum" : [
"NaturalPerson",
"CompanyName"
],
"type" : "string"
},
"fraudOffset" : {
"description" : "An integer value that is added to the normal fraud score. The value can be either positive or negative.",
"format" : "int32",
"type" : "integer"
},
"installments" : {
"x-addedInVersion" : 4,
"description" : "Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments).",
"$ref" : "#/components/schemas/Installments"
},
"lineItems" : {
"x-addedInVersion" : 32,
"description" : "Price and product information about the purchased items, to be included on the invoice sent to the shopper.\n> This field is required for 3x 4x Oney, Affirm, AfterPay, Klarna, RatePay, and Zip.",
"items" : {
"$ref" : "#/components/schemas/LineItem"
},
"type" : "array"
},
"mandate" : {
"description" : "The mandate details to initiate recurring transaction.",
"$ref" : "#/components/schemas/Mandate"
},
"mcc" : {
"x-addedInVersion" : 12,
"description" : "The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant.",
"type" : "string"
},
"merchantAccount" : {
"description" : "The merchant account identifier, with which you want to process the transaction.",
"type" : "string"
},
"merchantOrderReference" : {
"x-addedInVersion" : 9,
"description" : "This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle.\nThe same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations.\n> We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.",
"type" : "string"
},
"metadata" : {
"x-addedInVersion" : 17,
"additionalProperties" : {
"type" : "string"
},
"description" : "Metadata consists of entries, each of which includes a key and a value.\nLimits:\n* Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\".\n* Maximum 20 characters per key.\n* Maximum 80 characters per value. ",
"type" : "object"
},
"orderReference" : {
"description" : "When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead.",
"type" : "string"
},
"origin" : {
"description" : "Required for the Web integration.\n\nSet this parameter to the origin URL of the page that you are loading the SDK from.",
"type" : "string"
},
"recurringExpiry" : {
"description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.",
"type" : "string"
},
"recurringFrequency" : {
"description" : "Minimum number of days between authorisations. Only for 3D Secure 2.",
"type" : "string"
},
"reference" : {
"description" : "The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement.\nIf you need to provide multiple references for a transaction, separate them with hyphens (\"-\").\nMaximum length: 80 characters.",
"type" : "string"
},
"returnUrl" : {
"description" : "The URL to return to in case of a redirection.\nThe format depends on the channel. This URL can have a maximum of 1024 characters.\n* For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number.\nExample: `https://your-company.com/checkout?shopperOrder=12xy`\n* For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app).\nExample: `my-app://`\n* For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters).\nExample: `my-app://your.package.name`",
"maxLength" : 8000,
"type" : "string"
},
"riskData" : {
"description" : "Contains risk data, such as client-side data, used to identify risk for a transaction.",
"$ref" : "#/components/schemas/RiskData"
},
"sdkVersion" : {
"x-addedInVersion" : 32,
"description" : "The version of the SDK you are using (for Web SDK integrations only).",
"type" : "string"
},
"sessionValidity" : {
"description" : "The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.\n\nFor example: 2020-07-18T15:42:40.428+01:00",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks.\n> For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.",
"type" : "string"
},
"shopperIP" : {
"description" : "The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks).\n> For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations.\nThis field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://support.adyen.com/hc/en-us/requests/new).",
"type" : "string"
},
"shopperInteraction" : {
"description" : "Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.\nFor the web service API, Adyen assumes Ecommerce shopper interaction by default.\n\nThis field has the following possible values:\n* `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.\n* `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).\n* `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone.\n* `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.",
"enum" : [
"Ecommerce",
"ContAuth",
"Moto",
"POS"
],
"type" : "string"
},
"shopperLocale" : {
"x-addedInVersion" : 7,
"description" : "The combination of a language code and a country code to specify the language to be used in the payment.",
"type" : "string"
},
"shopperName" : {
"x-addedInVersion" : 7,
"description" : "The shopper's full name.",
"$ref" : "#/components/schemas/Name"
},
"shopperReference" : {
"description" : "Your reference to uniquely identify this shopper (for example, user ID or account ID). Minimum length: 3 characters.\n> This field is required for recurring payments.",
"type" : "string"
},
"shopperStatement" : {
"description" : "The text to be shown on the shopper's bank statement. To enable this field, contact our [Support Team](https://support.adyen.com/hc/en-us/requests/new).\n We recommend sending a maximum of 25 characters, otherwise banks might truncate the string.",
"type" : "string"
},
"socialSecurityNumber" : {
"x-addedInVersion" : 4,
"description" : "The shopper's social security number.",
"type" : "string"
},
"splits" : {
"x-addedInVersion" : 37,
"description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).",
"items" : {
"$ref" : "#/components/schemas/Split"
},
"type" : "array"
},
"store" : {
"x-addedInVersion" : 23,
"description" : "The physical store, for which this payment is processed.",
"maxLength" : 16,
"minLength" : 1,
"type" : "string"
},
"storePaymentMethod" : {
"x-addedInVersion" : 49,
"description" : "When true and `shopperReference` is provided, the payment details will be stored.",
"type" : "boolean"
},
"telephoneNumber" : {
"x-addedInVersion" : 7,
"description" : "The shopper's telephone number.",
"type" : "string"
},
"threeDSAuthenticationOnly" : {
"x-addedInVersion" : 50,
"default" : false,
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},
"token" : {
"description" : "The token obtained when initializing the SDK.\n\n> This parameter is required for iOS and Android; not required for Web.",
"type" : "string"
},
"trustedShopper" : {
"x-addedInVersion" : 37,
"description" : "Set to true if the payment should be routed to a trusted MID.",
"type" : "boolean"
}
},
"required" : [
"merchantAccount",
"reference",
"amount",
"returnUrl",
"countryCode"
]
},
"PaymentSetupResponse" : {
"properties" : {
"paymentSession" : {
"description" : "The encoded payment session that you need to pass to the SDK.",
"type" : "string"
},
"recurringDetails" : {
"deprecated" : true,
"description" : "The detailed list of stored payment details required to generate payment forms. Will be empty if oneClick is set to false in the request.",
"items" : {
"$ref" : "#/components/schemas/RecurringDetail"
},
"type" : "array"
}
}
},
"PaymentVerificationRequest" : {
"properties" : {
"payload" : {
"description" : "Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment.",
"maxLength" : 10000,
"type" : "string"
}
},
"required" : [
"payload"
]
},
"PaymentVerificationResponse" : {
"properties" : {
"additionalData" : {
"additionalProperties" : {
"type" : "string"
},
"x-anyOf" : [
{
"$ref" : "#/components/schemas/ResponseAdditionalData3DSecure"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataBillingAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCard"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataCommon"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataDeliveryAddress"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataInstallments"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataNetworkTokens"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataOpi"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataPayPal"
},
{
"$ref" : "#/components/schemas/ResponseAdditionalDataSepa"
}
],
"description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs** > **Additional data settings**.",
"type" : "object"
},
"fraudResult" : {
"description" : "The fraud result properties of the payment.",
"$ref" : "#/components/schemas/FraudResult"
},
"merchantReference" : {
"description" : "A unique value that you provided in the initial `/paymentSession` request as a `reference` field.",
"type" : "string"
},
"order" : {
"description" : "Contains updated information regarding the order in case order information was provided in the request.",
"$ref" : "#/components/schemas/CheckoutOrderResponse"
},
"paymentMethod" : {
"description" : "The payment method used in the transaction.",
"type" : "string"
},
"pspReference" : {
"description" : "Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request.",
"type" : "string"
},
"refusalReason" : {
"description" : "If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values.\n\nFor more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"refusalReasonCode" : {
"x-addedInVersion" : 37,
"description" : "Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons).",
"type" : "string"
},
"resultCode" : {
"description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – 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** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.",
"enum" : [
"AuthenticationFinished",
"Authorised",
"Cancelled",
"ChallengeShopper",
"Error",
"IdentifyShopper",
"Pending",
"PresentToShopper",
"Received",
"RedirectShopper",
"Refused",
"Success"
],
"type" : "string"
},
"serviceError" : {
"description" : "The type of the error.",
"$ref" : "#/components/schemas/ServiceError2"
},
"shopperLocale" : {
"description" : "The shopperLocale value provided in the payment request.",
"type" : "string"
}
},
"required" : [
"merchantReference",
"paymentMethod",
"shopperLocale"
]
},
"QiwiWalletDetails" : {
"additionalProperties" : false,
"properties" : {
"telephoneNumber" : {
"description" : "",
"type" : "string"
},
"type" : {
"default" : "qiwiwallet",
"description" : "**qiwiwallet**",
"enum" : [
"qiwiwallet"
],
"type" : "string"
}
},
"required" : [
"telephoneNumber"
],
"title" : "QIWI"
},
"RatepayDetails" : {
"additionalProperties" : false,
"properties" : {
"billingAddress" : {
"description" : "The address where to send the invoice.",
"type" : "string"
},
"deliveryAddress" : {
"description" : "The address where the goods should be delivered.",
"type" : "string"
},
"personalDetails" : {
"description" : "Shopper name, date of birth, phone number, and email address.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "ratepay",
"description" : "**ratepay**",
"enum" : [
"ratepay"
],
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "Ratepay"
},
"Recurring" : {
"properties" : {
"contract" : {
"description" : "The type of recurring contract to be used.\nPossible values:\n* `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid).\n* `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp).\n* `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not.\n* `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts).",
"enum" : [
"ONECLICK",
"RECURRING",
"PAYOUT"
],
"type" : "string"
},
"recurringDetailName" : {
"description" : "A descriptive name for this detail.",
"type" : "string"
},
"recurringExpiry" : {
"x-addedInVersion" : 40,
"description" : "Date after which no further authorisations shall be performed. Only for 3D Secure 2.",
"format" : "date-time",
"type" : "string"
},
"recurringFrequency" : {
"x-addedInVersion" : 40,
"description" : "Minimum number of days between authorisations. Only for 3D Secure 2.",
"type" : "string"
},
"tokenService" : {
"x-addedInVersion" : 25,
"description" : "The name of the token service.",
"enum" : [
"VISATOKENSERVICE",
"MCTOKENSERVICE"
],
"type" : "string"
}
}
},
"RecurringDetail" : {
"properties" : {
"brands" : {
"x-addedInVersion" : 49,
"description" : "List of possible brands. For example: visa, mc.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"configuration" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "The configuration of the payment method.",
"type" : "object"
},
"details" : {
"description" : "All input details to be provided to complete the payment with this payment method.",
"items" : {
"$ref" : "#/components/schemas/InputDetail"
},
"type" : "array"
},
"group" : {
"description" : "The group where this payment method belongs to.",
"$ref" : "#/components/schemas/PaymentMethodGroup"
},
"inputDetails" : {
"deprecated" : true,
"description" : "All input details to be provided to complete the payment with this payment method.",
"items" : {
"$ref" : "#/components/schemas/InputDetail"
},
"type" : "array"
},
"name" : {
"description" : "The displayable name of this payment method.",
"type" : "string"
},
"recurringDetailReference" : {
"description" : "The reference that uniquely identifies the recurring detail.",
"type" : "string"
},
"storedDetails" : {
"description" : "Contains information on previously stored payment details.",
"$ref" : "#/components/schemas/StoredDetails"
},
"supportsRecurring" : {
"description" : "Indicates whether this payment method supports tokenization or not.",
"type" : "boolean"
},
"type" : {
"description" : "The unique payment method code.",
"type" : "string"
}
}
},
"Redirect" : {
"properties" : {
"data" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "When the redirect URL must be accessed via POST, use this data to post to the redirect URL.",
"type" : "object"
},
"method" : {
"description" : "The web method that you must use to access the redirect URL.\n\nPossible values: GET, POST.",
"enum" : [
"GET",
"POST"
],
"type" : "string"
},
"url" : {
"description" : "The URL, to which you must redirect a shopper to complete a payment.",
"type" : "string"
}
}
},
"ResponseAdditionalData3DSecure" : {
"properties" : {
"cardHolderInfo" : {
"description" : "Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. ",
"type" : "string"
},
"scaExemptionRequested" : {
"description" : "Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** ",
"type" : "string"
}
}
},
"ResponseAdditionalDataBillingAddress" : {
"properties" : {
"billingAddress.city" : {
"description" : "The billing address city passed in the payment request.",
"type" : "string"
},
"billingAddress.country" : {
"description" : "The billing address country passed in the payment request.\n\nExample: NL",
"type" : "string"
},
"billingAddress.houseNumberOrName" : {
"description" : "The billing address house number or name passed in the payment request.",
"type" : "string"
},
"billingAddress.postalCode" : {
"description" : "The billing address postal code passed in the payment request.\n\nExample: 1011 DJ",
"type" : "string"
},
"billingAddress.stateOrProvince" : {
"description" : "The billing address state or province passed in the payment request.\n\nExample: NH",
"type" : "string"
},
"billingAddress.street" : {
"description" : "The billing address street passed in the payment request.",
"type" : "string"
}
}
},
"ResponseAdditionalDataCard" : {
"properties" : {
"cardBin" : {
"description" : "The Bank Identification Number of a credit card, which is the first six digits of a card number.\n\nExample: 521234",
"type" : "string"
},
"cardHolderName" : {
"description" : "The cardholder name passed in the payment request.",
"type" : "string"
},
"cardIssuingBank" : {
"description" : "The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available.",
"type" : "string"
},
"cardIssuingCountry" : {
"description" : "The country where the card was issued.\n\nExample: US",
"type" : "string"
},
"cardIssuingCurrency" : {
"description" : "The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. \n\nExample: USD",
"type" : "string"
},
"cardPaymentMethod" : {
"description" : "The card payment method used for the transaction.\n\nExample: amex",
"type" : "string"
},
"cardSummary" : {
"description" : "The last four digits of a card number.\n\n> Returned only in case of a card payment.",
"type" : "string"
}
}
},
"ResponseAdditionalDataCommon" : {
"properties" : {
"acquirerAccountCode" : {
"description" : "The name of the Adyen acquirer account.\n\nExample: PayPalSandbox_TestAcquirer\n\n> Only relevant for PayPal transactions.",
"type" : "string"
},
"acquirerCode" : {
"description" : "The name of the acquirer processing the payment request.\n\nExample: TestPmmAcquirer",
"type" : "string"
},
"acquirerReference" : {
"description" : "The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement.\n\nExample: 7C9N3FNBKT9",
"type" : "string"
},
"alias" : {
"description" : "The Adyen alias of the card.\n\nExample: H167852639363479",
"type" : "string"
},
"aliasType" : {
"description" : "The type of the card alias.\n\nExample: Default",
"type" : "string"
},
"authCode" : {
"description" : "Authorisation code:\n* When the payment is authorised successfully, this field holds the authorisation code for the payment.\n* When the payment is not authorised, this field is empty.\n\nExample: 58747",
"type" : "string"
},
"authorisedAmountCurrency" : {
"description" : "The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).",
"type" : "string"
},
"authorisedAmountValue" : {
"description" : "Value of the amount authorised.\n\nThis amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes).",
"type" : "string"
},
"avsResult" : {
"description" : "The AVS result code of the payment, which provides information about the outcome of the AVS check.\n\nFor possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs).",
"type" : "string"
},
"avsResultRaw" : {
"description" : "Raw AVS result received from the acquirer, where available.\n\nExample: D",
"type" : "string"
},
"bic" : {
"description" : "BIC of a bank account.\n\nExample: TESTNL01\n\n> Only relevant for SEPA Direct Debit transactions.",
"type" : "string"
},
"cvcResult" : {
"description" : "The result of CVC verification.",
"example" : "1 Matches",
"type" : "string"
},
"cvcResultRaw" : {
"description" : "The raw result of CVC verification.",
"example" : "M",
"type" : "string"
},
"dsTransID" : {
"description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction.",
"type" : "string"
},
"eci" : {
"description" : "The Electronic Commerce Indicator returned from the schemes for the 3DS payment session.\n\nExample: 02",
"type" : "string"
},
"expiryDate" : {
"description" : "The expiry date on the card.\n\nExample: 6/2016\n\n> Returned only in case of a card payment.",
"type" : "string"
},
"extraCostsCurrency" : {
"description" : "The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request.\n\nExample: EUR",
"type" : "string"
},
"extraCostsValue" : {
"description" : "The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units.",
"type" : "string"
},
"fraudCheck-[itemNr]-[FraudCheckname]" : {
"description" : "The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair.",
"type" : "string"
},
"fundingSource" : {
"description" : "Information regarding the funding type of the card. The possible return values are:\n* CHARGE\n* CREDIT\n* DEBIT\n* PREPAID\n* PREPAID_RELOADABLE\n\n* PREPAID_NONRELOADABLE\n* DEFFERED_DEBIT\n\n> This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.\n\nFor receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**.",
"type" : "string"
},
"fundsAvailability" : {
"description" : "Indicates availability of funds.\n\nVisa:\n* \"I\" (fast funds are supported)\n* \"N\" (otherwise)\n\nMastercard:\n* \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list)\n* \"N\" (otherwise)\n\n> Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\".",
"type" : "string"
},
"inferredRefusalReason" : {
"description" : "Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\".\n\nPossible values:\n\n* 3D Secure Mandated\n* Closed Account\n* ContAuth Not Supported\n* CVC Mandated\n* Ecommerce Not Allowed\n* Crossborder Not Supported\n* Card Updated\n\n* Low Authrate Bin\n* Non-reloadable prepaid card",
"type" : "string"
},
"issuerCountry" : {
"description" : "The issuing country of the card based on the BIN list that Adyen maintains.\n\nExample: JP",
"type" : "string"
},
"mcBankNetReferenceNumber" : {
"description" : "The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long.\n\n> Contact Support Team to enable this field.",
"type" : "string"
},
"networkTxReference" : {
"description" : "Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa.\n\nThis contains either the Mastercard Trace ID or the Visa Transaction ID.",
"type" : "string"
},
"nonScheme.transactionLimit" : {
"description" : "The maximum spendable value for a single transaction. Applicable to some gift cards.",
"type" : "string"
},
"nonScheme.transactionLimitCcy" : {
"description" : "The currency of the transaction limit.",
"type" : "string"
},
"ownerName" : {
"description" : "The owner name of a bank account.\n\nOnly relevant for SEPA Direct Debit transactions.",
"type" : "string"
},
"paymentAccountReference" : {
"description" : "The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters.",
"type" : "string"
},
"paymentMethodVariant" : {
"description" : "The Adyen sub-variant of the payment method used for the payment request.\n\nFor more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant).\n\nExample: mcpro",
"type" : "string"
},
"payoutEligible" : {
"description" : "Indicates whether a payout is eligible or not for this card.\n\nVisa:\n* \"Y\"\n* \"N\"\n\nMastercard:\n* \"Y\" (domestic and cross-border)\n\n* \"D\" (only domestic)\n* \"N\" (no MoneySend)\n* \"U\" (unknown)",
"type" : "string"
},
"realtimeAccountUpdaterStatus" : {
"description" : "The response code from the Real Time Account Updater service.\n\nPossible return values are:\n* CardChanged\n* CardExpiryChanged\n* CloseAccount\n\n* ContactCardAccountHolder",
"type" : "string"
},
"receiptFreeText" : {
"description" : "Message to be displayed on the terminal.",
"type" : "string"
},
"recurring.firstPspReference" : {
"description" : "The `pspReference`, of the first recurring payment that created the recurring detail.\n\nThis functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team.",
"type" : "string"
},
"recurring.recurringDetailReference" : {
"description" : "The reference that uniquely identifies the recurring transaction.",
"type" : "string"
},
"recurring.shopperReference" : {
"x-addedInVersion" : 40,
"description" : "The provided reference of the shopper for a recurring transaction.",
"type" : "string"
},
"recurringProcessingModel" : {
"x-addedInVersion" : 40,
"description" : "The processing model used for the recurring transaction.",
"enum" : [
"CardOnFile",
"Subscription",
"UnscheduledCardOnFile"
],
"type" : "string"
},
"referred" : {
"description" : "If the payment is referred, this field is set to true.\n\nThis field is unavailable if the payment is referred and is usually not returned with ecommerce transactions.\n\nExample: true",
"type" : "string"
},
"refusalReasonRaw" : {
"description" : "Raw refusal reason received from the acquirer, where available.\n\nExample: AUTHORISED",
"type" : "string"
},
"shopperInteraction" : {
"description" : "The shopper interaction type of the payment request.\n\nExample: Ecommerce",
"type" : "string"
},
"shopperReference" : {
"description" : "The shopperReference passed in the payment request.\n\nExample: AdyenTestShopperXX",
"type" : "string"
},
"terminalId" : {
"description" : "The terminal ID used in a point-of-sale payment.\n\nExample: 06022622",
"type" : "string"
},
"threeDAuthenticated" : {
"description" : "A Boolean value indicating whether 3DS authentication was completed on this payment.\n\nExample: true",
"type" : "string"
},
"threeDAuthenticatedResponse" : {
"description" : "The raw 3DS authentication result from the card issuer.\n\nExample: N",
"type" : "string"
},
"threeDOffered" : {
"description" : "A Boolean value indicating whether 3DS was offered for this payment.\n\nExample: true",
"type" : "string"
},
"threeDOfferedResponse" : {
"description" : "The raw enrollment result from the 3DS directory services of the card schemes.\n\nExample: Y",
"type" : "string"
},
"threeDSVersion" : {
"description" : "The 3D Secure 2 version.",
"type" : "string"
},
"visaTransactionId" : {
"description" : "The `visaTransactionId`, has a fixed length of 15 numeric characters.\n\n> Contact Support Team to enable this field.",
"type" : "string"
},
"xid" : {
"description" : "The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field.\n\nExample: ODgxNDc2MDg2MDExODk5MAAAAAA=",
"type" : "string"
}
}
},
"ResponseAdditionalDataDeliveryAddress" : {
"properties" : {
"deliveryAddress.city" : {
"description" : "The delivery address city passed in the payment request.",
"type" : "string"
},
"deliveryAddress.country" : {
"description" : "The delivery address country passed in the payment request.\n\nExample: NL",
"type" : "string"
},
"deliveryAddress.houseNumberOrName" : {
"description" : "The delivery address house number or name passed in the payment request.",
"type" : "string"
},
"deliveryAddress.postalCode" : {
"description" : "The delivery address postal code passed in the payment request.\n\nExample: 1011 DJ",
"type" : "string"
},
"deliveryAddress.stateOrProvince" : {
"description" : "The delivery address state or province passed in the payment request.\n\nExample: NH",
"type" : "string"
},
"deliveryAddress.street" : {
"description" : "The delivery address street passed in the payment request.",
"type" : "string"
}
}
},
"ResponseAdditionalDataInstallments" : {
"properties" : {
"installmentPaymentData.installmentType" : {
"description" : "Type of installment. The value of `installmentType` should be **IssuerFinanced**.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].annualPercentageRate" : {
"description" : "Annual interest rate.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].firstInstallmentAmount" : {
"description" : "First Installment Amount in minor units.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].installmentFee" : {
"description" : "Installment fee amount in minor units.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].interestRate" : {
"description" : "Interest rate for the installment period.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].maximumNumberOfInstallments" : {
"description" : "Maximum number of installments possible for this payment.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].minimumNumberOfInstallments" : {
"description" : "Minimum number of installments possible for this payment.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].numberOfInstallments" : {
"description" : "Total number of installments possible for this payment.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].subsequentInstallmentAmount" : {
"description" : "Subsequent Installment Amount in minor units.",
"type" : "string"
},
"installmentPaymentData.option[itemNr].totalAmountDue" : {
"description" : "Total amount in minor units.",
"type" : "string"
},
"installmentPaymentData.paymentOptions" : {
"description" : "Possible values:\n* PayInInstallmentsOnly\n* PayInFullOnly\n* PayInFullOrInstallments",
"type" : "string"
},
"installments.value" : {
"description" : "The number of installments that the payment amount should be charged with.\n\nExample: 5\n> Only relevant for card payments in countries that support installments.",
"type" : "string"
}
}
},
"ResponseAdditionalDataNetworkTokens" : {
"properties" : {
"networkToken.available" : {
"description" : "Indicates whether a network token is available for the specified card.",
"type" : "string"
},
"networkToken.bin" : {
"description" : "The Bank Identification Number of a tokenized card, which is the first six digits of a card number.",
"type" : "string"
},
"networkToken.tokenSummary" : {
"description" : "The last four digits of a network token.",
"type" : "string"
}
}
},
"ResponseAdditionalDataOpi" : {
"properties" : {
"opi.transToken" : {
"description" : "Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).",
"type" : "string"
}
}
},
"ResponseAdditionalDataPayPal" : {
"properties" : {
"paypalEmail" : {
"description" : "The buyer's PayPal account email address.\n\nExample: paypaltest@adyen.com",
"type" : "string"
},
"paypalPayerId" : {
"description" : "The buyer's PayPal ID.\n\nExample: LF5HCWWBRV2KL",
"type" : "string"
},
"paypalPayerResidenceCountry" : {
"description" : "The buyer's country of residence.\n\nExample: NL",
"type" : "string"
},
"paypalPayerStatus" : {
"description" : "The status of the buyer's PayPal account.\n\nExample: unverified",
"type" : "string"
},
"paypalProtectionEligibility" : {
"description" : "The eligibility for PayPal Seller Protection for this payment.\n\nExample: Ineligible",
"type" : "string"
}
}
},
"ResponseAdditionalDataSepa" : {
"properties" : {
"sepadirectdebit.dateOfSignature" : {
"description" : "The transaction signature date.\n\nFormat: yyyy-MM-dd",
"type" : "string"
},
"sepadirectdebit.mandateId" : {
"description" : "Its value corresponds to the pspReference value of the transaction.",
"type" : "string"
},
"sepadirectdebit.sequenceType" : {
"description" : "This field can take one of the following values:\n* OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction.\n\n* First: (FRST) Initial/first collection in a series of direct debit instructions.\n* Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor.\n* Final: (FNAL) Last/final collection in a series of direct debit instructions.\n\nExample: OOFF",
"type" : "string"
}
}
},
"RiskData" : {
"properties" : {
"clientData" : {
"description" : "Contains client-side data, like the device fingerprint, cookies, and specific browser settings.",
"type" : "string"
}
}
},
"SDKEphemPubKey" : {
"properties" : {
"crv" : {
"description" : "The `crv` value as received from the 3D Secure 2 SDK.",
"type" : "string"
},
"kty" : {
"description" : "The `kty` value as received from the 3D Secure 2 SDK.",
"type" : "string"
},
"x" : {
"description" : "The `x` value as received from the 3D Secure 2 SDK.",
"type" : "string"
},
"y" : {
"description" : "The `y` value as received from the 3D Secure 2 SDK.",
"type" : "string"
}
}
},
"SamsungPayDetails" : {
"additionalProperties" : false,
"properties" : {
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"debit"
],
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"samsungPayToken" : {
"description" : "The payload you received from the Samsung Pay SDK response.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "samsungpay",
"description" : "**samsungpay**",
"enum" : [
"samsungpay"
],
"type" : "string"
}
},
"required" : [
"samsungPayToken"
],
"title" : "Samsung Pay"
},
"SepaDirectDebitDetails" : {
"additionalProperties" : false,
"properties" : {
"iban" : {
"description" : "The International Bank Account Number (IBAN).",
"type" : "string"
},
"ownerName" : {
"description" : "The name of the bank account holder.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "sepadirectdebit",
"description" : "**sepadirectdebit**",
"enum" : [
"sepadirectdebit"
],
"type" : "string"
}
},
"required" : [
"iban",
"ownerName"
],
"title" : "SEPA Direct Debit"
},
"ServiceError" : {
"properties" : {
"additionalData" : {
"x-addedInVersion" : 46,
"additionalProperties" : {
"type" : "string"
},
"description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.",
"type" : "object"
},
"errorCode" : {
"description" : "The error code mapped to the error message.",
"type" : "string"
},
"errorType" : {
"description" : "The category of the error.",
"type" : "string"
},
"message" : {
"description" : "A short explanation of the issue.",
"type" : "string"
},
"pspReference" : {
"description" : "The PSP reference of the payment.",
"type" : "string"
},
"status" : {
"description" : "The HTTP response status.",
"format" : "int32",
"type" : "integer"
}
}
},
"ServiceError2" : {
"properties" : {
"errorCode" : {
"type" : "string"
},
"errorType" : {
"type" : "string"
},
"message" : {
"type" : "string"
}
}
},
"ShopperInput" : {
"properties" : {
"billingAddress" : {
"description" : "Specifies visibility of billing address fields.\n\nPermitted values:\n* editable\n* hidden\n* readOnly",
"enum" : [
"editable",
"hidden",
"readOnly"
],
"type" : "string"
},
"deliveryAddress" : {
"description" : "Specifies visibility of delivery address fields.\n\nPermitted values:\n* editable\n* hidden\n* readOnly",
"enum" : [
"editable",
"hidden",
"readOnly"
],
"type" : "string"
},
"personalDetails" : {
"description" : "Specifies visibility of personal details.\n\nPermitted values:\n* editable\n* hidden\n* readOnly",
"enum" : [
"editable",
"hidden",
"readOnly"
],
"type" : "string"
}
}
},
"ShopperInteractionDevice" : {
"properties" : {
"locale" : {
"description" : "Locale on the shopper interaction device.",
"type" : "string"
},
"os" : {
"description" : "Operating system running on the shopper interaction device.",
"type" : "string"
},
"osVersion" : {
"description" : "Version of the operating system on the shopper interaction device.",
"type" : "string"
}
}
},
"Split" : {
"properties" : {
"account" : {
"description" : "Unique identifier of the account where the split amount should be sent. This is required if `type` is **MarketPlace** or **BalanceAccount**.\n\n",
"type" : "string"
},
"amount" : {
"description" : "The amount of this split.",
"$ref" : "#/components/schemas/SplitAmount"
},
"description" : {
"description" : "A description of this split.",
"type" : "string"
},
"reference" : {
"description" : "Your reference for the split, which you can use to link the split to other operations such as captures and refunds.\n\nThis is required if `type` is **MarketPlace** or **BalanceAccount**. For the other types, we also recommend sending a reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. If the reference is not provided, the split is reported as part of the aggregated [TransferBalance record type](https://docs.adyen.com/reporting/marketpay-payments-accounting-report) in Adyen for Platforms.",
"type" : "string"
},
"type" : {
"description" : "The type of split.\nPossible values: **Default**, **PaymentFee**, **VAT**, **Commission**, **MarketPlace**, **BalanceAccount**.",
"enum" : [
"BalanceAccount",
"Commission",
"Default",
"MarketPlace",
"PaymentFee",
"VAT",
"Verification"
],
"type" : "string"
}
},
"required" : [
"amount",
"type"
]
},
"SplitAmount" : {
"properties" : {
"currency" : {
"description" : "The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).\n\nIf this value is not provided, the currency in which the payment is made will be used.",
"maxLength" : 3,
"minLength" : 3,
"type" : "string"
},
"value" : {
"description" : "The amount in [minor units](https://docs.adyen.com/development-resources/currency-codes).",
"format" : "int64",
"type" : "integer"
}
},
"required" : [
"value"
]
},
"StoredDetails" : {
"properties" : {
"bank" : {
"description" : "The stored bank account.",
"$ref" : "#/components/schemas/BankAccount"
},
"card" : {
"description" : "The stored card information.",
"$ref" : "#/components/schemas/Card"
},
"emailAddress" : {
"description" : "The email associated with stored payment details.",
"type" : "string"
}
}
},
"StoredPaymentMethod" : {
"properties" : {
"brand" : {
"description" : "The brand of the card.",
"type" : "string"
},
"expiryMonth" : {
"description" : "The month the card expires.",
"type" : "string"
},
"expiryYear" : {
"description" : "The year the card expires.",
"type" : "string"
},
"holderName" : {
"description" : "The unique payment method code.",
"type" : "string"
},
"id" : {
"description" : "A unique identifier of this stored payment method.",
"type" : "string"
},
"lastFour" : {
"description" : "The last four digits of the PAN.",
"type" : "string"
},
"name" : {
"description" : "The display name of the stored payment method.",
"type" : "string"
},
"shopperEmail" : {
"description" : "The shopper’s email address.",
"type" : "string"
},
"supportedShopperInteractions" : {
"description" : "The supported shopper interactions for this stored payment method.",
"items" : {
"type" : "string"
},
"type" : "array"
},
"type" : {
"description" : "The type of payment method.",
"type" : "string"
}
}
},
"StoredPaymentMethodDetails" : {
"additionalProperties" : false,
"properties" : {
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"description" : "The payment method type.",
"enum" : [
"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_VN",
"grabpay_PH",
"oxxo",
"gcash",
"kakaopay"
],
"type" : "string"
}
},
"title" : "Stored Payment Method"
},
"SubInputDetail" : {
"properties" : {
"configuration" : {
"additionalProperties" : {
"type" : "string"
},
"description" : "Configuration parameters for the required input.",
"type" : "object"
},
"items" : {
"description" : "In case of a select, the items to choose from.",
"items" : {
"$ref" : "#/components/schemas/Item"
},
"type" : "array"
},
"key" : {
"description" : "The value to provide in the result.",
"type" : "string"
},
"optional" : {
"description" : "True if this input is optional to provide.",
"type" : "boolean"
},
"type" : {
"description" : "The type of the required input.",
"type" : "string"
},
"value" : {
"description" : "The value can be pre-filled, if available.",
"type" : "string"
}
}
},
"ThreeDS2RequestData" : {
"properties" : {
"acquirerBIN" : {
"x-addedInVersion" : 49,
"description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.",
"type" : "string"
},
"acquirerMerchantID" : {
"x-addedInVersion" : 49,
"description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform.",
"type" : "string"
},
"authenticationOnly" : {
"deprecated" : true,
"x-deprecatedInVersion" : 50,
"x-deprecatedMessage" : "Use `threeDSAuthenticationOnly` instead.",
"default" : false,
"description" : "If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.",
"type" : "boolean"
},
"challengeIndicator" : {
"description" : "Possibility to specify a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n",
"enum" : [
"noPreference",
"requestNoChallenge",
"requestChallenge",
"requestChallengeAsMandate"
],
"type" : "string"
},
"deviceChannel" : {
"description" : "The environment of the shopper.\nAllowed values:\n* `app`\n* `browser`",
"type" : "string"
},
"deviceRenderOptions" : {
"description" : "Display options for the 3D Secure 2 SDK.\nOptional and only for `deviceChannel` **app**.",
"$ref" : "#/components/schemas/DeviceRenderOptions"
},
"mcc" : {
"x-addedInVersion" : 49,
"description" : "Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme.",
"type" : "string"
},
"merchantName" : {
"x-addedInVersion" : 49,
"description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters.\n> Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account.",
"type" : "string"
},
"messageVersion" : {
"default" : "2.1.0",
"description" : "The `messageVersion` value indicating the 3D Secure 2 protocol version.",
"type" : "string"
},
"notificationURL" : {
"description" : "URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**.",
"type" : "string"
},
"sdkAppID" : {
"description" : "The `sdkAppID` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.",
"type" : "string"
},
"sdkEncData" : {
"description" : "The `sdkEncData` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.",
"type" : "string"
},
"sdkEphemPubKey" : {
"description" : "The `sdkEphemPubKey` value as received from the 3D Secure 2 SDK.\nRequired for `deviceChannel` set to **app**.",
"$ref" : "#/components/schemas/SDKEphemPubKey"
},
"sdkMaxTimeout" : {
"default" : 60,
"description" : "The maximum amount of time in minutes for the 3D Secure 2 authentication process.\nOptional and only for `deviceChannel` set to **app**. Defaults to **60** minutes.",
"format" : "int32",
"type" : "integer"
},
"sdkReferenceNumber" : {
"description" : "The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.",
"type" : "string"
},
"sdkTransID" : {
"description" : "The `sdkTransID` value as received from the 3D Secure 2 SDK.\nOnly for `deviceChannel` set to **app**.",
"type" : "string"
},
"threeDSCompInd" : {
"description" : "Completion indicator for the device fingerprinting.",
"type" : "string"
},
"threeDSRequestorID" : {
"description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2.",
"type" : "string"
},
"threeDSRequestorName" : {
"description" : "Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2.",
"type" : "string"
},
"threeDSRequestorURL" : {
"description" : "URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process.",
"type" : "string"
},
"transactionType" : {
"x-addedInVersion" : 50,
"description" : "Identify the type of the transaction being authenticated.",
"enum" : [
"goodsOrServicePurchase",
"checkAcceptance",
"accountFunding",
"quasiCashTransaction",
"prepaidActivationAndLoad"
],
"type" : "string"
},
"whiteListStatus" : {
"x-addedInVersion" : 49,
"description" : "The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0.",
"type" : "string"
}
},
"required" : [
"deviceChannel"
]
},
"ThreeDS2Result" : {
"properties" : {
"authenticationValue" : {
"description" : "The `authenticationValue` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"cavvAlgorithm" : {
"x-addedInVersion" : 50,
"description" : "The algorithm used by the ACS to calculate the authentication value, only for CartesBancaires integrations.",
"type" : "string"
},
"dsTransID" : {
"description" : "The `dsTransID` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"eci" : {
"description" : "The `eci` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"messageVersion" : {
"x-addedInVersion" : 49,
"description" : "The `messageVersion` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"threeDSServerTransID" : {
"description" : "The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"timestamp" : {
"description" : "The `timestamp` value of the 3D Secure 2 authentication.",
"type" : "string"
},
"transStatus" : {
"description" : "The `transStatus` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"transStatusReason" : {
"description" : "The `transStatusReason` value as defined in the 3D Secure 2 specification.",
"type" : "string"
},
"whiteListStatus" : {
"x-addedInVersion" : 49,
"description" : "The `whiteListStatus` value as defined in the 3D Secure 2 specification.",
"type" : "string"
}
}
},
"ThreeDSecureData" : {
"properties" : {
"authenticationResponse" : {
"description" : "In 3D Secure 1, the authentication response if the shopper was redirected.\n\nIn 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter.",
"enum" : [
"Y",
"N",
"U",
"A"
],
"type" : "string"
},
"cavv" : {
"description" : "The cardholder authentication value (base64 encoded, 20 bytes in a decoded form).",
"format" : "byte",
"type" : "string"
},
"cavvAlgorithm" : {
"description" : "The CAVV algorithm used. Include this only for 3D Secure 1.",
"type" : "string"
},
"directoryResponse" : {
"description" : "In 3D Secure 1, this is the enrollment response from the 3D directory server.\n\nIn 3D Secure 2, this is the `transStatus` from the `ARes`.",
"enum" : [
"A",
"C",
"D",
"I",
"N",
"R",
"U",
"Y"
],
"type" : "string"
},
"dsTransID" : {
"x-addedInVersion" : 40,
"description" : "Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction.",
"type" : "string"
},
"eci" : {
"description" : "The electronic commerce indicator.",
"type" : "string"
},
"threeDSVersion" : {
"x-addedInVersion" : 40,
"description" : "The version of the 3D Secure protocol.",
"type" : "string"
},
"xid" : {
"description" : "Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form).",
"format" : "byte",
"type" : "string"
}
}
},
"UpdatePaymentLinkRequest" : {
"properties" : {
"status" : {
"description" : "Status of the payment link. Possible values:\n* **expired**",
"enum" : [
"expired"
],
"type" : "string"
}
},
"required" : [
"status"
]
},
"UpiDetails" : {
"additionalProperties" : false,
"properties" : {
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"shopperNotificationReference" : {
"description" : "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "upi",
"description" : "**upi**",
"enum" : [
"upi_collect"
],
"type" : "string"
},
"virtualPaymentAddress" : {
"description" : "The virtual payment address for UPI.",
"type" : "string"
}
},
"required" : [
"type"
],
"title" : "UPI"
},
"VippsDetails" : {
"additionalProperties" : false,
"properties" : {
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"telephoneNumber" : {
"description" : "",
"type" : "string"
},
"type" : {
"default" : "vipps",
"description" : "**vipps**",
"enum" : [
"vipps"
],
"type" : "string"
}
},
"required" : [
"telephoneNumber"
],
"title" : "Vipps"
},
"VisaCheckoutDetails" : {
"additionalProperties" : false,
"properties" : {
"fundingSource" : {
"description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.",
"enum" : [
"debit"
],
"type" : "string"
},
"type" : {
"default" : "visacheckout",
"description" : "**visacheckout**",
"enum" : [
"visacheckout"
],
"type" : "string"
},
"visaCheckoutCallId" : {
"description" : "The Visa Click to Pay Call ID value. When your shopper selects a payment and/or a shipping address from Visa Click to Pay, you will receive a Visa Click to Pay Call ID.",
"type" : "string"
}
},
"required" : [
"visaCheckoutCallId"
],
"title" : "Visa Checkout"
},
"WeChatPayDetails" : {
"additionalProperties" : false,
"properties" : {
"type" : {
"default" : "wechatpay",
"description" : "**wechatpay**",
"enum" : [
"wechatpay"
],
"type" : "string"
}
},
"title" : "WeChat Pay"
},
"WeChatPayMiniProgramDetails" : {
"additionalProperties" : false,
"properties" : {
"appId" : {
"type" : "string"
},
"openid" : {
"type" : "string"
},
"type" : {
"default" : "wechatpayMiniProgram",
"description" : "**wechatpayMiniProgram**",
"enum" : [
"wechatpayMiniProgram"
],
"type" : "string"
}
},
"title" : "WeChat Pay - Mini Program"
},
"ZipDetails" : {
"additionalProperties" : false,
"properties" : {
"clickAndCollect" : {
"description" : "Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them.",
"type" : "string"
},
"recurringDetailReference" : {
"deprecated" : true,
"x-deprecatedInVersion" : 49,
"x-deprecatedMessage" : "Use `storedPaymentMethodId` instead.",
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"storedPaymentMethodId" : {
"x-addedInVersion" : 49,
"description" : "This is the `recurringDetailReference` returned in the response when you created the token.",
"type" : "string"
},
"type" : {
"default" : "zip",
"description" : "**zip**",
"enum" : [
"zip"
],
"type" : "string"
}
},
"title" : "Zip"
}
},
"securitySchemes" : {
"ApiKeyAuth" : {
"in" : "header",
"name" : "X-API-Key",
"type" : "apiKey"
},
"BasicAuth" : {
"scheme" : "basic",
"type" : "http"
}
},
"headers" : {
"Idempotency-Key" : {
"description" : "The idempotency key used for processing the request. Present if the key was provided in the request.",
"schema" : {
"type" : "string"
}
}
},
"parameters" : {
"Idempotency-Key" : {
"description" : "A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).",
"example" : "37ca9c97-d1d1-4c62-89e8-706891a563ed",
"name" : "Idempotency-Key",
"in" : "header",
"schema" : {
"type" : "string"
}
}
},
"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"
}
},
"generic-422" : {
"summary" : "Response code 422. Unprocessable entity.",
"value" : {
"status" : 422,
"errorCode" : "14_030",
"message" : "Return URL is missing.",
"errorType" : "validation"
}
},
"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" : "Example response for request 'basic'",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 8700
},
"countryCode" : "NL",
"expiresAt" : "2021-04-08T14:06:39Z",
"merchantAccount" : "TestMerchantCheckout",
"reference" : "shopper-reference-ekvL83",
"shopperLocale" : "hu-HU",
"shopperReference" : "shopper-reference-LZfdWZ",
"status" : "active",
"url" : "https://test.adyen.link/PL61C53A8B97E6915A"
}
},
"patch-paymentLinks-linkId-basic" : {
"summary" : "Update the status of a payment link",
"value" : {
"status" : "expired"
}
},
"patch-paymentLinks-linkId-basic-200" : {
"summary" : "Example response for request 'basic'",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 8700
},
"countryCode" : "NL",
"expiresAt" : "2021-04-08T14:06:39Z",
"merchantAccount" : "TestMerchantCheckout",
"reference" : "shopper-reference-ekvL83",
"shopperLocale" : "hu-HU",
"shopperReference" : "shopper-reference-LZfdWZ",
"status" : "expired",
"url" : "https://test.adyen.link/PL61C53A8B97E6915A"
}
},
"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" : "Example response for request 'basic'",
"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
}
}
},
"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" : "Example response for request 'basic'",
"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_UNIQUE_SHOPPER_ID",
"shopperEmail" : "test@email.com",
"shopperLocale" : "pt-BR",
"billingAddress" : {
"street" : "Roque Petroni Jr",
"postalCode" : "59000060",
"city" : "São Paulo",
"houseNumberOrName" : "999",
"country" : "BR",
"stateOrProvince" : "SP"
},
"deliveryAddress" : {
"street" : "Roque Petroni Jr",
"postalCode" : "59000060",
"city" : "São Paulo",
"houseNumberOrName" : "999",
"country" : "BR",
"stateOrProvince" : "SP"
}
}
},
"post-paymentLinks-basic-200" : {
"summary" : "Example response for request 'basic'",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 1250
},
"expiresAt" : "2021-04-09T14:17:31Z",
"reference" : "shopper-reference-ekvL83",
"url" : "https://test.adyen.link/PL6DB3157D27FFBBCF"
}
},
"post-paymentMethods-balance-basic" : {
"summary" : "Retrieve gift card balance",
"value" : {
"paymentMethod" : {
"type" : "givex",
"number" : "4126491073027401",
"cvc" : "737"
},
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-paymentMethods-balance-plastix" : {
"summary" : "Retrieve gift card balance",
"value" : {
"paymentMethod" : {
"type" : "plastix",
"number" : "4010100000000000000",
"cvc" : "73737",
"holderName" : "BALANCE EUR 888"
},
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-paymentMethods-balance-plastix-200" : {
"summary" : "Example response for request 'plastix'",
"value" : {
"additionalData" : {
"nonScheme.transactionLimit" : "5000",
"nonScheme.transactionLimitCcy" : "EUR"
},
"pspReference" : "851617891188737F",
"resultCode" : "Success",
"balance" : {
"currency" : "EUR",
"value" : 888
}
}
},
"post-paymentMethods-basic" : {
"summary" : "Get available payment methods",
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-paymentMethods-basic-200" : {
"summary" : "Example response for request 'basic'",
"value" : {
"paymentMethods" : [
{
"details" : [
{
"details" : [
{
"key" : "ownerName",
"type" : "text"
},
{
"key" : "bankLocationId",
"type" : "text"
},
{
"key" : "bankAccountNumber",
"type" : "text"
}
],
"key" : "bankAccount",
"type" : "bankAccount"
}
],
"name" : "ACH Direct Debit",
"type" : "ach"
},
{
"name" : "Adyen Voucher",
"type" : "adyen_test_voucher"
},
{
"details" : [
{
"details" : [
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"items" : [
{
"id" : "M",
"name" : "male"
},
{
"id" : "F",
"name" : "female"
}
],
"key" : "gender",
"type" : "radio"
},
{
"key" : "dateOfBirth",
"type" : "date"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
}
],
"key" : "personalDetails",
"type" : "fieldSet"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "NL",
"name" : "Netherlands"
},
{
"id" : "BE",
"name" : "Belgium"
}
],
"key" : "country",
"type" : "select"
}
],
"key" : "billingAddress",
"type" : "address"
},
{
"key" : "separateDeliveryAddress",
"optional" : true,
"type" : "boolean",
"value" : "false"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "NL",
"name" : "Netherlands"
},
{
"id" : "BE",
"name" : "Belgium"
}
],
"key" : "country",
"type" : "select"
}
],
"key" : "deliveryAddress",
"optional" : true,
"type" : "address"
}
],
"name" : "AfterPay Invoice",
"type" : "afterpay_default"
},
{
"name" : "AfterPay DirectDebit",
"type" : "afterpay_directdebit"
},
{
"name" : "Afterpay",
"type" : "afterpaytouch"
},
{
"details" : [
{
"key" : "encryptedCardNumber",
"type" : "cardToken"
},
{
"key" : "encryptedSecurityCode",
"type" : "cardToken"
},
{
"key" : "encryptedExpiryMonth",
"type" : "cardToken"
},
{
"key" : "encryptedExpiryYear",
"type" : "cardToken"
},
{
"key" : "holderName",
"optional" : true,
"type" : "text"
}
],
"name" : "Credit Card",
"type" : "scheme"
},
{
"name" : "AliPay",
"type" : "alipay"
},
{
"name" : "AliPay HK",
"type" : "alipay_hk"
},
{
"name" : "AliPay",
"type" : "alipay_wap"
},
{
"details" : [
{
"key" : "additionalData.androidpay.token",
"type" : "androidPayToken"
}
],
"name" : "Android Pay",
"type" : "androidpay"
},
{
"details" : [
{
"key" : "additionalData.applepay.token",
"type" : "applePayToken"
}
],
"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"
},
{
"details" : [
{
"items" : [
{
"id" : "AUB_DIRECT",
"name" : "AU Small Finance Bank"
},
{
"id" : "ALB_DIRECT",
"name" : "Allahabad Bank "
},
{
"id" : "APG_DIRECT",
"name" : "Andhra Pragathi Grameena Bank"
},
{
"id" : "BDN_DIRECT",
"name" : "Bandhan bank"
},
{
"id" : "BBK_DIRECT",
"name" : "Bank of Bahrain and Kuwait"
},
{
"id" : "BBR_DIRECT",
"name" : "Bank of Baroda - Retail Banking"
},
{
"id" : "BCB_DIRECT",
"name" : "Bassien Catholic Co-Operative Bank "
},
{
"id" : "CNB_DIRECT",
"name" : "Canara Bank"
},
{
"id" : "SYD_DIRECT",
"name" : "Canara Bank (e-Syndicate)"
},
{
"id" : "CSB_DIRECT",
"name" : "Catholic Syrian Bank"
},
{
"id" : "CBI_DIRECT",
"name" : "Central Bank of India"
},
{
"id" : "CUB_DIRECT",
"name" : "City Union Bank"
},
{
"id" : "COB_DIRECT",
"name" : "Cosmos Bank"
},
{
"id" : "DEN_DIRECT",
"name" : "Dena Bank"
},
{
"id" : "DBK_DIRECT",
"name" : "Deutsche Bank"
},
{
"id" : "DCB_DIRECT",
"name" : "Development Credit Bank"
},
{
"id" : "DLB_DIRECT",
"name" : "Dhanlakshmi Bank - Retail Net Banking"
},
{
"id" : "ESF_DIRECT",
"name" : "ESAF Small Finance Bank"
},
{
"id" : "EQB_DIRECT",
"name" : "Equitas Small Finance Bank"
},
{
"id" : "FBK_DIRECT",
"name" : "Federal Bank"
},
{
"id" : "FNC_DIRECT",
"name" : "Fincare Bank"
},
{
"id" : "HDF_DIRECT",
"name" : "HDFC Bank"
},
{
"id" : "ICI_DIRECT",
"name" : "ICICI Bank "
},
{
"id" : "IDB_DIRECT",
"name" : "IDBI Bank - Retail Net Banking"
},
{
"id" : "IDN_DIRECT",
"name" : "IDFC FIRST Bank"
},
{
"id" : "INB_DIRECT",
"name" : "Indian Bank"
},
{
"id" : "IOB_DIRECT",
"name" : "Indian Overseas Bank"
},
{
"id" : "IDS_DIRECT",
"name" : "IndusInd Bank"
},
{
"id" : "JKB_DIRECT",
"name" : "Jammu & Kashmir Bank"
},
{
"id" : "JNB_DIRECT",
"name" : "Jana Small Finance Bank"
},
{
"id" : "JSB_DIRECT",
"name" : "Janata Sahakari Bank Ltd Pune"
},
{
"id" : "KJB_DIRECT",
"name" : "Kalyan Janata Sahakari Bank"
},
{
"id" : "KBL_DIRECT",
"name" : "Karnataka Bank Ltd"
},
{
"id" : "KVB_DIRECT",
"name" : "Karur Vysya Bank"
},
{
"id" : "162_DIRECT",
"name" : "Kotak Bank"
},
{
"id" : "LVR_DIRECT",
"name" : "Laxmi Vilas Bank - Retail"
},
{
"id" : "NKB_DIRECT",
"name" : "NKGSB Co-op Bank"
},
{
"id" : "NEB_DIRECT",
"name" : "North East Small Finance Bank"
},
{
"id" : "OBC_DIRECT",
"name" : "PNB (Erstwhile-Oriental Bank of Commerce)"
},
{
"id" : "UNI_DIRECT",
"name" : "PNB (Erstwhile-United Bank of India)"
},
{
"id" : "PMC_DIRECT",
"name" : "Punjab & Maharastra Co-op Bank"
},
{
"id" : "PSB_DIRECT",
"name" : "Punjab & Sind Bank"
},
{
"id" : "CPN_DIRECT",
"name" : "Punjab National Bank - Corporate "
},
{
"id" : "PNB_DIRECT",
"name" : "Punjab National Bank - Retail Banking"
},
{
"id" : "RBL_DIRECT",
"name" : "RBL Bank Limited"
},
{
"id" : "SWB_DIRECT",
"name" : "Saraswat Bank"
},
{
"id" : "SHB_DIRECT",
"name" : "Shivalik Mercantile Cooperative Bank Ltd"
},
{
"id" : "SIB_DIRECT",
"name" : "South Indian Bank"
},
{
"id" : "SCB_DIRECT",
"name" : "Standard Chartered Bank"
},
{
"id" : "SBI_DIRECT",
"name" : "State Bank of India"
},
{
"id" : "SRB_DIRECT",
"name" : "Suryoday Small Finance Bank"
},
{
"id" : "TJB_DIRECT",
"name" : "TJSB Bank"
},
{
"id" : "TNC_DIRECT",
"name" : "Tamil Nadu State Co-operative Bank"
},
{
"id" : "TMB_DIRECT",
"name" : "Tamilnad Mercantile Bank Ltd"
},
{
"id" : "TBB_DIRECT",
"name" : "Thane Bharat Sahakari Bank Ltd"
},
{
"id" : "MSB_DIRECT",
"name" : "The Mehsana Urban Co Op Bank Ltd"
},
{
"id" : "UCO_DIRECT",
"name" : "UCO Bank"
},
{
"id" : "UBI_DIRECT",
"name" : "Union Bank of India"
},
{
"id" : "ADB_DIRECT",
"name" : "Union Bank of India (Erstwhile Andhra Bank)"
},
{
"id" : "CRP_DIRECT",
"name" : "Union Bank of India (Erstwhile Corporation Bank)"
},
{
"id" : "VRB_DIRECT",
"name" : "Varachha Co-operative Bank Limited"
},
{
"id" : "VJB_DIRECT",
"name" : "Vijaya Bank"
},
{
"id" : "YBK_DIRECT",
"name" : "Yes Bank"
},
{
"id" : "ZOB_DIRECT",
"name" : "Zoroastrian Co-operative Bank Limited"
},
{
"id" : "DBS_DIRECT",
"name" : "digibank by DBS"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "Online Banking India",
"type" : "billdesk_online"
},
{
"name" : "UPI",
"type" : "billdesk_upi"
},
{
"details" : [
{
"items" : [
{
"id" : "DCW_DIRECT",
"name" : "DCB Cippy"
},
{
"id" : "ICC_DIRECT",
"name" : "ICC Cash Card"
},
{
"id" : "OXY_DIRECT",
"name" : "Oxigen Wallet"
},
{
"id" : "PCH_DIRECT",
"name" : "Pay World Money"
}
],
"key" : "issuer",
"type" : "select"
}
],
"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"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "Alfamart",
"type" : "doku_alfamart"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "BCA Bank Transfer",
"type" : "doku_bca_va"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "BNI VA",
"type" : "doku_bni_va"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "BRI VA",
"type" : "doku_bri_va"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "CIMB VA",
"type" : "doku_cimb_va"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "Danamon VA",
"type" : "doku_danamon_va"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "Indomaret",
"type" : "doku_indomaret"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "Mandiri VA",
"type" : "doku_mandiri_va"
},
{
"details" : [
{
"key" : "ovoId",
"type" : "text"
}
],
"name" : "OVO",
"type" : "doku_ovo"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "Bank Transfer",
"type" : "doku_permata_lite_atm"
},
{
"details" : [
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"key" : "infix",
"optional" : true,
"type" : "text"
}
],
"name" : "DOKU wallet",
"type" : "doku_wallet"
},
{
"details" : [
{
"items" : [
{
"id" : "66",
"name" : "Bank Nowy BFG S.A."
},
{
"id" : "92",
"name" : "Bank Spółdzielczy w Brodnicy"
},
{
"id" : "11",
"name" : "Bank transfer / postal"
},
{
"id" : "74",
"name" : "Banki Spółdzielcze"
},
{
"id" : "73",
"name" : "BLIK"
},
{
"id" : "90",
"name" : "BNP Paribas - płacę z Pl@net"
},
{
"id" : "59",
"name" : "CinkciarzPAY"
},
{
"id" : "87",
"name" : "Credit Agricole PBL"
},
{
"id" : "83",
"name" : "EnveloBank"
},
{
"id" : "76",
"name" : "Getin Bank PBL"
},
{
"id" : "81",
"name" : "Idea Cloud"
},
{
"id" : "7",
"name" : "ING Corporate customers"
},
{
"id" : "93",
"name" : "Kasa Stefczyka"
},
{
"id" : "44",
"name" : "Millennium - Płatności Internetowe"
},
{
"id" : "10",
"name" : "Millennium Corporate customers"
},
{
"id" : "68",
"name" : "mRaty"
},
{
"id" : "1",
"name" : "mTransfer"
},
{
"id" : "91",
"name" : "Nest Bank"
},
{
"id" : "80",
"name" : "Noble Pay"
},
{
"id" : "50",
"name" : "Pay Way Toyota Bank"
},
{
"id" : "45",
"name" : "Pay with Alior Bank"
},
{
"id" : "36",
"name" : "Pekao24Przelew"
},
{
"id" : "70",
"name" : "Pocztowy24"
},
{
"id" : "6",
"name" : "Przelew24"
},
{
"id" : "46",
"name" : "Płacę z Citi Handlowy"
},
{
"id" : "38",
"name" : "Płacę z ING"
},
{
"id" : "2",
"name" : "Płacę z Inteligo"
},
{
"id" : "4",
"name" : "Płacę z iPKO"
},
{
"id" : "75",
"name" : "Płacę z Plus Bank"
},
{
"id" : "51",
"name" : "Płać z BOŚ"
},
{
"id" : "55",
"name" : "Raty z Alior Bankiem PLN"
},
{
"id" : "89",
"name" : "Santander"
},
{
"id" : "52",
"name" : "SkyCash"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "Local Polish Payment Methods",
"type" : "dotpay"
},
{
"name" : "Dragonpay Prepaid Credits",
"type" : "dragonpay_credits"
},
{
"name" : "Online Banking",
"type" : "dragonpay_ebanking"
},
{
"name" : "GCash",
"type" : "dragonpay_gcash"
},
{
"name" : "Over The Counter Banks",
"type" : "dragonpay_otc_banking"
},
{
"name" : "OTC non-Bank via Dragonpay",
"type" : "dragonpay_otc_non_banking"
},
{
"name" : "Convenience Stores",
"type" : "dragonpay_otc_philippines"
},
{
"name" : "7/11",
"type" : "dragonpay_seveneleven"
},
{
"name" : "eagleeye_voucher",
"type" : "eagleeye_voucher"
},
{
"name" : "Finnish E-Banking",
"type" : "ebanking_FI"
},
{
"name" : "Pay-easy ATM",
"type" : "econtext_atm"
},
{
"name" : "Online Banking",
"type" : "econtext_online"
},
{
"name" : "7-Eleven",
"type" : "econtext_seven_eleven"
},
{
"name" : "Convenience Stores",
"type" : "econtext_stores"
},
{
"name" : "eft_directdebit_CA",
"type" : "eft_directdebit_CA"
},
{
"name" : "Lastschrift (ELV)",
"type" : "elv"
},
{
"details" : [
{
"items" : [
{
"id" : "231",
"name" : "POP Pankki"
},
{
"id" : "551",
"name" : "Komerční banka"
},
{
"id" : "232",
"name" : "Aktia"
},
{
"id" : "552",
"name" : "Raiffeisen"
},
{
"id" : "233",
"name" : "Säästöpankki"
},
{
"id" : "750",
"name" : "Swedbank"
},
{
"id" : "211",
"name" : "Nordea"
},
{
"id" : "553",
"name" : "ČSOB"
},
{
"id" : "234",
"name" : "S-Pankki"
},
{
"id" : "751",
"name" : "SEB"
},
{
"id" : "554",
"name" : "Moneta"
},
{
"id" : "235",
"name" : "OmaSP"
},
{
"id" : "752",
"name" : "Nordea"
},
{
"id" : "213",
"name" : "Op-Pohjola"
},
{
"id" : "555",
"name" : "UniCredit"
},
{
"id" : "753",
"name" : "LHV"
},
{
"id" : "556",
"name" : "Fio"
},
{
"id" : "557",
"name" : "mBank"
},
{
"id" : "216",
"name" : "Handelsbanken"
},
{
"id" : "558",
"name" : "Air Bank"
},
{
"id" : "260",
"name" : "Länsförsäkringar"
},
{
"id" : "240",
"name" : "BankDeposit"
},
{
"id" : "265",
"name" : "Sparbanken"
},
{
"id" : "640",
"name" : "BankDeposit"
},
{
"id" : "200",
"name" : "Ålandsbanken"
},
{
"id" : "940",
"name" : "Swedbank"
},
{
"id" : "500",
"name" : "Česká spořitelna"
},
{
"id" : "720",
"name" : "Swedbank"
},
{
"id" : "941",
"name" : "SEB"
},
{
"id" : "204",
"name" : "Danske Bank"
},
{
"id" : "721",
"name" : "SEB"
},
{
"id" : "942",
"name" : "Citadele"
},
{
"id" : "205",
"name" : "Handelsbanken"
},
{
"id" : "722",
"name" : "DNB"
},
{
"id" : "943",
"name" : "DNB"
},
{
"id" : "206",
"name" : "Nordea"
},
{
"id" : "723",
"name" : "Šiaulių bankas"
},
{
"id" : "207",
"name" : "SEB"
},
{
"id" : "724",
"name" : "Nordea"
},
{
"id" : "505",
"name" : "Komerční banka"
},
{
"id" : "208",
"name" : "Skandiabanken"
},
{
"id" : "209",
"name" : "Swedbank"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "Bank Payment",
"type" : "entercash"
},
{
"name" : "Nationale Entertainment Card",
"type" : "entertainmentcard"
},
{
"details" : [
{
"items" : [
{
"id" : "d5d5b133-1c0d-4c08-b2be-3c9b116dc326",
"name" : "Dolomitenbank"
},
{
"id" : "ee9fc487-ebe0-486c-8101-17dce5141a67",
"name" : "Raiffeissen Bankengruppe"
},
{
"id" : "6765e225-a0dc-4481-9666-e26303d4f221",
"name" : "Hypo Tirol Bank AG"
},
{
"id" : "8b0bfeea-fbb0-4337-b3a1-0e25c0f060fc",
"name" : "Sparda Bank Wien"
},
{
"id" : "1190c4d1-b37a-487e-9355-e0a067f54a9f",
"name" : "Schoellerbank AG"
},
{
"id" : "e2e97aaa-de4c-4e18-9431-d99790773433",
"name" : "Volksbank Gruppe"
},
{
"id" : "bb7d223a-17d5-48af-a6ef-8a2bf5a4e5d9",
"name" : "Immo-Bank"
},
{
"id" : "e6819e7a-f663-414b-92ec-cf7c82d2f4e5",
"name" : "Bank Austria"
},
{
"id" : "eff103e6-843d-48b7-a6e6-fbd88f511b11",
"name" : "Easybank AG"
},
{
"id" : "25942cc9-617d-42a1-89ba-d1ab5a05770a",
"name" : "VR-BankBraunau"
},
{
"id" : "4a0a975b-0594-4b40-9068-39f77b3a91f9",
"name" : "Volkskreditbank"
},
{
"id" : "3fdc41fc-3d3d-4ee3-a1fe-cd79cfd58ea3",
"name" : "Erste Bank und Sparkassen"
},
{
"id" : "ba7199cc-f057-42f2-9856-2378abf21638",
"name" : "BAWAG P.S.K. Gruppe"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "EPS",
"type" : "eps"
},
{
"name" : "Expert Cadeaukaart",
"type" : "expertgiftcard"
},
{
"details" : [
{
"details" : [
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"items" : [
{
"id" : "M",
"name" : "male"
},
{
"id" : "F",
"name" : "female"
}
],
"key" : "gender",
"type" : "radio"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
}
],
"key" : "personalDetails",
"type" : "fieldSet"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "FR",
"name" : "France"
},
{
"id" : "ES",
"name" : "Spain"
}
],
"key" : "country",
"type" : "select"
}
],
"key" : "billingAddress",
"type" : "address"
},
{
"key" : "separateDeliveryAddress",
"optional" : true,
"type" : "boolean",
"value" : "false"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "FR",
"name" : "France"
},
{
"id" : "ES",
"name" : "Spain"
}
],
"key" : "country",
"type" : "select"
}
],
"key" : "deliveryAddress",
"optional" : true,
"type" : "address"
}
],
"name" : "3x Oney",
"type" : "facilypay_3x"
},
{
"details" : [
{
"details" : [
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"items" : [
{
"id" : "M",
"name" : "male"
},
{
"id" : "F",
"name" : "female"
}
],
"key" : "gender",
"type" : "radio"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
}
],
"key" : "personalDetails",
"type" : "fieldSet"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "FR",
"name" : "France"
},
{
"id" : "ES",
"name" : "Spain"
}
],
"key" : "country",
"type" : "select"
}
],
"key" : "billingAddress",
"type" : "address"
},
{
"key" : "separateDeliveryAddress",
"optional" : true,
"type" : "boolean",
"value" : "false"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "FR",
"name" : "France"
},
{
"id" : "ES",
"name" : "Spain"
}
],
"key" : "country",
"type" : "select"
}
],
"key" : "deliveryAddress",
"optional" : true,
"type" : "address"
}
],
"name" : "4x Oney",
"type" : "facilypay_4x"
},
{
"name" : "Fashioncheque",
"type" : "fashioncheque"
},
{
"details" : [
{
"key" : "shopper.firstName",
"type" : "text"
},
{
"key" : "shopper.lastName",
"type" : "text"
},
{
"key" : "shopper.gender",
"type" : "text"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "countryCode",
"type" : "text"
}
],
"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"
},
{
"details" : [
{
"key" : "bic",
"type" : "text"
}
],
"name" : "GiroPay",
"type" : "giropay"
},
{
"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"
},
{
"details" : [
{
"items" : [
{
"id" : "1121",
"name" : "Test Issuer"
},
{
"id" : "1154",
"name" : "Test Issuer 5"
},
{
"id" : "1153",
"name" : "Test Issuer 4"
},
{
"id" : "1152",
"name" : "Test Issuer 3"
},
{
"id" : "1151",
"name" : "Test Issuer 2"
},
{
"id" : "1162",
"name" : "Test Issuer Cancelled"
},
{
"id" : "1161",
"name" : "Test Issuer Pending"
},
{
"id" : "1160",
"name" : "Test Issuer Refused"
},
{
"id" : "1159",
"name" : "Test Issuer 10"
},
{
"id" : "1158",
"name" : "Test Issuer 9"
},
{
"id" : "1157",
"name" : "Test Issuer 8"
},
{
"id" : "1156",
"name" : "Test Issuer 7"
},
{
"id" : "1155",
"name" : "Test Issuer 6"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "iDEAL",
"type" : "ideal"
},
{
"name" : "igive",
"type" : "igive"
},
{
"name" : "Korean Account Transfer (IniPay)",
"type" : "inicisIniPay_accounttransfer"
},
{
"name" : "Korean Credit Cards (IniPay)",
"type" : "inicisIniPay_creditcard"
},
{
"name" : "Korean Mobile Phone (IniPay)",
"type" : "inicisIniPay_mobilephone"
},
{
"name" : "Korean Virtual Account (IniPay)",
"type" : "inicisIniPay_virtualaccount"
},
{
"name" : "Korean Account Transfer (Mobile)",
"type" : "inicisMobile_accounttransfer"
},
{
"name" : "Korean Credit Cards (Mobile)",
"type" : "inicisMobile_creditcard"
},
{
"name" : "Korean Mobile Phone (Mobile)",
"type" : "inicisMobile_mobilephone"
},
{
"name" : "Korean Virtual Account (Mobile)",
"type" : "inicisMobile_virtualaccount"
},
{
"name" : "Korean Credit Cards",
"type" : "inicis_creditcard"
},
{
"name" : "Interac® Online",
"type" : "interac"
},
{
"name" : "Instant EFT",
"type" : "ipay"
},
{
"name" : "iPay88",
"type" : "ipay88"
},
{
"name" : "isracard",
"type" : "isracard"
},
{
"name" : "Phone Payment",
"type" : "ivr"
},
{
"name" : "Landline phone",
"type" : "ivrLandline"
},
{
"name" : "Mobile phone",
"type" : "ivrMobile"
},
{
"name" : "Kado Wereld",
"type" : "kadowereld"
},
{
"name" : "KakaoPay",
"type" : "kakaopay"
},
{
"name" : "Karen Millen Card",
"type" : "karenmillen"
},
{
"name" : "Karen Millen GiftCard",
"type" : "karenmillengiftcard"
},
{
"name" : "Bank Transfer",
"type" : "kcp_banktransfer"
},
{
"name" : "Korea–issued cards",
"type" : "kcp_creditcard"
},
{
"name" : "PayCo",
"type" : "kcp_payco"
},
{
"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" : "Klarna B2B",
"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"
},
{
"details" : [
{
"key" : "telephoneNumber",
"type" : "tel"
}
],
"name" : "China Online Banking - Credit Card",
"type" : "lianlianpay_ebanking_credit"
},
{
"details" : [
{
"items" : [
{
"id" : "01030000",
"name" : "Agricultural Bank of China"
},
{
"id" : "4031000",
"name" : "Bank of Beijing"
},
{
"id" : "01040000",
"name" : "Bank of China"
},
{
"id" : "03020000",
"name" : "China Citic Bank"
},
{
"id" : "01050000",
"name" : "China Construction Bank"
},
{
"id" : "03030000",
"name" : "China Everbright Bank"
},
{
"id" : "03080000",
"name" : "China Merchants Bank"
},
{
"id" : "03050000",
"name" : "China Minsheng Banking Group"
},
{
"id" : "03040000",
"name" : "Hua Xia Bank Co"
},
{
"id" : "01020000",
"name" : "Industrial and Commercial Bank of China"
},
{
"id" : "03070000",
"name" : "PingAn Bank"
},
{
"id" : "1000000",
"name" : "Postal Savings Bank of China"
}
],
"key" : "issuer",
"type" : "select"
},
{
"key" : "telephoneNumber",
"type" : "tel"
}
],
"name" : "China Online Banking - Debit Card",
"type" : "lianlianpay_ebanking_debit"
},
{
"details" : [
{
"items" : [
{
"id" : "01030000",
"name" : "Agricultural Bank of China"
},
{
"id" : "01050000",
"name" : "China Construction Bank"
},
{
"id" : "03080000",
"name" : "China Merchants Bank"
},
{
"id" : "01020000",
"name" : "Industrial and Commercial Bank of China"
},
{
"id" : "03100000",
"name" : "Shanghai Pudong Development Bank"
}
],
"key" : "issuer",
"type" : "select"
},
{
"key" : "telephoneNumber",
"type" : "tel"
}
],
"name" : "China Online Banking - Enterprise",
"type" : "lianlianpay_ebanking_enterprise"
},
{
"name" : "Loods5 Cadeaukaart",
"type" : "loods5giftcard"
},
{
"name" : "Loods5 Tegoedbon",
"type" : "loods5prepaidcard"
},
{
"name" : "Love2Shop GiftCard",
"type" : "love2shop"
},
{
"details" : [
{
"key" : "shopper.firstName",
"type" : "text"
},
{
"key" : "shopper.lastName",
"type" : "text"
},
{
"key" : "shopper.gender",
"type" : "text"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "countryCode",
"type" : "text"
}
],
"name" : "mada",
"type" : "mada"
},
{
"name" : "Mappin & Webb Card",
"type" : "mappinwebbcard"
},
{
"name" : "MB WAY",
"type" : "mbway"
},
{
"details" : [
{
"key" : "additionalData.amazonPayToken",
"type" : "text"
}
],
"name" : "Amazon Pay",
"supportsRecurring" : true,
"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"
},
{
"details" : [
{
"items" : [
{
"id" : "vtcpay-vietinbank",
"name" : "Vietinbank"
},
{
"id" : "vtcpay-bidv",
"name" : "BIDV"
},
{
"id" : "vtcpay-agribank",
"name" : "Agribank"
},
{
"id" : "vtcpay-mb",
"name" : "MB Bank"
},
{
"id" : "vtcpay-sacombank",
"name" : "Sacombank"
},
{
"id" : "vtcpay-dongabank",
"name" : "DongABank"
},
{
"id" : "vtcpay-maritimebank",
"name" : "MaritimeBank"
},
{
"id" : "vtcpay-vietcombank",
"name" : "Vietcombank"
},
{
"id" : "vtcpay-acb",
"name" : "ACB"
},
{
"id" : "vtcpay-techcombank",
"name" : "Techcombank"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "Vietnam E-Banking",
"type" : "molpay_ebanking_VN"
},
{
"details" : [
{
"items" : [
{
"id" : "fpx_bimb",
"name" : "Bank Islam"
},
{
"id" : "fpx_uob",
"name" : "UOB Bank"
},
{
"id" : "fpx_cimbclicks",
"name" : "CIMB Clicks"
},
{
"id" : "fpx_kfh",
"name" : "Kuwait Finance House"
},
{
"id" : "fpx_rhb",
"name" : "RHB Now"
},
{
"id" : "fpx_abmb",
"name" : "Alliance Bank"
},
{
"id" : "fpx_amb",
"name" : "Am Online"
},
{
"id" : "fpx_hsbc",
"name" : "HSBC"
},
{
"id" : "fpx_abb",
"name" : "Affin Bank"
},
{
"id" : "fpx_ocbc",
"name" : "OCBC Bank"
},
{
"id" : "fpx_pbb",
"name" : "Public Bank"
},
{
"id" : "fpx_scb",
"name" : "Standard Chartered Bank"
},
{
"id" : "fpx_bsn",
"name" : "Bank Simpanan Nasional"
},
{
"id" : "fpx_mb2u",
"name" : "Maybank2u"
},
{
"id" : "fpx_hlb",
"name" : "Hong Leong Connect"
},
{
"id" : "fpx_bmmb",
"name" : "Bank Muamalat"
},
{
"id" : "fpx_bkrm",
"name" : "Bank Rakyat"
}
],
"key" : "issuer",
"type" : "select"
}
],
"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" : "Tesco Lotus",
"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" : "Local Polish Payment Methods",
"type" : "onlineBanking_PL"
},
{
"details" : [
{
"items" : [
{
"id" : "1",
"name" : "Model Bank v2"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "Online banking",
"type" : "openbanking_UK"
},
{
"name" : "Oxxo",
"type" : "oxxo"
},
{
"name" : "Pathe Giftcard",
"type" : "pathegiftcard"
},
{
"name" : "PayBright",
"type" : "paybright"
},
{
"name" : "PayMaya 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"
},
{
"details" : [
{
"key" : "virtualPaymentAddress",
"type" : "text"
}
],
"name" : "PayU UPI",
"type" : "payu_IN_upi"
},
{
"name" : "EFT Pro via PayU",
"type" : "payu_ZA_eftpro"
},
{
"details" : [
{
"key" : "additionalData.paywithgoogle.token",
"type" : "payWithGoogleToken"
}
],
"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"
},
{
"details" : [
{
"items" : [
{
"id" : "+7",
"name" : "RU"
},
{
"id" : "+9955",
"name" : "GE"
},
{
"id" : "+507",
"name" : "PA"
},
{
"id" : "+44",
"name" : "GB"
},
{
"id" : "+992",
"name" : "TJ"
},
{
"id" : "+370",
"name" : "LT"
},
{
"id" : "+972",
"name" : "IL"
},
{
"id" : "+996",
"name" : "KG"
},
{
"id" : "+380",
"name" : "UA"
},
{
"id" : "+84",
"name" : "VN"
},
{
"id" : "+90",
"name" : "TR"
},
{
"id" : "+994",
"name" : "AZ"
},
{
"id" : "+374",
"name" : "AM"
},
{
"id" : "+371",
"name" : "LV"
},
{
"id" : "+91",
"name" : "IN"
},
{
"id" : "+66",
"name" : "TH"
},
{
"id" : "+373",
"name" : "MD"
},
{
"id" : "+1",
"name" : "US"
},
{
"id" : "+81",
"name" : "JP"
},
{
"id" : "+998",
"name" : "UZ"
},
{
"id" : "+77",
"name" : "KZ"
},
{
"id" : "+375",
"name" : "BY"
},
{
"id" : "+372",
"name" : "EE"
},
{
"id" : "+40",
"name" : "RO"
},
{
"id" : "+82",
"name" : "KR"
}
],
"key" : "qiwiwallet.telephoneNumberPrefix",
"type" : "select"
},
{
"key" : "qiwiwallet.telephoneNumber",
"type" : "text"
}
],
"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"
},
{
"details" : [
{
"key" : "sepa.ownerName",
"type" : "text"
},
{
"key" : "sepa.ibanNumber",
"type" : "text"
}
],
"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" : "Trustly",
"type" : "trustly"
},
{
"name" : "Online Banking by Trustpay",
"type" : "trustpay"
},
{
"name" : "TWINT",
"type" : "twint"
},
{
"name" : "Ukash",
"type" : "ukash"
},
{
"name" : "UnionPay",
"type" : "unionpay"
},
{
"details" : [
{
"key" : "virtualPaymentAddress",
"type" : "text"
}
],
"name" : "UPI Collect",
"type" : "upi_collect"
},
{
"name" : "Valuelink",
"type" : "valuelink"
},
{
"name" : "V&D Cadeaukaart",
"type" : "vdcadeaucard"
},
{
"details" : [
{
"key" : "telephoneNumber",
"optional" : true,
"type" : "tel"
}
],
"name" : "Vipps",
"type" : "vipps"
},
{
"details" : [
{
"key" : "additionalData.visacheckout.callId",
"type" : "text"
}
],
"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" : "Sberbank Online",
"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" : "Example response for request 'filtered'",
"value" : {
"paymentMethods" : [
{
"details" : [
{
"items" : [
{
"id" : "1121",
"name" : "Test Issuer"
},
{
"id" : "1154",
"name" : "Test Issuer 5"
},
{
"id" : "1153",
"name" : "Test Issuer 4"
},
{
"id" : "1152",
"name" : "Test Issuer 3"
},
{
"id" : "1151",
"name" : "Test Issuer 2"
},
{
"id" : "1162",
"name" : "Test Issuer Cancelled"
},
{
"id" : "1161",
"name" : "Test Issuer Pending"
},
{
"id" : "1160",
"name" : "Test Issuer Refused"
},
{
"id" : "1159",
"name" : "Test Issuer 10"
},
{
"id" : "1158",
"name" : "Test Issuer 9"
},
{
"id" : "1157",
"name" : "Test Issuer 8"
},
{
"id" : "1156",
"name" : "Test Issuer 7"
},
{
"id" : "1155",
"name" : "Test Issuer 6"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "iDEAL",
"type" : "ideal"
},
{
"details" : [
{
"key" : "encryptedCardNumber",
"type" : "cardToken"
},
{
"key" : "encryptedSecurityCode",
"type" : "cardToken"
},
{
"key" : "encryptedExpiryMonth",
"type" : "cardToken"
},
{
"key" : "encryptedExpiryYear",
"type" : "cardToken"
},
{
"key" : "holderName",
"optional" : true,
"type" : "text"
}
],
"name" : "Hitelkártya",
"type" : "scheme"
},
{
"name" : "PayPal",
"type" : "paypal"
},
{
"details" : [
{
"details" : [
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"items" : [
{
"id" : "M",
"name" : "male"
},
{
"id" : "F",
"name" : "female"
}
],
"key" : "gender",
"type" : "radio"
},
{
"key" : "dateOfBirth",
"type" : "date"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
}
],
"key" : "personalDetails",
"type" : "fieldSet"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "NL",
"name" : "Netherlands"
},
{
"id" : "BE",
"name" : "Belgium"
}
],
"key" : "country",
"type" : "select",
"value" : "NL"
}
],
"key" : "billingAddress",
"type" : "address"
},
{
"key" : "separateDeliveryAddress",
"optional" : true,
"type" : "boolean",
"value" : "false"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "NL",
"name" : "Netherlands"
},
{
"id" : "BE",
"name" : "Belgium"
}
],
"key" : "country",
"type" : "select",
"value" : "NL"
}
],
"key" : "deliveryAddress",
"optional" : true,
"type" : "address"
}
],
"name" : "AfterPay Invoice",
"type" : "afterpay_default"
},
{
"name" : "Pay later with Klarna.",
"type" : "klarna"
},
{
"details" : [
{
"key" : "sepa.ownerName",
"type" : "text"
},
{
"key" : "sepa.ibanNumber",
"type" : "text"
}
],
"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"
},
{
"details" : [
{
"key" : "additionalData.androidpay.token",
"type" : "androidPayToken"
}
],
"name" : "Android Pay",
"type" : "androidpay"
},
{
"details" : [
{
"key" : "additionalData.applepay.token",
"type" : "applePayToken"
}
],
"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"
},
{
"details" : [
{
"key" : "additionalData.amazonPayToken",
"type" : "text"
}
],
"name" : "Amazon Pay",
"supportsRecurring" : true,
"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"
},
{
"details" : [
{
"key" : "additionalData.paywithgoogle.token",
"type" : "payWithGoogleToken"
}
],
"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"
},
{
"details" : [
{
"key" : "additionalData.visacheckout.callId",
"type" : "text"
}
],
"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-oneclick" : {
"summary" : "Get payment methods including stored card details",
"value" : {
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"countryCode" : "NL",
"amount" : {
"currency" : "EUR",
"value" : 1000
},
"shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j"
}
},
"post-paymentMethods-include-oneclick-200" : {
"summary" : "Example response for request 'include-oneclick'",
"value" : {
"paymentMethods" : [
{
"details" : [
{
"items" : [
{
"id" : "1121",
"name" : "Test Issuer"
},
{
"id" : "1154",
"name" : "Test Issuer 5"
},
{
"id" : "1153",
"name" : "Test Issuer 4"
},
{
"id" : "1152",
"name" : "Test Issuer 3"
},
{
"id" : "1151",
"name" : "Test Issuer 2"
},
{
"id" : "1162",
"name" : "Test Issuer Cancelled"
},
{
"id" : "1161",
"name" : "Test Issuer Pending"
},
{
"id" : "1160",
"name" : "Test Issuer Refused"
},
{
"id" : "1159",
"name" : "Test Issuer 10"
},
{
"id" : "1158",
"name" : "Test Issuer 9"
},
{
"id" : "1157",
"name" : "Test Issuer 8"
},
{
"id" : "1156",
"name" : "Test Issuer 7"
},
{
"id" : "1155",
"name" : "Test Issuer 6"
}
],
"key" : "issuer",
"type" : "select"
}
],
"name" : "iDEAL",
"type" : "ideal"
},
{
"details" : [
{
"key" : "encryptedCardNumber",
"type" : "cardToken"
},
{
"key" : "encryptedSecurityCode",
"type" : "cardToken"
},
{
"key" : "encryptedExpiryMonth",
"type" : "cardToken"
},
{
"key" : "encryptedExpiryYear",
"type" : "cardToken"
},
{
"key" : "holderName",
"optional" : true,
"type" : "text"
}
],
"name" : "Credit Card",
"type" : "scheme"
},
{
"name" : "PayPal",
"type" : "paypal"
},
{
"details" : [
{
"details" : [
{
"key" : "firstName",
"type" : "text"
},
{
"key" : "lastName",
"type" : "text"
},
{
"items" : [
{
"id" : "M",
"name" : "male"
},
{
"id" : "F",
"name" : "female"
}
],
"key" : "gender",
"type" : "radio"
},
{
"key" : "dateOfBirth",
"type" : "date"
},
{
"key" : "telephoneNumber",
"type" : "tel"
},
{
"key" : "shopperEmail",
"type" : "emailAddress"
}
],
"key" : "personalDetails",
"type" : "fieldSet"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "NL",
"name" : "Netherlands"
},
{
"id" : "BE",
"name" : "Belgium"
}
],
"key" : "country",
"type" : "select",
"value" : "NL"
}
],
"key" : "billingAddress",
"type" : "address"
},
{
"key" : "separateDeliveryAddress",
"optional" : true,
"type" : "boolean",
"value" : "false"
},
{
"details" : [
{
"key" : "street",
"type" : "text"
},
{
"key" : "houseNumberOrName",
"type" : "text"
},
{
"key" : "city",
"type" : "text"
},
{
"key" : "postalCode",
"type" : "text"
},
{
"key" : "stateOrProvince",
"optional" : true,
"type" : "text"
},
{
"items" : [
{
"id" : "NL",
"name" : "Netherlands"
},
{
"id" : "BE",
"name" : "Belgium"
}
],
"key" : "country",
"type" : "select",
"value" : "NL"
}
],
"key" : "deliveryAddress",
"optional" : true,
"type" : "address"
}
],
"name" : "AfterPay Invoice",
"type" : "afterpay_default"
},
{
"name" : "Pay later with Klarna.",
"type" : "klarna"
},
{
"details" : [
{
"key" : "sepa.ownerName",
"type" : "text"
},
{
"key" : "sepa.ibanNumber",
"type" : "text"
}
],
"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"
},
{
"details" : [
{
"key" : "additionalData.androidpay.token",
"type" : "androidPayToken"
}
],
"name" : "Android Pay",
"type" : "androidpay"
},
{
"details" : [
{
"key" : "additionalData.applepay.token",
"type" : "applePayToken"
}
],
"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"
},
{
"details" : [
{
"key" : "additionalData.amazonPayToken",
"type" : "text"
}
],
"name" : "Amazon Pay",
"supportsRecurring" : true,
"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"
},
{
"details" : [
{
"key" : "additionalData.paywithgoogle.token",
"type" : "payWithGoogleToken"
}
],
"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"
},
{
"details" : [
{
"key" : "additionalData.visacheckout.callId",
"type" : "text"
}
],
"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-paymentSession-android" : {
"summary" : "Set up a payment session (Android)",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 17408
},
"reference" : "Your order number",
"shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
"channel" : "Android",
"token" : "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
"returnUrl" : "app://",
"countryCode" : "NL",
"shopperLocale" : "nl_NL",
"sessionValidity" : "2017-04-06T13:09:13Z",
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-paymentSession-enableOneClick" : {
"summary" : "Set up a payment session with the option to store card details",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 17408
},
"reference" : "Your order number",
"shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
"enableOneClick" : true,
"enableRecurring" : true,
"channel" : "Web",
"html" : true,
"origin" : "https://www.yourwebsite.com",
"returnUrl" : "https://www.yourshop.com/checkout/result",
"countryCode" : "NL",
"shopperLocale" : "nl_NL",
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT",
"sdkVersion" : "1.7.0"
}
},
"post-paymentSession-enableOneClick-200" : {
"summary" : "Example response for request 'enableOneClick'",
"value" : {
"paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..."
}
},
"post-paymentSession-ios" : {
"summary" : "Set up a payment session (iOS)",
"value" : {
"amount" : {
"currency" : "EUR",
"value" : 17408
},
"reference" : "Your order number",
"shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
"channel" : "iOS",
"token" : "TOKEN_YOU_GET_FROM_CHECKOUT_SDK",
"returnUrl" : "app://",
"countryCode" : "NL",
"shopperLocale" : "nl_NL",
"sessionValidity" : "2017-04-06T13:09:13Z",
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-paymentSession-web-200" : {
"summary" : "Example response for request 'web'",
"value" : {
"paymentSession" : "eyJjaGVja291dHNob3BwZXJCYXN..."
}
},
"post-payments-card-3d-secure-2-web" : {
"summary" : "Make a card payment with 3D Secure 2 native authentication",
"value" : {
"amount" : {
"currency" : "USD",
"value" : 1000
},
"reference" : "YOUR_ORDER_NUMBER",
"paymentMethod" : {
"type" : "scheme",
"number" : "4917610000000000",
"expiryMonth" : "03",
"expiryYear" : "2030",
"holderName" : "John Smith",
"cvc" : "737"
},
"additionalData" : {
"allow3DS2" : true
},
"accountInfo" : {
"accountCreationDate" : "2019-01-17T13:42:40+01:00"
},
"billingAddress" : {
"country" : "US",
"city" : "New York",
"street" : "Redwood Block",
"houseNumberOrName" : "37C",
"stateOrProvince" : "NY",
"postalCode" : "10039"
},
"shopperEmail" : "s.hopper@test.com",
"shopperIP" : "192.0.2.1",
"browserInfo" : {
"userAgent" : "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"acceptHeader" : "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,image/apng,*/*;q=0.8",
"language" : "nl-NL",
"colorDepth" : 24,
"screenHeight" : 723,
"screenWidth" : 1536,
"timeZoneOffset" : 0,
"javaEnabled" : true
},
"channel" : "web",
"origin" : "https://your-company.com",
"returnUrl" : "https://your-company.com/checkout/",
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-payments-card-3d-secure-direct" : {
"summary" : "Make 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"
},
"returnUrl" : "https://your-company.com/...",
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"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",
"gender" : "UNKNOWN",
"lastName" : "Approved"
},
"shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
"billingAddress" : {
"city" : "Ankeborg",
"country" : "SE",
"houseNumberOrName" : "1",
"postalCode" : "12345",
"street" : "Stargatan"
},
"deliveryAddress" : {
"city" : "Ankeborg",
"country" : "SE",
"houseNumberOrName" : "1",
"postalCode" : "12345",
"street" : "Stargatan"
},
"returnUrl" : "https://www.your-company.com/...",
"lineItems" : [
{
"quantity" : "1",
"amountExcludingTax" : "331",
"taxPercentage" : "2100",
"description" : "Shoes",
"id" : "Item #1",
"taxAmount" : "69",
"amountIncludingTax" : "400",
"productUrl" : "URL_TO_PURCHASED_ITEM",
"imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM"
},
{
"quantity" : "2",
"amountExcludingTax" : "248",
"taxPercentage" : "2100",
"description" : "Socks",
"id" : "Item #2",
"taxAmount" : "52",
"amountIncludingTax" : "300",
"productUrl" : "URL_TO_PURCHASED_ITEM",
"imageUrl" : "URL_TO_PICTURE_OF_PURCHASED_ITEM"
}
]
}
},
"post-payments-oneclick-direct" : {
"summary" : "Make a one-off payment with a token and CVV",
"value" : {
"amount" : {
"currency" : "USD",
"value" : 1000
},
"reference" : "Your order number",
"paymentMethod" : {
"type" : "scheme",
"storedPaymentMethodId" : "8416038790273850",
"cardDetails.cvc" : "737"
},
"shopperReference" : "YOUR_UNIQUE_SHOPPER_ID_6738oneoff",
"returnUrl" : "https://your-company.com/...",
"merchantAccount" : "YOUR_MERCHANT_ACCOUNT"
}
},
"post-payments-result-basic" : {
"summary" : "Verify payment results",
"value" : {
"payload" : "VALUE_YOU_GET_FROM_CHECKOUT_SDK"
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink