Skip to content

Latest commit

 

History

History
90 lines (77 loc) · 12.2 KB

PaymentRequest.md

File metadata and controls

90 lines (77 loc) · 12.2 KB

PaymentRequest

Properties

Name Type Description Notes
amount Amount
merchantAccount kotlin.String The merchant account identifier, with which you want to process the transaction.
reference kotlin.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 requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
accountInfo AccountInfo [optional]
additionalAmount Amount [optional]
additionalData kotlin.collections.Map<kotlin.String, kotlin.String> 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. [optional]
applicationInfo ApplicationInfo [optional]
bankAccount BankAccount [optional]
billingAddress Address [optional]
browserInfo BrowserInfo [optional]
captureDelayHours kotlin.Int The delay between the authorisation and scheduled auto-capture, specified in hours. [optional]
card Card [optional]
dateOfBirth kotlin.String The shopper's date of birth. Format ISO-8601: YYYY-MM-DD [optional]
dccQuote ForexQuote [optional]
deliveryAddress Address [optional]
deliveryDate kotlin.String The date and time the purchased goods should be delivered. Format ISO 8601: YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 [optional]
deviceFingerprint kotlin.String A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting. [optional]
entityType inline The type of the entity the payment is processed for. [optional]
fraudOffset kotlin.Int An integer value that is added to the normal fraud score. The value can be either positive or negative. [optional]
fundDestination FundDestination [optional]
fundSource FundSource [optional]
fundingSource inline 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. [optional]
installments Installments [optional]
localizedShopperStatement kotlin.collections.Map<kotlin.String, kotlin.String> 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 is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. [optional]
mandate Mandate [optional]
mcc kotlin.String The 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. [optional]
merchantOrderReference kotlin.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`. [optional]
merchantRiskIndicator MerchantRiskIndicator [optional]
metadata kotlin.collections.Map<kotlin.String, kotlin.String> Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the &quot;177&quot; error occurs: &quot;Metadata size exceeds limit&quot;. * Maximum 20 characters per key. * Maximum 80 characters per value. [optional]
mpiData ThreeDSecureData [optional]
nationality kotlin.String The two-character country code of the shopper's nationality. [optional]
orderReference kotlin.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. [optional]
platformChargebackLogic PlatformChargebackLogic [optional]
recurring Recurring [optional]
recurringProcessingModel inline 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. [optional]
selectedBrand kotlin.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. [optional]
selectedRecurringDetailReference kotlin.String The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. [optional]
sessionId kotlin.String A session ID used to identify a payment session. [optional]
shopperEmail kotlin.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 mobile implementations. [optional]
shopperIP kotlin.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 Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, contact Support. [optional]
shopperInteraction inline 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. [optional]
shopperLocale kotlin.String The combination of a language code and a country code to specify the language to be used in the payment. [optional]
shopperName Name [optional]
shopperReference kotlin.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. [optional]
shopperStatement kotlin.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 . , ' _ - ? + * /_. [optional]
socialSecurityNumber kotlin.String The shopper's social security number. [optional]
splits kotlin.collections.List<Split> An array of objects specifying how the payment should be split when using Adyen for Platforms or Issuing. [optional]
store kotlin.String The ecommerce or point-of-sale store that is processing the payment. Used in: * Partner platform integrations for the Classic Platforms integration. * Platform setup integrations for the Balance Platform. [optional]
telephoneNumber kotlin.String The shopper's telephone number. [optional]
threeDS2RequestData ThreeDS2RequestData [optional]
threeDSAuthenticationOnly kotlin.Boolean If set to true, you will only perform the 3D Secure 2 authentication, and not the payment authorisation. [optional]
totalsGroup kotlin.String The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). [optional]
trustedShopper kotlin.Boolean Set to true if the payment should be routed to a trusted MID. [optional]

Enum: entityType

Name Value
entityType NaturalPerson, CompanyName

Enum: fundingSource

Name Value
fundingSource credit, debit

Enum: recurringProcessingModel

Name Value
recurringProcessingModel CardOnFile, Subscription, UnscheduledCardOnFile

Enum: shopperInteraction

Name Value
shopperInteraction Ecommerce, ContAuth, Moto, POS