PaymentSetupRequest |
PaymentSetupRequest.addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.additionalAmount(Amount additionalAmount) |
additionalAmount
|
PaymentSetupRequest |
PaymentSetupRequest.additionalData(Map<String,String> additionalData) |
This field contains additional data, which may be required for a particular payment request.
|
PaymentSetupRequest |
PaymentSetupRequest.addLineItemsItem(LineItem lineItemsItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.addSplitsItem(Split splitsItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.allowedPaymentMethods(List<String> allowedPaymentMethods) |
List of payment methods to be presented to the shopper.
|
PaymentSetupRequest |
PaymentSetupRequest.amount(Amount amount) |
amount
|
PaymentSetupRequest |
PaymentSetupRequest.applicationInfo(ApplicationInfo applicationInfo) |
applicationInfo
|
PaymentSetupRequest |
PaymentSetupRequest.billingAddress(Address billingAddress) |
billingAddress
|
PaymentSetupRequest |
PaymentSetupRequest.blockedPaymentMethods(List<String> blockedPaymentMethods) |
List of payment methods to be hidden from the shopper.
|
PaymentSetupRequest |
PaymentSetupRequest.captureDelayHours(Integer captureDelayHours) |
The delay between the authorisation and scheduled auto-capture, specified in hours.
|
PaymentSetupRequest |
PaymentSetupRequest.channel(PaymentSetupRequest.ChannelEnum channel) |
The platform where a payment transaction takes place.
|
PaymentSetupRequest |
PaymentSetupRequest.checkoutAttemptId(String checkoutAttemptId) |
Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
|
PaymentSetupRequest |
PaymentSetupRequest.company(Company company) |
company
|
PaymentSetupRequest |
PaymentSetupRequest.configuration(ModelConfiguration configuration) |
configuration
|
PaymentSetupRequest |
PaymentSetupRequest.conversionId(String conversionId) |
Deprecated.
|
PaymentSetupRequest |
PaymentSetupRequest.countryCode(String countryCode) |
The shopper country.
|
PaymentSetupRequest |
PaymentSetupRequest.dateOfBirth(LocalDate dateOfBirth) |
The shopper's date of birth.
|
PaymentSetupRequest |
PaymentSetupRequest.dccQuote(ForexQuote dccQuote) |
dccQuote
|
PaymentSetupRequest |
PaymentSetupRequest.deliveryAddress(Address deliveryAddress) |
deliveryAddress
|
PaymentSetupRequest |
PaymentSetupRequest.deliveryDate(OffsetDateTime deliveryDate) |
The date and time the purchased goods should be delivered.
|
PaymentSetupRequest |
PaymentSetupRequest.enableOneClick(Boolean enableOneClick) |
When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.
|
PaymentSetupRequest |
PaymentSetupRequest.enablePayOut(Boolean enablePayOut) |
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
|
PaymentSetupRequest |
PaymentSetupRequest.enableRecurring(Boolean enableRecurring) |
When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.
|
PaymentSetupRequest |
PaymentSetupRequest.entityType(PaymentSetupRequest.EntityTypeEnum entityType) |
The type of the entity the payment is processed for.
|
PaymentSetupRequest |
PaymentSetupRequest.fraudOffset(Integer fraudOffset) |
An integer value that is added to the normal fraud score.
|
static PaymentSetupRequest |
PaymentSetupRequest.fromJson(String jsonString) |
Create an instance of PaymentSetupRequest given an JSON string
|
PaymentSetupRequest |
PaymentSetupRequest.installments(Installments installments) |
installments
|
PaymentSetupRequest |
PaymentSetupRequest.lineItems(List<LineItem> lineItems) |
Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment).
|
PaymentSetupRequest |
PaymentSetupRequest.localizedShopperStatement(Map<String,String> localizedShopperStatement) |
The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
|
PaymentSetupRequest |
PaymentSetupRequest.mandate(Mandate mandate) |
mandate
|
PaymentSetupRequest |
PaymentSetupRequest.mcc(String mcc) |
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.
|
PaymentSetupRequest |
PaymentSetupRequest.merchantAccount(String merchantAccount) |
The merchant account identifier, with which you want to process the transaction.
|
PaymentSetupRequest |
PaymentSetupRequest.merchantOrderReference(String merchantOrderReference) |
This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
|
PaymentSetupRequest |
PaymentSetupRequest.metadata(Map<String,String> metadata) |
Metadata consists of entries, each of which includes a key and a value.
|
PaymentSetupRequest |
PaymentSetupRequest.orderReference(String orderReference) |
When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
|
PaymentSetupRequest |
PaymentSetupRequest.origin(String origin) |
Required for the Web integration.
|
PaymentSetupRequest |
PaymentSetupRequest.platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) |
platformChargebackLogic
|
PaymentSetupRequest |
PaymentSetupRequest.putAdditionalDataItem(String key,
String additionalDataItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.putLocalizedShopperStatementItem(String key,
String localizedShopperStatementItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.putMetadataItem(String key,
String metadataItem) |
|
PaymentSetupRequest |
PaymentSetupRequest.recurringExpiry(String recurringExpiry) |
Date after which no further authorisations shall be performed.
|
PaymentSetupRequest |
PaymentSetupRequest.recurringFrequency(String recurringFrequency) |
Minimum number of days between authorisations.
|
PaymentSetupRequest |
PaymentSetupRequest.reference(String reference) |
The reference to uniquely identify a payment.
|
PaymentSetupRequest |
PaymentSetupRequest.returnUrl(String returnUrl) |
The URL to return to in case of a redirection.
|
PaymentSetupRequest |
PaymentSetupRequest.riskData(RiskData riskData) |
riskData
|
PaymentSetupRequest |
PaymentSetupRequest.sdkVersion(String sdkVersion) |
The version of the SDK you are using (for Web SDK integrations only).
|
PaymentSetupRequest |
PaymentSetupRequest.secureRemoteCommerceCheckoutData(SecureRemoteCommerceCheckoutData secureRemoteCommerceCheckoutData) |
secureRemoteCommerceCheckoutData
|
PaymentSetupRequest |
PaymentSetupRequest.sessionValidity(String sessionValidity) |
The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
|
PaymentSetupRequest |
PaymentSetupRequest.shopperEmail(String shopperEmail) |
The shopper's email address.
|
PaymentSetupRequest |
PaymentSetupRequest.shopperInteraction(PaymentSetupRequest.ShopperInteractionEnum shopperInteraction) |
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
|
PaymentSetupRequest |
PaymentSetupRequest.shopperIP(String shopperIP) |
The shopper's IP address.
|
PaymentSetupRequest |
PaymentSetupRequest.shopperLocale(String shopperLocale) |
The combination of a language code and a country code to specify the language to be used in the payment.
|
PaymentSetupRequest |
PaymentSetupRequest.shopperName(Name shopperName) |
shopperName
|
PaymentSetupRequest |
PaymentSetupRequest.shopperReference(String shopperReference) |
Required for recurring payments.
|
PaymentSetupRequest |
PaymentSetupRequest.shopperStatement(String shopperStatement) |
The text to be shown on the shopper's bank statement.
|
PaymentSetupRequest |
PaymentSetupRequest.socialSecurityNumber(String socialSecurityNumber) |
The shopper's social security number.
|
PaymentSetupRequest |
PaymentSetupRequest.splits(List<Split> splits) |
An array of objects specifying how the payment should be split when using either Adyen for Platforms for [marketplaces](https://docs.adyen.com/marketplaces/split-payments) or [platforms]((https://docs.adyen.com/platforms/split-payments), or standalone [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).
|
PaymentSetupRequest |
PaymentSetupRequest.store(String store) |
Required for Adyen for Platforms integrations if you are a platform model.
|
PaymentSetupRequest |
PaymentSetupRequest.storePaymentMethod(Boolean storePaymentMethod) |
When true and `shopperReference` is provided, the payment details will be stored.
|
PaymentSetupRequest |
PaymentSetupRequest.telephoneNumber(String telephoneNumber) |
The shopper's telephone number.
|
PaymentSetupRequest |
PaymentSetupRequest.threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) |
Deprecated.
|
PaymentSetupRequest |
PaymentSetupRequest.token(String token) |
The token obtained when initializing the SDK.
|
PaymentSetupRequest |
PaymentSetupRequest.trustedShopper(Boolean trustedShopper) |
Set to true if the payment should be routed to a trusted MID.
|