PaymentRequest |
PaymentRequest.accountInfo(AccountInfo accountInfo) |
accountInfo
|
PaymentRequest |
PaymentRequest.additionalAmount(Amount additionalAmount) |
additionalAmount
|
PaymentRequest |
PaymentRequest.additionalData(Map<String,String> additionalData) |
This field contains additional data, which may be required for a particular payment request.
|
PaymentRequest |
PaymentRequest.addLineItemsItem(LineItem lineItemsItem) |
|
PaymentRequest |
PaymentRequest.addSplitsItem(Split splitsItem) |
|
PaymentRequest |
PaymentRequest.addSubMerchantsItem(SubMerchantInfo subMerchantsItem) |
|
PaymentRequest |
PaymentRequest.amount(Amount amount) |
amount
|
PaymentRequest |
PaymentRequest.applicationInfo(ApplicationInfo applicationInfo) |
applicationInfo
|
PaymentRequest |
PaymentRequest.authenticationData(AuthenticationData authenticationData) |
authenticationData
|
PaymentRequest |
PaymentRequest.bankAccount(CheckoutBankAccount bankAccount) |
bankAccount
|
PaymentRequest |
PaymentRequest.billingAddress(BillingAddress billingAddress) |
billingAddress
|
PaymentRequest |
PaymentRequest.browserInfo(BrowserInfo browserInfo) |
browserInfo
|
PaymentRequest |
PaymentRequest.captureDelayHours(Integer captureDelayHours) |
The delay between the authorisation and scheduled auto-capture, specified in hours.
|
PaymentRequest |
PaymentRequest.channel(PaymentRequest.ChannelEnum channel) |
The platform where a payment transaction takes place.
|
PaymentRequest |
PaymentRequest.checkoutAttemptId(String checkoutAttemptId) |
Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.
|
PaymentRequest |
PaymentRequest.company(Company company) |
company
|
PaymentRequest |
PaymentRequest.conversionId(String conversionId) |
Deprecated.
|
PaymentRequest |
PaymentRequest.countryCode(String countryCode) |
The shopper country.
|
PaymentRequest |
PaymentRequest.dateOfBirth(OffsetDateTime dateOfBirth) |
The shopper's date of birth.
|
PaymentRequest |
PaymentRequest.dccQuote(ForexQuote dccQuote) |
dccQuote
|
PaymentRequest |
PaymentRequest.deliverAt(OffsetDateTime deliverAt) |
The date and time the purchased goods should be delivered.
|
PaymentRequest |
PaymentRequest.deliveryAddress(DeliveryAddress deliveryAddress) |
deliveryAddress
|
PaymentRequest |
PaymentRequest.deliveryDate(OffsetDateTime deliveryDate) |
Deprecated.
|
PaymentRequest |
PaymentRequest.deviceFingerprint(String deviceFingerprint) |
A string containing the shopper's device fingerprint.
|
PaymentRequest |
PaymentRequest.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](https://docs.adyen.com/get-started-with-adyen/payment-glossary/#one-click-payments-definition).
|
PaymentRequest |
PaymentRequest.enablePayOut(Boolean enablePayOut) |
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.
|
PaymentRequest |
PaymentRequest.enableRecurring(Boolean enableRecurring) |
When true and `shopperReference` is provided, the payment details will be stored for [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types) where the shopper is not present, such as subscription or automatic top-up payments.
|
PaymentRequest |
PaymentRequest.entityType(PaymentRequest.EntityTypeEnum entityType) |
The type of the entity the payment is processed for.
|
PaymentRequest |
PaymentRequest.fraudOffset(Integer fraudOffset) |
An integer value that is added to the normal fraud score.
|
static PaymentRequest |
PaymentRequest.fromJson(String jsonString) |
Create an instance of PaymentRequest given an JSON string
|
PaymentRequest |
PaymentRequest.fundOrigin(FundOrigin fundOrigin) |
fundOrigin
|
PaymentRequest |
PaymentRequest.fundRecipient(FundRecipient fundRecipient) |
fundRecipient
|
PaymentRequest |
PaymentRequest.industryUsage(PaymentRequest.IndustryUsageEnum industryUsage) |
The reason for the amount update.
|
PaymentRequest |
PaymentRequest.installments(Installments installments) |
installments
|
PaymentRequest |
PaymentRequest.lineItems(List<LineItem> lineItems) |
Price and product information about the purchased items, to be included on the invoice sent to the shopper.
|
PaymentRequest |
PaymentRequest.localizedShopperStatement(Map<String,String> localizedShopperStatement) |
The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.
|
PaymentRequest |
PaymentRequest.mandate(Mandate mandate) |
mandate
|
PaymentRequest |
PaymentRequest.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.
|
PaymentRequest |
PaymentRequest.merchantAccount(String merchantAccount) |
The merchant account identifier, with which you want to process the transaction.
|
PaymentRequest |
PaymentRequest.merchantOrderReference(String merchantOrderReference) |
This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate).
|
PaymentRequest |
PaymentRequest.merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) |
merchantRiskIndicator
|
PaymentRequest |
PaymentRequest.metadata(Map<String,String> metadata) |
Metadata consists of entries, each of which includes a key and a value.
|
PaymentRequest |
PaymentRequest.mpiData(ThreeDSecureData mpiData) |
mpiData
|
PaymentRequest |
PaymentRequest.order(EncryptedOrderData order) |
order
|
PaymentRequest |
PaymentRequest.orderReference(String orderReference) |
When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.
|
PaymentRequest |
PaymentRequest.origin(String origin) |
Required for the 3D Secure 2 `channel` **Web** integration.
|
PaymentRequest |
PaymentRequest.paymentMethod(CheckoutPaymentMethod paymentMethod) |
paymentMethod
|
PaymentRequest |
PaymentRequest.platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) |
platformChargebackLogic
|
PaymentRequest |
PaymentRequest.putAdditionalDataItem(String key,
String additionalDataItem) |
|
PaymentRequest |
PaymentRequest.putLocalizedShopperStatementItem(String key,
String localizedShopperStatementItem) |
|
PaymentRequest |
PaymentRequest.putMetadataItem(String key,
String metadataItem) |
|
PaymentRequest |
PaymentRequest.recurringExpiry(String recurringExpiry) |
Date after which no further authorisations shall be performed.
|
PaymentRequest |
PaymentRequest.recurringFrequency(String recurringFrequency) |
Minimum number of days between authorisations.
|
PaymentRequest |
PaymentRequest.recurringProcessingModel(PaymentRequest.RecurringProcessingModelEnum recurringProcessingModel) |
Defines a recurring payment type.
|
PaymentRequest |
PaymentRequest.redirectFromIssuerMethod(String redirectFromIssuerMethod) |
Specifies the redirect method (GET or POST) when redirecting back from the issuer.
|
PaymentRequest |
PaymentRequest.redirectToIssuerMethod(String redirectToIssuerMethod) |
Specifies the redirect method (GET or POST) when redirecting to the issuer.
|
PaymentRequest |
PaymentRequest.reference(String reference) |
The reference to uniquely identify a payment.
|
PaymentRequest |
PaymentRequest.returnUrl(String returnUrl) |
The URL to return to in case of a redirection.
|
PaymentRequest |
PaymentRequest.riskData(RiskData riskData) |
riskData
|
PaymentRequest |
PaymentRequest.sessionValidity(String sessionValidity) |
The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.
|
PaymentRequest |
PaymentRequest.shopperConversionId(String shopperConversionId) |
A unique ID that can be used to associate `/paymentMethods` and `/payments` requests with the same shopper transaction, offering insights into conversion rates.
|
PaymentRequest |
PaymentRequest.shopperEmail(String shopperEmail) |
The shopper's email address.
|
PaymentRequest |
PaymentRequest.shopperInteraction(PaymentRequest.ShopperInteractionEnum shopperInteraction) |
Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
|
PaymentRequest |
PaymentRequest.shopperIP(String shopperIP) |
The shopper's IP address.
|
PaymentRequest |
PaymentRequest.shopperLocale(String shopperLocale) |
The combination of a language code and a country code to specify the language to be used in the payment.
|
PaymentRequest |
PaymentRequest.shopperName(Name shopperName) |
shopperName
|
PaymentRequest |
PaymentRequest.shopperReference(String shopperReference) |
Required for recurring payments.
|
PaymentRequest |
PaymentRequest.shopperStatement(String shopperStatement) |
The text to be shown on the shopper's bank statement.
|
PaymentRequest |
PaymentRequest.socialSecurityNumber(String socialSecurityNumber) |
The shopper's social security number.
|
PaymentRequest |
PaymentRequest.splits(List<Split> splits) |
An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/platforms/process-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/classic-platforms/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).
|
PaymentRequest |
PaymentRequest.store(String store) |
Required for Adyen for Platforms integrations if you are a platform model.
|
PaymentRequest |
PaymentRequest.storePaymentMethod(Boolean storePaymentMethod) |
When true and `shopperReference` is provided, the payment details will be stored for future [recurring payments](https://docs.adyen.com/online-payments/tokenization/#recurring-payment-types).
|
PaymentRequest |
PaymentRequest.subMerchants(List<SubMerchantInfo> subMerchants) |
This field contains additional information on the submerchant, who is onboarded to an acquirer through a payment facilitator or aggregator
|
PaymentRequest |
PaymentRequest.telephoneNumber(String telephoneNumber) |
The shopper's telephone number.
|
PaymentRequest |
PaymentRequest.threeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData) |
threeDS2RequestData
|
PaymentRequest |
PaymentRequest.threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) |
Deprecated.
|
PaymentRequest |
PaymentRequest.trustedShopper(Boolean trustedShopper) |
Set to true if the payment should be routed to a trusted MID.
|