Package com.adyen.model.checkout
Class DonationPaymentRequest
- java.lang.Object
-
- com.adyen.model.checkout.DonationPaymentRequest
-
public class DonationPaymentRequest extends Object
DonationPaymentRequest
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDonationPaymentRequest.ChannelEnumThe platform where a payment transaction takes place.static classDonationPaymentRequest.EntityTypeEnumThe type of the entity the payment is processed for.static classDonationPaymentRequest.FundingSourceEnumThe funding source that should be used when multiple sources are available.static classDonationPaymentRequest.IndustryUsageEnumThe reason for the amount update.static classDonationPaymentRequest.RecurringProcessingModelEnumDefines a recurring payment type.static classDonationPaymentRequest.ShopperInteractionEnumSpecifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.
-
Field Summary
-
Constructor Summary
Constructors Constructor Description DonationPaymentRequest()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DonationPaymentRequestaccountInfo(AccountInfo accountInfo)DonationPaymentRequestaddAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)DonationPaymentRequestaddBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)DonationPaymentRequestadditionalAmount(Amount additionalAmount)DonationPaymentRequestadditionalData(Map<String,String> additionalData)DonationPaymentRequestaddLineItemsItem(LineItem lineItemsItem)DonationPaymentRequestaddSplitsItem(Split splitsItem)DonationPaymentRequestallowedPaymentMethods(List<String> allowedPaymentMethods)DonationPaymentRequestamount(Amount amount)DonationPaymentRequestapplicationInfo(ApplicationInfo applicationInfo)DonationPaymentRequestauthenticationData(AuthenticationData authenticationData)DonationPaymentRequestbillingAddress(BillingAddress billingAddress)DonationPaymentRequestblockedPaymentMethods(List<String> blockedPaymentMethods)DonationPaymentRequestbrowserInfo(BrowserInfo browserInfo)DonationPaymentRequestcaptureDelayHours(Integer captureDelayHours)DonationPaymentRequestchannel(DonationPaymentRequest.ChannelEnum channel)DonationPaymentRequestcheckoutAttemptId(String checkoutAttemptId)DonationPaymentRequestcompany(Company company)DonationPaymentRequestconversionId(String conversionId)DonationPaymentRequestcountryCode(String countryCode)DonationPaymentRequestdateOfBirth(OffsetDateTime dateOfBirth)DonationPaymentRequestdccQuote(ForexQuote dccQuote)DonationPaymentRequestdeliverAt(OffsetDateTime deliverAt)DonationPaymentRequestdeliveryAddress(DeliveryAddress deliveryAddress)DonationPaymentRequestdeliveryDate(OffsetDateTime deliveryDate)DonationPaymentRequestdeviceFingerprint(String deviceFingerprint)DonationPaymentRequestdonationAccount(String donationAccount)DonationPaymentRequestdonationOriginalPspReference(String donationOriginalPspReference)DonationPaymentRequestdonationToken(String donationToken)DonationPaymentRequestenableOneClick(Boolean enableOneClick)DonationPaymentRequestenablePayOut(Boolean enablePayOut)DonationPaymentRequestenableRecurring(Boolean enableRecurring)DonationPaymentRequestentityType(DonationPaymentRequest.EntityTypeEnum entityType)booleanequals(Object o)Return true if this DonationPaymentRequest object is equal to o.DonationPaymentRequestfraudOffset(Integer fraudOffset)static DonationPaymentRequestfromJson(String jsonString)Create an instance of DonationPaymentRequest given an JSON stringDonationPaymentRequestfundingSource(DonationPaymentRequest.FundingSourceEnum fundingSource)DonationPaymentRequestfundOrigin(FundOrigin fundOrigin)DonationPaymentRequestfundRecipient(FundRecipient fundRecipient)AccountInfogetAccountInfo()Get accountInfoAmountgetAdditionalAmount()Get additionalAmountMap<String,String>getAdditionalData()This field contains additional data, which may be required for a particular payment request.List<String>getAllowedPaymentMethods()List of payment methods to be presented to the shopper.AmountgetAmount()Get amountApplicationInfogetApplicationInfo()Get applicationInfoAuthenticationDatagetAuthenticationData()Get authenticationDataBillingAddressgetBillingAddress()Get billingAddressList<String>getBlockedPaymentMethods()List of payment methods to be hidden from the shopper.BrowserInfogetBrowserInfo()Get browserInfoIntegergetCaptureDelayHours()The delay between the authorisation and scheduled auto-capture, specified in hours.DonationPaymentRequest.ChannelEnumgetChannel()The platform where a payment transaction takes place.StringgetCheckoutAttemptId()Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.CompanygetCompany()Get companyStringgetConversionId()Deprecated.StringgetCountryCode()The shopper country.OffsetDateTimegetDateOfBirth()The shopper's date of birth.ForexQuotegetDccQuote()Get dccQuoteOffsetDateTimegetDeliverAt()The date and time the purchased goods should be delivered.DeliveryAddressgetDeliveryAddress()Get deliveryAddressOffsetDateTimegetDeliveryDate()The date and time the purchased goods should be delivered.StringgetDeviceFingerprint()A string containing the shopper's device fingerprint.StringgetDonationAccount()Donation account to which the transaction is credited.StringgetDonationOriginalPspReference()PSP reference of the transaction from which the donation token is generated.StringgetDonationToken()Donation token received in the `/payments` call.BooleangetEnableOneClick()When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.BooleangetEnablePayOut()When true and `shopperReference` is provided, the payment details will be tokenized for payouts.BooleangetEnableRecurring()When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.DonationPaymentRequest.EntityTypeEnumgetEntityType()The type of the entity the payment is processed for.IntegergetFraudOffset()An integer value that is added to the normal fraud score.DonationPaymentRequest.FundingSourceEnumgetFundingSource()The funding source that should be used when multiple sources are available.FundOrigingetFundOrigin()Get fundOriginFundRecipientgetFundRecipient()Get fundRecipientDonationPaymentRequest.IndustryUsageEnumgetIndustryUsage()The reason for the amount update.InstallmentsgetInstallments()Get installmentsList<LineItem>getLineItems()Price and product information about the purchased items, to be included on the invoice sent to the shopper.Map<String,String>getLocalizedShopperStatement()The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set.MandategetMandate()Get mandateStringgetMcc()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.StringgetMerchantAccount()The merchant account identifier, with which you want to process the transaction.StringgetMerchantOrderReference()This reference allows linking multiple transactions to each other for reporting purposes (i.e.MerchantRiskIndicatorgetMerchantRiskIndicator()Get merchantRiskIndicatorMap<String,String>getMetadata()Metadata consists of entries, each of which includes a key and a value.ThreeDSecureDatagetMpiData()Get mpiDataEncryptedOrderDatagetOrder()Get orderStringgetOrderReference()When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment.StringgetOrigin()Required for the 3D Secure 2 `channel` **Web** integration.DonationPaymentMethodgetPaymentMethod()Get paymentMethodPlatformChargebackLogicgetPlatformChargebackLogic()Get platformChargebackLogicStringgetRecurringExpiry()Date after which no further authorisations shall be performed.StringgetRecurringFrequency()Minimum number of days between authorisations.DonationPaymentRequest.RecurringProcessingModelEnumgetRecurringProcessingModel()Defines a recurring payment type.StringgetRedirectFromIssuerMethod()Specifies the redirect method (GET or POST) when redirecting back from the issuer.StringgetRedirectToIssuerMethod()Specifies the redirect method (GET or POST) when redirecting to the issuer.StringgetReference()The reference to uniquely identify a payment.StringgetReturnUrl()The URL to return to in case of a redirection.RiskDatagetRiskData()Get riskDataStringgetSelectedRecurringDetailReference()The `recurringDetailReference` you want to use for this payment.StringgetSessionValidity()The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format.StringgetShopperEmail()The shopper's email address.DonationPaymentRequest.ShopperInteractionEnumgetShopperInteraction()Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer.StringgetShopperIP()The shopper's IP address.StringgetShopperLocale()The combination of a language code and a country code to specify the language to be used in the payment.NamegetShopperName()Get shopperNameStringgetShopperReference()Required for recurring payments.StringgetShopperStatement()The text to be shown on the shopper's bank statement.StringgetSocialSecurityNumber()The shopper's social security number.List<Split>getSplits()An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).StringgetStore()The ecommerce or point-of-sale store that is processing the payment.BooleangetStorePaymentMethod()When true and `shopperReference` is provided, the payment details will be stored.StringgetTelephoneNumber()The shopper's telephone number.ThreeDS2RequestData2getThreeDS2RequestData()Get threeDS2RequestDataBooleangetThreeDSAuthenticationOnly()Deprecated.BooleangetTrustedShopper()Set to true if the payment should be routed to a trusted MID.inthashCode()DonationPaymentRequestindustryUsage(DonationPaymentRequest.IndustryUsageEnum industryUsage)DonationPaymentRequestinstallments(Installments installments)DonationPaymentRequestlineItems(List<LineItem> lineItems)DonationPaymentRequestlocalizedShopperStatement(Map<String,String> localizedShopperStatement)DonationPaymentRequestmandate(Mandate mandate)DonationPaymentRequestmcc(String mcc)DonationPaymentRequestmerchantAccount(String merchantAccount)DonationPaymentRequestmerchantOrderReference(String merchantOrderReference)DonationPaymentRequestmerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)DonationPaymentRequestmetadata(Map<String,String> metadata)DonationPaymentRequestmpiData(ThreeDSecureData mpiData)DonationPaymentRequestorder(EncryptedOrderData order)DonationPaymentRequestorderReference(String orderReference)DonationPaymentRequestorigin(String origin)DonationPaymentRequestpaymentMethod(DonationPaymentMethod paymentMethod)DonationPaymentRequestplatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)DonationPaymentRequestputAdditionalDataItem(String key, String additionalDataItem)DonationPaymentRequestputLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)DonationPaymentRequestputMetadataItem(String key, String metadataItem)DonationPaymentRequestrecurringExpiry(String recurringExpiry)DonationPaymentRequestrecurringFrequency(String recurringFrequency)DonationPaymentRequestrecurringProcessingModel(DonationPaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)DonationPaymentRequestredirectFromIssuerMethod(String redirectFromIssuerMethod)DonationPaymentRequestredirectToIssuerMethod(String redirectToIssuerMethod)DonationPaymentRequestreference(String reference)DonationPaymentRequestreturnUrl(String returnUrl)DonationPaymentRequestriskData(RiskData riskData)DonationPaymentRequestselectedRecurringDetailReference(String selectedRecurringDetailReference)DonationPaymentRequestsessionValidity(String sessionValidity)voidsetAccountInfo(AccountInfo accountInfo)voidsetAdditionalAmount(Amount additionalAmount)voidsetAdditionalData(Map<String,String> additionalData)voidsetAllowedPaymentMethods(List<String> allowedPaymentMethods)voidsetAmount(Amount amount)voidsetApplicationInfo(ApplicationInfo applicationInfo)voidsetAuthenticationData(AuthenticationData authenticationData)voidsetBillingAddress(BillingAddress billingAddress)voidsetBlockedPaymentMethods(List<String> blockedPaymentMethods)voidsetBrowserInfo(BrowserInfo browserInfo)voidsetCaptureDelayHours(Integer captureDelayHours)voidsetChannel(DonationPaymentRequest.ChannelEnum channel)voidsetCheckoutAttemptId(String checkoutAttemptId)voidsetCompany(Company company)voidsetConversionId(String conversionId)Deprecated.voidsetCountryCode(String countryCode)voidsetDateOfBirth(OffsetDateTime dateOfBirth)voidsetDccQuote(ForexQuote dccQuote)voidsetDeliverAt(OffsetDateTime deliverAt)voidsetDeliveryAddress(DeliveryAddress deliveryAddress)voidsetDeliveryDate(OffsetDateTime deliveryDate)voidsetDeviceFingerprint(String deviceFingerprint)voidsetDonationAccount(String donationAccount)voidsetDonationOriginalPspReference(String donationOriginalPspReference)voidsetDonationToken(String donationToken)voidsetEnableOneClick(Boolean enableOneClick)voidsetEnablePayOut(Boolean enablePayOut)voidsetEnableRecurring(Boolean enableRecurring)voidsetEntityType(DonationPaymentRequest.EntityTypeEnum entityType)voidsetFraudOffset(Integer fraudOffset)voidsetFundingSource(DonationPaymentRequest.FundingSourceEnum fundingSource)voidsetFundOrigin(FundOrigin fundOrigin)voidsetFundRecipient(FundRecipient fundRecipient)voidsetIndustryUsage(DonationPaymentRequest.IndustryUsageEnum industryUsage)voidsetInstallments(Installments installments)voidsetLineItems(List<LineItem> lineItems)voidsetLocalizedShopperStatement(Map<String,String> localizedShopperStatement)voidsetMandate(Mandate mandate)voidsetMcc(String mcc)voidsetMerchantAccount(String merchantAccount)voidsetMerchantOrderReference(String merchantOrderReference)voidsetMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)voidsetMetadata(Map<String,String> metadata)voidsetMpiData(ThreeDSecureData mpiData)voidsetOrder(EncryptedOrderData order)voidsetOrderReference(String orderReference)voidsetOrigin(String origin)voidsetPaymentMethod(DonationPaymentMethod paymentMethod)voidsetPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)voidsetRecurringExpiry(String recurringExpiry)voidsetRecurringFrequency(String recurringFrequency)voidsetRecurringProcessingModel(DonationPaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)voidsetRedirectFromIssuerMethod(String redirectFromIssuerMethod)voidsetRedirectToIssuerMethod(String redirectToIssuerMethod)voidsetReference(String reference)voidsetReturnUrl(String returnUrl)voidsetRiskData(RiskData riskData)voidsetSelectedRecurringDetailReference(String selectedRecurringDetailReference)voidsetSessionValidity(String sessionValidity)voidsetShopperEmail(String shopperEmail)voidsetShopperInteraction(DonationPaymentRequest.ShopperInteractionEnum shopperInteraction)voidsetShopperIP(String shopperIP)voidsetShopperLocale(String shopperLocale)voidsetShopperName(Name shopperName)voidsetShopperReference(String shopperReference)voidsetShopperStatement(String shopperStatement)voidsetSocialSecurityNumber(String socialSecurityNumber)voidsetSplits(List<Split> splits)voidsetStore(String store)voidsetStorePaymentMethod(Boolean storePaymentMethod)voidsetTelephoneNumber(String telephoneNumber)voidsetThreeDS2RequestData(ThreeDS2RequestData2 threeDS2RequestData)voidsetThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)Deprecated.voidsetTrustedShopper(Boolean trustedShopper)DonationPaymentRequestshopperEmail(String shopperEmail)DonationPaymentRequestshopperInteraction(DonationPaymentRequest.ShopperInteractionEnum shopperInteraction)DonationPaymentRequestshopperIP(String shopperIP)DonationPaymentRequestshopperLocale(String shopperLocale)DonationPaymentRequestshopperName(Name shopperName)DonationPaymentRequestshopperReference(String shopperReference)DonationPaymentRequestshopperStatement(String shopperStatement)DonationPaymentRequestsocialSecurityNumber(String socialSecurityNumber)DonationPaymentRequestsplits(List<Split> splits)DonationPaymentRequeststore(String store)DonationPaymentRequeststorePaymentMethod(Boolean storePaymentMethod)DonationPaymentRequesttelephoneNumber(String telephoneNumber)DonationPaymentRequestthreeDS2RequestData(ThreeDS2RequestData2 threeDS2RequestData)DonationPaymentRequestthreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)StringtoJson()Convert an instance of DonationPaymentRequest to an JSON stringStringtoString()DonationPaymentRequesttrustedShopper(Boolean trustedShopper)
-
-
-
Field Detail
-
JSON_PROPERTY_ACCOUNT_INFO
public static final String JSON_PROPERTY_ACCOUNT_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_AMOUNT
public static final String JSON_PROPERTY_ADDITIONAL_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ADDITIONAL_DATA
public static final String JSON_PROPERTY_ADDITIONAL_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
public static final String JSON_PROPERTY_ALLOWED_PAYMENT_METHODS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AMOUNT
public static final String JSON_PROPERTY_AMOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_APPLICATION_INFO
public static final String JSON_PROPERTY_APPLICATION_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AUTHENTICATION_DATA
public static final String JSON_PROPERTY_AUTHENTICATION_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BILLING_ADDRESS
public static final String JSON_PROPERTY_BILLING_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
public static final String JSON_PROPERTY_BLOCKED_PAYMENT_METHODS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_BROWSER_INFO
public static final String JSON_PROPERTY_BROWSER_INFO
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CAPTURE_DELAY_HOURS
public static final String JSON_PROPERTY_CAPTURE_DELAY_HOURS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CHANNEL
public static final String JSON_PROPERTY_CHANNEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COMPANY
public static final String JSON_PROPERTY_COMPANY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_CONVERSION_ID
public static final String JSON_PROPERTY_CONVERSION_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_COUNTRY_CODE
public static final String JSON_PROPERTY_COUNTRY_CODE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DATE_OF_BIRTH
public static final String JSON_PROPERTY_DATE_OF_BIRTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DCC_QUOTE
public static final String JSON_PROPERTY_DCC_QUOTE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVER_AT
public static final String JSON_PROPERTY_DELIVER_AT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVERY_ADDRESS
public static final String JSON_PROPERTY_DELIVERY_ADDRESS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DELIVERY_DATE
public static final String JSON_PROPERTY_DELIVERY_DATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DEVICE_FINGERPRINT
public static final String JSON_PROPERTY_DEVICE_FINGERPRINT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DONATION_ACCOUNT
public static final String JSON_PROPERTY_DONATION_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DONATION_ORIGINAL_PSP_REFERENCE
public static final String JSON_PROPERTY_DONATION_ORIGINAL_PSP_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_DONATION_TOKEN
public static final String JSON_PROPERTY_DONATION_TOKEN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLE_ONE_CLICK
public static final String JSON_PROPERTY_ENABLE_ONE_CLICK
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLE_PAY_OUT
public static final String JSON_PROPERTY_ENABLE_PAY_OUT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENABLE_RECURRING
public static final String JSON_PROPERTY_ENABLE_RECURRING
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ENTITY_TYPE
public static final String JSON_PROPERTY_ENTITY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FRAUD_OFFSET
public static final String JSON_PROPERTY_FRAUD_OFFSET
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FUND_ORIGIN
public static final String JSON_PROPERTY_FUND_ORIGIN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FUND_RECIPIENT
public static final String JSON_PROPERTY_FUND_RECIPIENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FUNDING_SOURCE
public static final String JSON_PROPERTY_FUNDING_SOURCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INDUSTRY_USAGE
public static final String JSON_PROPERTY_INDUSTRY_USAGE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_INSTALLMENTS
public static final String JSON_PROPERTY_INSTALLMENTS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LINE_ITEMS
public static final String JSON_PROPERTY_LINE_ITEMS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT
public static final String JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MANDATE
public static final String JSON_PROPERTY_MANDATE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MCC
public static final String JSON_PROPERTY_MCC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ACCOUNT
public static final String JSON_PROPERTY_MERCHANT_ACCOUNT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
public static final String JSON_PROPERTY_MERCHANT_ORDER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MERCHANT_RISK_INDICATOR
public static final String JSON_PROPERTY_MERCHANT_RISK_INDICATOR
- See Also:
- Constant Field Values
-
JSON_PROPERTY_METADATA
public static final String JSON_PROPERTY_METADATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_MPI_DATA
public static final String JSON_PROPERTY_MPI_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORDER
public static final String JSON_PROPERTY_ORDER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORDER_REFERENCE
public static final String JSON_PROPERTY_ORDER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORIGIN
public static final String JSON_PROPERTY_ORIGIN
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PAYMENT_METHOD
public static final String JSON_PROPERTY_PAYMENT_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
public static final String JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_EXPIRY
public static final String JSON_PROPERTY_RECURRING_EXPIRY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_FREQUENCY
public static final String JSON_PROPERTY_RECURRING_FREQUENCY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RECURRING_PROCESSING_MODEL
public static final String JSON_PROPERTY_RECURRING_PROCESSING_MODEL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD
public static final String JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD
public static final String JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REFERENCE
public static final String JSON_PROPERTY_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RETURN_URL
public static final String JSON_PROPERTY_RETURN_URL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_RISK_DATA
public static final String JSON_PROPERTY_RISK_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
public static final String JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SESSION_VALIDITY
public static final String JSON_PROPERTY_SESSION_VALIDITY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_EMAIL
public static final String JSON_PROPERTY_SHOPPER_EMAIL
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_I_P
public static final String JSON_PROPERTY_SHOPPER_I_P
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_INTERACTION
public static final String JSON_PROPERTY_SHOPPER_INTERACTION
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_LOCALE
public static final String JSON_PROPERTY_SHOPPER_LOCALE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_NAME
public static final String JSON_PROPERTY_SHOPPER_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_REFERENCE
public static final String JSON_PROPERTY_SHOPPER_REFERENCE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SHOPPER_STATEMENT
public static final String JSON_PROPERTY_SHOPPER_STATEMENT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SPLITS
public static final String JSON_PROPERTY_SPLITS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE
public static final String JSON_PROPERTY_STORE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_STORE_PAYMENT_METHOD
public static final String JSON_PROPERTY_STORE_PAYMENT_METHOD
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TELEPHONE_NUMBER
public static final String JSON_PROPERTY_TELEPHONE_NUMBER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
public static final String JSON_PROPERTY_THREE_D_S2_REQUEST_DATA
- See Also:
- Constant Field Values
-
JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
public static final String JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TRUSTED_SHOPPER
public static final String JSON_PROPERTY_TRUSTED_SHOPPER
- See Also:
- Constant Field Values
-
-
Method Detail
-
accountInfo
public DonationPaymentRequest accountInfo(AccountInfo accountInfo)
-
getAccountInfo
public AccountInfo getAccountInfo()
Get accountInfo- Returns:
- accountInfo
-
setAccountInfo
public void setAccountInfo(AccountInfo accountInfo)
-
additionalAmount
public DonationPaymentRequest additionalAmount(Amount additionalAmount)
-
getAdditionalAmount
public Amount getAdditionalAmount()
Get additionalAmount- Returns:
- additionalAmount
-
setAdditionalAmount
public void setAdditionalAmount(Amount additionalAmount)
-
additionalData
public DonationPaymentRequest additionalData(Map<String,String> additionalData)
-
putAdditionalDataItem
public DonationPaymentRequest putAdditionalDataItem(String key, String additionalDataItem)
-
getAdditionalData
public Map<String,String> getAdditionalData()
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.- Returns:
- additionalData
-
allowedPaymentMethods
public DonationPaymentRequest allowedPaymentMethods(List<String> allowedPaymentMethods)
-
addAllowedPaymentMethodsItem
public DonationPaymentRequest addAllowedPaymentMethodsItem(String allowedPaymentMethodsItem)
-
getAllowedPaymentMethods
public List<String> getAllowedPaymentMethods()
List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]`- Returns:
- allowedPaymentMethods
-
amount
public DonationPaymentRequest amount(Amount amount)
-
getAmount
public Amount getAmount()
Get amount- Returns:
- amount
-
setAmount
public void setAmount(Amount amount)
-
applicationInfo
public DonationPaymentRequest applicationInfo(ApplicationInfo applicationInfo)
-
getApplicationInfo
public ApplicationInfo getApplicationInfo()
Get applicationInfo- Returns:
- applicationInfo
-
setApplicationInfo
public void setApplicationInfo(ApplicationInfo applicationInfo)
-
authenticationData
public DonationPaymentRequest authenticationData(AuthenticationData authenticationData)
-
getAuthenticationData
public AuthenticationData getAuthenticationData()
Get authenticationData- Returns:
- authenticationData
-
setAuthenticationData
public void setAuthenticationData(AuthenticationData authenticationData)
-
billingAddress
public DonationPaymentRequest billingAddress(BillingAddress billingAddress)
-
getBillingAddress
public BillingAddress getBillingAddress()
Get billingAddress- Returns:
- billingAddress
-
setBillingAddress
public void setBillingAddress(BillingAddress billingAddress)
-
blockedPaymentMethods
public DonationPaymentRequest blockedPaymentMethods(List<String> blockedPaymentMethods)
-
addBlockedPaymentMethodsItem
public DonationPaymentRequest addBlockedPaymentMethodsItem(String blockedPaymentMethodsItem)
-
getBlockedPaymentMethods
public List<String> getBlockedPaymentMethods()
List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]`- Returns:
- blockedPaymentMethods
-
browserInfo
public DonationPaymentRequest browserInfo(BrowserInfo browserInfo)
-
getBrowserInfo
public BrowserInfo getBrowserInfo()
Get browserInfo- Returns:
- browserInfo
-
setBrowserInfo
public void setBrowserInfo(BrowserInfo browserInfo)
-
captureDelayHours
public DonationPaymentRequest captureDelayHours(Integer captureDelayHours)
-
getCaptureDelayHours
public Integer getCaptureDelayHours()
The delay between the authorisation and scheduled auto-capture, specified in hours.- Returns:
- captureDelayHours
-
setCaptureDelayHours
public void setCaptureDelayHours(Integer captureDelayHours)
-
channel
public DonationPaymentRequest channel(DonationPaymentRequest.ChannelEnum channel)
-
getChannel
public DonationPaymentRequest.ChannelEnum getChannel()
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- Returns:
- channel
-
setChannel
public void setChannel(DonationPaymentRequest.ChannelEnum channel)
-
checkoutAttemptId
public DonationPaymentRequest checkoutAttemptId(String checkoutAttemptId)
-
getCheckoutAttemptId
public String getCheckoutAttemptId()
Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey.- Returns:
- checkoutAttemptId
-
setCheckoutAttemptId
public void setCheckoutAttemptId(String checkoutAttemptId)
-
company
public DonationPaymentRequest company(Company company)
-
getCompany
public Company getCompany()
Get company- Returns:
- company
-
setCompany
public void setCompany(Company company)
-
conversionId
public DonationPaymentRequest conversionId(String conversionId)
-
getConversionId
@Deprecated public String getConversionId()
Deprecated.Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey.- Returns:
- conversionId
-
setConversionId
@Deprecated public void setConversionId(String conversionId)
Deprecated.
-
countryCode
public DonationPaymentRequest countryCode(String countryCode)
-
getCountryCode
public String getCountryCode()
The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE- Returns:
- countryCode
-
setCountryCode
public void setCountryCode(String countryCode)
-
dateOfBirth
public DonationPaymentRequest dateOfBirth(OffsetDateTime dateOfBirth)
-
getDateOfBirth
public OffsetDateTime getDateOfBirth()
The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD- Returns:
- dateOfBirth
-
setDateOfBirth
public void setDateOfBirth(OffsetDateTime dateOfBirth)
-
dccQuote
public DonationPaymentRequest dccQuote(ForexQuote dccQuote)
-
getDccQuote
public ForexQuote getDccQuote()
Get dccQuote- Returns:
- dccQuote
-
setDccQuote
public void setDccQuote(ForexQuote dccQuote)
-
deliverAt
public DonationPaymentRequest deliverAt(OffsetDateTime deliverAt)
-
getDeliverAt
public OffsetDateTime getDeliverAt()
The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00- Returns:
- deliverAt
-
setDeliverAt
public void setDeliverAt(OffsetDateTime deliverAt)
-
deliveryAddress
public DonationPaymentRequest deliveryAddress(DeliveryAddress deliveryAddress)
-
getDeliveryAddress
public DeliveryAddress getDeliveryAddress()
Get deliveryAddress- Returns:
- deliveryAddress
-
setDeliveryAddress
public void setDeliveryAddress(DeliveryAddress deliveryAddress)
-
deliveryDate
public DonationPaymentRequest deliveryDate(OffsetDateTime deliveryDate)
-
getDeliveryDate
public OffsetDateTime getDeliveryDate()
The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00- Returns:
- deliveryDate
-
setDeliveryDate
public void setDeliveryDate(OffsetDateTime deliveryDate)
-
deviceFingerprint
public DonationPaymentRequest deviceFingerprint(String deviceFingerprint)
-
getDeviceFingerprint
public String getDeviceFingerprint()
A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting).- Returns:
- deviceFingerprint
-
setDeviceFingerprint
public void setDeviceFingerprint(String deviceFingerprint)
-
donationAccount
public DonationPaymentRequest donationAccount(String donationAccount)
-
getDonationAccount
public String getDonationAccount()
Donation account to which the transaction is credited.- Returns:
- donationAccount
-
setDonationAccount
public void setDonationAccount(String donationAccount)
-
donationOriginalPspReference
public DonationPaymentRequest donationOriginalPspReference(String donationOriginalPspReference)
-
getDonationOriginalPspReference
public String getDonationOriginalPspReference()
PSP reference of the transaction from which the donation token is generated. Required when `donationToken` is provided.- Returns:
- donationOriginalPspReference
-
setDonationOriginalPspReference
public void setDonationOriginalPspReference(String donationOriginalPspReference)
-
donationToken
public DonationPaymentRequest donationToken(String donationToken)
-
getDonationToken
public String getDonationToken()
Donation token received in the `/payments` call.- Returns:
- donationToken
-
setDonationToken
public void setDonationToken(String donationToken)
-
enableOneClick
public DonationPaymentRequest enableOneClick(Boolean enableOneClick)
-
getEnableOneClick
public Boolean getEnableOneClick()
When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments.- Returns:
- enableOneClick
-
setEnableOneClick
public void setEnableOneClick(Boolean enableOneClick)
-
enablePayOut
public DonationPaymentRequest enablePayOut(Boolean enablePayOut)
-
getEnablePayOut
public Boolean getEnablePayOut()
When true and `shopperReference` is provided, the payment details will be tokenized for payouts.- Returns:
- enablePayOut
-
setEnablePayOut
public void setEnablePayOut(Boolean enablePayOut)
-
enableRecurring
public DonationPaymentRequest enableRecurring(Boolean enableRecurring)
-
getEnableRecurring
public Boolean getEnableRecurring()
When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments.- Returns:
- enableRecurring
-
setEnableRecurring
public void setEnableRecurring(Boolean enableRecurring)
-
entityType
public DonationPaymentRequest entityType(DonationPaymentRequest.EntityTypeEnum entityType)
-
getEntityType
public DonationPaymentRequest.EntityTypeEnum getEntityType()
The type of the entity the payment is processed for.- Returns:
- entityType
-
setEntityType
public void setEntityType(DonationPaymentRequest.EntityTypeEnum entityType)
-
fraudOffset
public DonationPaymentRequest fraudOffset(Integer fraudOffset)
-
getFraudOffset
public Integer getFraudOffset()
An integer value that is added to the normal fraud score. The value can be either positive or negative.- Returns:
- fraudOffset
-
setFraudOffset
public void setFraudOffset(Integer fraudOffset)
-
fundOrigin
public DonationPaymentRequest fundOrigin(FundOrigin fundOrigin)
-
getFundOrigin
public FundOrigin getFundOrigin()
Get fundOrigin- Returns:
- fundOrigin
-
setFundOrigin
public void setFundOrigin(FundOrigin fundOrigin)
-
fundRecipient
public DonationPaymentRequest fundRecipient(FundRecipient fundRecipient)
-
getFundRecipient
public FundRecipient getFundRecipient()
Get fundRecipient- Returns:
- fundRecipient
-
setFundRecipient
public void setFundRecipient(FundRecipient fundRecipient)
-
fundingSource
public DonationPaymentRequest fundingSource(DonationPaymentRequest.FundingSourceEnum fundingSource)
-
getFundingSource
public DonationPaymentRequest.FundingSourceEnum getFundingSource()
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**.- Returns:
- fundingSource
-
setFundingSource
public void setFundingSource(DonationPaymentRequest.FundingSourceEnum fundingSource)
-
industryUsage
public DonationPaymentRequest industryUsage(DonationPaymentRequest.IndustryUsageEnum industryUsage)
-
getIndustryUsage
public DonationPaymentRequest.IndustryUsageEnum getIndustryUsage()
The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment**- Returns:
- industryUsage
-
setIndustryUsage
public void setIndustryUsage(DonationPaymentRequest.IndustryUsageEnum industryUsage)
-
installments
public DonationPaymentRequest installments(Installments installments)
-
getInstallments
public Installments getInstallments()
Get installments- Returns:
- installments
-
setInstallments
public void setInstallments(Installments installments)
-
lineItems
public DonationPaymentRequest lineItems(List<LineItem> lineItems)
-
addLineItemsItem
public DonationPaymentRequest addLineItemsItem(LineItem lineItemsItem)
-
getLineItems
public List<LineItem> getLineItems()
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 Zip.- Returns:
- lineItems
-
localizedShopperStatement
public DonationPaymentRequest localizedShopperStatement(Map<String,String> localizedShopperStatement)
-
putLocalizedShopperStatementItem
public DonationPaymentRequest putLocalizedShopperStatementItem(String key, String localizedShopperStatementItem)
-
getLocalizedShopperStatement
public Map<String,String> getLocalizedShopperStatement()
The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters.- Returns:
- localizedShopperStatement
-
setLocalizedShopperStatement
public void setLocalizedShopperStatement(Map<String,String> localizedShopperStatement)
-
mandate
public DonationPaymentRequest mandate(Mandate mandate)
-
getMandate
public Mandate getMandate()
Get mandate- Returns:
- mandate
-
setMandate
public void setMandate(Mandate mandate)
-
mcc
public DonationPaymentRequest mcc(String mcc)
-
getMcc
public String getMcc()
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. This code reflects the predominant activity that is conducted by the merchant.- Returns:
- mcc
-
setMcc
public void setMcc(String mcc)
-
merchantAccount
public DonationPaymentRequest merchantAccount(String merchantAccount)
-
getMerchantAccount
public String getMerchantAccount()
The merchant account identifier, with which you want to process the transaction.- Returns:
- merchantAccount
-
setMerchantAccount
public void setMerchantAccount(String merchantAccount)
-
merchantOrderReference
public DonationPaymentRequest merchantOrderReference(String merchantOrderReference)
-
getMerchantOrderReference
public String getMerchantOrderReference()
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`.- Returns:
- merchantOrderReference
-
setMerchantOrderReference
public void setMerchantOrderReference(String merchantOrderReference)
-
merchantRiskIndicator
public DonationPaymentRequest merchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
-
getMerchantRiskIndicator
public MerchantRiskIndicator getMerchantRiskIndicator()
Get merchantRiskIndicator- Returns:
- merchantRiskIndicator
-
setMerchantRiskIndicator
public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator)
-
metadata
public DonationPaymentRequest metadata(Map<String,String> metadata)
-
putMetadataItem
public DonationPaymentRequest putMetadataItem(String key, String metadataItem)
-
getMetadata
public Map<String,String> getMetadata()
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.- Returns:
- metadata
-
mpiData
public DonationPaymentRequest mpiData(ThreeDSecureData mpiData)
-
getMpiData
public ThreeDSecureData getMpiData()
Get mpiData- Returns:
- mpiData
-
setMpiData
public void setMpiData(ThreeDSecureData mpiData)
-
order
public DonationPaymentRequest order(EncryptedOrderData order)
-
getOrder
public EncryptedOrderData getOrder()
Get order- Returns:
- order
-
setOrder
public void setOrder(EncryptedOrderData order)
-
orderReference
public DonationPaymentRequest orderReference(String orderReference)
-
getOrderReference
public String getOrderReference()
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 `merchantOrderReference`instead.- Returns:
- orderReference
-
setOrderReference
public void setOrderReference(String orderReference)
-
origin
public DonationPaymentRequest origin(String origin)
-
getOrigin
public String getOrigin()
Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.- Returns:
- origin
-
setOrigin
public void setOrigin(String origin)
-
paymentMethod
public DonationPaymentRequest paymentMethod(DonationPaymentMethod paymentMethod)
-
getPaymentMethod
public DonationPaymentMethod getPaymentMethod()
Get paymentMethod- Returns:
- paymentMethod
-
setPaymentMethod
public void setPaymentMethod(DonationPaymentMethod paymentMethod)
-
platformChargebackLogic
public DonationPaymentRequest platformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
-
getPlatformChargebackLogic
public PlatformChargebackLogic getPlatformChargebackLogic()
Get platformChargebackLogic- Returns:
- platformChargebackLogic
-
setPlatformChargebackLogic
public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic)
-
recurringExpiry
public DonationPaymentRequest recurringExpiry(String recurringExpiry)
-
getRecurringExpiry
public String getRecurringExpiry()
Date after which no further authorisations shall be performed. Only for 3D Secure 2.- Returns:
- recurringExpiry
-
setRecurringExpiry
public void setRecurringExpiry(String recurringExpiry)
-
recurringFrequency
public DonationPaymentRequest recurringFrequency(String recurringFrequency)
-
getRecurringFrequency
public String getRecurringFrequency()
Minimum number of days between authorisations. Only for 3D Secure 2.- Returns:
- recurringFrequency
-
setRecurringFrequency
public void setRecurringFrequency(String recurringFrequency)
-
recurringProcessingModel
public DonationPaymentRequest recurringProcessingModel(DonationPaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)
-
getRecurringProcessingModel
public DonationPaymentRequest.RecurringProcessingModelEnum getRecurringProcessingModel()
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.- Returns:
- recurringProcessingModel
-
setRecurringProcessingModel
public void setRecurringProcessingModel(DonationPaymentRequest.RecurringProcessingModelEnum recurringProcessingModel)
-
redirectFromIssuerMethod
public DonationPaymentRequest redirectFromIssuerMethod(String redirectFromIssuerMethod)
-
getRedirectFromIssuerMethod
public String getRedirectFromIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting back from the issuer.- Returns:
- redirectFromIssuerMethod
-
setRedirectFromIssuerMethod
public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod)
-
redirectToIssuerMethod
public DonationPaymentRequest redirectToIssuerMethod(String redirectToIssuerMethod)
-
getRedirectToIssuerMethod
public String getRedirectToIssuerMethod()
Specifies the redirect method (GET or POST) when redirecting to the issuer.- Returns:
- redirectToIssuerMethod
-
setRedirectToIssuerMethod
public void setRedirectToIssuerMethod(String redirectToIssuerMethod)
-
reference
public DonationPaymentRequest reference(String reference)
-
getReference
public String getReference()
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.- Returns:
- reference
-
setReference
public void setReference(String reference)
-
returnUrl
public DonationPaymentRequest returnUrl(String returnUrl)
-
getReturnUrl
public String getReturnUrl()
The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * 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.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](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name`- Returns:
- returnUrl
-
setReturnUrl
public void setReturnUrl(String returnUrl)
-
riskData
public DonationPaymentRequest riskData(RiskData riskData)
-
getRiskData
public RiskData getRiskData()
Get riskData- Returns:
- riskData
-
setRiskData
public void setRiskData(RiskData riskData)
-
selectedRecurringDetailReference
public DonationPaymentRequest selectedRecurringDetailReference(String selectedRecurringDetailReference)
-
getSelectedRecurringDetailReference
public String getSelectedRecurringDetailReference()
The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.- Returns:
- selectedRecurringDetailReference
-
setSelectedRecurringDetailReference
public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference)
-
sessionValidity
public DonationPaymentRequest sessionValidity(String sessionValidity)
-
getSessionValidity
public String getSessionValidity()
The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00- Returns:
- sessionValidity
-
setSessionValidity
public void setSessionValidity(String sessionValidity)
-
shopperEmail
public DonationPaymentRequest shopperEmail(String shopperEmail)
-
getShopperEmail
public String getShopperEmail()
The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations.- Returns:
- shopperEmail
-
setShopperEmail
public void setShopperEmail(String shopperEmail)
-
shopperIP
public DonationPaymentRequest shopperIP(String shopperIP)
-
getShopperIP
public String getShopperIP()
The shopper's IP address. In general, 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). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new).- Returns:
- shopperIP
-
setShopperIP
public void setShopperIP(String shopperIP)
-
shopperInteraction
public DonationPaymentRequest shopperInteraction(DonationPaymentRequest.ShopperInteractionEnum shopperInteraction)
-
getShopperInteraction
public DonationPaymentRequest.ShopperInteractionEnum getShopperInteraction()
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.- Returns:
- shopperInteraction
-
setShopperInteraction
public void setShopperInteraction(DonationPaymentRequest.ShopperInteractionEnum shopperInteraction)
-
shopperLocale
public DonationPaymentRequest shopperLocale(String shopperLocale)
-
getShopperLocale
public String getShopperLocale()
The combination of a language code and a country code to specify the language to be used in the payment.- Returns:
- shopperLocale
-
setShopperLocale
public void setShopperLocale(String shopperLocale)
-
shopperName
public DonationPaymentRequest shopperName(Name shopperName)
-
getShopperName
public Name getShopperName()
Get shopperName- Returns:
- shopperName
-
setShopperName
public void setShopperName(Name shopperName)
-
shopperReference
public DonationPaymentRequest shopperReference(String shopperReference)
-
getShopperReference
public String getShopperReference()
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.- Returns:
- shopperReference
-
setShopperReference
public void setShopperReference(String shopperReference)
-
shopperStatement
public DonationPaymentRequest shopperStatement(String shopperStatement)
-
getShopperStatement
public String getShopperStatement()
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 **. , ' _ - ? + * /_**.- Returns:
- shopperStatement
-
setShopperStatement
public void setShopperStatement(String shopperStatement)
-
socialSecurityNumber
public DonationPaymentRequest socialSecurityNumber(String socialSecurityNumber)
-
getSocialSecurityNumber
public String getSocialSecurityNumber()
The shopper's social security number.- Returns:
- socialSecurityNumber
-
setSocialSecurityNumber
public void setSocialSecurityNumber(String socialSecurityNumber)
-
splits
public DonationPaymentRequest splits(List<Split> splits)
-
addSplitsItem
public DonationPaymentRequest addSplitsItem(Split splitsItem)
-
getSplits
public List<Split> getSplits()
An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).- Returns:
- splits
-
store
public DonationPaymentRequest store(String store)
-
getStore
public String getStore()
The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms).- Returns:
- store
-
setStore
public void setStore(String store)
-
storePaymentMethod
public DonationPaymentRequest storePaymentMethod(Boolean storePaymentMethod)
-
getStorePaymentMethod
public Boolean getStorePaymentMethod()
When true and `shopperReference` is provided, the payment details will be stored.- Returns:
- storePaymentMethod
-
setStorePaymentMethod
public void setStorePaymentMethod(Boolean storePaymentMethod)
-
telephoneNumber
public DonationPaymentRequest telephoneNumber(String telephoneNumber)
-
getTelephoneNumber
public String getTelephoneNumber()
The shopper's telephone number.- Returns:
- telephoneNumber
-
setTelephoneNumber
public void setTelephoneNumber(String telephoneNumber)
-
threeDS2RequestData
public DonationPaymentRequest threeDS2RequestData(ThreeDS2RequestData2 threeDS2RequestData)
-
getThreeDS2RequestData
public ThreeDS2RequestData2 getThreeDS2RequestData()
Get threeDS2RequestData- Returns:
- threeDS2RequestData
-
setThreeDS2RequestData
public void setThreeDS2RequestData(ThreeDS2RequestData2 threeDS2RequestData)
-
threeDSAuthenticationOnly
public DonationPaymentRequest threeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
-
getThreeDSAuthenticationOnly
@Deprecated public Boolean getThreeDSAuthenticationOnly()
Deprecated.If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation.- Returns:
- threeDSAuthenticationOnly
-
setThreeDSAuthenticationOnly
@Deprecated public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly)
Deprecated.
-
trustedShopper
public DonationPaymentRequest trustedShopper(Boolean trustedShopper)
-
getTrustedShopper
public Boolean getTrustedShopper()
Set to true if the payment should be routed to a trusted MID.- Returns:
- trustedShopper
-
setTrustedShopper
public void setTrustedShopper(Boolean trustedShopper)
-
equals
public boolean equals(Object o)
Return true if this DonationPaymentRequest object is equal to o.
-
fromJson
public static DonationPaymentRequest fromJson(String jsonString) throws com.fasterxml.jackson.core.JsonProcessingException
Create an instance of DonationPaymentRequest given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of DonationPaymentRequest
- Throws:
com.fasterxml.jackson.core.JsonProcessingException- if the JSON string is invalid with respect to DonationPaymentRequest
-
toJson
public String toJson() throws com.fasterxml.jackson.core.JsonProcessingException
Convert an instance of DonationPaymentRequest to an JSON string- Returns:
- JSON string
- Throws:
com.fasterxml.jackson.core.JsonProcessingException
-
-