--- title: "Start a transaction" method: POST path: "/payments" tags: ["Payments"] --- # Start a transaction `POST /payments` Sends payment parameters (like amount, country, and currency) together with other required input details collected from the shopper. To know more about required parameters for specific payment methods, refer to our [payment method guides](https://docs.adyen.com/payment-methods). The response depends on the [payment flow](https://docs.adyen.com/payment-methods#payment-flow): * For a direct flow, the response includes a `pspReference` and a `resultCode` with the payment result, for example **Authorised** or **Refused**. * For a redirect or additional action, the response contains an `action` object. ## Headers - `Idempotency-Key` string ## Request body - PaymentRequest - `additionalAmount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `additionalData` object — 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. - `amount` Amount, required - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `bankAccount` CheckoutBankAccount - `accountType` 'balance' | 'checking' | 'deposit' | 'general' | 'other' | 'payment' | 'savings' — The type of the bank account. - `bankAccountNumber` string — The bank account number (without separators). - `bankCity` string — The bank city. - `bankLocationId` string — The location id of the bank. The field value is `nil` in most cases. - `bankName` string — The name of the bank. - `bic` string — The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. - `countryCode` string — Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL'). - `iban` string — The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). - `ownerName` string — 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 Møller 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'. - `taxId` string — The bank account holder's tax ID. - `billingAddress` BillingAddress - `city` string, required — The name of the city. Maximum length: 3000 characters. - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters. - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. - `street` string, required — 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`. - `browserInfo` BrowserInfo - `acceptHeader` string, required — The accept header value of the shopper's browser. - `userAgent` string, required — The user agent value of the shopper's browser. - `captureDelayHours` integer — The [delay between the authorization and automatic capture](https://docs.adyen.com/online-payments/capture?tab=delayed-individual_2#delayed-automatic-capture) of the payment, specified in hours. Maximum value: **672** (28 days). - `channel` 'iOS' | 'Android' | 'Web' — 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 - `checkoutAttemptId` string — Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. - `company` Company - `homepage` string — The company website's home page. - `name` string — The company name. - `registrationNumber` string — Registration number of the company. - `registryLocation` string — Registry location of the company. - `taxId` string — Tax ID of the company. - `type` string — The company type. - `countryCode` string — The shopper country code. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE - `dateOfBirth` string, date-time — The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD - `dccQuote` ForexQuote - `account` string — The account name. - `accountType` string — The account type. - `baseAmount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `basePoints` integer, required — The base points. - `buy` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `interbank` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `reference` string — The reference assigned to the forex quote request. - `sell` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `signature` string — The signature to validate the integrity. - `source` string — The source of the forex quote. - `type` string — The type of forex. - `validTill` string, date-time, required — The date until which the forex quote is valid. - `deliveryAddress` DeliveryAddress - `city` string, required — The name of the city. Maximum length: 3000 characters. - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - `firstName` string - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters. - `lastName` string - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. - `street` string, required — 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`. - `deliveryDate` string, date-time — 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 - `deviceFingerprint` string — A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). - `enableOneClick` boolean — When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future [one-click payments](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition). - `enablePayOut` boolean — When true and `shopperReference` is provided, the payment details will be tokenized for payouts. - `enableRecurring` boolean — When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments. - `entityType` 'NaturalPerson' | 'CompanyName' — The type of the entity the payment is processed for. - `fraudOffset` integer — An integer value that is added to the normal fraud score. The value can be either positive or negative. - `fundOrigin` FundOrigin - `billingAddress` Address - `city` string, required — The name of the city. Maximum length: 3000 characters. - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters. - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. - `street` string, required — 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`. - `shopperEmail` string — The email address of the person funding the money. - `shopperName` Name - `firstName` string, required — The first name. - `lastName` string, required — The last name. - `telephoneNumber` string — The phone number of the person funding the money. - `walletIdentifier` string — The unique identifier of the wallet where the funds are coming from. - `fundRecipient` FundRecipient - `IBAN` string — The IBAN of the bank account where the funds are being transferred to. - `billingAddress` Address - `city` string, required — The name of the city. Maximum length: 3000 characters. - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters. - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. - `street` string, required — 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`. - `paymentMethod` CardDetails - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper. - `brand` string — Secondary brand of the card. For example: **plastix**, **hmclub**. - `checkoutAttemptId` string — The checkout attempt identifier. - `cupsecureplus.smscode` string - `cvc` string — The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `encryptedCard` string — Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details. - `encryptedCardNumber` string — The encrypted card number. - `encryptedExpiryMonth` string — The encrypted card expiry month. - `encryptedExpiryYear` string — The encrypted card expiry year. - `encryptedPassword` string — This field contains an encrypted, one-time password or an authentication code provided by the cardholder. - `encryptedSecurityCode` string — The encrypted card verification code. - `expiryMonth` string — The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `expiryYear` string — The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `fastlaneData` string — The encoded fastlane data blob - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `holderName` string — The name of the card holder. - `networkPaymentReference` string — The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. - `number` string — The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. - `srcCorrelationId` string — An identifier used for the Click to Pay transaction. - `srcDigitalCardId` string — The SRC reference for the Click to Pay token. - `srcScheme` string — The scheme that is being used for Click to Pay. - `srcTokenReference` string — The reference for the Click to Pay token. - `threeDS2SdkVersion` string — Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. - `type` 'bcmc' | 'scheme' | 'networkToken' | 'giftcard' | 'card' | 'clicktopay' — Default payment method details. Common for scheme payment methods, and for simple payment method details. - `shopperEmail` string — The email address of the shopper. - `shopperName` Name - `firstName` string, required — The first name. - `lastName` string, required — The last name. - `shopperReference` string — Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. The value is case-sensitive and must be at least three characters. > Your reference must not include personally identifiable information (PII) such as name or email address. - `storedPaymentMethodId` string — This is the `recurringDetailReference` returned in the response when you created the token. - `subMerchant` SubMerchant - `city` string — The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters - `country` string — The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters - `mcc` string — The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits - `name` string — The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters - `taxId` string — The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ - `telephoneNumber` string — The telephone number of the shopper. - `walletIdentifier` string — The unique identifier for the wallet the funds are being transferred to. You can use the shopper reference or any other identifier. - `walletOwnerTaxId` string — The tax identifier of the person receiving the funds. - `walletPurpose` 'identifiedBoleto' | 'transferDifferentWallet' | 'transferOwnWallet' | 'transferSameWallet' | 'unidentifiedBoleto' — The purpose of a digital wallet transaction. - `installments` Installments - `value` integer, required — Defines the number of installments. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. This value can be zero for Installments processed in Mexico. - `lineItems` LineItem[] — Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty. - `amountExcludingTax` integer — Item amount excluding the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). - `amountIncludingTax` integer — Item amount including the tax, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). - `description` string — Description of the line item. - `id` string — ID of the line item. - `imageUrl` string — Link to the picture of the purchased item. - `itemCategory` string — Item category, used by the payment methods PayPal and Ratepay. - `productUrl` string — Link to the purchased item. - `quantity` integer — Number of items. - `taxAmount` integer — Tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes/#minor-units). - `taxPercentage` integer — Tax percentage, represented as a [basis point](https://en.wikipedia.org/wiki/Basis_point) integer. For example: - **530** for 5.3% (five point three percent) - **2100** for 21% (twenty-one percent) - `mandate` Mandate - `amount` string, required — The billing amount (in minor units) of the recurring transactions. - `amountRule` 'max' | 'exact' — The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`. - `billingAttemptsRule` 'on' | 'before' | 'after' — The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date. - `billingDay` string — The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`. - `count` string — The number of transactions that can be performed within the given frequency. - `endsAt` string, required — End date of the billing plan, in YYYY-MM-DD format. - `frequency` 'adhoc' | 'daily' | 'weekly' | 'biWeekly' | 'monthly' | 'quarterly' | 'halfYearly' | 'yearly', required — The frequency with which a shopper should be charged. Possible values: **adhoc**, **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**. - `remarks` string — The message shown by UPI to the shopper on the approval screen. - `startsAt` string — Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. - `mcc` string — The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. - `merchantAccount` string, required — The merchant account identifier, with which you want to process the transaction. - `merchantOrderReference` string — You can use this reference to link multiple transactions to one another (for example, to track order authorization rate).For each billing cycle, this reference should be unique. After the first authorized payment attempt, do not reuse the reference. If you use this parameter, include it in all of the payment requests that you make. We strongly recommend that you: * Always include this parameter, so that you can benefit from linking payment requests to one another, in case of authorization retries. * Additionally include the following parameters in the `additionalData` object: [`retry.orderAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-orderAttemptNumber), [`retry.chainAttemptNumber`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-chainAttemptNumber), and [`retry.skipRetry`](https://docs.adyen.com/api-explorer/Checkout/latest/post/sessions#request-additionalData-AdditionalDataRetry-retry-skipRetry) - `metadata` object — Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the "177" error occurs: "Metadata size exceeds limit". * Maximum 20 characters per key. * Maximum 80 characters per value. - `mpiData` ThreeDSecureData - `authenticationResponse` 'Y' | 'N' | 'U' | 'A' — In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter. - `cavv` string, byte — The cardholder authentication value (base64 encoded, 20 bytes in a decoded form). - `cavvAlgorithm` string — The CAVV algorithm used. Include this only for 3D Secure 1. - `directoryResponse` 'A' | 'C' | 'D' | 'I' | 'N' | 'R' | 'U' | 'Y' — In 3D Secure 2, this is the `transStatus` from the `ARes`. - `eci` string — The electronic commerce indicator. - `xid` string, byte — Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form). - `order` EncryptedOrderData - `orderData` string, required — The encrypted order data. - `pspReference` string, required — The `pspReference` that belongs to the order. - `orderReference` string — When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. - `paymentMethod` union, required — The type and required details of a payment method to use. - AchDetails - `accountHolderType` 'business' | 'personal' — The account holder type (personal or business). - `bankAccountNumber` string — The bank account number (without separators). - `bankAccountType` 'balance' | 'checking' | 'deposit' | 'general' | 'other' | 'payment' | 'savings' — The bank account type (checking, savings...). - `bankLocationId` string — The bank routing number of the account. The field value is `nil` in most cases. - `checkoutAttemptId` string — The checkout attempt identifier. - `encryptedBankAccountNumber` string — Encrypted bank account number. The bank account number (without separators). - `encryptedBankLocationId` string — Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases. - `ownerName` string — 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 Møller 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'. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `transferInstrumentId` string — The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts. - `type` 'ach' | 'ach_plaid' — **ach** - AffirmDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `type` 'affirm' — **affirm** - AfterpayDetails - `billingAddress` string — The address where to send the invoice. - `checkoutAttemptId` string — The checkout attempt identifier. - `deliveryAddress` string — The address where the goods should be delivered. - `personalDetails` string — Shopper name, date of birth, phone number, and email address. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'afterpay_default' | 'afterpaytouch' | 'afterpay_b2b' | 'clearpay', required — **afterpay_default** - AlmaDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `feeType` 'merchantPays' | 'shopperPays' — **Alma payment request fee type** - `type` 'alma' — The payment method type. - AmazonPayDetails - `amazonPayToken` string — This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically. - `checkoutAttemptId` string — The checkout attempt identifier. - `checkoutSessionId` string — The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken. - `type` 'amazonpay' — **amazonpay** - AncvDetails - `beneficiaryId` string — ANCV account identification (email or account number) - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'ancv' — **ancv** - AndroidPayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `type` 'androidpay' — **androidpay** - ApplePayDetails - `applePayToken` string, required — The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. - `checkoutAttemptId` string — The checkout attempt identifier. - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'applepay' — **applepay** - BacsDirectDebitDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `transferInstrumentId` string — The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts. - `type` 'directdebit_GB' — **directdebit_GB** - BillDeskDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string, required — The issuer id of the shopper's selected bank. - `type` 'billdesk_online' | 'billdesk_wallet', required — **billdesk** - BlikDetails - `blikCode` string — BLIK code consisting of 6 digits. - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'blik' — **blik** - CardDetails - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper. - `brand` string — Secondary brand of the card. For example: **plastix**, **hmclub**. - `checkoutAttemptId` string — The checkout attempt identifier. - `cupsecureplus.smscode` string - `cvc` string — The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `encryptedCard` string — Only include this for JSON Web Encryption (JWE) implementations. The JWE-encrypted card details. - `encryptedCardNumber` string — The encrypted card number. - `encryptedExpiryMonth` string — The encrypted card expiry month. - `encryptedExpiryYear` string — The encrypted card expiry year. - `encryptedPassword` string — This field contains an encrypted, one-time password or an authentication code provided by the cardholder. - `encryptedSecurityCode` string — The encrypted card verification code. - `expiryMonth` string — The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `expiryYear` string — The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `fastlaneData` string — The encoded fastlane data blob - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `holderName` string — The name of the card holder. - `networkPaymentReference` string — The transaction identifier from card schemes. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments#responses-200-additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. - `number` string — The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. - `srcCorrelationId` string — An identifier used for the Click to Pay transaction. - `srcDigitalCardId` string — The SRC reference for the Click to Pay token. - `srcScheme` string — The scheme that is being used for Click to Pay. - `srcTokenReference` string — The reference for the Click to Pay token. - `threeDS2SdkVersion` string — Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. - `type` 'bcmc' | 'scheme' | 'networkToken' | 'giftcard' | 'card' | 'clicktopay' — Default payment method details. Common for scheme payment methods, and for simple payment method details. - CashAppDetails - `cashtag` string — Cash App issued cashtag for recurring payment - `checkoutAttemptId` string — The checkout attempt identifier. - `customerId` string — Cash App issued customerId for recurring payment - `grantId` string — Cash App issued grantId for one time payment - `onFileGrantId` string — Cash App issued onFileGrantId for recurring payment - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `requestId` string — Cash App request id - `subtype` string — The payment method subtype. - `type` 'cashapp' — cashapp - CellulantDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string — The Cellulant issuer. - `type` 'cellulant' — **Cellulant** - DirectDebitAuDetails - `bankAccountNumber` string — The shopper's banking account number used to complete payment. - `bankBranchCode` string — The shopper's BSB (their bank's branch code) number used to complete payment. - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'directdebit_AU' — **directdebit_AU** - DokuDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `firstName` string, required — The shopper's first name. - `lastName` string, required — The shopper's last name. - `shopperEmail` string, required — The shopper's email. - `type` 'doku_mandiri_va' | 'doku_cimb_va' | 'doku_danamon_va' | 'doku_bni_va' | 'doku_permata_lite_atm' | 'doku_bri_va' | 'doku_bca_va' | 'doku_alfamart' | 'doku_indomaret' | 'doku_wallet' | 'doku_ovo', required — **doku** - DragonpayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string, required — The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it. - `shopperEmail` string — The shopper’s email address. - `type` 'dragonpay_ebanking' | 'dragonpay_otc_banking' | 'dragonpay_otc_non_banking' | 'dragonpay_otc_philippines', required — **dragonpay** - EBankingFinlandDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string — The Ebanking Finland issuer value of the shopper's selected bank. - `type` 'ebanking_FI', required — **ebanking_FI** - EcontextVoucherDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `firstName` string, required — The shopper's first name. - `lastName` string, required — The shopper's last name. - `shopperEmail` string, required — The shopper's email. - `telephoneNumber` string, required — The shopper's contact number. It must have an international number format, for example **+31 20 779 1846**. Formats like **+31 (0)20 779 1846** or **0031 20 779 1846** are not accepted. - `type` 'econtext_seven_eleven' | 'econtext_online' | 'econtext' | 'econtext_stores' | 'econtext_atm', required — **econtextvoucher** - EftDetails - `bankAccountNumber` string — The bank account number (without separators). - `bankCode` string — The financial institution code. - `bankLocationId` string — The bank routing number of the account. - `checkoutAttemptId` string — The checkout attempt identifier. - `ownerName` string — 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 Møller 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'. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'eft_directdebit_CA' — **eft** - ExternalTokenDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `expiryMonth` string — The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `expiryYear` string — The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `holderName` string — The name of the card holder. - `number` string — The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). - `storedPaymentMethodId` string, required — Identifier used to fetch the token from the external service - `subtype` 'hilton', required — The external service from which to fetch the token. Supported only for specific companies. Contact Adyen if you want to use this feature. - `type` 'externalToken', required — The type of token. Allowed value: **externalToken**. - FastlaneDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `fastlaneData` string, required — The encoded fastlane data blob - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'fastlane', required — **fastlane** - GenericIssuerPaymentMethodDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string, required — The issuer id of the shopper's selected bank. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'onlineBanking_PL' | 'eps' | 'onlineBanking_SK' | 'onlineBanking_CZ' | 'onlinebanking_IN', required — **genericissuer** - GooglePayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `googlePayCardNetwork` string — The selected payment card network. - `googlePayToken` string, required — The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `threeDS2SdkVersion` string — Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. - `type` 'googlepay' — **googlepay**, **paywithgoogle** - IdealDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string — The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'ideal' — **ideal** - KlarnaDetails - `billingAddress` string — The address where to send the invoice. - `checkoutAttemptId` string — The checkout attempt identifier. - `deliveryAddress` string — The address where the goods should be delivered. - `personalDetails` string — Shopper name, date of birth, phone number, and email address. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `subtype` string — The type of flow to initiate. - `type` 'klarna' | 'klarnapayments' | 'klarnapayments_account' | 'klarnapayments_b2b' | 'klarna_paynow' | 'klarna_account' | 'klarna_b2b', required — **klarna** - KlarnaNetworkDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `klarnaNetworkData` string — A string containing a structured JSON object. This is a passthrough field used to enable custom features or data exchange with Klarna. - `type` 'klarna_network', required — **klarna_network** - MasterpassDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `masterpassTransactionId` string, required — The Masterpass transaction ID. - `type` 'masterpass' — **masterpass** - MbwayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `shopperEmail` string, required - `telephoneNumber` string, required - `type` 'mbway' — **mbway** - MobilePayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `type` 'mobilepay' — **mobilepay** - MolPayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string, required — The shopper's bank. Specify this with the issuer value that corresponds to this bank. - `type` 'molpay_ebanking_fpx_MY' | 'molpay_ebanking_TH', required — **molpay** - OpenInvoiceDetails - `billingAddress` string — The address where to send the invoice. - `checkoutAttemptId` string — The checkout attempt identifier. - `deliveryAddress` string — The address where the goods should be delivered. - `personalDetails` string — Shopper name, date of birth, phone number, and email address. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'openinvoice' | 'afterpay_directdebit' | 'atome_pos' — **openinvoice** - PayByBankAISDirectDebitDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'paybybank_AIS_DD', required — **paybybank_AIS_DD** - PayByBankDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `issuer` string — The PayByBank issuer value of the shopper's selected bank. - `type` 'paybybank', required — **paybybank** - PayPalDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `orderID` string — The unique ID associated with the order. - `payeePreferred` string — IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED - `payerID` string — The unique ID associated with the payer. - `payerSelected` string — PAYPAL or PAYPAL_CREDIT - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `subtype` 'express' | 'redirect' | 'sdk' — The type of flow to initiate. - `type` 'paypal', required — **paypal** - PayPayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'paypay' — **paypay** - PayToDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperAccountIdentifier` string — The shopper's banking details or payId reference, used to complete payment. - `type` 'payto' — **payto** - PayUUpiDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. - `type` 'payu_IN_upi', required — **payu_IN_upi** - `virtualPaymentAddress` string — The virtual payment address for UPI. - PayWithGoogleDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `googlePayToken` string, required — The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `threeDS2SdkVersion` string — Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. - `type` 'paywithgoogle' — **paywithgoogle** - PaymentDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `type` 'alipay' | 'multibanco' | 'bankTransfer' | 'bankTransfer_IBAN' | 'paybright' | 'paynow' | 'affirm_pos' | 'iris' | 'wero' | 'trustly' | 'trustlyvector' | 'oney' | 'facilypay' | 'facilypay_3x' | 'facilypay_4x' | 'facilypay_6x' | 'facilypay_10x' | 'facilypay_12x' | 'unionpay' | 'kcp_banktransfer' | 'kcp_payco' | 'kcp_creditcard' | 'wechatpaySDK' | 'wechatpayQR' | 'wechatpayWeb' | 'molpay_boost' | 'wallet_IN' | 'payu_IN_cashcard' | 'payu_IN_nb' | 'paytm' | 'molpay_ebanking_VN' | 'molpay_ebanking_MY' | 'molpay_ebanking_direct_MY' | 'swish' | 'bizum' | 'walley' | 'walley_b2b' | 'paypo' | 'scalapay' | 'scalapay_3x' | 'scalapay_4x' | 'molpay_fpx' | 'payme' | 'payme_pos' | 'konbini' | 'directEbanking' | 'boletobancario' | 'cashticket' | 'ikano' | 'karenmillen' | 'oasis' | 'warehouse' | 'primeiropay_boleto' | 'mada' | 'benefit' | 'knet' | 'omannet' | 'gopay_wallet' | 'kcp_naverpay' | 'fawry' | 'atome' | 'naps' | 'nordea' | 'boletobancario_bradesco' | 'boletobancario_itau' | 'boletobancario_santander' | 'boletobancario_bancodobrasil' | 'boletobancario_hsbc' | 'molpay_maybank2u' | 'molpay_cimb' | 'molpay_rhb' | 'molpay_amb' | 'molpay_hlb' | 'molpay_affin_epg' | 'molpay_bankislam' | 'molpay_publicbank' | 'fpx_agrobank' | 'touchngo' | 'maybank2u_mae' | 'duitnow' | 'promptpay' | 'twint_pos' | 'alipay_hk' | 'alipay_hk_web' | 'alipay_hk_wap' | 'alipay_wap' | 'balanceplatform' — The payment method type. - PixDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `pixRecurring` PixRecurring - `billingDate` string — The date on which the shopper's payment method will be charged, in YYYY-MM-DD format. - `businessDayOnly` boolean — Flag used to define whether liquidation can happen only on business days - `endsAt` string — End date of the billing plan, in YYYY-MM-DD format. The end date must align with the frequency and the start date of the billing plan. If left blank, the subscription will continue indefinitely unless it is cancelled by the shopper. - `frequency` 'weekly' | 'monthly' | 'quarterly' | 'half-yearly' | 'yearly' — The frequency at which the shopper will be charged. - `minAmount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `originalPspReference` string — The pspReference for the failed recurring payment. Find this in AUTHORISATION webhook you received after the billing date. - `recurringAmount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `recurringStatement` string — The text that that will be shown on the shopper's bank statement for the recurring payments. We recommend to add a descriptive text about the subscription to let your shoppers recognize your recurring payments. Maximum length: 35 characters. - `retryPolicy` boolean — When set to true, you can retry for failed recurring payments. The default value is true. - `startsAt` string — Start date of the billing plan, in YYYY-MM-DD format. The default value is the transaction date. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'pix' — The payment method type. - PixPayByBankDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `deviceId` string - `issuer` string - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `riskSignals` PixPayByBankRiskSignals - `confidenceScore` ConfidenceScore - `errors` string[] - `score` number, double - `elapsedTimeSinceBoot` integer - `isRootedDevice` boolean - `language` string - `osVersion` string - `screenBrightness` integer - `screenDimensions` ScreenDimensions - `height` integer - `width` integer - `userTimeZoneOffset` integer - `type` 'paybybank_pix' — **paybybank_pix** - PseDetails - `bank` string, required — The shopper's bank. - `checkoutAttemptId` string — The checkout attempt identifier. - `clientType` string, required — The client type. - `identification` string, required — The identification code. - `identificationType` string, required — The identification type. - `type` 'pse_payulatam' — The payment method type. - RakutenPayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'rakutenpay' — **rakutenpay** - RatepayDetails - `billingAddress` string — The address where to send the invoice. - `checkoutAttemptId` string — The checkout attempt identifier. - `deliveryAddress` string — The address where the goods should be delivered. - `personalDetails` string — Shopper name, date of birth, phone number, and email address. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'ratepay' | 'ratepay_directdebit', required — **ratepay** - RivertyDetails - `billingAddress` string — The address where to send the invoice. - `checkoutAttemptId` string — The checkout attempt identifier. - `deliveryAddress` string — The address where the goods should be delivered. - `deviceFingerprint` string — A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). - `iban` string — The iban number of the customer - `personalDetails` string — Shopper name, date of birth, phone number, and email address. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `subtype` string — The payment method subtype. - `type` 'riverty' | 'riverty_account' | 'riverty_installments' | 'sepadirectdebit_riverty', required — **riverty** - SamsungPayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `samsungPayToken` string, required — The payload you received from the Samsung Pay SDK response. - `type` 'samsungpay' — **samsungpay** - SepaDirectDebitDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `dueDate` string — The date that the the shopper's bank account is charged. - `iban` string, required — The International Bank Account Number (IBAN). - `ownerName` string, required — The name of the bank account holder. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `transferInstrumentId` string — The unique identifier of your user's verified transfer instrument, which you can use to top up their balance accounts. - `type` 'sepadirectdebit' | 'sepadirectdebit_amazonpay' — **sepadirectdebit** - StoredPaymentMethodDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'alipay_plus' | 'alipay_plus_alipay_cn' | 'alipay_plus_alipay_hk' | 'alipay_plus_dana' | 'alipay_plus_gcash' | 'alipay_plus_kakaopay' | 'alipay_plus_kplus' | 'alipay_plus_naverpay' | 'alipay_plus_rabbitlinepay' | 'alipay_plus_tosspay' | 'alipay_plus_touchngo' | 'alipay_plus_truemoney' | 'bcmc_mobile' | 'bcmc_mobile_QR' | 'bcmc_mobile_app' | 'momo_wallet' | 'momo_wallet_app' | 'paymaya_wallet' | 'grabpay_SG' | 'grabpay_MY' | 'grabpay_TH' | 'grabpay_ID' | 'grabpay_VN' | 'grabpay_PH' | 'oxxo' | 'gcash' | 'dana' | 'kakaopay' | 'truemoney' | 'paysafecard' — The payment method type. - TwintDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `subtype` string — The type of flow to initiate. - `type` 'twint' — The payment method type. - UpiCollectDetails - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper. - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. - `type` 'upi_collect', required — **upi_collect** - `virtualPaymentAddress` string — The virtual payment address for UPI. - UpiIntentDetails - `appId` string — TPAP (Third Party Application) Id that is being used to make the UPI payment - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper. - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. - `type` 'upi_intent', required — **upi_intent** - UpiQrDetails - `billingSequenceNumber` string — The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper. - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `shopperNotificationReference` string — The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. - `type` 'upi_qr', required — **upi_qr** - VippsDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `telephoneNumber` string, required - `type` 'vipps' — **vipps** - VisaCheckoutDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `fundingSource` 'credit' | 'debit' | 'prepaid' — The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. - `type` 'visacheckout' — **visacheckout** - `visaCheckoutCallId` string, required — The Visa Click to Pay Call ID value. When your shopper selects a payment and/or a shipping address from Visa Click to Pay, you will receive a Visa Click to Pay Call ID. - WeChatPayDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `type` 'wechatpay' | 'wechatpay_pos' — **wechatpay** - WeChatPayMiniProgramDetails - `appId` string - `checkoutAttemptId` string — The checkout attempt identifier. - `openid` string - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'wechatpayMiniProgram' — **wechatpayMiniProgram** - ZipDetails - `checkoutAttemptId` string — The checkout attempt identifier. - `clickAndCollect` string — Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them. - `recurringDetailReference` string — This is the `recurringDetailReference` returned in the response when you created the token. - `type` 'zip' | 'zip_pos' — **zip** - `recurringExpiry` string — Date after which no further authorisations shall be performed. Only for 3D Secure 2. - `recurringFrequency` string — Minimum number of days between authorisations. Only for 3D Secure 2. - `recurringProcessingModel` 'CardOnFile' | 'Subscription' | 'UnscheduledCardOnFile' — Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. - `redirectFromIssuerMethod` string — Specifies the redirect method (GET or POST) when redirecting back from the issuer. - `redirectToIssuerMethod` string — Specifies the redirect method (GET or POST) when redirecting to the issuer. - `reference` string, required — The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. To provide multiple references for one transaction, separate the reference values with the hyphen (`-`) character.We strongly recommend that you use a unique value for each transaction. Maximum length: 80 characters. - `returnUrl` string, required — The URL to return to in case of a redirection. The format depends on the channel. * 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.example.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` If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address. - `riskData` RiskData - `clientData` string — Contains client-side data, like the device fingerprint, cookies, and specific browser settings. - `sessionValidity` string — The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00 - `shopperConversionId` string — A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates. - `shopperEmail` string — The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > Required for Visa and JCB transactions that require 3D Secure 2 authentication if you did not include the `telephoneNumber`. - `shopperIP` string — The shopper's IP address. We recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > Required for Visa and JCB transactions that require 3D Secure 2 authentication for all web and mobile integrations, if you did not include the `shopperEmail`. For native mobile integrations, the field is required to support cases where authentication is routed to the redirect flow. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). - `shopperInteraction` 'Ecommerce' | 'ContAuth' | 'Moto' | 'POS' — 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. - `shopperLocale` string — The combination of a language code and a country code to specify the language to be used in the payment. - `shopperName` ShopperName - `firstName` string, required — The first name. - `lastName` string, required — The last name. - `shopperReference` string — Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. - `shopperStatement` string — The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /**. - `socialSecurityNumber` string — The shopper's social security number. - `splits` Split[] — An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). - `account` string — The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/classic-platforms): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked. - `amount` SplitAmount - `currency` string — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency. - `value` integer, required — The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). - `description` string — Your description for the split item. - `reference` string — Your unique reference for the part of the payment booked to the specified `account`. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/classic-platforms)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/adyen-for-platforms-model)). For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. - `type` 'AcquiringFees' | 'AdyenCommission' | 'AdyenFees' | 'AdyenMarkup' | 'BalanceAccount' | 'Commission' | 'Default' | 'Interchange' | 'MarketPlace' | 'PaymentFee' | 'Remainder' | 'SchemeFee' | 'Surcharge' | 'Tip' | 'TopUp' | 'VAT', required — The part of the payment you want to book to the specified `account`. Possible values for the [Balance Platform](https://docs.adyen.com/adyen-for-platforms-model): * **BalanceAccount**: Books part of the payment (specified in `amount`) to the specified `account`. * Transaction fees types that you can book to the specified `account`: * **AcquiringFees**: The aggregated amount of the interchange and scheme fees. * **PaymentFee**: The aggregated amount of all transaction fees. * **AdyenFees**: The aggregated amount of Adyen's commission and markup fees. * **AdyenCommission**: The transaction fees due to Adyen under [blended rates](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **AdyenMarkup**: The transaction fees due to Adyen under [Interchange ++ pricing](https://www.adyen.com/knowledge-hub/interchange-fees-explained). * **Interchange**: The fees paid to the issuer for each payment made with the card network. * **SchemeFee**: The fees paid to the card scheme for using their network. * **Commission**: Your platform's commission on the payment (specified in `amount`), booked to your liable balance account. * **Remainder**: The amount left over after a currency conversion, booked to the specified `account`. * **Surcharge**: The payment acceptance fee imposed by the card scheme or debit network provider, paid by your user's customer. * **TopUp**: Allows you and your users to top up balance accounts using direct debit, card payments, or other payment methods. * **VAT**: The value-added tax charged on the payment, booked to your platforms liable balance account. * **Default**: In very specific use cases, allows you to book the specified `amount` to the specified `account`. For more information, contact Adyen support. Possible values for the [Classic Platforms integration](https://docs.adyen.com/classic-platforms): **Commission**, **Default**, **MarketPlace**, **PaymentFee**, **VAT**. - `store` string — Required for Adyen for Platforms integrations if you are a platform model. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-reference) (on [balance platform](https://docs.adyen.com/platforms)) or the [storeReference](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccountHolder#request-accountHolderDetails-storeDetails-storeReference) (in the [classic integration](https://docs.adyen.com/classic-platforms/processing-payments/route-payment-to-store/#route-a-payment-to-a-store)) for the ecommerce or point-of-sale store that is processing the payment. - `subMerchants` SubMerchantInfoWrapper[] — This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator - `SubMerchant` SubMerchantInfo - `address` BillingAddress - `city` string, required — The name of the city. Maximum length: 3000 characters. - `country` string, required — The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. - `houseNumberOrName` string, required — The number or name of the house. Maximum length: 3000 characters. - `postalCode` string, required — A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. - `stateOrProvince` string — The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. - `street` string, required — 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`. - `amount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `email` string — Required for transactions performed by registered payment facilitators. The email associated with the sub-merchant's account. - `id` string — 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. * Format: Alphanumeric * Maximum length: 15 characters - `mcc` string — Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits - `name` string — Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. Exception: for acquirers in Brazil, this value does not overwrite the shopper statement. * Format: Alphanumeric * Maximum length: 22 characters - `phoneNumber` string — Required for transactions performed by registered payment facilitators. The phone number associated with the sub-merchant's account. - `registeredSince` string - `taxId` string — Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ - `url` string — Required for transactions performed by registered payment facilitators. The sub-merchant's URL on the platform, i.e. the sub-merchant's shop. - `surcharge` Surcharge - `value` integer, required — The [surcharge](https://docs.adyen.com/online-payments/surcharge/) amount to apply to the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). When you apply surcharge, include the surcharge in the `amount.value` field. Review our [Surcharge compliance guide](https://docs.adyen.com/development-resources/surcharge-compliance/) to learn about how to comply with regulatory requirements when applying surcharge. - `telephoneNumber` string — The shopper's telephone number. The phone number must include a plus sign (+) and a country code (1-3 digits), followed by the number (4-15 digits). If the value you provide does not follow the guidelines, we do not submit it for authentication. > Required for Visa and JCB transactions that require 3D Secure 2 authentication, if you did not include the `shopperEmail`. - `trustedShopper` boolean — Set to true if the payment should be routed to a trusted MID. ## Response `200` OK - the request has succeeded. - PaymentResponse - `additionalData` object — Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. - `details` InputDetail[] — When non-empty, contains all the fields that you must submit to the `/payments/details` endpoint. - `configuration` object — Configuration parameters for the required input. - `details` SubInputDetail[] — Input details can also be provided recursively. - `configuration` object — Configuration parameters for the required input. - `items` Item[] — In case of a select, the items to choose from. - `id` string — The value to provide in the result. - `name` string — The display name. - `key` string — The value to provide in the result. - `optional` boolean — True if this input is optional to provide. - `type` string — The type of the required input. - `value` string — The value can be pre-filled, if available. - `inputDetails` SubInputDetail[] — Input details can also be provided recursively (deprecated). - `configuration` object — Configuration parameters for the required input. - `items` Item[] — In case of a select, the items to choose from. - `id` string — The value to provide in the result. - `name` string — The display name. - `key` string — The value to provide in the result. - `optional` boolean — True if this input is optional to provide. - `type` string — The type of the required input. - `value` string — The value can be pre-filled, if available. - `itemSearchUrl` string — In case of a select, the URL from which to query the items. - `items` Item[] — In case of a select, the items to choose from. - `id` string — The value to provide in the result. - `name` string — The display name. - `key` string — The value to provide in the result. - `optional` boolean — True if this input value is optional. - `type` string — The type of the required input. - `value` string — The value can be pre-filled, if available. - `fraudResult` FraudResult - `accountScore` integer, required — The total fraud score generated by the risk checks. - `results` FraudCheckResultWrapper[] — The result of the individual risk checks. - `FraudCheckResult` FraudCheckResult - `accountScore` integer, required — The fraud score generated by the risk check. - `checkId` integer, required — The ID of the risk check. - `name` string, required — The name of the risk check. - `order` CheckoutOrderResponse - `amount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `expiresAt` string — The expiry date for the order. - `orderData` string — The encrypted order data. - `pspReference` string, required — The `pspReference` that belongs to the order. - `reference` string — The merchant reference for the order. - `remainingAmount` Amount - `currency` string, required — The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes#currency-codes) of the amount. - `value` integer, required — The numeric value of the amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes#minor-units). - `outputDetails` object — Contains the details that will be presented to the shopper. - `paymentData` string — When non-empty, contains a value that you must submit to the `/payments/details` endpoint. - `pspReference` string — Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response. - `redirect` Redirect - `data` object — When the redirect URL must be accessed via POST, use this data to post to the redirect URL. - `method` 'GET' | 'POST' — The web method that you must use to access the redirect URL. Possible values: GET, POST. - `url` string — The URL, to which you must redirect a shopper to complete a payment. - `refusalReason` string — If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). - `refusalReasonCode` string — Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). - `resultCode` 'AuthenticationFinished' | 'AuthenticationNotRequired' | 'Authorised' | 'Cancelled' | 'ChallengeShopper' | 'Error' | 'IdentifyShopper' | 'PartiallyAuthorised' | 'Pending' | 'PresentToShopper' | 'Received' | 'RedirectShopper' | 'Refused' | 'Success' — The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. ## Other responses - `400` — Bad Request - a problem reading or understanding the request. - `401` — Unauthorized - authentication required. - `403` — Forbidden - insufficient permissions to process the request. - `422` — Unprocessable Entity - a request validation error. - `500` — Internal Server Error - the server could not process the request. --- [API](https://skmtc.net/adyen/apis/checkoutservice.md) · [All operations](https://skmtc.net/adyen/apis/checkoutservice/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/checkoutservice/versions/513ede066d35/schema)