Adyen · Schema
PaymentSetupRequest
PaymentSetupRequest schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| additionalAmount | object | If you want a [BIN or card verification](https://docs.adyen.com/payment-methods/cards/bin-data-and-card-verification) request to use a non-zero value, assign this value to `additionalAmount` (while th |
| 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. |
| allowedPaymentMethods | array | List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"allowedPay |
| amount | object | The amount information for the transaction (in [minor units](https://docs.adyen.com/development-resources/currency-codes)). For [BIN or card verification](https://docs.adyen.com/payment-methods/cards/ |
| applicationInfo | object | Information about your application. For more details, see [Building Adyen solutions](https://docs.adyen.com/development-resources/building-adyen-solutions). |
| billingAddress | object | The address where to send the invoice. > The `billingAddress` object is required in the following scenarios. Include all of the fields within this object. >* For 3D Secure 2 transactions in all browse |
| blockedPaymentMethods | array | List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `"blockedPaym |
| captureDelayHours | integer | The delay between the authorisation and scheduled auto-capture, specified in hours. |
| channel | string | 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 |
| checkoutAttemptId | string | Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. |
| company | object | Information regarding the company. |
| configuration | object | Specify configurations to enable additional features. |
| conversionId | string | Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. |
| countryCode | string | The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE |
| dateOfBirth | string | The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD |
| dccQuote | object | The forex quote as returned in the response of the forex service. |
| deliveryAddress | object | The address where the purchased goods should be delivered. |
| deliveryDate | string | 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 |
| 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. |
| 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 tokenized for recurring payments. |
| entityType | string | 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. |
| installments | object | Contains installment settings. For more information, refer to [Installments](https://docs.adyen.com/payment-methods/cards/credit-card-installments). |
| lineItems | array | Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3 |
| localizedShopperStatement | object | The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement |
| mandate | object | The mandate details to initiate recurring transaction. |
| 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 activi |
| merchantAccount | string | 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 sho |
| 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". * Maxim |
| 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 mu |
| origin | string | Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from. |
| platformChargebackLogic | object | Defines how to book chargebacks when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#chargebacks-and-disputes). |
| 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. |
| reference | string | 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 require |
| returnUrl | string | The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also |
| riskData | object | Contains risk data, such as client-side data, used to identify risk for a transaction. |
| sdkVersion | string | The version of the SDK you are using (for Web SDK integrations only). |
| 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 |
| shopperEmail | string | The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and m |
| shopperIP | string | The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Se |
| shopperInteraction | string | 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 b |
| shopperLocale | string | The combination of a language code and a country code to specify the language to be used in the payment. |
| shopperName | object | The shopper's full 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 identif |
| 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, |
| socialSecurityNumber | string | The shopper's social security number. |
| splits | array | An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [I |
| store | string | Required for Adyen for Platforms integrations if you have a platform setup. This is your [reference](https://docs.adyen.com/api-explorer/Management/3/post/merchants/(merchantId)/stores#request-referen |
| storePaymentMethod | boolean | When true and `shopperReference` is provided, the payment details will be stored. |
| telephoneNumber | string | The shopper's telephone number. |
| threeDSAuthenticationOnly | 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. |
| token | string | The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web. |
| trustedShopper | boolean | Set to true if the payment should be routed to a trusted MID. |