DonationPaymentRequest class abstract

DonationPaymentRequest

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.
  • 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.
  • authenticationData - Data for 3DS authentication.
  • 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.
  • channel - The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the sdkVersion or token. Possible values: * iOS * Android * Web
  • checkoutAttemptId - Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
  • conversionId - Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
  • countryCode - The shopper country. Format: ISO 3166-1 alpha-2 Example: NL or DE
  • dateOfBirth - The shopper's date of birth. Format ISO-8601: YYYY-MM-DD
  • deliverAt - 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
  • deliveryAddress - The address where the purchased goods should be delivered.
  • deviceFingerprint - A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
  • donationAccount - Donation account to which the transaction is credited.
  • donationCampaignId - The donation campaign ID received in the /donationCampaigns call.
  • donationOriginalPspReference - PSP reference of the transaction from which the donation token is generated. Required when donationToken is provided.
  • donationToken - Donation token received in the /payments call.
  • lineItems - Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
  • merchantAccount - The merchant account identifier, with which you want to process the transaction.
  • 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).
  • origin - > Required for browser-based (channel Web) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.
  • paymentMethod
  • 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.
  • redirectFromIssuerMethod - Specifies the redirect method (GET or POST) when redirecting back from the issuer.
  • redirectToIssuerMethod - Specifies the redirect method (GET or POST) when redirecting to the issuer.
  • 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.
  • returnUrl - The URL to return to in case of a redirection. The format depends on the channel. * For web, include the protocol http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: https://your-company.example.com/checkout?shopperOrder=12xy * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the Apple Developer documentation. Example: my-app:// * For Android, use a custom URL handled by an Activity on your app. You can configure it with an intent filter. Example: my-app://your.package.name If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
  • sessionValidity - The date and time until when the session remains valid, in ISO 8601 format. For example: 2020-07-18T15:42:40.428+01:00
  • 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 authorization 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 authorization (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. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
  • socialSecurityNumber - The shopper's social security number.
  • 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.
Annotations
  • @BuiltValue.new()

Constructors

DonationPaymentRequest([void updates(DonationPaymentRequestBuilder 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
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
authenticationData → AuthenticationData?
Data for 3DS authentication.
no setter
billingAddress → 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.
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
channel → DonationPaymentRequestChannelEnum?
The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the sdkVersion or token. Possible values: * iOS * Android * Web
no setter
checkoutAttemptId → String?
Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
no setter
conversionId → String?
Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
no setter
countryCode → String?
The shopper country. Format: ISO 3166-1 alpha-2 Example: NL or DE
no setter
dateOfBirth → DateTime?
The shopper's date of birth. Format ISO-8601: YYYY-MM-DD
no setter
deliverAt → 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
deliveryAddress → DeliveryAddress?
The address where the purchased goods should be delivered.
no setter
deviceFingerprint → String?
A string containing the shopper's device fingerprint. For more information, refer to Device fingerprinting.
no setter
donationAccount → String?
Donation account to which the transaction is credited.
no setter
donationCampaignId → String?
The donation campaign ID received in the /donationCampaigns call.
no setter
donationOriginalPspReference → String?
PSP reference of the transaction from which the donation token is generated. Required when donationToken is provided.
no setter
donationToken → String?
Donation token received in the /payments call.
no setter
hashCode → int
The hash code for this object.
no setterinherited
lineItems → BuiltList<LineItem>?
Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Riverty.
no setter
merchantAccount → String
The merchant account identifier, with which you want to process the transaction.
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
origin → String?

Required for browser-based (channel Web) 3D Secure 2 transactions.Set this to the origin URL of the page where you are rendering the Drop-in/Component. Do not include subdirectories and a trailing slash.

no setter
paymentMethod → DonationPaymentRequestPaymentMethod?
no setter
recurringProcessingModel → DonationPaymentRequestRecurringProcessingModelEnum?
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
redirectFromIssuerMethod → String?
Specifies the redirect method (GET or POST) when redirecting back from the issuer.
no setter
redirectToIssuerMethod → String?
Specifies the redirect method (GET or POST) when redirecting to the issuer.
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
returnUrl → String
The URL to return to in case of a redirection. The format depends on the channel. * For web, include the protocol http:// or https://. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: https://your-company.example.com/checkout?shopperOrder=12xy * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the Apple Developer documentation. Example: my-app:// * For Android, use a custom URL handled by an Activity on your app. You can configure it with an intent filter. Example: my-app://your.package.name If the URL to return to includes non-ASCII characters, like spaces or special letters, URL encode the value. We strongly recommend that you use a maximum of 1024 characters. > The URL must not include personally identifiable information (PII), for example name or email address.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionValidity → String?
The date and time until when the session remains valid, in ISO 8601 format. For example: 2020-07-18T15:42:40.428+01:00
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 → DonationPaymentRequestShopperInteractionEnum?
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 authorization 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 authorization (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 → ShopperName?
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. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address.
no setter
socialSecurityNumber → String?
The shopper's social security number.
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 → ThreeDS2RequestFields?
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

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild(dynamic updates(DonationPaymentRequestBuilder)) → DonationPaymentRequest
Rebuilds the instance.
inherited
toBuilder() → DonationPaymentRequestBuilder
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<DonationPaymentRequest>
no setter