PaymentRequest class abstract

PaymentRequest

Properties:

  • accountInfo - Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.
  • additionalAmount - If you want a BIN or card verification request to use a non-zero value, assign this value to additionalAmount (while the amount must be still set to 0 to trigger BIN or card verification). Required to be in the same currency as the amount.
  • additionalData - 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 - The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
  • applicationInfo - Information about your application. For more details, see Building Adyen solutions.
  • bankAccount - The details of the bank account, from which the payment should be made. > Either bankAccount or card field must be provided in a payment request.
  • billingAddress - The address where to send the invoice. > The billingAddress object is required in the following scenarios. Include all of the fields within this object. >* For 3D Secure 2 transactions in all browser-based and mobile implementations. >* For cross-border payouts to and from Canada.
  • browserInfo - The shopper's browser information. > For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the userAgent and acceptHeader fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 2 redirect.
  • captureDelayHours - The delay between the authorisation and scheduled auto-capture, specified in hours.
  • card - A container for card data. > Either bankAccount or card field must be provided in a payment request.
  • dateOfBirth - The shopper's date of birth. Format ISO-8601: YYYY-MM-DD
  • dccQuote - The forex quote as returned in the response of the forex service.
  • deliveryAddress - The address where the purchased goods should be delivered.
  • deliveryDate - 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
  • deviceFingerprint - A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
  • entityType - The type of the entity the payment is processed for.
  • fraudOffset - An integer value that is added to the normal fraud score. The value can be either positive or negative.
  • fundDestination - the person or entity receiving the money
  • fundSource - The person or entity funding the money.
  • fundingSource - 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 - Contains installment settings. For more information, refer to Installments.
  • localizedShopperStatement - 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 - The mandate details to initiate recurring transaction.
  • mcc - 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.
  • merchantAccount - The merchant account identifier, with which you want to process the transaction.
  • merchantOrderReference - 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 - Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.
  • metadata - 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 - Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
  • nationality - The two-character country code of the shopper's nationality.
  • orderReference - 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 merchantOrderReferenceinstead.
  • platformChargebackLogic - Defines how to book chargebacks when using Adyen for Platforms.
  • recurring - The recurring settings for the payment. Use this property when you want to enable recurring payments.
  • recurringProcessingModel - 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 - 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 - Checkout data for a Secure Remote Commerce payment.
  • selectedBrand - 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 - The recurringDetailReference you want to use for this payment. The value LATEST can be used to select the most recently stored recurring detail.
  • sessionId - A session ID used to identify a payment session.
  • shopperEmail - 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 - 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.
  • shopperInteraction - 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 - The combination of a language code and a country code to specify the language to be used in the payment.
  • shopperName - The shopper's full name.
  • shopperReference - 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 - 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 - The shopper's social security number.
  • splits - An array of objects specifying how the payment should be split when using either Adyen for Platforms for marketplaces or platforms, or standalone Issuing.
  • store - Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.
  • telephoneNumber - 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 - Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to Online payments or Classic integration documentation.
  • threeDSAuthenticationOnly - Required to trigger the authentication-only flow. If set to true, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: false.
  • totalsGroup - The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
  • trustedShopper - Set to true if the payment should be routed to a trusted MID.
Annotations
  • @BuiltValue.new()

Constructors

PaymentRequest([void updates(PaymentRequestBuilder b)])
factory

Properties

