openapi: 3.1.0 info: version: '6' x-publicVersion: true title: Adyen Account acceptDispute Session API description: "This API is used for the classic integration. If you are just starting your implementation, refer to our [new integration guide](https://docs.adyen.com/marketplaces-and-platforms) instead.\n\nThe Account API provides endpoints for managing account-related entities on your platform. These related entities include account holders, accounts, bank accounts, shareholders, and verification-related documents. The management operations include actions such as creation, retrieval, updating, and deletion of them.\n\nFor more information, refer to our [documentation](https://docs.adyen.com/marketplaces-and-platforms/classic).\n## Authentication\nYour Adyen contact will provide your API credential and an API key. To connect to the API, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"ws@MarketPlace.YOUR_PLATFORM_ACCOUNT\":\"YOUR_WS_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nWhen going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Account API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://cal-test.adyen.com/cal/services/Account/v6/createAccountHolder\n```" x-timestamp: '2023-05-30T15:27:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi servers: - url: https://cal-test.adyen.com/cal/services/Account/v6 tags: - name: Session paths: /paymentSession: post: tags: - Session summary: Adyen Create a Payment Session description: 'Provides the data object that can be used to start the Checkout SDK. To set up the payment, pass its amount, currency, and other required parameters. We use this to optimise the payment flow and perform better risk assessment of the transaction. For more information, refer to [How it works](https://docs.adyen.com/online-payments#howitworks).' deprecated: true x-deprecatedInVersion: '37' operationId: post-paymentSession x-sortIndex: 1 x-methodName: paymentSession security: - BasicAuth: [] - ApiKeyAuth: [] requestBody: content: application/json: examples: android: $ref: '#/components/examples/post-paymentSession-android' enableOneClick: $ref: '#/components/examples/post-paymentSession-enableOneClick' ios: $ref: '#/components/examples/post-paymentSession-ios' split: $ref: '#/components/examples/post-paymentSession-split' web: $ref: '#/components/examples/post-paymentSession-web' schema: $ref: '#/components/schemas/PaymentSetupRequest' parameters: - $ref: '#/components/parameters/Idempotency-Key' responses: '200': content: application/json: examples: enableOneClick: $ref: '#/components/examples/post-paymentSession-enableOneClick-200' web: $ref: '#/components/examples/post-paymentSession-web-200' schema: $ref: '#/components/schemas/PaymentSetupResponse' description: OK - the request has succeeded. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' '400': content: application/json: examples: generic: $ref: '#/components/examples/generic-400' schema: $ref: '#/components/schemas/ServiceError' description: Bad Request - a problem reading or understanding the request. '401': content: application/json: examples: generic: $ref: '#/components/examples/generic-401' schema: $ref: '#/components/schemas/ServiceError' description: Unauthorized - authentication required. '403': content: application/json: examples: generic: $ref: '#/components/examples/generic-403' schema: $ref: '#/components/schemas/ServiceError' description: Forbidden - insufficient permissions to process the request. '422': content: application/json: examples: generic: $ref: '#/components/examples/generic-422' schema: $ref: '#/components/schemas/ServiceError' description: Unprocessable Entity - a request validation error. headers: Idempotency-Key: $ref: '#/components/headers/Idempotency-Key' '500': content: application/json: examples: generic: $ref: '#/components/examples/generic-500' schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. x-microcks-operation: delay: 0 dispatcher: FALLBACK /sessions/{sessionId}: get: tags: - Session summary: Adyen Get the Result of a Payment Session description: Returns the status of the payment session with the `sessionId` and `sessionResult` specified in the path. x-addedInVersion: '68' operationId: get-sessions-sessionId x-sortIndex: 2 x-methodName: getResultOfPaymentSession security: - BasicAuth: [] - ApiKeyAuth: [] parameters: - description: A unique identifier of the session. name: sessionId in: path required: true schema: type: string - description: The `sessionResult` value from the Drop-in or Component. name: sessionResult in: query required: true schema: type: string responses: '200': content: application/json: examples: success: $ref: '#/components/examples/get-sessions-sessionId-success-200' schema: $ref: '#/components/schemas/SessionResultResponse' description: OK - the request has succeeded. x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: RecurringDetail: properties: brand: x-addedInVersion: '65' description: 'Brand for the selected gift card. For example: plastix, hmclub.' type: string brands: x-addedInVersion: '49' description: 'List of possible brands. For example: visa, mc.' items: type: string type: array configuration: additionalProperties: type: string description: The configuration of the payment method. type: object fundingSource: x-addedInVersion: '53' description: The funding source of the payment method. enum: - credit - debit type: string group: description: The group where this payment method belongs to. $ref: '#/components/schemas/PaymentMethodGroup' inputDetails: deprecated: true description: All input details to be provided to complete the payment with this payment method. items: $ref: '#/components/schemas/InputDetail' type: array issuers: x-addedInVersion: '68' description: A list of issuers for this payment method. items: $ref: '#/components/schemas/PaymentMethodIssuer' type: array name: description: The displayable name of this payment method. type: string recurringDetailReference: description: The reference that uniquely identifies the recurring detail. type: string storedDetails: description: Contains information on previously stored payment details. $ref: '#/components/schemas/StoredDetails' type: description: The unique payment method code. type: string type: object PaymentMethodGroup: properties: name: description: The name of the group. type: string paymentMethodData: description: Echo data to be used if the payment method is displayed as part of this group. type: string type: description: The unique code of the group. type: string type: object LineItem: properties: amountExcludingTax: description: Item amount excluding the tax, in minor units. format: int64 type: integer amountIncludingTax: description: Item amount including the tax, in minor units. format: int64 type: integer brand: x-addedInVersion: '70' description: Brand of the item. type: string color: x-addedInVersion: '70' description: Color of the item. type: string description: description: Description of the line item. type: string id: description: ID of the line item. type: string imageUrl: description: Link to the picture of the purchased item. type: string itemCategory: description: Item category, used by the payment methods PayPal and Ratepay. type: string manufacturer: x-addedInVersion: '70' description: Manufacturer of the item. type: string productUrl: description: Link to the purchased item. type: string quantity: description: Number of items. format: int64 type: integer receiverEmail: x-addedInVersion: '70' description: Email associated with the given product in the basket (usually in electronic gift cards). type: string size: x-addedInVersion: '70' description: Size of the item. type: string sku: x-addedInVersion: '70' description: Stock keeping unit. type: string taxAmount: description: Tax amount, in minor units. format: int64 type: integer taxPercentage: description: Tax percentage, in minor units. format: int64 type: integer upc: x-addedInVersion: '70' description: Universal Product Code. type: string type: object ForexQuote: properties: account: description: The account name. type: string accountType: description: The account type. type: string baseAmount: description: The base amount. $ref: '#/components/schemas/Amount' basePoints: description: The base points. format: int32 type: integer buy: description: The buy rate. $ref: '#/components/schemas/Amount' interbank: description: The interbank amount. $ref: '#/components/schemas/Amount' reference: description: The reference assigned to the forex quote request. type: string sell: description: The sell rate. $ref: '#/components/schemas/Amount' signature: description: The signature to validate the integrity. type: string source: description: The source of the forex quote. type: string type: description: The type of forex. type: string validTill: description: The date until which the forex quote is valid. format: date-time type: string required: - validTill - basePoints type: object Installments: properties: plan: x-addedInVersion: '64' description: 'The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values: * **regular** * **revolving** ' enum: - regular - revolving type: string value: description: 'Defines the number of installments. Its value needs to be greater than zero. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary.' format: int32 type: integer required: - value type: object AdditionalDataRiskStandalone: properties: PayPal.CountryCode: description: Shopper's country of residence in the form of ISO standard 3166 2-character country codes. type: string PayPal.EmailId: description: Shopper's email. type: string PayPal.FirstName: description: Shopper's first name. type: string PayPal.LastName: description: Shopper's last name. type: string PayPal.PayerId: description: 'Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters.' type: string PayPal.Phone: description: Shopper's phone number. type: string PayPal.ProtectionEligibility: description: 'Allowed values: * **Eligible** Merchant is protected by PayPal''s Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** Merchant is protected by PayPal''s Seller Protection Policy for Item Not Received. * **Ineligible** Merchant is not protected under the Seller Protection Policy.' type: string PayPal.TransactionId: description: Unique transaction ID of the payment. type: string avsResultRaw: description: 'Raw AVS result received from the acquirer, where available. Example: D' type: string bin: description: The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). type: string cvcResultRaw: description: 'Raw CVC result received from the acquirer, where available. Example: 1' type: string riskToken: description: Unique identifier or token for the shopper's card details. type: string threeDAuthenticated: description: 'A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true' type: string threeDOffered: description: 'A Boolean value indicating whether 3DS was offered for this payment. Example: true' type: string tokenDataType: description: 'Required for PayPal payments only. The only supported value is: **paypal**.' type: string type: object PaymentSetupRequest: properties: additionalAmount: description: 'If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while the amount must be still set to 0 to trigger BIN or card verification). Required to be in the same currency as the `amount`. ' $ref: '#/components/schemas/Amount' additionalData: additionalProperties: type: string x-anyOf: - $ref: '#/components/schemas/AdditionalData3DSecure' - $ref: '#/components/schemas/AdditionalDataAirline' - $ref: '#/components/schemas/AdditionalDataCarRental' - $ref: '#/components/schemas/AdditionalDataCommon' - $ref: '#/components/schemas/AdditionalDataLevel23' - $ref: '#/components/schemas/AdditionalDataLodging' - $ref: '#/components/schemas/AdditionalDataOpenInvoice' - $ref: '#/components/schemas/AdditionalDataOpi' - $ref: '#/components/schemas/AdditionalDataRatepay' - $ref: '#/components/schemas/AdditionalDataRetry' - $ref: '#/components/schemas/AdditionalDataRisk' - $ref: '#/components/schemas/AdditionalDataRiskStandalone' - $ref: '#/components/schemas/AdditionalDataSubMerchant' - $ref: '#/components/schemas/AdditionalDataTemporaryServices' - $ref: '#/components/schemas/AdditionalDataWallets' description: 'This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value.' type: object allowedPaymentMethods: x-addedInVersion: '33' description: 'List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"allowedPaymentMethods":["ideal","giropay"]`' items: type: string type: array amount: description: The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) requests, set amount to 0 (zero). $ref: '#/components/schemas/Amount' applicationInfo: x-addedInVersion: '40' description: Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). $ref: '#/components/schemas/ApplicationInfo' billingAddress: x-addedInVersion: '4' description: 'The address where to send the invoice. > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object. >* For 3D Secure 2 transactions in all browser-based and mobile implementations. >* For cross-border payouts to and from Canada.' $ref: '#/components/schemas/Address' blockedPaymentMethods: x-addedInVersion: '33' description: 'List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"blockedPaymentMethods":["ideal","giropay"]`' items: type: string type: array captureDelayHours: x-addedInVersion: '2' description: The delay between the authorisation and scheduled auto-capture, specified in hours. format: int32 type: integer channel: description: 'The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web' enum: - iOS - Android - Web type: string checkoutAttemptId: x-addedInVersion: '68' description: Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. type: string company: x-addedInVersion: '32' description: Information regarding the company. $ref: '#/components/schemas/Company' configuration: description: Specify configurations to enable additional features. $ref: '#/components/schemas/Configuration' conversionId: x-addedInVersion: '49' deprecated: true x-deprecatedInVersion: '68' x-deprecatedMessage: Use `checkoutAttemptId` instead description: Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. type: string countryCode: description: 'The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE' type: string dateOfBirth: x-addedInVersion: '7' description: 'The shopper''s date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD' format: date type: string dccQuote: description: The forex quote as returned in the response of the forex service. $ref: '#/components/schemas/ForexQuote' deliveryAddress: description: The address where the purchased goods should be delivered. $ref: '#/components/schemas/Address' deliveryDate: x-addedInVersion: '8' description: 'The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00' format: date-time type: string enableOneClick: x-addedInVersion: '32' description: When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments. type: boolean enablePayOut: x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for payouts. type: boolean enableRecurring: x-addedInVersion: '32' description: When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. type: boolean entityType: x-addedInVersion: '24' description: The type of the entity the payment is processed for. enum: - NaturalPerson - CompanyName type: string fraudOffset: description: An integer value that is added to the normal fraud score. The value can be either positive or negative. format: int32 type: integer installments: x-addedInVersion: '4' description: Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/Installments' lineItems: x-addedInVersion: '32' description: 'Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip.' items: $ref: '#/components/schemas/LineItem' type: array localizedShopperStatement: x-addedInVersion: '68' additionalProperties: type: string description: "The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.\nIf not supplied, left empty, or for cross-border transactions, **shopperStatement** is used.\n\nAdyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports:\n\n* UTF-8 based Katakana, capital letters, numbers and special characters. \n* Half-width or full-width characters." type: object mandate: description: The mandate details to initiate recurring transaction. $ref: '#/components/schemas/Mandate' mcc: x-addedInVersion: '12' description: The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. type: string merchantAccount: description: The merchant account identifier, with which you want to process the transaction. type: string merchantOrderReference: x-addedInVersion: '9' description: 'This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`.' type: string metadata: x-addedInVersion: '17' additionalProperties: type: string description: 'Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". * Maximum 20 characters per key. * Maximum 80 characters per value. ' type: object orderReference: description: When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. type: string origin: description: 'Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from.' type: string platformChargebackLogic: x-addedInVersion: '68' description: Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). $ref: '#/components/schemas/PlatformChargebackLogic' recurringExpiry: description: Date after which no further authorisations shall be performed. Only for 3D Secure 2. type: string recurringFrequency: description: Minimum number of days between authorisations. Only for 3D Secure 2. type: string reference: description: 'The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.' type: string returnUrl: description: 'The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`' maxLength: 8000 type: string riskData: description: Contains risk data, such as client-side data, used to identify risk for a transaction. $ref: '#/components/schemas/RiskData' sdkVersion: x-addedInVersion: '32' description: The version of the SDK you are using (for Web SDK integrations only). type: string sessionValidity: description: 'The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00' type: string shopperEmail: description: 'The shopper''s email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.' type: string shopperIP: description: 'The shopper''s IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).' type: string shopperInteraction: description: 'Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal.' enum: - Ecommerce - ContAuth - Moto - POS type: string shopperLocale: x-addedInVersion: '7' description: The combination of a language code and a country code to specify the language to be used in the payment. type: string shopperName: x-addedInVersion: '7' description: The shopper's full name. $ref: '#/components/schemas/Name' shopperReference: description: "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address." type: string shopperStatement: description: "The text to be shown on the shopper's bank statement.\n We recommend sending a maximum of 22 characters, otherwise banks might truncate the string.\n Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**." type: string socialSecurityNumber: x-addedInVersion: '4' description: The shopper's social security number. type: string splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/marketplaces-and-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. maxLength: 16 minLength: 1 type: string storePaymentMethod: x-addedInVersion: '49' description: When true and `shopperReference` is provided, the payment details will be stored. type: boolean telephoneNumber: x-addedInVersion: '7' description: The shopper's telephone number. type: string threeDSAuthenticationOnly: x-addedInVersion: '50' deprecated: true x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.authenticationOnly` instead. default: false description: If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. type: boolean token: description: 'The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web.' type: string trustedShopper: x-addedInVersion: '37' description: Set to true if the payment should be routed to a trusted MID. type: boolean required: - merchantAccount - reference - amount - returnUrl - countryCode type: object AdditionalDataLodging: properties: lodging.checkInDate: description: 'The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.' type: string lodging.checkOutDate: description: 'The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**.' type: string lodging.customerServiceTollFreeNumber: description: 'The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros.' type: string lodging.fireSafetyActIndicator: description: 'Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be ''Y'' or ''N''. * Format: alphabetic * Max length: 1 character' type: string lodging.folioCashAdvances: description: 'The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters' type: string lodging.folioNumber: description: 'The card acceptors internal invoice or billing ID reference number. * Max length: 25 characters. * Must not start with a space *Must not be all zeros.' type: string lodging.foodBeverageCharges: description: 'Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters' type: string lodging.noShowIndicator: description: "Indicates if the customer didn't check in for their booking.\n Possible values: \n* **Y**: the customer didn't check in \n* **N**: the customer checked in" type: string lodging.prepaidExpenses: description: 'The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters' type: string lodging.propertyPhoneNumber: description: 'The lodging property location''s phone number. * Format: numeric. * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros.' type: string lodging.room1.numberOfNights: description: 'The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number' type: string lodging.totalRoomTax: description: 'The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number' type: string lodging.totalTax: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number' type: string travelEntertainmentAuthData.duration: description: 'The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. Must be ''H'' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character' type: string type: object Item: properties: id: description: The value to provide in the result. type: string name: description: The display name. type: string type: object AdditionalDataCarRental: properties: carRental.checkOutDate: description: 'The pick-up date. * Date format: `yyyyMMdd`' type: string carRental.customerServiceTollFreeNumber: description: 'The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros.' type: string carRental.daysRented: description: 'Number of days for which the car is being rented. * Format: Numeric * maxLength: 4 * Must not be all spaces' type: string carRental.fuelCharges: description: 'Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12' type: string carRental.insuranceCharges: description: 'Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12 * Must not be all spaces *Must not be all zeros.' type: string carRental.locationCity: description: 'The city where the car is rented. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.locationCountry: description: 'The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2' type: string carRental.locationStateProvince: description: 'The state or province where the car is rented. * Format: Alphanumeric * maxLength: 2 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.noShowIndicator: description: 'Indicates if the customer didn''t pick up their rental car. * Y - Customer did not pick up their car * N - Not applicable' type: string carRental.oneWayDropOffCharges: description: 'The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 12' type: string carRental.rate: description: 'The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Alphanumeric * maxLength: 12' type: string carRental.rateIndicator: description: 'Specifies whether the given rate is applied daily or weekly. * D - Daily rate * W - Weekly rate' type: string carRental.rentalAgreementNumber: description: 'The rental agreement number for the car rental. * Format: Alphanumeric * maxLength: 9 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.rentalClassId: description: 'The classification of the rental car. * Format: Alphanumeric * maxLength: 4 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.renterName: description: 'The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 * If you send more than 26 characters, the name is truncated * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.returnCity: description: 'The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.returnCountry: description: 'The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2' type: string carRental.returnDate: description: 'The last date to return the car by. * Date format: `yyyyMMdd` * maxLength: 8' type: string carRental.returnLocationId: description: 'The agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.returnStateProvince: description: 'The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 * Must not start with a space or be all spaces *Must not be all zeros.' type: string carRental.taxExemptIndicator: description: 'Indicates if the goods or services were tax-exempt, or if tax was not paid on them. Values: * Y - Goods or services were tax exempt * N - Tax was not collected' type: string travelEntertainmentAuthData.duration: description: 'Number of days the car is rented for. This should be included in the auth message. * Format: Numeric * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or is being submitted. Value should be ''A'' for car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1' type: string type: object AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: description: 'The customer code. * Encoding: ASCII * Max length: 25 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.destinationCountryCode: description: 'The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. * Encoding: ASCII * Fixed length: 3 characters' type: string enhancedSchemeData.destinationPostalCode: description: 'The postal code of the destination address. * Encoding: ASCII * Max length: 10 characters * Must not start with a space' type: string enhancedSchemeData.destinationStateProvinceCode: description: 'Destination state or province code. * Encoding: ASCII * Max length: 3 characters * Must not start with a space' type: string enhancedSchemeData.dutyAmount: description: 'The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters' type: string enhancedSchemeData.freightAmount: description: 'The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric *Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].commodityCode: description: 'The [UNSPC commodity code](https://www.unspsc.org/) of the item. * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].description: description: 'A description of the item. * Encoding: ASCII * Max length: 26 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].discountAmount: description: 'The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters' type: string enhancedSchemeData.itemDetailLine[itemNr].productCode: description: 'The product code. * Encoding: ASCII. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].quantity: description: 'The number of items. Must be an integer greater than zero. * Encoding: Numeric * Max length: 12 characters * Must not start with a space or be all spaces ' type: string enhancedSchemeData.itemDetailLine[itemNr].totalAmount: description: 'The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitOfMeasure: description: 'The unit of measurement for an item. * Encoding: ASCII Max length: 3 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.itemDetailLine[itemNr].unitPrice: description: 'The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters * Must not be all zeros.' type: string enhancedSchemeData.orderDate: description: 'The order date. * Format: `ddMMyy` * Encoding: ASCII * Max length: 6 characters' type: string enhancedSchemeData.shipFromPostalCode: description: 'The postal code of the address the item is shipped from. * Encoding: ASCII * Max length: 10 characters * Must not start with a space or be all spaces * Must not be all zeros.' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. *Encoding: Numeric *Max length: 12 characters * Must not be all zeros.' type: string type: object ApplicationInfo: properties: adyenLibrary: description: Adyen-developed software, such as libraries and plugins, used to interact with the Adyen API. For example, Magento plugin, Java API library, etc. $ref: '#/components/schemas/CommonField' adyenPaymentSource: description: Adyen-developed software to get payment details. For example, Checkout SDK, Secured Fields SDK, etc. $ref: '#/components/schemas/CommonField' externalPlatform: description: Third-party developed platform used to initiate payment requests. For example, Magento, Zuora, etc. $ref: '#/components/schemas/ExternalPlatform' merchantApplication: description: Merchant developed software, such as cashier application, used to interact with the Adyen API. $ref: '#/components/schemas/CommonField' merchantDevice: description: Merchant device information. $ref: '#/components/schemas/MerchantDevice' shopperInteractionDevice: description: Shopper interaction device, such as terminal, mobile device or web browser, to initiate payment requests. $ref: '#/components/schemas/ShopperInteractionDevice' type: object CommonField: properties: name: description: Name of the field. For example, Name of External Platform. type: string version: description: Version of the field. For example, Version of External Platform. type: string type: object MerchantDevice: properties: os: description: Operating system running on the merchant device. type: string osVersion: description: Version of the operating system on the merchant device. type: string reference: description: Merchant device reference. type: string type: object InstallmentsNumber: properties: maxNumberOfInstallments: description: Maximum number of installments format: int32 type: integer required: - maxNumberOfInstallments type: object AdditionalDataWallets: properties: androidpay.token: description: The Android Pay token retrieved from the SDK. type: string masterpass.transactionId: description: The Mastercard Masterpass Transaction ID retrieved from the SDK. type: string payment.token: description: The Apple Pay token retrieved from the SDK. type: string paywithgoogle.token: description: The Google Pay token retrieved from the SDK. type: string samsungpay.token: description: The Samsung Pay token retrieved from the SDK. type: string visacheckout.callId: description: The Visa Checkout Call ID retrieved from the SDK. type: string type: object SubInputDetail: properties: configuration: additionalProperties: type: string description: Configuration parameters for the required input. type: object items: description: In case of a select, the items to choose from. items: $ref: '#/components/schemas/Item' type: array key: description: The value to provide in the result. type: string optional: description: True if this input is optional to provide. type: boolean type: description: The type of the required input. type: string value: description: The value can be pre-filled, if available. type: string type: object InputDetail: properties: configuration: additionalProperties: type: string description: Configuration parameters for the required input. type: object details: description: Input details can also be provided recursively. items: $ref: '#/components/schemas/SubInputDetail' type: array inputDetails: deprecated: true description: Input details can also be provided recursively (deprecated). items: $ref: '#/components/schemas/SubInputDetail' type: array itemSearchUrl: description: In case of a select, the URL from which to query the items. type: string items: description: In case of a select, the items to choose from. items: $ref: '#/components/schemas/Item' type: array key: description: The value to provide in the result. type: string optional: description: True if this input value is optional. type: boolean type: description: The type of the required input. type: string value: description: The value can be pre-filled, if available. type: string type: object PaymentMethodIssuer: properties: disabled: default: false description: A boolean value indicating whether this issuer is unavailable. Can be `true` whenever the issuer is offline. type: boolean id: description: The unique identifier of this issuer, to submit in requests to /payments. type: string name: description: A localized name of the issuer. type: string required: - id - name type: object SplitAmount: properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency. maxLength: 3 minLength: 3 type: string value: description: The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: - value type: object AdditionalDataRatepay: properties: ratepay.installmentAmount: description: Amount the customer has to pay each month. type: string ratepay.interestRate: description: Interest rate of this installment. type: string ratepay.lastInstallmentAmount: description: Amount of the last installment. type: string ratepay.paymentFirstday: description: Calendar day of the first payment. type: string ratepaydata.deliveryDate: description: Date the merchant delivered the goods to the customer. type: string ratepaydata.dueDate: description: Date by which the customer must settle the payment. type: string ratepaydata.invoiceDate: description: Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. type: string ratepaydata.invoiceId: description: Identification name or number for the invoice, defined by the merchant. type: string type: object Address: properties: city: description: 'The name of the city. Maximum length: 3000 characters.' maxLength: 3000 type: string country: description: 'The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don''t know the country or are not collecting the country from the shopper, provide `country` as `ZZ`.' type: string houseNumberOrName: description: 'The number or name of the house. Maximum length: 3000 characters.' maxLength: 3000 type: string postalCode: description: A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. type: string stateOrProvince: description: 'The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada.' type: string street: description: 'The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`.' maxLength: 3000 type: string required: - street - houseNumberOrName - city - postalCode - country type: object AdditionalDataOpi: properties: opi.includeTransToken: description: 'Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce).' type: string type: object AdditionalData3DSecure: properties: allow3DS2: deprecated: true x-deprecatedInVersion: '69' x-deprecatedMessage: Use `authenticationData.threeDSRequestData.nativeThreeDS` instead. description: "Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2).\n\n > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure)\nor send the `executeThreeD` parameter.\nPossible values:\n* **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience.\n* **false** Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration.\n" type: string challengeWindowSize: description: "Dimensions of the 3DS2 challenge window to be displayed to the cardholder.\n\nPossible values:\n\n* **01** - size of 250x400 \n* **02** - size of 390x400\n* **03** - size of 500x600\n* **04** - size of 600x400\n* **05** - Fullscreen" enum: - '01' - '02' - '03' - '04' - '05' type: string executeThreeD: deprecated: true x-deprecatedInVersion: '69' x-deprecatedMessage: Use [`authenticationData.attemptAuthentication`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments?target=_blank#request-authenticationData-attemptAuthentication) instead description: "Indicates if you want to perform 3D Secure authentication on a transaction.\n\n > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure.\n\nPossible values:\n* **true** Perform 3D Secure authentication.\n* **false** Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. \n" type: string mpiImplementationType: description: In case of Secure+, this field must be set to **CUPSecurePlus**. type: string scaExemption: description: "Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction.\n\n Possible values:\n* **lowValue** \n* **secureCorporate** \n* **trustedBeneficiary** \n* **transactionRiskAnalysis** " type: string threeDSVersion: description: "Indicates your preference for the 3D Secure version. \n> If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure.\n\nPossible values:\n* **1.0.2**: Apply 3D Secure version 1.0.2. \n* **2.1.0**: Apply 3D Secure version 2.1.0. \n* **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0.\n\nThe following rules apply:\n* If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2.\n* If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error.\n\n" type: string type: object ServiceError: properties: additionalData: x-addedInVersion: '46' additionalProperties: type: string description: Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. type: object errorCode: description: The error code mapped to the error message. type: string errorType: description: The category of the error. type: string message: description: A short explanation of the issue. type: string pspReference: description: The PSP reference of the payment. type: string status: description: The HTTP response status. format: int32 type: integer type: object AdditionalDataSubMerchant: properties: subMerchant.numberOfSubSellers: description: Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**. type: string subMerchant.subSeller[subSellerNr].city: description: 'Required for transactions performed by registered payment facilitators. The city of the sub-merchant''s address. * Format: Alphanumeric * Maximum length: 13 characters' type: string subMerchant.subSeller[subSellerNr].country: description: "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters" type: string subMerchant.subSeller[subSellerNr].id: description: "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters" type: string subMerchant.subSeller[subSellerNr].mcc: description: "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits" type: string subMerchant.subSeller[subSellerNr].name: description: 'Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters' type: string subMerchant.subSeller[subSellerNr].postalCode: description: 'Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant''s address, without dashes. * Format: Numeric * Fixed length: 8 digits' type: string subMerchant.subSeller[subSellerNr].state: description: 'Required for transactions performed by registered payment facilitators. The state code of the sub-merchant''s address, if applicable to the country. * Format: Alphanumeric * Maximum length: 2 characters' type: string subMerchant.subSeller[subSellerNr].street: description: 'Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant''s address. * Format: Alphanumeric * Maximum length: 60 characters' type: string subMerchant.subSeller[subSellerNr].taxId: description: 'Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ' type: string type: object AdditionalDataCommon: properties: RequestedTestErrorResponseCode: description: 'Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** There wasn''t a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response.' type: string allowPartialAuth: description: "Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. \nIf a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue.\nTo enable this functionality, contact our Support Team." type: string authorisationType: description: 'Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** flags the payment request to be handled as a pre-authorisation. * **FinalAuth** flags the payment request to be handled as a final authorisation.' type: string customRoutingFlag: description: 'Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request''s additional data to target a specific acquirer. To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed." enum: - NoShow - DelayedCharge type: string manualCapture: description: Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction. type: string networkTxReference: description: 'Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT.' type: string overwriteBrand: description: Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction. type: string subMerchantCity: description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant''s address. * Format: alpha-numeric. * Maximum length: 13 characters.' type: string subMerchantCountry: description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant''s address. * Format: alpha-numeric. * Fixed length: 3 characters.' type: string subMerchantID: description: 'This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters.' type: string subMerchantName: description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters.' type: string subMerchantPostalCode: description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant''s address. * Format: alpha-numeric. * Maximum length: 10 characters.' type: string subMerchantState: description: 'This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant''s address. * Format: alpha-numeric. * Maximum length: 3 characters.' type: string subMerchantStreet: description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant''s address. * Format: alpha-numeric. * Maximum length: 60 characters.' type: string subMerchantTaxId: description: 'This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters.' type: string type: object Name: properties: firstName: description: The first name. type: string lastName: description: The last name. type: string required: - firstName - lastName type: object StoredDetails: properties: bank: description: The stored bank account. $ref: '#/components/schemas/BankAccount' card: description: The stored card information. $ref: '#/components/schemas/Card' emailAddress: description: The email associated with stored payment details. type: string type: object ExternalPlatform: properties: integrator: description: External platform integrator. type: string name: description: Name of the field. For example, Name of External Platform. type: string version: description: Version of the field. For example, Version of External Platform. type: string type: object PaymentSetupResponse: properties: paymentSession: description: The encoded payment session that you need to pass to the SDK. type: string recurringDetails: deprecated: true description: The detailed list of stored payment details required to generate payment forms. Will be empty if oneClick is set to false in the request. items: $ref: '#/components/schemas/RecurringDetail' type: array type: object Mandate: properties: amount: description: The billing amount (in minor units) of the recurring transactions. type: string amountRule: description: "The limitation rule of the billing amount.\n\nPossible values:\n * **max**: The transaction amount can not exceed the `amount`.\n\n * **exact**: The transaction amount should be the same as the `amount`.\n\n" enum: - max - exact type: string billingAttemptsRule: description: "The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date.\n\nPossible values:\n\n * **on**: On a specific date.\n\n * **before**: Before and on a specific date.\n\n * **after**: On and after a specific date.\n\n" enum: - 'on' - before - after type: string billingDay: description: 'The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`.' type: string endsAt: description: End date of the billing plan, in YYYY-MM-DD format. type: string frequency: description: 'The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**.' enum: - adhoc - daily - weekly - biWeekly - monthly - quarterly - halfYearly - yearly type: string remarks: description: The message shown by UPI to the shopper on the approval screen. type: string startsAt: description: Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. type: string required: - frequency - amount - endsAt type: object Avs: properties: addressEditable: description: Indicates whether the shopper is allowed to modify the billing address for the current payment request. type: boolean enabled: description: 'Specifies whether the shopper should enter their billing address during checkout. Allowed values: * yes Perform AVS checks for every card payment. * automatic Perform AVS checks only when required to optimize the conversion rate. * no Do not perform AVS checks.' enum: - 'yes' - 'no' - automatic type: string type: object Company: properties: homepage: description: The company website's home page. type: string name: description: The company name. type: string registrationNumber: description: Registration number of the company. type: string registryLocation: description: Registry location of the company. type: string taxId: description: Tax ID of the company. type: string type: description: The company type. type: string type: object Configuration: properties: avs: description: Describes the configuration for AVS ([Address Verification System](https://en.wikipedia.org/wiki/Address_Verification_System)). $ref: '#/components/schemas/Avs' cardHolderName: x-addedInVersion: '37' description: 'Determines whether the cardholder name should be provided or not. Permitted values: * NONE * OPTIONAL * REQUIRED' enum: - NONE - OPTIONAL - REQUIRED type: string installments: description: Describes the configuration for [installment payments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). $ref: '#/components/schemas/InstallmentsNumber' shopperInput: x-addedInVersion: '37' description: Determines how to display the details fields. $ref: '#/components/schemas/ShopperInput' type: object AdditionalDataOpenInvoice: properties: openinvoicedata.merchantData: description: 'Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. The `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end. Since the field is optional, if it''s not included it does not impact computing the merchant signature. Applies only to Klarna. You can contact Klarna for the format and structure of the string.' type: string openinvoicedata.numberOfLines: description: 'The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1.' type: string openinvoicedata.recipientFirstName: description: First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. type: string openinvoicedata.recipientLastName: description: Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. type: string openinvoicedataLine[itemNr].currencyCode: description: The three-character ISO currency code. type: string openinvoicedataLine[itemNr].description: description: A text description of the product the invoice line refers to. type: string openinvoicedataLine[itemNr].itemAmount: description: 'The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded.' type: string openinvoicedataLine[itemNr].itemId: description: A unique id for this item. Required for RatePay if the description of each item is not unique. type: string openinvoicedataLine[itemNr].itemVatAmount: description: The VAT due for one item in the invoice line, represented in minor units. type: string openinvoicedataLine[itemNr].itemVatPercentage: description: 'The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900.' type: string openinvoicedataLine[itemNr].numberOfItems: description: The number of units purchased of a specific product. type: string openinvoicedataLine[itemNr].returnShippingCompany: description: Name of the shipping company handling the the return shipment. type: string openinvoicedataLine[itemNr].returnTrackingNumber: description: The tracking number for the return of the shipment. type: string openinvoicedataLine[itemNr].returnTrackingUri: description: URI where the customer can track the return of their shipment. type: string openinvoicedataLine[itemNr].shippingCompany: description: Name of the shipping company handling the delivery. type: string openinvoicedataLine[itemNr].shippingMethod: description: Shipping method. type: string openinvoicedataLine[itemNr].trackingNumber: description: The tracking number for the shipment. type: string openinvoicedataLine[itemNr].trackingUri: description: URI where the customer can track their shipment. type: string type: object AdditionalDataTemporaryServices: properties: enhancedSchemeData.customerReference: description: 'The customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25' type: string enhancedSchemeData.employeeName: description: "The name or ID of the person working in a temporary capacity.\n* maxLength: 40. \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.jobDescription: description: "The job description of the person working in a temporary capacity.\n* maxLength: 40 \n* Must not be all spaces. \n*Must not be all zeros." type: string enhancedSchemeData.regularHoursRate: description: 'The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 7 * Must not be empty * Can be all zeros' type: string enhancedSchemeData.regularHoursWorked: description: 'The hours worked. * maxLength: 7 * Must not be empty * Can be all zeros' type: string enhancedSchemeData.requestName: description: 'The name of the person requesting temporary services. * maxLength: 40 * Must not be all zeros * Must not be all spaces' type: string enhancedSchemeData.tempStartDate: description: 'The billing period start date. * Format: ddMMyy * maxLength: 6' type: string enhancedSchemeData.tempWeekEnding: description: 'The billing period end date. * Format: ddMMyy * maxLength: 6' type: string enhancedSchemeData.totalTaxAmount: description: 'The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00 * maxLength: 12' type: string type: object Card: properties: cvc: description: 'The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 length: 3 digits * CID length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored.' maxLength: 20 minLength: 1 type: string expiryMonth: description: 'The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November' maxLength: 2 minLength: 1 type: string expiryYear: description: 'The card expiry year. Format: 4 digits. For example: 2020' maxLength: 4 minLength: 4 type: string holderName: description: The name of the cardholder, as printed on the card. maxLength: 50 minLength: 1 type: string issueNumber: description: The issue number of the card (for some UK debit cards only). maxLength: 2 minLength: 1 type: string number: description: 'The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned.' maxLength: 19 minLength: 4 type: string startMonth: description: The month component of the start date (for some UK debit cards only). maxLength: 2 minLength: 1 type: string startYear: description: The year component of the start date (for some UK debit cards only). maxLength: 4 minLength: 4 type: string type: object AdditionalDataRetry: properties: retry.chainAttemptNumber: description: 'The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string retry.orderAttemptNumber: description: 'The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string retry.skipRetry: description: 'The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together.' type: string type: object ShopperInteractionDevice: properties: locale: description: Locale on the shopper interaction device. type: string os: description: Operating system running on the shopper interaction device. type: string osVersion: description: Version of the operating system on the shopper interaction device. type: string type: object RiskData: properties: clientData: description: Contains client-side data, like the device fingerprint, cookies, and specific browser settings. type: string customFields: x-addedInVersion: '65' additionalProperties: type: string description: Any custom fields used as part of the input to configured risk rules. type: object fraudOffset: x-addedInVersion: '65' description: An integer value that is added to the normal fraud score. The value can be either positive or negative. format: int32 type: integer profileReference: x-addedInVersion: '65' description: The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. type: string type: object AdditionalDataRisk: properties: riskdata.[customFieldName]: description: The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). type: string riskdata.basket.item[itemNr].amountPerItem: description: The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). type: string riskdata.basket.item[itemNr].brand: description: Brand of the item. type: string riskdata.basket.item[itemNr].category: description: Category of the item. type: string riskdata.basket.item[itemNr].color: description: Color of the item. type: string riskdata.basket.item[itemNr].currency: description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). type: string riskdata.basket.item[itemNr].itemID: description: ID of the item. type: string riskdata.basket.item[itemNr].manufacturer: description: Manufacturer of the item. type: string riskdata.basket.item[itemNr].productTitle: description: A text description of the product the invoice line refers to. type: string riskdata.basket.item[itemNr].quantity: description: Quantity of the item purchased. type: string riskdata.basket.item[itemNr].receiverEmail: description: Email associated with the given product in the basket (usually in electronic gift cards). type: string riskdata.basket.item[itemNr].size: description: Size of the item. type: string riskdata.basket.item[itemNr].sku: description: '[Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit).' type: string riskdata.basket.item[itemNr].upc: description: '[Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code).' type: string riskdata.promotions.promotion[itemNr].promotionCode: description: Code of the promotion. type: string riskdata.promotions.promotion[itemNr].promotionDiscountAmount: description: The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). type: string riskdata.promotions.promotion[itemNr].promotionDiscountCurrency: description: The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). type: string riskdata.promotions.promotion[itemNr].promotionDiscountPercentage: description: 'Promotion''s percentage discount. It is represented in percentage value and there is no need to include the ''%'' sign. e.g. for a promotion discount of 30%, the value of the field should be 30.' type: string riskdata.promotions.promotion[itemNr].promotionName: description: Name of the promotion. type: string riskdata.riskProfileReference: description: Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). type: string riskdata.skipRisk: description: If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score. type: string type: object Amount: properties: currency: description: The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). maxLength: 3 minLength: 3 type: string value: description: The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). format: int64 type: integer required: - value - currency type: object AdditionalDataAirline: properties: airline.agency_invoice_number: description: 'The reference number for the invoice, issued by the agency. * Encoding: ASCII * minLength: 1 character * maxLength: 6 characters' type: string airline.agency_plan_name: description: 'The two-letter agency plan identifier. * Encoding: ASCII * minLength: 2 characters * maxLength: 2 characters' type: string airline.airline_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier. * Format: IATA 3-digit accounting code (PAX) * Example: KLM = 074 * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros.' type: string airline.airline_designator_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. * Encoding: ASCII * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros.' type: string airline.boarding_fee: description: 'The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 character * maxLength: 18 characters' type: string airline.computerized_reservation_system: description: 'The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Encoding: ASCII * minLength: 4 characters * maxLength: 4 characters' type: string airline.customer_reference_number: description: 'The alphanumeric customer reference number. * Encoding: ASCII * maxLength: 20 characters * If you send more than 20 characters, the customer reference number is truncated * Must not be all spaces' type: string airline.document_type: description: 'A code that identifies the type of item bought. The description of the code can appear on credit card statements. * Encoding: ASCII * Example: Passenger ticket = 01 * minLength: 2 characters * maxLength: 2 characters' type: string airline.flight_date: description: 'The flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 characters * maxLength: 16 characters' type: string airline.leg.carrier_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. This field is required if the airline data includes leg details. * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.class_of_travel: description: "A one-letter travel class identifier.\n The following are common:\n * F: first class\n* J: business class\n* Y: economy class\n* W: premium economy\n\n* Encoding: ASCII\n* minLength: 1 character\n* maxLength: 1 character\n* Must not be all spaces\n*Must not be all zeros." type: string airline.leg.date_of_travel: description: "\t\nDate and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`.\n* Encoding: ASCII\n* minLength: 16 characters\n* maxLength: 16 characters" type: string airline.leg.depart_airport: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport. This field is required if the airline data includes leg details. * Encoding: ASCII * Example: Amsterdam = AMS * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.depart_tax: description: 'The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 * maxLength: 12 *Must not be all zeros.' type: string airline.leg.destination_code: description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport. This field is required if the airline data includes leg details. * Example: Amsterdam = AMS * Encoding: ASCII * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.fare_base_code: description: 'The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric. * minLength: 1 character * maxLength: 6 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.flight_number: description: 'The flight identifier. * minLength: 1 character * maxLength: 5 characters * Must not be all spaces *Must not be all zeros.' type: string airline.leg.stop_over_code: description: 'A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not. * Encoding: ASCII * minLength: 1 character * maxLength: 1 character' type: string airline.passenger.date_of_birth: description: 'The passenger''s date of birth. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10' type: string airline.passenger.first_name: description: 'The passenger''s first name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII' type: string airline.passenger.last_name: description: 'The passenger''s last name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII' type: string airline.passenger.telephone_number: description: 'The passenger''s telephone number, including country code. This is an alphanumeric field that can include the ''+'' and ''-'' signs. * Encoding: ASCII * minLength: 3 characters * maxLength: 30 characters' type: string airline.passenger.traveller_type: description: 'The IATA passenger type code (PTC). * Encoding: ASCII * minLength: 3 characters * maxLength: 6 characters' type: string airline.passenger_name: description: "The passenger's name, initials, and title.\n* Format: last name + first name or initials + title\n* Example: *FLYER / MARY MS*\n* minLength: 1 character\n* maxLength: 20 characters\n* If you send more than 20 characters, the name is truncated\n* Must not be all spaces \n*Must not be all zeros." type: string airline.ticket_issue_address: description: 'The address of the organization that issued the ticket. * minLength: 0 characters * maxLength: 16 characters' type: string airline.ticket_number: description: 'The ticket''s unique identifier. * minLength: 1 character * maxLength: 15 characters * Must not be all spaces *Must not be all zeros.' type: string airline.travel_agency_code: description: 'The unique identifier from IATA or ARC for the travel agency that issues the ticket. * Encoding: ASCII * minLength: 1 character * maxLength: 8 characters * Must not be all spaces *Must not be all zeros.' type: string airline.travel_agency_name: description: 'The name of the travel agency. * Encoding: ASCII * minLength: 1 character * maxLength: 25 characters * Must not be all spaces *Must not be all zeros.' type: string required: - airline.passenger_name type: object PlatformChargebackLogic: properties: behavior: x-addedInVersion: '68' description: 'The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**.' enum: - deductAccordingToSplitRatio - deductFromLiableAccount - deductFromOneBalanceAccount type: string costAllocationAccount: x-addedInVersion: '68' description: The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. type: string targetAccount: x-addedInVersion: '68' description: 'The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**.' type: string type: object SessionResultResponse: properties: id: description: A unique identifier of the session. type: string status: description: "The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates.\n\nPossible values:\n\n * **completed** The shopper completed the payment. This means that the payment was authorized.\n * **paymentPending** The shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow.\n * **refused** The session has been refused, due to too many refused payment attempts. Shoppers can no longer complete the payment with this session.\n * **canceled** The shopper canceled the payment.\n * **active** The session is still active and can be paid.\n * **expired** The session expired (default: 1 hour after session creation). Shoppers can no longer complete the payment with this session.\n" enum: - active - canceled - completed - expired - paymentPending - refused type: string type: object ShopperInput: properties: billingAddress: description: 'Specifies visibility of billing address fields. Permitted values: * editable * hidden * readOnly' enum: - editable - hidden - readOnly type: string deliveryAddress: description: 'Specifies visibility of delivery address fields. Permitted values: * editable * hidden * readOnly' enum: - editable - hidden - readOnly type: string personalDetails: description: 'Specifies visibility of personal details. Permitted values: * editable * hidden * readOnly' enum: - editable - hidden - readOnly type: string type: object BankAccount: properties: bankAccountNumber: description: The bank account number (without separators). type: string bankCity: x-addedInVersion: '18' description: The bank city. type: string bankLocationId: description: The location id of the bank. The field value is `nil` in most cases. type: string bankName: description: The name of the bank. type: string bic: description: The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. type: string countryCode: description: 'Country code where the bank is located. A valid value is an ISO two-character country code (e.g. ''NL'').' type: string iban: description: The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). type: string ownerName: description: 'The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * 12 is converted to ch12. * A is converted to euA. * Peter Mller is converted to Peter Mller, because banks don''t accept ''''. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don''t match the required format, the response returns the error message: 203 ''Invalid bank account holder name''.' type: string taxId: x-addedInVersion: '18' description: The bank account holder's tax ID. type: string type: object Split: properties: account: description: 'The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked.' type: string amount: description: 'The amount of the split item. * Required for all split types in the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * Required if `type` is **BalanceAccount**, **Commission**, **Default**, or **VAT** in your [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms) integration.' $ref: '#/components/schemas/SplitAmount' description: description: Your description for the split item. type: string reference: description: 'Your unique reference for the split item. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports.' type: string type: description: 'The type of the split item. Possible values: * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**.' enum: - AcquiringFees - AdyenCommission - AdyenFees - AdyenMarkup - BalanceAccount - Commission - Default - Interchange - MarketPlace - PaymentFee - Remainder - SchemeFee - Surcharge - Tip - VAT type: string required: - type type: object examples: generic-401: summary: Response code 401. Unauthorized. value: status: 401 errorCode: '000' message: HTTP Status Response - Unauthorized errorType: security generic-403: summary: Response code 403. Forbidden. value: status: 403 errorCode: '901' message: Invalid Merchant Account errorType: security pspReference: 881611827877203B post-paymentSession-web-200: summary: Example response for request 'web' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... generic-400: summary: Response code 400. Bad request. value: status: 400 errorCode: '702' message: 'Unexpected input: ", expected: }' errorType: validation post-paymentSession-enableOneClick-200: summary: Example response for request 'enableOneClick' value: paymentSession: eyJjaGVja291dHNob3BwZXJCYXN... generic-422: summary: Response code 422. Unprocessable entity. value: status: 422 errorCode: '14_030' message: Return URL is missing. errorType: validation pspReference: '8816118280275544' generic-500: summary: Response code 500. Internal server error. value: status: 500 errorCode: '905' message: Payment details are not supported errorType: configuration pspReference: '8516091485743033' post-paymentSession-android: summary: Set up a payment session (Android) value: amount: currency: EUR value: 17408 reference: Your order number shopperReference: YOUR_SHOPPER_REFERENCE channel: Android token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK returnUrl: app:// countryCode: NL shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT get-sessions-sessionId-success-200: summary: 'Response code: 200 - Success' description: The status of the session with the specified ID. value: id: CS12345678 status: completed post-paymentSession-ios: summary: Set up a payment session (iOS) value: amount: currency: EUR value: 17408 reference: Your order number shopperReference: YOUR_SHOPPER_REFERENCE channel: iOS token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK returnUrl: app:// countryCode: NL shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-enableOneClick: summary: Set up a payment session with the option to store card details value: amount: currency: EUR value: 17408 reference: Your order number shopperReference: YOUR_SHOPPER_REFERENCE enableOneClick: true enableRecurring: true channel: Web origin: https://www.yourwebsite.com returnUrl: https://www.yourshop.com/checkout/result countryCode: NL shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.7.0 post-paymentSession-split: summary: Split a payment between a sub-merchant and a platform account value: amount: currency: EUR value: 6200 additionalData: split.api: '1' split.nrOfItems: '2' split.totalAmount: '6200' split.currencyCode: EUR split.item1.amount: '6000' split.item1.type: MarketPlace split.item1.account: '151272963' split.item1.reference: '6124145' split.item1.description: 'Porcelain Doll: Eliza (20cm)' split.item2.amount: '200' split.item2.type: Commission split.item2.reference: '6124146' reference: Your order number shopperReference: YOUR_SHOPPER_REFERENCE channel: Android token: TOKEN_YOU_GET_FROM_CHECKOUT_SDK returnUrl: app:// countryCode: NL shopperLocale: nl_NL sessionValidity: '2017-04-06T13:09:13Z' merchantAccount: YOUR_MERCHANT_ACCOUNT post-paymentSession-web: summary: Set up a payment session (Web) value: amount: currency: EUR value: 17408 reference: Your order number shopperReference: YOUR_SHOPPER_REFERENCE channel: Web origin: https://www.yourwebsite.com returnUrl: https://www.yourshop.com/checkout/result countryCode: NL shopperLocale: nl_NL merchantAccount: YOUR_MERCHANT_ACCOUNT sdkVersion: 1.9.5 parameters: Idempotency-Key: description: A unique identifier for the message with a maximum of 64 characters (we recommend a UUID). example: 37ca9c97-d1d1-4c62-89e8-706891a563ed name: Idempotency-Key in: header schema: type: string headers: Idempotency-Key: description: The idempotency key used for processing the request. Present if the key was provided in the request. schema: type: string securitySchemes: ApiKeyAuth: in: header name: X-API-Key type: apiKey BasicAuth: scheme: basic type: http x-groups: - Account holders - Accounts - Verification