--- title: "Create an authorisation" method: POST path: "/authorise" tags: ["Payments"] --- # Create an authorisation `POST /authorise` Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation. > This endpoint is [inactive](https://docs.adyen.com/online-payments/upgrade-your-integration#checkout-api-lifecycle) and is no longer supported for new integrations. > * If you are building a new integration, use the Checkout API [`/payments`](https://docs.adyen.com/api-explorer/Checkout/latest/post/payments) endpoint instead. > * If you have an existing integration using this endpoint, reach out to your Adyen contact and [migrate to the Checkout API](https://docs.adyen.com/online-payments/upgrade-your-integration/migrate-to-checkout-api). >The Checkout API enables your [online payments](https://docs.adyen.com/online-payments) integration to accept all supported payment methods, use the latest features, and access more benefits. ## Request body - PaymentRequest - `accountInfo` AccountInfo - `accountAgeIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days - `accountChangeDate` string, date-time — Date when the shopper's account was last changed. - `accountChangeIndicator` 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days - `accountCreationDate` string, date-time — Date when the shopper's account was created. - `accountType` 'notApplicable' | 'credit' | 'debit' — Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit - `addCardAttemptsDay` integer — Number of attempts the shopper tried to add a card to their account in the last day. - `deliveryAddressUsageDate` string, date-time — Date the selected delivery address was first used. - `deliveryAddressUsageIndicator` 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days - `homePhone` string — Shopper's home phone number (including the country code). - `mobilePhone` string — Shopper's mobile phone number (including the country code). - `passwordChangeDate` string, date-time — Date when the shopper last changed their password. - `passwordChangeIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days - `pastTransactionsDay` integer — Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. - `pastTransactionsYear` integer — Number of all transactions (successful and abandoned) from this shopper in the past year. - `paymentAccountAge` string, date-time — Date this payment method was added to the shopper's account. - `paymentAccountIndicator` 'notApplicable' | 'thisTransaction' | 'lessThan30Days' | 'from30To60Days' | 'moreThan60Days' — Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days - `purchasesLast6Months` integer — Number of successful purchases in the last six months. - `suspiciousActivity` boolean — Whether suspicious activity was recorded on this account. - `workPhone` string — Shopper's work phone number (including the country code). - `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). - `applicationInfo` ApplicationInfo - `adyenLibrary` CommonField - `name` string — Name of the field. For example, Name of External Platform. - `version` string — Version of the field. For example, Version of External Platform. - `adyenPaymentSource` CommonField - `name` string — Name of the field. For example, Name of External Platform. - `version` string — Version of the field. For example, Version of External Platform. - `externalPlatform` ExternalPlatform - `integrator` string — External platform integrator. - `name` string — Name of the field. For example, Name of External Platform. - `version` string — Version of the field. For example, Version of External Platform. - `merchantApplication` CommonField - `name` string — Name of the field. For example, Name of External Platform. - `version` string — Version of the field. For example, Version of External Platform. - `merchantDevice` MerchantDevice - `os` string — Operating system running on the merchant device. - `osVersion` string — Version of the operating system on the merchant device. - `reference` string — Merchant device reference. - `shopperInteractionDevice` ShopperInteractionDevice - `locale` string — Locale on the shopper interaction device. - `os` string — Operating system running on the shopper interaction device. - `osVersion` string — Version of the operating system on the shopper interaction device. - `bankAccount` BankAccount - `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` 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`. - `browserInfo` BrowserInfo - `acceptHeader` string, required — The accept header value of the shopper's browser. - `colorDepth` integer, required — The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. - `javaEnabled` boolean, required — Boolean value indicating if the shopper's browser is able to execute Java. - `javaScriptEnabled` boolean — Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. - `language` string, required — The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). - `screenHeight` integer, required — The total height of the shopper's device screen in pixels. - `screenWidth` integer, required — The total width of the shopper's device screen in pixels. - `timeZoneOffset` integer, required — Time difference between UTC time and the shopper's browser local time, in minutes. - `userAgent` string, required — The user agent value of the shopper's browser. - `captureDelayHours` integer — The delay between the authorisation and scheduled auto-capture, specified in hours. - `card` Card - `cvc` string — 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. - `expiryMonth` string — The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November - `expiryYear` string — The card expiry year. Format: 4 digits. For example: 2020 - `holderName` string — The name of the cardholder, as printed on the card. - `issueNumber` string — The issue number of the card (for some UK debit cards only). - `number` string — 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. - `startMonth` string — The month component of the start date (for some UK debit cards only). - `startYear` string — The year component of the start date (for some UK debit cards only). - `dateOfBirth` string, date — 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` 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`. - `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). - `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. - `fundDestination` FundDestination - `IBAN` string — Bank Account Number of the recipient - `additionalData` object — a map of name/value pairs for passing in additional/industry-specific data - `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`. - `card` Card - `cvc` string — 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. - `expiryMonth` string — The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November - `expiryYear` string — The card expiry year. Format: 4 digits. For example: 2020 - `holderName` string — The name of the cardholder, as printed on the card. - `issueNumber` string — The issue number of the card (for some UK debit cards only). - `number` string — 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. - `startMonth` string — The month component of the start date (for some UK debit cards only). - `startYear` string — The year component of the start date (for some UK debit cards only). - `selectedRecurringDetailReference` string — The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. - `shopperEmail` string — the email address of the person - `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. - `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 person - `walletPurpose` string — The purpose of a digital wallet transaction. - `fundSource` FundSource - `additionalData` object — A map of name-value pairs for passing additional or industry-specific data. - `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`. - `card` Card - `cvc` string — 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. - `expiryMonth` string — The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November - `expiryYear` string — The card expiry year. Format: 4 digits. For example: 2020 - `holderName` string — The name of the cardholder, as printed on the card. - `issueNumber` string — The issue number of the card (for some UK debit cards only). - `number` string — 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. - `startMonth` string — The month component of the start date (for some UK debit cards only). - `startYear` string — The year component of the start date (for some UK debit cards only). - `shopperEmail` string — Email address of the person. - `shopperName` Name - `firstName` string, required — The first name. - `lastName` string, required — The last name. - `telephoneNumber` string — Phone number of the person - `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**. - `installments` Installments - `extra` integer — Defines the bonus percentage, refund percentage or if the transaction is Buy now Pay later. Used for [card installments in Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico) - `plan` 'bonus' | 'buynow_paylater' | 'interes_refund_prctg' | 'interest_bonus' | 'nointeres_refund_prctg' | 'nointerest_bonus' | 'refund_prctg' | 'regular' | 'revolving' | 'with_interest' — The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). and [Mexico](https://docs.adyen.com/payment-methods/cards/credit-card-installments/#getting-paid-mexico). By default, this is set to **regular**. - `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. - `localizedShopperStatement` object — The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If this parameter is left empty, not provided, or not applicable (in case of cross-border transactions), then **shopperStatement** is used. Currently, `localizedShopperStatement` is only supported for payments with Visa, Mastercard, JCB, Diners, and Discover. **Supported characters**: Hiragana, Katakana, Kanji, and alphanumeric. - `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: **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 — 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`. - `merchantRiskIndicator` MerchantRiskIndicator - `addressMatch` boolean — Whether the chosen delivery address is identical to the billing address. - `deliveryAddressIndicator` 'shipToBillingAddress' | 'shipToVerifiedAddress' | 'shipToNewAddress' | 'shipToStore' | 'digitalGoods' | 'goodsNotShipped' | 'other' — Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other` - `deliveryEmail` string — The delivery email address (for digital goods). - `deliveryEmailAddress` string — For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters. - `deliveryTimeframe` 'electronicDelivery' | 'sameDayShipping' | 'overnightShipping' | 'twoOrMoreDaysShipping' — The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` - `giftCardAmount` 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). - `giftCardCount` integer — For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. - `giftCardCurr` string — For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. - `preOrderDate` string, date-time — For pre-order purchases, the expected date this product will be available to the shopper. - `preOrderPurchase` boolean — Indicator for whether this transaction is for pre-ordering a product. - `preOrderPurchaseInd` string — Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. - `reorderItems` boolean — Indicator for whether the shopper has already purchased the same items in the past. - `reorderItemsInd` string — Indicates whether the cardholder is reordering previously purchased merchandise. - `shipIndicator` string — Indicates shipping method chosen for the transaction. - `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. - `challengeCancel` '01' | '02' | '03' | '04' | '05' | '06' | '07' — Indicator informing the Access Control Server (ACS) and the Directory Server (DS) that the authentication has been cancelled. For possible values, refer to [3D Secure API reference](https://docs.adyen.com/online-payments/3d-secure/api-reference#mpidata). - `directoryResponse` 'A' | 'C' | 'D' | 'I' | 'N' | 'R' | 'U' | 'Y' — In 3D Secure 2, this is the `transStatus` from the `ARes`. - `dsTransID` string — Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. - `eci` string — The electronic commerce indicator. - `riskScore` string — Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations. - `threeDSVersion` string — The version of the 3D Secure protocol. - `tokenAuthenticationVerificationValue` string, byte — Network token authentication verification value (TAVV). The network token cryptogram. - `transStatusReason` string — Provides information on why the `transStatus` field has the specified value. For possible values, refer to [our docs](https://docs.adyen.com/online-payments/3d-secure/api-reference#possible-transstatusreason-values). - `xid` string, byte — Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form). - `nationality` string — The two-character country code of the shopper's nationality. - `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. - `platformChargebackLogic` PlatformChargebackLogic - `behavior` 'deductAccordingToSplitRatio' | 'deductFromLiableAccount' | 'deductFromOneBalanceAccount' — The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. - `costAllocationAccount` string — The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. - `targetAccount` string — The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. - `recurring` Recurring - `contract` 'ONECLICK' | 'ONECLICK,RECURRING' | 'RECURRING' | 'PAYOUT' | 'EXTERNAL' — The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts). * `EXTERNAL` - Use this when you store payment details and send the raw card number or network token directly in your API request. - `recurringDetailName` string — A descriptive name for this detail. - `recurringExpiry` string, date-time — 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. - `tokenService` 'VISATOKENSERVICE' | 'MCTOKENSERVICE' | 'AMEXTOKENSERVICE' | 'TOKEN_SHARING' — The name of the token service. - `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. - `reference` string, required — 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. - `secureRemoteCommerceCheckoutData` SecureRemoteCommerceCheckoutData - `checkoutPayload` string — The Secure Remote Commerce checkout payload to process the payment with. - `correlationId` string — This is the unique identifier generated by SRC system to track and link SRC messages. Available within the present checkout session (e.g. received in an earlier API response during the present session). - `cvc` string — The [card verification code](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#card-security-code-cvc-cvv-cid). - `digitalCardId` string — A unique identifier that represents the token associated with a card enrolled. Required for scheme 'mc'. - `scheme` 'mc' | 'visa' — The Secure Remote Commerce scheme. - `tokenReference` string — A unique identifier that represents the token associated with a card enrolled. Required for scheme 'visa'. - `selectedBrand` string — Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card. - `selectedRecurringDetailReference` string — The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. - `sessionId` string — A session ID used to identify a payment session. - `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 language for the payment. The value combines the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) language code with the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes) country code. For example, **nl-NL**. When using Drop-in/Components, the specified language appears if your front-end global configuration does not set the `locale`. - `shopperName` 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. - `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 the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms](https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). - `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. - `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`. - `threeDS2RequestData` ThreeDS2RequestData - `acctInfo` AcctInfo - `chAccAgeInd` '01' | '02' | '03' | '04' | '05' — Length of time that the cardholder has had the account with the 3DS Requestor. Allowed values: * **01** — No account * **02** — Created during this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days - `chAccChange` string — Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Format: **YYYYMMDD** - `chAccChangeInd` '01' | '02' | '03' | '04' — Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Allowed values: * **01** — Changed during this transaction * **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60 days - `chAccPwChange` string — Date that cardholder’s account with the 3DS Requestor had a password change or account reset. Format: **YYYYMMDD** - `chAccPwChangeInd` '01' | '02' | '03' | '04' | '05' — Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. Allowed values: * **01** — No change * **02** — Changed during this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days - `chAccString` string — Date that the cardholder opened the account with the 3DS Requestor. Format: **YYYYMMDD** - `nbPurchaseAccount` string — Number of purchases with this cardholder account during the previous six months. Max length: 4 characters. - `paymentAccAge` string — String that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Format: **YYYYMMDD** - `paymentAccInd` '01' | '02' | '03' | '04' | '05' — Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Allowed values: * **01** — No account (guest checkout) * **02** — During this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days - `provisionAttemptsDay` string — Number of Add Card attempts in the last 24 hours. Max length: 3 characters. - `shipAddressUsage` string — String when the shipping address used for this transaction was first used with the 3DS Requestor. Format: **YYYYMMDD** - `shipAddressUsageInd` '01' | '02' | '03' | '04' — Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Allowed values: * **01** — This transaction * **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60 days - `shipNameIndicator` '01' | '02' — Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Allowed values: * **01** — Account Name identical to shipping Name * **02** — Account Name different to shipping Name - `suspiciousAccActivity` '01' | '02' — Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Allowed values: * **01** — No suspicious activity has been observed * **02** — Suspicious activity has been observed - `txnActivityDay` string — Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters. - `txnActivityYear` string — Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters. - `acctType` '01' | '02' | '03' — Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit - `acquirerBIN` string — Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. - `acquirerMerchantID` string — Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. - `addrMatch` 'Y' | 'N' — Indicates whether the cardholder shipping address and cardholder billing address are the same. Allowed values: * **Y** — Shipping address matches billing address. * **N** — Shipping address does not match billing address. - `authenticationOnly` boolean — 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. - `challengeIndicator` 'noPreference' | 'requestNoChallenge' | 'requestChallenge' | 'requestChallengeAsMandate' — Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` - `deviceChannel` string, required — The environment of the shopper. Allowed values: * `app` * `browser` - `deviceRenderOptions` DeviceRenderOptions - `sdkInterface` 'native' | 'html' | 'both' — Supported SDK interface types. Allowed values: * native * html * both - `sdkUiType` string[] — UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect - `homePhone` Phone - `cc` string — Country code. Length: 1–3 digits. - `subscriber` string — Subscriber number. Length: 4-15 digits. - `mcc` string — Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. - `merchantName` string — Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters. > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account. - `messageVersion` string — The `messageVersion` value indicating the 3D Secure 2 protocol version. - `mobilePhone` Phone - `cc` string — Country code. Length: 1–3 digits. - `subscriber` string — Subscriber number. Length: 4-15 digits. - `notificationURL` string — URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. - `payTokenInd` boolean — Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. - `paymentAuthenticationUseCase` string — Indicates the type of payment for which an authentication is requested (message extension) - `purchaseInstalData` string — Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters. - `recurringExpiry` string — Date after which no further authorisations shall be performed. Format: YYYYMMDD - `recurringFrequency` string — Indicates the minimum number of days between authorisations. Maximum length: 4 characters. - `sdkAppID` string — The `sdkAppID` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. - `sdkEncData` string — The `sdkEncData` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. - `sdkEphemPubKey` SDKEphemPubKey - `crv` string — The `crv` value as received from the 3D Secure 2 SDK. - `kty` string — The `kty` value as received from the 3D Secure 2 SDK. - `x` string — The `x` value as received from the 3D Secure 2 SDK. - `y` string — The `y` value as received from the 3D Secure 2 SDK. - `sdkMaxTimeout` integer — The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes. - `sdkReferenceNumber` string — The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. - `sdkTransID` string — The `sdkTransID` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. - `sdkVersion` string — Version of the 3D Secure 2 mobile SDK. Only for `deviceChannel` set to **app**. - `threeDSCompInd` string — Completion indicator for the device fingerprinting. - `threeDSRequestorAuthenticationInd` string — Indicates the type of Authentication request. - `threeDSRequestorAuthenticationInfo` ThreeDSRequestorAuthenticationInfo - `threeDSReqAuthData` string — Data that documents and supports a specific authentication process. Maximum length: 2048 bytes. - `threeDSReqAuthMethod` '01' | '02' | '03' | '04' | '05' | '06' — Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values: * **01** — No 3DS Requestor authentication occurred (for example, cardholder “logged in” as guest). * **02** — Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials. * **03** — Login to the cardholder account at the 3DS Requestor system using federated ID. * **04** — Login to the cardholder account at the 3DS Requestor system using issuer credentials. * **05** — Login to the cardholder account at the 3DS Requestor system using third-party authentication. * **06** — Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator. - `threeDSReqAuthTimestamp` string — Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM - `threeDSRequestorChallengeInd` '01' | '02' | '03' | '04' | '05' | '06' — Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only - `threeDSRequestorID` string — Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2. - `threeDSRequestorName` string — Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2. - `threeDSRequestorPriorAuthenticationInfo` ThreeDSRequestorPriorAuthenticationInfo - `threeDSReqPriorAuthData` string — Data that documents and supports a specific authentication process. Maximum length: 2048 bytes. - `threeDSReqPriorAuthMethod` '01' | '02' | '03' | '04' — Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values: * **01** — Frictionless authentication occurred by ACS. * **02** — Cardholder challenge occurred by ACS. * **03** — AVS verified. * **04** — Other issuer methods. - `threeDSReqPriorAuthTimestamp` string — Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM - `threeDSReqPriorRef` string — This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters. - `threeDSRequestorURL` string — URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process. - `transType` '01' | '03' | '10' | '11' | '28' — Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi-Cash Transaction * **28** — Prepaid Activation and Load - `transactionType` 'goodsOrServicePurchase' | 'checkAcceptance' | 'accountFunding' | 'quasiCashTransaction' | 'prepaidActivationAndLoad' — Identify the type of the transaction being authenticated. - `whiteListStatus` string — The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. - `workPhone` Phone - `cc` string — Country code. Length: 1–3 digits. - `subscriber` string — Subscriber number. Length: 4-15 digits. - `threeDSAuthenticationOnly` boolean — Required to trigger the [authentication-only flow](https://docs.adyen.com/online-payments/3d-secure/authentication-only/). If set to **true**, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: **false**. - `totalsGroup` string — The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). - `trustedShopper` boolean — Set to true if the payment should be routed to a trusted MID. ## Response `200` OK - the request has succeeded. - PaymentResult - `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**. - `authCode` string — Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. - `dccAmount` 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). - `dccSignature` string — Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). - `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. - `issuerUrl` string — The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL. - `md` string — The payment session. - `paRequest` string — The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). - `pspReference` string — Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. - `refusalReason` 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). - `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/adyen-payment-api.md) · [All operations](https://skmtc.net/adyen/apis/adyen-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adyen/adyen-payment-api/versions/82f2803ec1b9/schema)