PaymentMethodsRequest class abstract

PaymentMethodsRequest

Properties:

  • 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.
  • allowedPaymentMethods - List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type. Example: \"allowedPaymentMethods\":[\"ideal\",\"applepay\"]
  • amount - The amount information for the transaction (in minor units). For BIN or card verification requests, set amount to 0 (zero).
  • blockedPaymentMethods - List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type. Example: \"blockedPaymentMethods\":[\"ideal\",\"applepay\"]
  • 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 can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
  • countryCode - The shopper's country code.
  • merchantAccount - The merchant account identifier, with which you want to process the transaction.
  • order - The order information required for partial payments.
  • shopperConversionId - A unique ID that can be used to associate /paymentMethods and /payments requests with the same shopper transaction, offering insights into conversion rates.
  • 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.
  • shopperLocale - The combination of a language code and a country code to specify the language to be used in the payment.
  • 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.
  • splitCardFundingSources - Boolean value indicating whether the card payment method should be split into separate debit and credit options.
  • 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.
  • storeFiltrationMode - Specifies how payment methods should be filtered based on the store parameter: - exclusive: Only payment methods belonging to the specified store are returned. - inclusive: Payment methods from the store and those not associated with any other store are returned.
  • 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.
Annotations
  • @BuiltValue.new()

Constructors

PaymentMethodsRequest([void updates(PaymentMethodsRequestBuilder b)])
factory

Properties

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
allowedPaymentMethods → BuiltList<String>?
List of payment methods to be presented to the shopper. To refer to payment methods, use their payment method type. Example: \"allowedPaymentMethods\":[\"ideal\",\"applepay\"]
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
blockedPaymentMethods → BuiltList<String>?
List of payment methods to be hidden from the shopper. To refer to payment methods, use their payment method type. Example: \"blockedPaymentMethods\":[\"ideal\",\"applepay\"]
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 → PaymentMethodsRequestChannelEnum?
The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web
no setter
countryCode → String?
The shopper's country code.
no setter
hashCode → int
The hash code for this object.
no setterinherited
merchantAccount → String
The merchant account identifier, with which you want to process the transaction.
no setter
order → EncryptedOrderData?
The order information required for partial payments.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shopperConversionId → String?
A unique ID that can be used to associate /paymentMethods and /payments requests with the same shopper transaction, offering insights into conversion rates.
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
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
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
splitCardFundingSources → bool?
Boolean value indicating whether the card payment method should be split into separate debit and credit options.
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
storeFiltrationMode → PaymentMethodsRequestStoreFiltrationModeEnum?
Specifies how payment methods should be filtered based on the store parameter: - exclusive: Only payment methods belonging to the specified store are returned. - inclusive: Payment methods from the store and those not associated with any other store are returned.
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

Methods

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