accountInfo → AccountInfo?
Shopper account information for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.
no setter
additionalAmount → Amount?
If you want a BIN or card verification request to use a non-zero value, assign this value to additionalAmount (while the amount must be still set to 0 to trigger BIN or card verification). Required to be in the same currency as the amount.
no setter
additionalData → BuiltMap<String, 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.
no setter
amount → Amount
The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
no setter
applicationInfo → ApplicationInfo?
Information about your application. For more details, see Building Adyen solutions.
no setter
bankAccount → BankAccount?
The details of the bank account, from which the payment should be made. > Either bankAccount or card field must be provided in a payment request.
no setter
billingAddress → Address?
The address where to send the invoice. > The billingAddress object is required in the following scenarios. Include all of the fields within this object. >* For 3D Secure 2 transactions in all browser-based and mobile implementations. >* For cross-border payouts to and from Canada.
no setter
browserInfo → BrowserInfo?
The shopper's browser information. > For 3D Secure, the full object is required for web integrations. For mobile app integrations, include the userAgent and acceptHeader fields to indicate that your integration can support a redirect in case a payment is routed to 3D Secure 2 redirect.
no setter
captureDelayHours → int?
The delay between the authorisation and scheduled auto-capture, specified in hours.
no setter
card → Card?
A container for card data. > Either bankAccount or card field must be provided in a payment request.
no setter
dateOfBirth → Date?
The shopper's date of birth. Format ISO-8601: YYYY-MM-DD
no setter
dccQuote → ForexQuote?
The forex quote as returned in the response of the forex service.
no setter
deliveryAddress → Address?
The address where the purchased goods should be delivered.
no setter
deliveryDate → DateTime?
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
no setter
deviceFingerprint → String?
A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
no setter
entityType → PaymentRequestEntityTypeEnum?
The type of the entity the payment is processed for.
no setter
fraudOffset → int?
An integer value that is added to the normal fraud score. The value can be either positive or negative.
no setter
fundDestination → FundDestination?
the person or entity receiving the money
no setter
fundingSource → PaymentRequestFundingSourceEnum?
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.
no setter
fundSource → FundSource?
The person or entity funding the money.
no setter
hashCode → int
The hash code for this object.
no setterinherited
installments → Installments?
Contains installment settings. For more information, refer to Installments.
no setter
localizedShopperStatement → BuiltMap<String, String>?
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.
no setter
mandate → Mandate?
The mandate details to initiate recurring transaction.
no setter
mcc → 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.
no setter
merchantAccount → String
The merchant account identifier, with which you want to process the transaction.
no setter
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.
no setter
merchantRiskIndicator → MerchantRiskIndicator?
Additional risk fields for 3D Secure 2. > For 3D Secure 2 transactions, we recommend that you include this object to increase the chances of achieving a frictionless flow.
no setter
metadata → BuiltMap<String, 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 "177" error occurs: "Metadata size exceeds limit". * Maximum 20 characters per key. * Maximum 80 characters per value.
no setter
mpiData → ThreeDSecureData?
Authentication data produced by an MPI (Mastercard SecureCode, Visa Secure, or Cartes Bancaires).
no setter
nationality → String?
The two-character country code of the shopper's nationality.
no setter
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 merchantOrderReferenceinstead.
no setter
platformChargebackLogic → PlatformChargebackLogic?
Defines how to book chargebacks when using Adyen for Platforms.
no setter
recurring → Recurring?
The recurring settings for the payment. Use this property when you want to enable recurring payments.
no setter
recurringProcessingModel → PaymentRequestRecurringProcessingModelEnum?
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.
no setter
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 requirement. If you need to provide multiple references for a transaction, separate them with hyphens ("-"). Maximum length: 80 characters.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secureRemoteCommerceCheckoutData → SecureRemoteCommerceCheckoutData?
Checkout data for a Secure Remote Commerce payment.
no setter
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.
no setter
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.
no setter
sessionId → String?
A session ID used to identify a payment session.
no setter
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.
no setter
shopperInteraction → PaymentRequestShopperInteractionEnum?
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.
no setter
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.
no setter
shopperLocale → String?
The combination of a language code and a country code to specify the language to be used in the payment.
no setter
shopperName → Name?
The shopper's full name.
no setter
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.
no setter
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 . , ' _ - ? + * /_.
no setter
socialSecurityNumber → String?
The shopper's social security number.
no setter
splits → BuiltList<Split>?
An array of objects specifying how the payment should be split when using either Adyen for Platforms for marketplaces or platforms, or standalone Issuing.
no setter
store → String?
Required for Adyen for Platforms integrations if you are a platform model. This is your reference (on balance platform) or the storeReference (in the classic integration) for the ecommerce or point-of-sale store that is processing the payment.
no setter
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.
no setter
threeDS2RequestData → ThreeDS2RequestData?
Request fields for 3D Secure 2. To check if any of the following fields are required for your integration, refer to Online payments or Classic integration documentation.
no setter
threeDSAuthenticationOnly → bool?
Required to trigger the authentication-only flow. If set to true, you will only perform the 3D Secure 2 authentication, and will not proceed to the payment authorization.Default: false.
no setter
totalsGroup → String?
The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available).
no setter
trustedShopper → bool?
Set to true if the payment should be routed to a trusted MID.
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(PaymentRequestBuilder)) → PaymentRequest
Rebuilds the instance.
inherited
toBuilder() → PaymentRequestBuilder
Converts the instance to a builder B.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

serializer → Serializer<PaymentRequest>
no setter