S-Index (onlinepayments-sdk-java 4.12.0 API)

A B C D E F G H I J L M N O P R S T U V W

S

SDK_IDENTIFIER - Static variable in class com.onlinepayments.MetaDataProvider
SecretKeyNotAvailableException - Exception in com.onlinepayments.webhooks: Represents an error that causes a secret key to not be available.
SecretKeyNotAvailableException(String, String) - Constructor for exception com.onlinepayments.webhooks.SecretKeyNotAvailableException
SecretKeyNotAvailableException(String, Throwable) - Constructor for exception com.onlinepayments.webhooks.SecretKeyNotAvailableException
SecretKeyNotAvailableException(String, String, Throwable) - Constructor for exception com.onlinepayments.webhooks.SecretKeyNotAvailableException
SecretKeyStore - Interface in com.onlinepayments.webhooks: A store of secret keys.
SepaDirectDebitPaymentMethodSpecificInput - Class in com.onlinepayments.domain: Object containing the specific input details for SEPA direct debit payments
SepaDirectDebitPaymentMethodSpecificInput() - Constructor for class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput
SepaDirectDebitPaymentMethodSpecificInputBase - Class in com.onlinepayments.domain: Object containing the specific input details for SEPA direct debit payments
SepaDirectDebitPaymentMethodSpecificInputBase() - Constructor for class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase
SepaDirectDebitPaymentMethodSpecificOutput - Class in com.onlinepayments.domain: Object containing the SEPA direct debit details
SepaDirectDebitPaymentMethodSpecificOutput() - Constructor for class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput
SepaDirectDebitPaymentProduct771SpecificInput - Class in com.onlinepayments.domain: Object containing information specific to SEPA Direct Debit
SepaDirectDebitPaymentProduct771SpecificInput() - Constructor for class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput
SepaDirectDebitPaymentProduct771SpecificInputBase - Class in com.onlinepayments.domain: Object containing information specific to SEPA Direct Debit
SepaDirectDebitPaymentProduct771SpecificInputBase() - Constructor for class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase
services() - Method in class com.onlinepayments.merchant.MerchantClient: Resource /v2/{merchantId}/services
services() - Method in interface com.onlinepayments.merchant.MerchantClientInterface: Resource /v2/{merchantId}/services
ServicesClient - Class in com.onlinepayments.merchant.services: Services client.
ServicesClient(ApiResource, Map<String, String>) - Constructor for class com.onlinepayments.merchant.services.ServicesClient
ServicesClientInterface - Interface in com.onlinepayments.merchant.services: Services client.
SessionRequest - Class in com.onlinepayments.domain
SessionRequest() - Constructor for class com.onlinepayments.domain.SessionRequest
SessionResponse - Class in com.onlinepayments.domain
SessionResponse() - Constructor for class com.onlinepayments.domain.SessionResponse
sessions() - Method in class com.onlinepayments.merchant.MerchantClient: Resource /v2/{merchantId}/sessions
sessions() - Method in interface com.onlinepayments.merchant.MerchantClientInterface: Resource /v2/{merchantId}/sessions
SessionsClient - Class in com.onlinepayments.merchant.sessions: Sessions client.
SessionsClient(ApiResource, Map<String, String>) - Constructor for class com.onlinepayments.merchant.sessions.SessionsClient
SessionsClientInterface - Interface in com.onlinepayments.merchant.sessions: Sessions client.
setAcceptedByUser(Boolean) - Method in class com.onlinepayments.domain.CurrencyConversion: Dynamic Currency Conversion(DCC) Proposal accepted by user
setAcceptedByUser(Boolean) - Method in class com.onlinepayments.domain.CurrencyConversionInput: Dynamic Currency Conversion(DCC) Proposal accepted by user
setAcceptHeader(String) - Method in class com.onlinepayments.domain.CustomerDevice: The accept-header of the customer client from the HTTP Headers.
setAccount(CustomerAccount) - Method in class com.onlinepayments.domain.Customer: Object containing data related to the account the customer has with you
setAccountId(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Username with which the PayPal account holder has registered at PayPal
setAccountNumber(String) - Method in class com.onlinepayments.domain.LoanRecipient: Should be filled with the last 10 digits of the bank account number of the recipient of the loan.
setAccountOnFile(AccountOnFile) - Method in class com.onlinepayments.domain.PaymentProductGroup
setAccountsOnFile(List<AccountOnFile>) - Method in class com.onlinepayments.domain.PaymentProduct: List of tokens for that payment product
setAccountType(String) - Method in class com.onlinepayments.domain.Customer: Type of the customer account that is used to place this order.
setAcquiredAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing amount and ISO currency code attributes
setAcquiredAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing amount and ISO currency code attributes
setAcquirerExemption(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Indicates the Acquirer TRA exemption
setAcquirerInformation(AcquirerInformation) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Information about the acquirer used to process the transaction
setAcsTransactionId(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Identifier of the authenticated transaction at the ACS/Issuer.
setAcsTransactionId(String) - Method in class com.onlinepayments.domain.ThreeDSecureData: The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
setAcsTransactionId(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Authenticated Transaction Identifier at the ACS/Issuer.
setActionType(String) - Method in class com.onlinepayments.domain.MandateMerchantAction: Action merchants needs to take in the online mandate process.
setActionType(String) - Method in class com.onlinepayments.domain.MerchantAction: Action merchants needs to take in the online payment process.
setAdditionalInfo(String) - Method in class com.onlinepayments.domain.Address: Second line of street or additional address information
setAdditionalInfo(String) - Method in class com.onlinepayments.domain.AddressPersonal: Second line of street or additional address information
setAdditionalInput(AdditionalOrderInput) - Method in class com.onlinepayments.domain.Order: Object containing additional input on the order
setAddress(AddressPersonal) - Method in class com.onlinepayments.domain.Shipping: Object containing address information
setAddressIndicator(String) - Method in class com.onlinepayments.domain.Shipping: Indicates shipping method chosen for the transaction.
setAddressSelectionAtPayPal(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput: Indicates whether to use PayPal Express Checkout Shortcut.
setAdValoremRate(Float) - Method in class com.onlinepayments.domain.SurchargeRate: A percentage rate defined on a merchant's configuration used in the calculation of a surcharge amount.
setAgentNumericCode(String) - Method in class com.onlinepayments.domain.AirlineData: Numeric code identifying the agent This field is used by the following payment products: 840
setAirlineClass(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Reservation Booking Designator This field is used by the following payment products: cards
setAirlineData(AirlineData) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object that holds airline specific data
setAirlineLoyaltyStatus(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Airline loyalty program level for the passenger on the itinerary.
setAlias(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: An alias for the mandate.
setAlias(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: An alias for the mandate.
setAlias(String) - Method in class com.onlinepayments.domain.MandateResponse: An alias for the mandate.
setAlias(String) - Method in class com.onlinepayments.domain.TokenCard: An alias for the token.
setAlias(String) - Method in class com.onlinepayments.domain.TokenEWallet: Deprecated: This field is not used by any payment product An alias for the token.
setAllowDynamicLinking(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
setAllowDynamicLinking(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
setAllowedNumberOfPaymentAttempts(Integer) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: The maximum number of times a customer can try to pay before the payment is definitely declined.
setAllowedValues(List<String>) - Method in class com.onlinepayments.domain.FixedListValidator
setAllowsRecurring(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct: Indicates if the product supports recurring payments * true - This payment product supports recurring payments * false - This payment product does not support recurring transactions and can only be used for one-off payments
setAllowsTokenization(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct: Indicates if the payment details can be tokenized for future re-use * true - Payment details from payments done with this payment product can be tokenized for future re-use * false - Payment details from payments done with this payment product can not be tokenized
setAlwaysShow(Boolean) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: * true - Indicates that this field is advised to be captured to increase the success rates even-though it isn't marked as required.
setAmount(Long) - Method in class com.onlinepayments.domain.AmountBreakdown: Amount in cents and always having 2 decimals
setAmount(Long) - Method in class com.onlinepayments.domain.AmountOfMoney: Amount in the smallest currency unit, i.e.: * EUR is a 2-decimals currency, the value 1234 will result in EUR 12.34 * KWD is a 3-decimals currency, the value 1234 will result in KWD 1.234 * JPY is a zero-decimal currency, the value 1234 will result in JPY 1234
setAmount(Long) - Method in class com.onlinepayments.domain.CapturePaymentRequest: Here you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits).
setAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentLinkOrder: Object containing amount and ISO currency code attributes
setAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Transaction: Object containing amount and ISO currency code attributes
setAmount(Long) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Whole amount in cents (not containing any decimals)
setAmount(Long) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Whole amount in cents (not containing any decimals)
setAmount(Long) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: Amount in cents and always having 2 decimals
setAmount(Long) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Whole amount in cents (not containing any decimals)
setAmount(Long) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Whole amount in cents (not containing any decimals)
setAmountBreakdown(List<AmountBreakdown>) - Method in class com.onlinepayments.domain.ShoppingCart: Deprecated: Use order.shipping.shippingCost for shipping cost.
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CalculateSurchargeRequest: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CancelPaymentRequest: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.GiftCardPurchase: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.LineItem: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.OperationOutput: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.Order: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentContext: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.PayoutOutput: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.RefundOutput: Object containing amount and ISO currency code attributes
setAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.RefundRequest: Object containing amount and ISO currency code attributes
setAmountPaid(Long) - Method in class com.onlinepayments.domain.CaptureOutput: Amount that has been paid.
setAmountPaid(Long) - Method in class com.onlinepayments.domain.PaymentOutput: Amount that has been paid.
setAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundOutput
setApiEndpoint(URI) - Method in class com.onlinepayments.CommunicatorConfiguration
setApiKeyId(String) - Method in class com.onlinepayments.CommunicatorConfiguration
setApiVersion(String) - Method in class com.onlinepayments.domain.WebhooksEvent
setAppliedExemption(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
setAppliedExemption(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Exemption requested and applied in the authorization
setAppSwitchLink(String) - Method in class com.onlinepayments.domain.PaymentProduct5404: Contains a application switch url that should open WeChat Pay application in mobile device (intended to be used by a device with the WeChat Pay app)
setArrivalAirport(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Arrival airport/city code This field is used by the following payment products: 840
setArrivalTime(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The arrival time in the local time zone Format: HH:MM This field is used by the following payment products: 840
setAskConsumerConsent(Boolean) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Indicate if the tokenization form should contain a checkbox asking the user to give consent for storing their information for future payments.
setAssetUrl(String) - Method in class com.onlinepayments.domain.SessionResponse: The datacenter-specific base url for assets.
setAttributeKey(String) - Method in class com.onlinepayments.domain.LabelTemplateElement: Name of the attribute that is shown to the customer on selection pages or screens
setAttributes(List<AccountOnFileAttribute>) - Method in class com.onlinepayments.domain.AccountOnFile
setAuthenticatedAmount(Long) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Allows amount to be authenticated to be different from amount authorized.
setAuthentication(CustomerAccountAuthentication) - Method in class com.onlinepayments.domain.CustomerAccount: Object containing data on the authentication used by the customer to access their account
setAuthenticationAmount(Long) - Method in class com.onlinepayments.domain.ThreeDSecure: Allows amount to be authenticated to be different from amount authorized.
setAuthenticationStatus(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: One-letter authentication status returned by DS.
setAuthorisationCode(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Card Authorization code as returned by the acquirer
setAuthorisationCode(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Card Authorization code as returned by the acquirer
setAuthorisationCode(String) - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput: The reference returned by redsys to identify the transaction
setAuthorizationMode(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Determines the type of the authorization that will be used.
setAuthorizationMode(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Determines the type of the authorization that will be used.
setAuthorizationMode(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput: Determines the type of the authorization that will be used.
setAuthorizationMode(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Determines the type of the authorization that will be used.
setAuthorizationMode(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: Determines the type of the authorization that will be used.
setAuthorizationType(AuthorizationType) - Method in class com.onlinepayments.CommunicatorConfiguration
setAvsResult(String) - Method in class com.onlinepayments.domain.CardFraudResults: Result of the Address Verification Service checks.
setBankAccountIban(BankAccountIban) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing IBAN information
setBaseAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.DccProposal: Object containing amount and ISO currency code attributes
setBillingAddress(Address) - Method in class com.onlinepayments.domain.Customer: Object containing billing address details
setBillingAddress(Address) - Method in class com.onlinepayments.domain.CustomerToken: Object containing billing address details
setBillingAddress(Address) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Object containing billing address details
setBin(String) - Method in class com.onlinepayments.domain.CardEssentials: The first digits of the credit card number from left to right with a minimum of 6 digits.
setBin(String) - Method in class com.onlinepayments.domain.GetIINDetailsRequest: The first digits of the credit card number from left to right with a minimum of 6 digits.
setBlackListData(String) - Method in class com.onlinepayments.domain.FraudFields: Additional black list input
setBody(String, String) - Method in class com.onlinepayments.logging.LogMessageBuilder
setBody(InputStream, Charset, String) - Method in class com.onlinepayments.logging.LogMessageBuilder
setBody(Reader, String) - Method in class com.onlinepayments.logging.LogMessageBuilder
setBrand(String) - Method in class com.onlinepayments.domain.PaymentProduct5100SpecificInput: Indicate whether to use a specific Cpay brand.
setBrand(String) - Method in class com.onlinepayments.domain.PaymentProduct5402SpecificOutput: The specific meal voucher brand used for the transaction
setBrowserData(BrowserData) - Method in class com.onlinepayments.domain.CustomerDevice: Object containing information regarding the browser of the customer
setBuyerCompliantBankMessage(String) - Method in class com.onlinepayments.domain.PaymentProduct3208SpecificOutput: This field indicates the text that must be returned and shown to the buyer to be compliant with the law regulating this payment product.
setBuyerCompliantBankMessage(String) - Method in class com.onlinepayments.domain.PaymentProduct3209SpecificOutput: This field indicates the text that must be returned and shown to the buyer to be compliant with the law regulating this payment product.
setCaptureOutput(CaptureOutput) - Method in class com.onlinepayments.domain.Capture: Object containing capture details
setCaptureOutput(CaptureOutput) - Method in class com.onlinepayments.domain.CaptureResponse: Object containing capture details
setCaptures(List<Capture>) - Method in class com.onlinepayments.domain.CapturesResponse: The list of all captures performed on the requested payment.
setCard(Card) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing card details
setCard(CardEssentials) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Object containing card details
setCard(Card) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: Object containing card details
setCard(SurchargeCalculationCard) - Method in class com.onlinepayments.domain.CardSource: An object containing card number and payment product id, which is used to determine surcharge product type
setCard(CardWithoutCvv) - Method in class com.onlinepayments.domain.CompletePaymentCardPaymentMethodSpecificInput
setCard(CardWithoutCvv) - Method in class com.onlinepayments.domain.CreatedTokenResponse
setCard(TokenCardSpecificInput) - Method in class com.onlinepayments.domain.CreateTokenRequest: Object containing the token details for a card
setCard(CardInfo) - Method in class com.onlinepayments.domain.CurrencyConversionRequest
setCard(Card) - Method in class com.onlinepayments.domain.TokenData: Object containing card details
setCard(TokenCard) - Method in class com.onlinepayments.domain.TokenResponse: Object containing card details
setCardholderName(String) - Method in class com.onlinepayments.domain.Card: The card holder's name on the card.
setCardholderName(String) - Method in class com.onlinepayments.domain.CardWithoutCvv: The card holder's name on the card.
setCardholderName(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: Card holder's name on the card.
setCardNumber(String) - Method in class com.onlinepayments.domain.Card: The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
setCardNumber(String) - Method in class com.onlinepayments.domain.CardEssentials: The complete credit/debit card number
setCardNumber(String) - Method in class com.onlinepayments.domain.CardInfo: The complete credit/debit card number
setCardNumber(String) - Method in class com.onlinepayments.domain.CardWithoutCvv: The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
setCardNumber(String) - Method in class com.onlinepayments.domain.SurchargeCalculationCard: The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
setCardOnFileRecurringExpiration(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: The end date of the last scheduled payment in a series of transactions.
setCardOnFileRecurringFrequency(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Period of payment occurrence for recurring and installment payments.
setCardPaymentMethodSpecificInput(CompletePaymentCardPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CompletePaymentRequest
setCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputBase) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for card payments
setCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for card payments
setCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputForHostedCheckout) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Object containing card payment specific data for hosted checkout
setCardPaymentMethodSpecificOutput(CardPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the card payment method details
setCardPaymentMethodSpecificOutput(CardPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the card payment method details
setCardPayoutMethodSpecificInput(CardPayoutMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object containing the payout details for a card
setCardRefundMethodSpecificOutput(RefundCardMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
setCardSource(CardSource) - Method in class com.onlinepayments.domain.CalculateSurchargeRequest: Contains elements from which card number can be obtained.
setCardType(String) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: The card's type as categorised by the payment method.
setCardType(String) - Method in class com.onlinepayments.domain.IINDetail: The card's type as categorised by the payment method.
setCardWithoutCvv(CardWithoutCvv) - Method in class com.onlinepayments.domain.TokenCardData
setCarrierCode(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: IATA carrier code This field is used by the following payment products: cards, 840
setCategory(String) - Method in class com.onlinepayments.domain.APIError: Category the error belongs to.
setCavv(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
setCavv(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Cardholder Authentication Verification Value.
setCavvAlgorithm(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
setChallengeCanvasSize(String) - Method in class com.onlinepayments.domain.GPayThreeDSecure: Dimensions of the challenge window that potentially will be displayed to the customer.
setChallengeCanvasSize(String) - Method in class com.onlinepayments.domain.ThreeDSecure: Dimensions of the challenge window that potentially will be displayed to the customer.
setChallengeCanvasSize(String) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Dimensions of the challenge window that potentially will be displayed to the customer.
setChallengeIndicator(String) - Method in class com.onlinepayments.domain.GPayThreeDSecure: Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
setChallengeIndicator(String) - Method in class com.onlinepayments.domain.ThreeDSecure: Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
setChallengeIndicator(String) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
setChallengeIndicator(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Challenge Indicator used for this transaction.
setChangeDate(String) - Method in class com.onlinepayments.domain.CustomerAccount: The last date (YYYYMMDD) on which the customer made changes to their account with you.
setChangedDuringCheckout(Boolean) - Method in class com.onlinepayments.domain.CustomerAccount: * true = the customer made changes to their account during this checkout * false = the customer didn't change anything to their account during this checkout/n The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
setCheckInDate(String) - Method in class com.onlinepayments.domain.LodgingData: The date the guest checks into (or plans to check in to) the facility.
setCity(String) - Method in class com.onlinepayments.domain.Address: City
setCity(String) - Method in class com.onlinepayments.domain.AddressPersonal: City
setCity(String) - Method in class com.onlinepayments.domain.MandateAddress: City Required for Create mandate and Create payment calls.
setClientApiUrl(String) - Method in class com.onlinepayments.domain.SessionResponse: The datacenter-specific base url for client requests.
setClientSessionId(String) - Method in class com.onlinepayments.domain.SessionResponse: The identifier of the session that has been created.
setCoBrands(List<IINDetail>) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: List of IIN details
setCode(String) - Method in class com.onlinepayments.domain.AirlineData: Airline numeric code This field is used by the following payment products: 840
setCode(String) - Method in class com.onlinepayments.domain.APIError: Deprecated: Use errorCode instead.
setColorDepth(Integer) - Method in class com.onlinepayments.domain.BrowserData: ColorDepth in bits.
setCompanyInformation(CompanyInformation) - Method in class com.onlinepayments.domain.Customer: Object containing company information
setCompanyInformation(CompanyInformation) - Method in class com.onlinepayments.domain.CustomerToken: Object containing company information
setCompanyName(String) - Method in class com.onlinepayments.domain.MandateCustomer: Name of company, as a customer
setCompanyName(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Name of the company in case the PayPal account is owned by a business
setComputedToken(String) - Method in class com.onlinepayments.domain.ExternalTokenLinked: The computed token
setConjunctionTicket(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage This field is used by the following payment products: 840
setConnectTimeout(int) - Method in class com.onlinepayments.CommunicatorConfiguration
setContactDetails(ContactDetails) - Method in class com.onlinepayments.domain.Customer: Object containing contact details like email address and phone number
setContactDetails(MandateContactDetails) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing contact details like email address and phone number
setCountryCode(String) - Method in class com.onlinepayments.domain.Address: ISO 3166-1 alpha-2 country code
setCountryCode(String) - Method in class com.onlinepayments.domain.AddressPersonal: ISO 3166-1 alpha-2 country code
setCountryCode(String) - Method in class com.onlinepayments.domain.CardEssentials: ISO 3166-1 alpha-2 country code
setCountryCode(String) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: The ISO 3166-1 alpha-2 country code of the country where the card was issued.
setCountryCode(String) - Method in class com.onlinepayments.domain.MandateAddress: ISO 3166-1 alpha-2 country code.
setCountryCode(String) - Method in class com.onlinepayments.domain.PaymentContext: The country the payment takes place in
setCountryCode(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: ISO 3166-1 alpha-2 country code
setCountryCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: ISO 3166-1 alpha-2 country code of the transaction
setCountryCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: ISO 3166-1 alpha-2 country code of the transaction
setCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: ISO 3166-1 alpha-2 country code
setCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: ISO 3166-1 alpha-2 country code of the transaction
setCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: ISO 3166-1 alpha-2 country code of the transaction
setCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetProductDirectoryParams: ISO 3166-1 alpha-2 country code
setCouponNumber(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The coupon number associated with this leg of the trip.
setCreated(String) - Method in class com.onlinepayments.domain.WebhooksEvent
setCreateDate(String) - Method in class com.onlinepayments.domain.CustomerAccount: The date (YYYYMMDD) on which the customer created their account with you
setCreateDate(String) - Method in class com.onlinepayments.domain.PaymentAccountOnFile: The date (YYYYMMDD) when the payment account on file was first created.
setCreatedPaymentOutput(CreatedPaymentOutput) - Method in class com.onlinepayments.domain.GetHostedCheckoutResponse: This object will return the details of the payment after the payment is cancelled by the customer, rejected or authorized
setCreationOutput(PaymentCreationOutput) - Method in class com.onlinepayments.domain.CompletePaymentResponse: Object containing the details of the created payment.
setCreationOutput(PaymentCreationOutput) - Method in class com.onlinepayments.domain.CreatePaymentResponse: Object containing the details of the created payment.
setCryptogram(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: The 3D secure online payment cryptogram.
setCurrencyCode(String) - Method in class com.onlinepayments.domain.AmountOfMoney: Three-letter ISO currency code representing the currency for the amount
setCurrencyCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Three-letter ISO currency code representing the currency for the amount
setCurrencyCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Three-letter ISO currency code representing the currency for the amount
setCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: Three-letter ISO currency code representing the currency for the amount
setCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Three-letter ISO currency code representing the currency for the amount
setCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Three-letter ISO currency code representing the currency for the amount
setCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetProductDirectoryParams: Three-letter ISO currency code representing the currency of the transaction
setCurrencyConversion(CurrencyConversionInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
setCurrencyConversion(CurrencyConversion) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
setCurrencyConversion(CurrencyConversion) - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
setCurrencyConversionSpecificInput(CurrencyConversionSpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for Dynamic Currency Conversion.
setCustom(String) - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput: Free text field that you can use to support reconciliation flow.
setCustomer(MandateCustomer) - Method in class com.onlinepayments.domain.CreateMandateRequest: Customer object containing customer specific inputs.
setCustomer(MandateCustomer) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Customer object containing customer specific inputs.
setCustomer(MandateCustomer) - Method in class com.onlinepayments.domain.MandateResponse: Customer object containing customer specific inputs.
setCustomer(Customer) - Method in class com.onlinepayments.domain.Order: Object containing the details of the customer
setCustomer(CustomerOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the details of the customer
setCustomer(CustomerToken) - Method in class com.onlinepayments.domain.TokenEWallet
setCustomerAccount(PaymentProduct840CustomerAccount) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Object containing the details of the PayPal account
setCustomerAccount(RefundPaymentProduct840CustomerAccount) - Method in class com.onlinepayments.domain.RefundPaymentProduct840SpecificOutput
setCustomerAccountStatus(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Status of the PayPal account * verified - PayPal has verified the funding means for this account * unverified - PayPal has not verified the funding means for this account
setCustomerAccountStatus(String) - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount
setCustomerAddress(Address) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Object containing billing address details
setCustomerAddressStatus(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Status of the customer's shipping address as registered by PayPal * none - Status is unknown at PayPal * confirmed - The address has been confirmed * unconfirmed - The address has not been confirmed
setCustomerAddressStatus(String) - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount
setCustomerId(String) - Method in class com.onlinepayments.domain.SessionResponse: The session is built up around the customer in the form of the customerId.
setCustomerIpAddress(String) - Method in class com.onlinepayments.domain.FraudFields: Deprecated: Use order.customer.device.ipAddress instead.
setCustomerReference(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: The unique identifier of a customer
setCustomerReference(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: The unique identifier of a customer
setCustomerReference(String) - Method in class com.onlinepayments.domain.MandateResponse: The unique identifier of a customer
setCvv(String) - Method in class com.onlinepayments.domain.Card: Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.
setCvvResult(String) - Method in class com.onlinepayments.domain.CardFraudResults: Result of the Card Verification Value checks.
setData(TokenCardData) - Method in class com.onlinepayments.domain.TokenCard
setData(TokenData) - Method in class com.onlinepayments.domain.TokenCardSpecificInput: Object containing the token details for a card
setDataRestrictions(PaymentProductFieldDataRestrictions) - Method in class com.onlinepayments.domain.PaymentProductField: Object containing data restrictions that apply to this field, like minimum and/or maximum length
setDate(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Date of the leg Format: YYYYMMDD This field is used by the following payment products: cards, 840
setDateOfBirth(String) - Method in class com.onlinepayments.domain.LoanRecipient: The date of birth of the customer of the recipient of the loan.
setDateOfBirth(String) - Method in class com.onlinepayments.domain.PersonalInformation: The date of birth of the customer of the recipient of the loan.
setDateTime(String) - Method in class com.onlinepayments.domain.PaymentLinkEvent: The date and time the change occurred.
setDccEnabled(Boolean) - Method in class com.onlinepayments.domain.CurrencyConversionSpecificInput: Indicates if this transaction is Dynamic Currency Conversion (DCC) enabled.
setDccSessionId(String) - Method in class com.onlinepayments.domain.CurrencyConversionInput: Dynamic Currency Conversion(DCC) Session Id that was previously returned by rate enquiry (/dccrate).
setDccSessionId(String) - Method in class com.onlinepayments.domain.CurrencyConversionResponse: The identifier of the Dynamic Currency Conversion(DCC) session that has been created.
setDecryptedPaymentData(DecryptedPaymentData) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: The payment data if you do the decryption of the encrypted payment data yourself.
setDepartureTime(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The departure time in the local time at the departure airport Format: HH:MM This field is used by the following payment products: 840
setDescription(String) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: A note related to the created payment link.
setDescription(String) - Method in class com.onlinepayments.domain.LineItemInvoiceData: Shopping cart item description
setDescriptor(String) - Method in class com.onlinepayments.domain.OrderReferences: Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer.
setDetails(String) - Method in class com.onlinepayments.domain.PaymentLinkEvent: Details of the events.
setDetails(String) - Method in class com.onlinepayments.domain.ShippingMethod: Details about the shipping method
setDevice(CustomerDevice) - Method in class com.onlinepayments.domain.Customer: Object containing information on the device and browser of the customer
setDevice(CustomerDeviceOutput) - Method in class com.onlinepayments.domain.CustomerOutput: Object containing information on the device and browser of the customer
setDirectoryServerTransactionId(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
setDisclaimerDisplay(String) - Method in class com.onlinepayments.domain.DccProposal: Card scheme disclaimer to present to the cardholder
setDisclaimerReceipt(String) - Method in class com.onlinepayments.domain.DccProposal: Card scheme disclaimer to print within cardholder receipt
setDiscountAmount(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: Discount on the line item, with the last two digits implied as decimal places
setDisplayElements(List<PaymentProductFieldDisplayElement>) - Method in class com.onlinepayments.domain.ValueMappingElement
setDisplayHints(AccountOnFileDisplayHints) - Method in class com.onlinepayments.domain.AccountOnFile: Object containing information for the client on how best to display this field
setDisplayHints(PaymentProductDisplayHints) - Method in class com.onlinepayments.domain.PaymentProduct: Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
setDisplayHints(PaymentProductFieldDisplayHints) - Method in class com.onlinepayments.domain.PaymentProductField: Object containing display hints for this field, like the order, mask, preferred keyboard
setDisplayHints(PaymentProductDisplayHints) - Method in class com.onlinepayments.domain.PaymentProductGroup: Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
setDisplayHintsList(List<PaymentProductDisplayHints>) - Method in class com.onlinepayments.domain.PaymentProduct: List of display hints
setDisplayHintsList(List<PaymentProductDisplayHints>) - Method in class com.onlinepayments.domain.PaymentProductGroup: List of display hints
setDisplayOrder(Integer) - Method in class com.onlinepayments.domain.PaymentProductDisplayHints: Determines the order in which the payment products and groups should be shown (sorted ascending)
setDisplayOrder(Integer) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: The order in which the fields should be shown (ascending)
setDpan(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: The device specific PAN.
setDpan(String) - Method in class com.onlinepayments.domain.MobilePaymentData: The obfuscated DPAN.
setDsTransactionId(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure Directory Server Transaction Identifier used for this transaction.
setEci(Integer) - Method in class com.onlinepayments.domain.DecryptedPaymentData: Electronic Commerce Indicator.
setEci(Integer) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
setEci(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Indicates Authentication validation results returned after AuthenticationValidation
setEligibility(String) - Method in class com.onlinepayments.domain.ProtectionEligibility: * Eligible - Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received * PartiallyEligible - Merchant is protected by PayPal's Seller Protection Policy for Item Not Received * Ineligible — Merchant is not protected under the Seller Protection Policy
setEmailAddress(String) - Method in class com.onlinepayments.domain.ContactDetails: Email address of the customer
setEmailAddress(String) - Method in class com.onlinepayments.domain.MandateContactDetails: Email address of the customer
setEmailAddress(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setEmailAddress(String) - Method in class com.onlinepayments.domain.Shipping: Email address linked to the shipping
setEncryptedCustomerInput(String) - Method in class com.onlinepayments.domain.CardSource: Data that was encrypted client side containing all customer entered data elements like card data.
setEncryptedCustomerInput(String) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Data that was encrypted client side containing all customer entered data elements like card data.
setEncryptedPaymentData(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: The payment data if we will do the decryption of the encrypted payment data.
setEndorsementOrRestriction(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax.
setEntries(List<DirectoryEntry>) - Method in class com.onlinepayments.domain.ProductDirectory: List of entries in the directory
setEphemeralKey(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Ephemeral Key A unique generated key used by Apple to encrypt data.
setErrorCode(String) - Method in class com.onlinepayments.domain.APIError: Error code
setErrorId(String) - Method in class com.onlinepayments.domain.ErrorResponse: Unique reference, for debugging purposes, of this error response
setErrorId(String) - Method in class com.onlinepayments.domain.PaymentErrorResponse: Unique reference, for debugging purposes, of this error response
setErrorId(String) - Method in class com.onlinepayments.domain.PayoutErrorResponse
setErrorId(String) - Method in class com.onlinepayments.domain.RefundErrorResponse
setErrors(List<APIError>) - Method in class com.onlinepayments.domain.ErrorResponse: List of one or more errors
setErrors(List<APIError>) - Method in class com.onlinepayments.domain.OrderStatusOutput
setErrors(List<APIError>) - Method in class com.onlinepayments.domain.PaymentErrorResponse
setErrors(List<APIError>) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Contains the set of errors
setErrors(List<APIError>) - Method in class com.onlinepayments.domain.PayoutErrorResponse: Contains the set of errors
setErrors(List<APIError>) - Method in class com.onlinepayments.domain.RefundErrorResponse
setEWallet(TokenEWallet) - Method in class com.onlinepayments.domain.TokenResponse: Object containing eWallet details
setEWalletRefundMethodSpecificOutput(RefundEWalletMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
setExchangeRate(Float) - Method in class com.onlinepayments.domain.RateDetails: Expressed as a percentage, applied to convert the original amount into the resulting amount without charge
setExchangeTicket(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: New ticket number that is issued when a ticket is exchanged This field is used by the following payment products: 840
setExclude(PaymentProductFilter) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedCheckout: Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment.
setExclude(PaymentProductFilterHostedTokenization) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedTokenization: Contains the payment product ids that should be excluded from the payment products available for the payment.
setExemptionEngineFlow(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Detailed description of the Exemption Engine outcomes
setExemptionRequest(String) - Method in class com.onlinepayments.domain.GPayThreeDSecure: In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
setExemptionRequest(String) - Method in class com.onlinepayments.domain.ThreeDSecure: In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
setExemptionRequest(String) - Method in class com.onlinepayments.domain.ThreeDSecureBase: In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
setExistingUniqueMandateReference(String) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput: The unique reference of the existing mandate to use in this payment.
setExistingUniqueMandateReference(String) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase: The unique reference of the existing mandate to use in this payment.
setExpirationDate(String) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: The date after which the payment link will not be usable to complete the payment.
setExpirationDate(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The date after which the payment link will not be usable to complete the payment.
setExpirationDate(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setExpiredCardTokens(List<String>) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: Tokens referencing expired cards are returned in this array.
setExpiryDate(String) - Method in class com.onlinepayments.domain.Card: Expiry date of the card Format: MMYY
setExpiryDate(String) - Method in class com.onlinepayments.domain.CardEssentials: Expiry date of the card Format: MMYY
setExpiryDate(String) - Method in class com.onlinepayments.domain.CardWithoutCvv: Expiry date of the card Format: MMYY
setExpiryDate(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: Expiry date of the card Format: MMYY.
setExpiryDate(String) - Method in class com.onlinepayments.domain.MobilePaymentData: Expiry date of the tokenized card.
setExternalCardholderAuthenticationData(ExternalCardholderAuthenticationData) - Method in class com.onlinepayments.domain.ThreeDSecure: Object containing 3D secure details.
setExternalReference(String) - Method in class com.onlinepayments.domain.PaymentCreationOutput: The external reference identifier for this transaction.
setExternalTokenLinked(ExternalTokenLinked) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
setExternalTokenLinked(ExternalTokenLinked) - Method in class com.onlinepayments.domain.CreatedTokenResponse
setExternalTokenLinked(ExternalTokenLinked) - Method in class com.onlinepayments.domain.TokenResponse
setExtraMerchantData(String) - Method in class com.onlinepayments.domain.RedirectPaymentProduct3306SpecificInput: In some cases, Klarna require additional information regarding the customer and the purchase in order to make a correct risk assessment.
setFare(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Deprecated: Use legFare instead.
setFareBasis(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Fare Basis/Ticket Designator This field is used by the following payment products: 840
setFaxNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: Fax number of the customer
setFee(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Fee for this leg of the trip This field is used by the following payment products: 840
setFields(List<PaymentProductField>) - Method in class com.onlinepayments.domain.PaymentProduct: Object containing all the fields and their details that are associated with this payment product.
setFirstName(String) - Method in class com.onlinepayments.domain.AirlinePassenger: First name of the passenger This field is used by the following payment products: cards, 840
setFirstName(String) - Method in class com.onlinepayments.domain.MandatePersonalName: Given name(s) or first name(s) of the customer.
setFirstName(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: First name of the PayPal account holder
setFirstName(String) - Method in class com.onlinepayments.domain.PersonalName: Given name(s) or first name(s) of the customer
setFirstName(String) - Method in class com.onlinepayments.domain.PersonalNameToken
setFirstUsageDate(String) - Method in class com.onlinepayments.domain.Shipping: Date (YYYYMMDD) when the shipping details for this transaction were first used.
setFiscalNumber(String) - Method in class com.onlinepayments.domain.Customer: Fiscal registration number of the customer or the tax registration number of the company for a business customer.
setFixedList(FixedListValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setFlightDate(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Date of the Flight Format: YYYYMMDD
setFlightIndicator(String) - Method in class com.onlinepayments.domain.AirlineData: Indicator representing the type of flight on the itinerary.
setFlightLegs(List<AirlineFlightLeg>) - Method in class com.onlinepayments.domain.AirlineData: Object that holds the data on the individual legs of the flight ticket
setFlightNumber(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The flight number assigned by the airline carrier with no leading spaces Should be a numeric string This field is used by the following payment products: cards, 840
setFlow(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: 3D Secure Flow used during this transaction.
setFlow(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure Flow used during this transaction.
setFormElement(PaymentProductFieldFormElement) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Object detailing the type of form element that should be used to present the field
setFraudFields(FraudFields) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing additional data that will be used to assess the risk of fraud
setFraudFields(FraudFields) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing additional data that will be used to assess the risk of fraud
setFraudResults(CardFraudResults) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Fraud results contained in the CardFraudResults object
setFraudResults(CardFraudResults) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Fraud results contained in the CardFraudResults object
setFraudResults(FraudResults) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Object containing the results of the fraud screening
setFraudResults(FraudResults) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput: Object containing the results of the fraud screening
setFraudServiceResult(String) - Method in class com.onlinepayments.domain.CardFraudResults: Resulting advice of the fraud prevention checks.
setFraudServiceResult(String) - Method in class com.onlinepayments.domain.FraudResults: Resulting advice of the fraud prevention checks.
setGateway(String) - Method in class com.onlinepayments.domain.PaymentProduct320SpecificData: The gateway identifier.
setGender(String) - Method in class com.onlinepayments.domain.PersonalInformation: The gender of the customer, possible values are: * male * female * unknown or empty
setGeneratedToken(String) - Method in class com.onlinepayments.domain.ExternalTokenLinked: The generated token
setGiftCardPurchase(GiftCardPurchase) - Method in class com.onlinepayments.domain.ShoppingCart: Object containing information on purchased gift card(s)
setGroupCards(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputForHostedCheckout: * true - Hosted Checkout will allow to show cards grouped as one payment method * false - Default - Hosted Checkout will show cards as separate payment methods
setGroups(List<String>) - Method in class com.onlinepayments.domain.PaymentProductFilter: List containing all payment product groups that should either be restricted to in or excluded from the payment context.
setGTSComputedToken(String) - Method in class com.onlinepayments.domain.ExternalTokenLinked: Deprecated: Use the field ComputedToken instead.
setHadSuspiciousActivity(Boolean) - Method in class com.onlinepayments.domain.CustomerAccount: Specifies if you have experienced suspicious activity on the account of the customer true = you have experienced suspicious activity (including previous fraud) on the customer account used for this transaction false = you have experienced no suspicious activity (including previous fraud) on the customer account used for this transaction
setHide(List<String>) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client.
setHide(List<String>) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client.
setHide(List<String>) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client.
setHide(List<String>) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Allows you to hide elements from the response, reducing the amount of data that needs to be returned to your client.
setHost(String) - Method in class com.onlinepayments.ProxyConfiguration
setHostedCheckoutId(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: The ID of the Hosted Checkout Session in which the payment was made.
setHostedCheckoutId(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificOutput: The ID of the Hosted Checkout Session in which the payment was made.
setHostedCheckoutSpecificInput(HostedCheckoutSpecificInput) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing hosted checkout specific data
setHostedCheckoutSpecificOutput(HostedCheckoutSpecificOutput) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Hosted Checkout specific information.
setHostedCheckoutSpecificOutput(HostedCheckoutSpecificOutput) - Method in class com.onlinepayments.domain.PaymentResponse: Hosted Checkout specific information.
setHostedTokenizationId(String) - Method in class com.onlinepayments.domain.CardSource: An Id of a hosted tokenization session
setHostedTokenizationId(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: The ID of the Hosted Tokenization Session
setHostedTokenizationId(String) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Use this field after a successful Hosted Tokenization session to create a payment with the tokenized payment method details.
setHostedTokenizationUrl(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: The URL you can use in your JavaScript when instantiating the Tokenizer.
setHouseNumber(String) - Method in class com.onlinepayments.domain.Address: House number
setHouseNumber(String) - Method in class com.onlinepayments.domain.AddressPersonal: House number
setHouseNumber(String) - Method in class com.onlinepayments.domain.MandateAddress: House number
setHtmlContent(String) - Method in class com.onlinepayments.domain.GetPrivacyPolicyResponse: HTML content to be displayed to the user.
setHttpsProtocols(Set<String>) - Method in class com.onlinepayments.CommunicatorConfiguration
setHttpStatusCode(Integer) - Method in class com.onlinepayments.domain.APIError: HTTP status code for this error that can be used to determine the type of error
setIban(String) - Method in class com.onlinepayments.domain.BankAccountIban: The IBAN is the International Bank Account Number.
setIban(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setId(Integer) - Method in class com.onlinepayments.domain.AccountOnFile
setId(String) - Method in class com.onlinepayments.domain.APIError: ID of the error.
setId(String) - Method in class com.onlinepayments.domain.Capture
setId(String) - Method in class com.onlinepayments.domain.CaptureResponse: Our unique payment transaction identifier
setId(String) - Method in class com.onlinepayments.domain.OperationOutput: Our unique payment transaction identifier
setId(String) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Our unique payment transaction identifier
setId(Integer) - Method in class com.onlinepayments.domain.PaymentProduct: The ID of the payment product in our system
setId(String) - Method in class com.onlinepayments.domain.PaymentProductField
setId(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: The ID of the display element.
setId(String) - Method in class com.onlinepayments.domain.PaymentProductGroup: The ID of the payment product group in our system
setId(String) - Method in class com.onlinepayments.domain.PaymentResponse: Our unique payment transaction identifier
setId(String) - Method in class com.onlinepayments.domain.PayoutResponse
setId(String) - Method in class com.onlinepayments.domain.PayoutResult
setId(String) - Method in class com.onlinepayments.domain.RefundResponse: Our unique payment transaction identifier
setId(String) - Method in class com.onlinepayments.domain.TokenResponse: ID of the token
setId(String) - Method in class com.onlinepayments.domain.WebhooksEvent
setIdempotenceRequestTimestamp(Long) - Method in class com.onlinepayments.CallContext: Sets the idempotence request timestamp.
setImage(String) - Method in class com.onlinepayments.domain.PaymentProductFieldTooltip: Deprecated: This field is not used by any payment product Relative URL that can be used to retrieve an image for the tooltip image.
setInitialSchemeTransactionId(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: The unique scheme transactionId of the initial transaction that was performed with SCA.
setInitialSchemeTransactionId(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: The unique scheme transactionId of the initial transaction that was performed with SCA.
setInitialSchemeTransactionId(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: The unique scheme transactionId of the initial transaction that was performed with SCA.
setIntegrator(String) - Method in class com.onlinepayments.CommunicatorConfiguration
setInvalidTokens(List<String>) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: Tokens that are submitted in the request are validated.
setInvalidTokens(List<String>) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: Tokens that are submitted in the request are validated.
setInvalidTokens(List<String>) - Method in class com.onlinepayments.domain.SessionResponse: Tokens that are submitted in the request are validated.
setInvertedExchangeRate(Float) - Method in class com.onlinepayments.domain.RateDetails: Exchange rate, expressed as a percentage, applied to convert the resulting amount into the original amount
setInvoiceData(LineItemInvoiceData) - Method in class com.onlinepayments.domain.LineItem: Object containing the line items of the invoice or shopping cart
setInvoiceNumber(String) - Method in class com.onlinepayments.domain.AirlineData: Airline tracing number This field is used by the following payment products: cards
setIpAddress(String) - Method in class com.onlinepayments.domain.CustomerDevice: The IP address of the customer client from the HTTP Headers.
setIpAddressCountryCode(String) - Method in class com.onlinepayments.domain.CustomerDeviceOutput: ISO 3166-1 alpha-2 country code
setIsAllowedInContext(Boolean) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: Populated only if you submitted a payment context.
setIsAllowedInContext(Boolean) - Method in class com.onlinepayments.domain.IINDetail: Populated only if you submitted a payment context.
setIsAuthorized(Boolean) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Indicates if the transaction has been authorized
setIsCancellable(Boolean) - Method in class com.onlinepayments.domain.OrderStatusOutput: Flag indicating if the payment can be cancelled * true * false
setIsCancellable(Boolean) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Flag indicating if the payment can be cancelled
setIsCancellable(Boolean) - Method in class com.onlinepayments.domain.PayoutStatusOutput: Flag indicating if the payout can be cancelled * true * false
setIsETicket(Boolean) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product * true = The ticket is an E-Ticket * false = the ticket is not an E-Ticket'
setIsFinal(Boolean) - Method in class com.onlinepayments.domain.CancelPaymentRequest: This property indicates whether this will be the final operation.
setIsFinal(Boolean) - Method in class com.onlinepayments.domain.CapturePaymentRequest: This property indicates whether this will be the final operation.
setIsFirstUsage(Boolean) - Method in class com.onlinepayments.domain.Shipping: Indicator if this shipping address is used for the first time to ship an order true = the shipping details are used for the first time with this transaction false = the shipping details have been used for other transactions in the past
setIsNewToken(Boolean) - Method in class com.onlinepayments.domain.CreatedTokenResponse: Indicates if a new token was created * true - A new token was created * false - A token with the same card number already exists and is returned.
setIsNewToken(Boolean) - Method in class com.onlinepayments.domain.PaymentCreationOutput: Indicates if a new token was created * true - A new token was created * false - A token with the same card number already exists and is returned.
setIsPreOrder(Boolean) - Method in class com.onlinepayments.domain.ShoppingCart: The customer is pre-ordering one or more items
setIsRecurring(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: * true - Only payment products that support recurring payments will be shown.
setIsRecurring(Boolean) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: * true - Only payment products that support recurring payments will be shown.
setIsRecurring(Boolean) - Method in class com.onlinepayments.domain.PaymentContext: True if the payment is recurring
setIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: This allows you to filter payment products based on their support for recurring payments.
setIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: This allows you to filter payment products based on their support for recurring payments.
setIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: This allows you to filter networks based on their support for recurring or not * true * false
setIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: This allows you to filter payment products based on their support for recurring payments.
setIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: This allows you to filter payment products based on their support for recurring payments.
setIsRefundable(Boolean) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Flag indicating if the payment can be refunded
setIsRequired(Boolean) - Method in class com.onlinepayments.domain.PaymentProductFieldDataRestrictions: * true - Indicates that this field is required * false - Indicates that this field is optional
setIsRestrictedTicket(Boolean) - Method in class com.onlinepayments.domain.AirlineData: Indicates if the ticket is refundable or not.
setIssueDate(String) - Method in class com.onlinepayments.domain.AirlineData: This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
setIssuerId(String) - Method in class com.onlinepayments.domain.DirectoryEntry: Unique ID of the issuing bank of the customer
setIssuerId(String) - Method in class com.onlinepayments.domain.RedirectPaymentProduct809SpecificInput: Unique ID of the issuing bank of the customer
setIssuerList(String) - Method in class com.onlinepayments.domain.DirectoryEntry: To be used to sort the issuers.
setIssuerName(String) - Method in class com.onlinepayments.domain.DirectoryEntry: Name of the issuing bank as it should be presented to the customer
setIsTemporary(Boolean) - Method in class com.onlinepayments.domain.TokenResponse: Temporary tokens have a lifespan of two hours and can only be used once.
setIsThirdParty(Boolean) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product * true - The payer is the ticket holder * false - The payer is not the ticket holder
setItems(List<LineItem>) - Method in class com.onlinepayments.domain.ShoppingCart: Shopping cart data
setJavaEnabled(Boolean) - Method in class com.onlinepayments.domain.BrowserData: true =Java is enabled in the browser false = Java is not enabled in the browser Value is returned from the navigator.javaEnabled property.
setJavaScriptEnabled(Boolean) - Method in class com.onlinepayments.domain.BrowserData: * true = JavaScript is enabled in the browser.
setKey(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Name of the key or property
setLabel(String) - Method in class com.onlinepayments.domain.PaymentProductDisplayHints: Name of the payment product or group based on the locale that was included in the request
setLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: The label of the display element.
setLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Label/Name of the field to be used in the user interface
setLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldTooltip: A text explaining the field in more detail.
setLabelTemplate(List<LabelTemplateElement>) - Method in class com.onlinepayments.domain.AccountOnFileDisplayHints: Array of attribute keys and their mask
setLanguage(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: The language code of the customer.
setLanguage(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: The language code of the customer.
setLegFare(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Fee for this leg of the trip This field is used by the following payment products: 840
setLength(LengthValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setLiability(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Determines the Fraud liability.
setLink(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Deprecated: This field is not used by any payment product Link that should be used to replace the '{link}' variable in the label.
setLoanRecipient(LoanRecipient) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object containing specific data regarding the recipient of a loan in the UK
setLocale(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Locale used in the GUI towards the consumer.
setLocale(String) - Method in class com.onlinepayments.domain.Customer: The locale that the customer should be addressed in (for 3rd parties).
setLocale(String) - Method in class com.onlinepayments.domain.CustomerDevice: Locale of the client device/browser.
setLocale(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Locale used in the GUI towards the consumer.
setLocale(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Deprecated: This field has no effect.
setLocale(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Deprecated: This field has no effect.
setLocale(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Locale used in the GUI towards the consumer.
setLocale(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Locale used in the GUI towards the consumer.
setLocale(String) - Method in class com.onlinepayments.merchant.services.GetPrivacyPolicyParams: Locale in which the privacy policy will be returned.
setLodgingData(LodgingData) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object that holds lodging specific data
setLogo(String) - Method in class com.onlinepayments.domain.AccountOnFileDisplayHints: Partial URL that you can reference for the image of this payment product.
setLogo(String) - Method in class com.onlinepayments.domain.PaymentProductDisplayHints: Partial URL that you can reference for the image of this payment product.
setLuhn(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setMandate(MandateResponse) - Method in class com.onlinepayments.domain.CreateMandateResponse: Object containing the created mandate.
setMandate(MandateResponse) - Method in class com.onlinepayments.domain.GetMandateResponse: Object containing the created mandate.
setMandate(CreateMandateWithReturnUrl) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput: Object containing information to create a SEPA Direct Debit mandate.
setMandate(CreateMandateRequest) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase: Object containing information to create a SEPA Direct Debit mandate.
setMandateAddress(MandateAddress) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing billing address details.
setMandateReference(String) - Method in class com.onlinepayments.domain.PaymentProduct771SpecificOutput: Unique reference to a Mandate
setMarkUpRate(Float) - Method in class com.onlinepayments.domain.RateDetails: The markup is the percentage added to the exchange rate by a provider when they sell you currency.
setMask(String) - Method in class com.onlinepayments.domain.LabelTemplateElement: Regular mask for the attributeKey Note: The mask is optional as not every field has a mask
setMask(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: A mask that can be used in the input field.
setMaxConnections(int) - Method in class com.onlinepayments.CommunicatorConfiguration
setMaxLength(Integer) - Method in class com.onlinepayments.domain.LengthValidator
setMaxValue(Integer) - Method in class com.onlinepayments.domain.RangeValidator
setMerchantAction(MerchantAction) - Method in class com.onlinepayments.domain.CompletePaymentResponse: Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment
setMerchantAction(MandateMerchantAction) - Method in class com.onlinepayments.domain.CreateMandateResponse: Object that contains the action, including the needed data, that you should perform next, showing the redirect to a third party to complete the payment or like showing instructions.
setMerchantAction(MerchantAction) - Method in class com.onlinepayments.domain.CreatePaymentResponse: Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment
setMerchantCustomerId(String) - Method in class com.onlinepayments.domain.AirlineData: Your ID of the customer in the context of the airline data This field is used by the following payment products: 840
setMerchantCustomerId(String) - Method in class com.onlinepayments.domain.Customer: Your identifier for the customer.
setMerchantFinanceCode(String) - Method in class com.onlinepayments.domain.PaymentProduct3208SpecificInput: This field indicates the finance code provided by the merchant after the buyer has selected the proper financing option.
setMerchantFinanceCode(String) - Method in class com.onlinepayments.domain.PaymentProduct3209SpecificInput: This field indicates the finance code provided by the merchant after the buyer has selected the proper financing option.
setMerchantFraudRate(Integer) - Method in class com.onlinepayments.domain.ThreeDSecure: Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
setMerchantFraudRate(Integer) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
setMerchantId(String) - Method in class com.onlinepayments.domain.WebhooksEvent
setMerchantParameters(String) - Method in class com.onlinepayments.domain.CaptureOutput: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
setMerchantParameters(String) - Method in class com.onlinepayments.domain.OrderReferences: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
setMerchantParameters(String) - Method in class com.onlinepayments.domain.PaymentOutput: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
setMerchantParameters(String) - Method in class com.onlinepayments.domain.PaymentReferences: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
setMerchantParameters(String) - Method in class com.onlinepayments.domain.RefundOutput: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
setMerchantReference(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: Your unique reference of the transaction that is also returned in our report files.
setMerchantReference(String) - Method in class com.onlinepayments.domain.OrderReferences: Your unique reference of the transaction that is also returned in our report files.
setMerchantReference(String) - Method in class com.onlinepayments.domain.PaymentLinkOrder: Your unique reference of the transaction that is also returned in our report files.
setMerchantReference(String) - Method in class com.onlinepayments.domain.PaymentReferences: Your unique reference of the transaction that is also returned in our report files.
setMerchantScore(String) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Score calculated by the 3DS Requestor and provided to CB Scoring service only.
setMessage(String) - Method in class com.onlinepayments.domain.APIError: Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
setMethod(String) - Method in class com.onlinepayments.domain.CustomerAccountAuthentication: Authentication used by the customer on your website Possible values are * guest = no login occurred, customer is logged in as guest * merchant-credentials = the customer logged in using credentials that are specific to you * federated-id = the customer logged in using a federated ID * issuer-credentials = the customer logged in using credentials from the card issuer (of the card used in this transaction) * third-party-authentication = the customer logged in using third-party authentication * fido-authentication = the customer logged in using a FIDO authenticator
setMethod(ShippingMethod) - Method in class com.onlinepayments.domain.Shipping: Object containing information regarding shipping method
setMethod(String) - Method in class com.onlinepayments.domain.ThreeDSecureData: Method of authentication used for this transaction.
setMinLength(Integer) - Method in class com.onlinepayments.domain.LengthValidator
setMinValue(Integer) - Method in class com.onlinepayments.domain.RangeValidator
setMobilePaymentMethodSpecificInput(MobilePaymentMethodHostedCheckoutSpecificInput) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for mobile payments
setMobilePaymentMethodSpecificInput(MobilePaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for mobile payments
setMobilePaymentMethodSpecificOutput(MobilePaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the mobile payment method details
setMobilePaymentMethodSpecificOutput(MobilePaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the mobile payment method details
setMobilePhoneNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: International version of the mobile phone number of the customer including the leading + (i.e.
setMobileRefundMethodSpecificOutput(RefundMobileMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
setMode(String) - Method in class com.onlinepayments.domain.SurchargeSpecificInput: The surcharge mode which defines how a merchant will apply surcharging.
setMode(String) - Method in class com.onlinepayments.domain.SurchargeSpecificOutput: The surcharge mode which defines how a merchant will apply surcharging.
setMustWriteReason(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Deprecated: This field is not used by any payment product The reason why the status is MUST_WRITE.
setName(String) - Method in class com.onlinepayments.domain.AcquirerInformation: Name of the acquirer used to process the transaction
setName(PersonalName) - Method in class com.onlinepayments.domain.AddressPersonal: Object containing the name details of the customer
setName(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Name of the airline
setName(String) - Method in class com.onlinepayments.domain.CompanyInformation: Name of company, as a customer
setName(MandatePersonalName) - Method in class com.onlinepayments.domain.MandatePersonalInformation: Object containing the name details of the customer.
setName(PersonalName) - Method in class com.onlinepayments.domain.PersonalInformation: Object containing the name details of the customer
setName(PersonalNameToken) - Method in class com.onlinepayments.domain.PersonalInformationToken
setName(String) - Method in class com.onlinepayments.domain.ShippingMethod: Name of the shipping method
setNetAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Surcharge: Object containing amount and ISO currency code attributes
setNetwork(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: The card network that was used for a mobile payment method operation
setNetwork(String) - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput: The card network that was used for a mobile payment method operation
setNetworks(List<String>) - Method in class com.onlinepayments.domain.PaymentProduct302SpecificData: The networks that can be used in the current payment context.
setNetworks(List<String>) - Method in class com.onlinepayments.domain.PaymentProduct320SpecificData: The networks that can be used in the current payment context.
setNetworks(List<String>) - Method in class com.onlinepayments.domain.PaymentProductNetworksResponse: Array containing network entries for a payment product.
setNumber(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Deprecated: This field is not used by any payment product Sequence number of the flight leg
setNumberOfCardOnFileCreationAttemptsLast24Hours(Integer) - Method in class com.onlinepayments.domain.PaymentAccountOnFile: Number of attempts made to add new card to the customer account in the last 24 hours
setNumberOfGiftCards(Integer) - Method in class com.onlinepayments.domain.GiftCardPurchase: Number of gift cards that are purchased through this transaction
setNumberOfItems(Integer) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Number of purchased items or services.
setNumberOfPaymentAttemptsLast24Hours(Integer) - Method in class com.onlinepayments.domain.CustomerPaymentActivity: Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
setNumberOfPaymentAttemptsLastYear(Integer) - Method in class com.onlinepayments.domain.CustomerPaymentActivity: Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
setNumberOfPurchasesLast6Months(Integer) - Method in class com.onlinepayments.domain.CustomerPaymentActivity: Number of successful purchases made by this customer with you in the last 6 months
setObfuscate(Boolean) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: * true - The data in this field should be obfuscated as it is entered, just like a password field * false - The data in this field does not need to be obfuscated
setOperations(List<OperationOutput>) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Object that contains the complete list of operations executed on the payment.
setOrder(Order) - Method in class com.onlinepayments.domain.CompletePaymentRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
setOrder(Order) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
setOrder(Order) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
setOrder(Order) - Method in class com.onlinepayments.domain.SubsequentPaymentRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
setOrderLineDetails(OrderLineDetails) - Method in class com.onlinepayments.domain.LineItem: Object containing additional information that when supplied can have a beneficial effect on the discountrates
setOriginAirport(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Origin airport/city code This field is used by the following payment products: cards, 840
setPairingToken(String) - Method in class com.onlinepayments.domain.PaymentProduct5407: A numeric token, which the user has to copy or type into the TWINT app in order to pair it with the merchant for the payment process.
setPartialPan(String) - Method in class com.onlinepayments.domain.LoanRecipient: Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.
setPartialRedirectUrl(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: The partial URL as generated by our system.
setPartialRedirectUrl(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: Deprecated.
setPassengerClass(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: PassengerClass if this leg This field is used by the following payment products: 840
setPassengerName(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: Use passengers instead Name of passenger
setPassengers(List<AirlinePassenger>) - Method in class com.onlinepayments.domain.AirlineData: Object that holds the data on the individual passengers This field is used by the following payment products: cards, 840
setPassengerType(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Type of passenger on the itinerary.
setPassword(String) - Method in class com.onlinepayments.ProxyConfiguration
setPasswordChangeDate(String) - Method in class com.onlinepayments.domain.CustomerAccount: The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
setPasswordChangedDuringCheckout(Boolean) - Method in class com.onlinepayments.domain.CustomerAccount: Indicates if the password of an account is changed during this checkout true = the customer made changes to their password of the account used during this checkout false = the customer didn't change anything to their password of the account used during this checkout
setPayerId(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
setPayerId(String) - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount: The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
setPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CancelPaymentResponse: Object that holds the payment related properties
setPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CompletePaymentResponse: Object that holds the payment related properties
setPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CreatedPaymentOutput: Object that holds the payment related properties
setPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CreatePaymentResponse: Object that holds the payment related properties
setPayment(PaymentResponse) - Method in class com.onlinepayments.domain.SubsequentPaymentResponse: Object that holds the payment related properties
setPayment(PaymentResponse) - Method in class com.onlinepayments.domain.WebhooksEvent
setPaymentAccountOnFile(PaymentAccountOnFile) - Method in class com.onlinepayments.domain.CustomerAccount: Object containing information on the payment account data on file (tokens)
setPaymentActivity(CustomerPaymentActivity) - Method in class com.onlinepayments.domain.CustomerAccount: Object containing data on the purchase history of the customer with you
setPaymentContext(PaymentContext) - Method in class com.onlinepayments.domain.GetIINDetailsRequest
setPaymentData(MobilePaymentData) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Object containing payment details
setPaymentEndDate(String) - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput: The end date of the payment validity
setPaymentId(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The unique payment transaction identifier.
setPaymentLinkEvents(List<PaymentLinkEvent>) - Method in class com.onlinepayments.domain.PaymentLinkResponse
setPaymentLinkId(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The unique link identifier.
setPaymentLinkOrder(PaymentLinkOrder) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: An object containing the details of the related payment.
setPaymentLinkOrder(PaymentLinkOrder) - Method in class com.onlinepayments.domain.PaymentLinkResponse: An object containing the details of the related payment.
setPaymentMethod(String) - Method in class com.onlinepayments.domain.CaptureOutput: Payment method identifier used by the our payment engine.
setPaymentMethod(String) - Method in class com.onlinepayments.domain.OperationOutput: Payment method identifier used by the our payment engine.
setPaymentMethod(String) - Method in class com.onlinepayments.domain.PaymentOutput: Payment method identifier used by the our payment engine.
setPaymentMethod(String) - Method in class com.onlinepayments.domain.PaymentProduct: Payment method identifier used by the our payment engine.
setPaymentMethod(String) - Method in class com.onlinepayments.domain.RefundOutput: Payment method identifier used by the our payment engine.
setPaymentOption(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: The specific payment option for the payment.
setPaymentOption(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: The specific payment option for the payment.
setPaymentOption(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: The specific payment option for the payment.
setPaymentOutput(PaymentOutput) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Object containing payment details
setPaymentOutput(PaymentOutput) - Method in class com.onlinepayments.domain.PaymentResponse: Object containing payment details
setPaymentProduct130SpecificInput(PaymentProduct130SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific input required for CB payments
setPaymentProduct130SpecificInput(PaymentProduct130SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for CB payments
setPaymentProduct302SpecificData(PaymentProduct302SpecificData) - Method in class com.onlinepayments.domain.PaymentProduct
setPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific input required for OneyDuplo Leroy Merlin payments.
setPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for OneyDuplo Leroy Merlin payments.
setPaymentProduct3208SpecificOutput(PaymentProduct3208SpecificOutput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: OneyDuplo Leroy Merlin specific details
setPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific input required for OneyDuplo Alcampo payments.
setPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for OneyDuplo Alcampo payments.
setPaymentProduct3209SpecificOutput(PaymentProduct3209SpecificOutput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: OneyDuplo Alcampo specific details
setPaymentProduct320SpecificData(PaymentProduct320SpecificData) - Method in class com.onlinepayments.domain.PaymentProduct
setPaymentProduct320SpecificInput(MobilePaymentProduct320SpecificInput) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Object containing information specific to Google Pay.
setPaymentProduct3306SpecificInput(RedirectPaymentProduct3306SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input required for Klarna payments (Payment product ID 3306)
setPaymentProduct5001SpecificOutput(PaymentProduct5001SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Bizum (payment product 5001) specific details
setPaymentProduct5100SpecificInput(PaymentProduct5100SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for Cpay payments.
setPaymentProduct5402SpecificOutput(PaymentProduct5402SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Meal vouchers (payment product 5402) specific details
setPaymentProduct5404(PaymentProduct5404) - Method in class com.onlinepayments.domain.ShowFormData: Contains the third party data for payment product 5404 (WeChat Pay)
setPaymentProduct5407(PaymentProduct5407) - Method in class com.onlinepayments.domain.ShowFormData: Contains the third party data for payment product 5407 (Twint)
setPaymentProduct5500SpecificOutput(PaymentProduct5500SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Multibanco (payment product 5500) specific details
setPaymentProduct771SpecificInput(SepaDirectDebitPaymentProduct771SpecificInput) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput: Object containing information specific to SEPA Direct Debit
setPaymentProduct771SpecificInput(SepaDirectDebitPaymentProduct771SpecificInputBase) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase: Object containing information specific to SEPA Direct Debit
setPaymentProduct771SpecificOutput(PaymentProduct771SpecificOutput) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput: Output that is SEPA Direct Debit specific (i.e.
setPaymentProduct809SpecificInput(RedirectPaymentProduct809SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input required for iDeal payments (Payment product ID 809)
setPaymentProduct840SpecificInput(RedirectPaymentProduct840SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input required for PayPal payments (Payment product ID 840)
setPaymentProduct840SpecificOutput(PaymentProduct840SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: PayPal (payment product 840) specific details
setPaymentProduct840SpecificOutput(RefundPaymentProduct840SpecificOutput) - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
setPaymentProductFilters(PaymentProductFiltersHostedTokenization) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Contains the payment product ids that will be used for manipulating the payment products available for the payment to the customer.
setPaymentProductFilters(PaymentProductFiltersHostedCheckout) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
setPaymentProductGroup(String) - Method in class com.onlinepayments.domain.PaymentProduct: The payment product group that has this payment product, if there is any.
setPaymentProductGroups(List<PaymentProductGroup>) - Method in class com.onlinepayments.domain.GetPaymentProductGroupsResponse: Array containing payment product groups and their characteristics
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.AccountOnFile: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardInfo: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CreateTokenRequest: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: The payment product identifier associated with the card.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.IINDetail: The payment product identifier associated with the card.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.Surcharge: The payment product identifier.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SurchargeCalculationCard: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.domain.TokenResponse: Payment product identifier - Please see Products documentation for a full overview of possible values.
setPaymentProductId(Integer) - Method in class com.onlinepayments.merchant.services.GetPrivacyPolicyParams: ID of the specific payment product for which you wish to retrieve the privacy policy.
setPaymentProducts(List<PaymentProduct>) - Method in class com.onlinepayments.domain.GetPaymentProductsResponse: Array containing payment products and their characteristics
setPaymentReference(String) - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput: The reference to be used within the Multibanco network to confirm the payment
setPaymentResult(CreatePaymentResponse) - Method in class com.onlinepayments.domain.PaymentErrorResponse: Object that contains details on the created payment in case one has been created.
setPaymentStartDate(String) - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput: The start date of the payment validity
setPaymentStatusCategory(String) - Method in class com.onlinepayments.domain.CreatedPaymentOutput
setPayout(PayoutResponse) - Method in class com.onlinepayments.domain.WebhooksEvent
setPayoutOutput(PayoutOutput) - Method in class com.onlinepayments.domain.PayoutResponse
setPayoutOutput(PayoutOutput) - Method in class com.onlinepayments.domain.PayoutResult
setPayoutReason(String) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: Allows you to additionally specify the reason for initiating the payout for authorization purposes.
setPayoutReason(String) - Method in class com.onlinepayments.domain.PayoutOutput: Allows you to additionally specify the reason for initiating the payout for authorization purposes.
setPayoutResult(PayoutResult) - Method in class com.onlinepayments.domain.PayoutErrorResponse
setPersonalInformation(PersonalInformation) - Method in class com.onlinepayments.domain.Customer: Object containing personal information like name, date of birth and gender.
setPersonalInformation(PersonalInformationToken) - Method in class com.onlinepayments.domain.CustomerToken
setPersonalInformation(MandatePersonalInformation) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing personal information of the customer.
setPhoneNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: Phone number of the customer
setPlaceholderLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: A placeholder value for the form element
setPlaceOfIssue(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
setPnr(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Passenger name record
setPointOfSale(String) - Method in class com.onlinepayments.domain.AirlineData: IATA point of sale name This field is used by the following payment products: 840
setPort(int) - Method in class com.onlinepayments.ProxyConfiguration
setPosCityCode(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product City code of the point of sale
setPreferredInputType(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: The type of keyboard that can best be used to fill out the value of this field.
setPreOrderItemAvailabilityDate(String) - Method in class com.onlinepayments.domain.ShoppingCart: Date (YYYYMMDD) when the preordered item becomes available
setPriorThreeDSecureData(ThreeDSecureData) - Method in class com.onlinepayments.domain.ThreeDSecure: Object containing data regarding the customer authentication that occurred prior to the current transaction
setPriorThreeDSecureData(ThreeDSecureData) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Object containing data regarding the customer authentication that occurred prior to the current transaction
setProductCategories(List<String>) - Method in class com.onlinepayments.domain.FraudFields: List of product categories that are being purchased.
setProductCode(String) - Method in class com.onlinepayments.domain.OrderLineDetails: Product or UPC Code
setProductName(String) - Method in class com.onlinepayments.domain.OrderLineDetails: The name of the product.
setProductPrice(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: The price of one unit of the product, the value should be zero or greater
setProducts(List<Integer>) - Method in class com.onlinepayments.domain.PaymentProductFilter: List containing all payment product ids that should either be restricted to in or excluded from the payment context.
setProducts(List<Integer>) - Method in class com.onlinepayments.domain.PaymentProductFilterHostedTokenization: List containing all payment product ids that should either be restricted to in or excluded from the payment context.
setProductType(String) - Method in class com.onlinepayments.domain.OrderLineDetails: Code used to classify items that are purchased
setPropertyName(String) - Method in class com.onlinepayments.domain.APIError: Returned only if the error relates to a value that was missing or incorrect.
setProposal(DccProposal) - Method in class com.onlinepayments.domain.CurrencyConversion: Details of currency conversion to be proposed to the cardholder
setProposal(DccProposal) - Method in class com.onlinepayments.domain.CurrencyConversionResponse: Details of currency conversion to be proposed to the cardholder
setProtectionEligibility(ProtectionEligibility) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Kind of seller protection in force for the PayPal transaction
setProxyConfiguration(ProxyConfiguration) - Method in class com.onlinepayments.CommunicatorConfiguration
setPublicKeyHash(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Public Key Hash A unique identifier to retrieve key used by Apple to encrypt information.
setPurchaseType(String) - Method in class com.onlinepayments.domain.OrderTypeInformation: Possible values are: * physical (tangible goods shipped to the customers) * digital (digital services like ebooks, streaming...)
setQrCode(String) - Method in class com.onlinepayments.domain.PaymentProduct5407: Contains a base64 encoded PNG image.
setQrCodeUrl(String) - Method in class com.onlinepayments.domain.PaymentProduct5404: Contains a QR code url that can be used to build a QR code (intended to be scanned by a device with the WeChat Pay app)
setQuantity(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
setQuotationDateTime(String) - Method in class com.onlinepayments.domain.RateDetails: Date and time at which the exchange rate has been quoted
setRange(RangeValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setRate(RateDetails) - Method in class com.onlinepayments.domain.DccProposal
setRecipientName(String) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: The payment link recipient name.
setRecipientName(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The payment link recipient name.
setRecurrenceType(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: Specifies whether the mandate is for one-off or recurring payments.
setRecurrenceType(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Specifies whether the mandate is for one-off or recurring payments.
setRecurrenceType(String) - Method in class com.onlinepayments.domain.MandateResponse: Specifies whether the mandate is for one-off or recurring payments.
setRecurring(CardRecurrenceDetails) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing data related to recurring
setRecurring(CardRecurrenceDetails) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing data related to recurring
setRecurringPaymentSequenceIndicator(String) - Method in class com.onlinepayments.domain.CardRecurrenceDetails: * first = This transaction is the first of a series of recurring transactions * recurring = This transaction is a subsequent transaction in a series of recurring transactions Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions.
setRedirectData(MandateRedirectData) - Method in class com.onlinepayments.domain.MandateMerchantAction: Object containing all data needed to redirect the customer
setRedirectData(RedirectData) - Method in class com.onlinepayments.domain.MerchantAction: Object containing all data needed to redirect the customer
setRedirectionData(RedirectionData) - Method in class com.onlinepayments.domain.GPayThreeDSecure: Object containing browser specific redirection related data
setRedirectionData(RedirectionData) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing browser specific redirection related data
setRedirectionData(RedirectionData) - Method in class com.onlinepayments.domain.ThreeDSecure: Object containing browser specific redirection related data
setRedirectionUrl(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The URL that will redirect the customer to the Hosted Checkout page to process the payment.
setRedirectPaymentMethodSpecificInput(RedirectPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
setRedirectPaymentMethodSpecificInput(RedirectPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
setRedirectPaymentMethodSpecificOutput(RedirectPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the redirect payment product details
setRedirectPaymentMethodSpecificOutput(RedirectPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the redirect payment product details
setRedirectRefundMethodSpecificOutput(RefundRedirectMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
setRedirectUrl(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: The full hosted checkout URL as generated by our system.
setRedirectURL(String) - Method in class com.onlinepayments.domain.MandateRedirectData: The URL that the customer should be redirected to.
setRedirectURL(String) - Method in class com.onlinepayments.domain.RedirectData: The URL that the customer should be redirected to.
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.CaptureOutput: Object that holds all reference properties that are linked to this transaction
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.CapturePaymentRequest: Object that holds all reference properties that are linked to this transaction
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object that holds all reference properties that are linked to this transaction
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.OperationOutput: Object that holds all reference properties that are linked to this transaction
setReferences(OrderReferences) - Method in class com.onlinepayments.domain.Order: Object that holds all reference properties that are linked to this transaction
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.PaymentOutput: Object that holds all reference properties that are linked to this transaction
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.RefundOutput: Object that holds all reference properties that are linked to this transaction
setReferences(PaymentReferences) - Method in class com.onlinepayments.domain.RefundRequest: Object that holds all reference properties that are linked to this transaction
setRefund(RefundResponse) - Method in class com.onlinepayments.domain.WebhooksEvent
setRefundOutput(RefundOutput) - Method in class com.onlinepayments.domain.RefundResponse: Object containing refund details
setRefundResult(RefundResponse) - Method in class com.onlinepayments.domain.RefundErrorResponse: This object has the numeric representation of the current refund status, timestamp of last status change and performable action on the current refund resource.
setRefunds(List<RefundResponse>) - Method in class com.onlinepayments.domain.RefundsResponse: The list of all refunds performed on the requested payment.
setRegularExpression(RegularExpressionValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setRegularExpression(String) - Method in class com.onlinepayments.domain.RegularExpressionValidator
setReOrderIndicator(Boolean) - Method in class com.onlinepayments.domain.ShoppingCart: Indicates whether the cardholder is reordering previously purchased item(s) true = the customer is re-ordering at least one of the items again false = this is the first time the customer is ordering these items
setRequiresApproval(Boolean) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically
setRequiresApproval(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically
setRestrictTo(PaymentProductFilter) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedCheckout: Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment.
setRestrictTo(PaymentProductFilterHostedTokenization) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedTokenization: Contains the payment product ids that should be excluded from the payment products available for the payment.
setResult(CurrencyConversionResult) - Method in class com.onlinepayments.domain.CurrencyConversionResponse: Result of a requested currency conversion
setResult(String) - Method in class com.onlinepayments.domain.CurrencyConversionResult: Functional response to the request: * Allowed: Dynamic currency conversion may be offered to the cardholder * InvalidCard: The card is not valid for dynamic currency conversion * InvalidMerchant: The card acceptor has not been recognised * NoRate: Exchange rates are not available * NotAvailable: Dynamic currency conversion is not available for other reason
setResult(String) - Method in class com.onlinepayments.domain.Surcharge: Token describing result.
setResult(String) - Method in class com.onlinepayments.domain.TestConnection
setResultReason(String) - Method in class com.onlinepayments.domain.CurrencyConversionResult: Plain text explaining the result of the currency conversion request
setRetriable(Boolean) - Method in class com.onlinepayments.domain.APIError: Flag indicating if the request is retriable.
setRETURNMAC(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: When the customer is returned to your site we will append this property and value to the query-string.
setRETURNMAC(String) - Method in class com.onlinepayments.domain.MandateRedirectData: A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment.
setRETURNMAC(String) - Method in class com.onlinepayments.domain.RedirectData: A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
setReturnUrl(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: The URL that the customer is redirect to after the payment flow has finished.
setReturnUrl(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: Return URL to use if the mandate signing requires redirection.
setReturnUrl(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Return URL to use if the mandate signing requires redirection.
setReturnUrl(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: The URL that the customer is redirect to after the payment flow has finished.
setReturnUrl(String) - Method in class com.onlinepayments.domain.RedirectionData: The URL that the customer is redirected to after the payment flow has finished.
setScheme(String) - Method in class com.onlinepayments.ProxyConfiguration
setSchemeEci(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme.
setSchemeReferenceData(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication.
setSchemeReferenceData(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication.
setSchemeReferenceData(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication.
setSchemeRiskScore(Integer) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Global score calculated by the Carte Bancaire (130) Scoring platform.
setScreenHeight(String) - Method in class com.onlinepayments.domain.BrowserData: Height of the screen in pixels.
setScreenWidth(String) - Method in class com.onlinepayments.domain.BrowserData: Width of the screen in pixels.
setSecretApiKey(String) - Method in class com.onlinepayments.CommunicatorConfiguration
setSecureCorporatePayment(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecure: Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
setSecureCorporatePayment(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
setSepaDirectDebitPaymentMethodSpecificInput(SepaDirectDebitPaymentMethodSpecificInputBase) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for SEPA direct debit payments
setSepaDirectDebitPaymentMethodSpecificInput(SepaDirectDebitPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for SEPA direct debit payments
setSepaDirectDebitPaymentMethodSpecificOutput(SepaDirectDebitPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the SEPA direct debit details
setSepaDirectDebitPaymentMethodSpecificOutput(SepaDirectDebitPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the SEPA direct debit details
setSessionTimeout(Integer) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: The number of minutes after which the session will expire.
setShipping(Shipping) - Method in class com.onlinepayments.domain.Order: Object containing information regarding shipping / delivery
setShippingCost(Long) - Method in class com.onlinepayments.domain.Shipping: Cost associated with the shipping of the order.
setShippingCostTax(Long) - Method in class com.onlinepayments.domain.Shipping: Tax amount of the shipping cost.
setShoppingCart(ShoppingCart) - Method in class com.onlinepayments.domain.Order: Shopping cart data, including items and specific amounts.
setShoppingCartExtension(ShoppingCartExtension) - Method in class com.onlinepayments.CommunicatorConfiguration
setShowFormData(ShowFormData) - Method in class com.onlinepayments.domain.MerchantAction: Object returned for the SHOW_FORM actionType.
setShowResultPage(Boolean) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: * true - Default - Hosted Checkout will show a result page to the customer when applicable.
setSignatureType(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: Specifies whether the mandate is unsigned or signed by SMS.
setSignatureType(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Specifies whether the mandate is unsigned or signed by SMS.
setSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Deprecated: Use threeDSecure.skipAuthentication instead.
setSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.GPayThreeDSecure: * true = 3D Secure authentication will be skipped for this transaction.
setSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecure: * true = 3D Secure authentication will be skipped for this transaction.
setSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecureBase: * true = 3D Secure authentication will be skipped for this transaction.
setSkipSoftDecline(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecure: * true = Soft Decline retry mechanism will be skipped for this transaction.
setSkipSoftDecline(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecureBase: * true = Soft Decline retry mechanism will be skipped for this transaction.
setSocketTimeout(int) - Method in class com.onlinepayments.CommunicatorConfiguration
setSource(String) - Method in class com.onlinepayments.domain.RateDetails: Indicates the exchange rate source name.
setSpecificRate(Integer) - Method in class com.onlinepayments.domain.SurchargeRate: A specific, fixed rate in cents defined on a merchant's configuration that is used in the calculation of a surcharge amount.
setSpeed(Integer) - Method in class com.onlinepayments.domain.ShippingMethod: Number of hours to delivery
setState(String) - Method in class com.onlinepayments.domain.Address: Full name of the state or province
setState(String) - Method in class com.onlinepayments.domain.AddressPersonal: Full name of the state or province
setStatus(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Possible values: * READ_ONLY - attribute cannot be updated and should be presented in that way to the user * CAN_WRITE - attribute can be updated and should be presented as an editable field, for example an expiration date that will expire very soon * MUST_WRITE - attribute should be updated and must be presented as an editable field, for example an expiration date that has already expired Any updated values that are entered for CAN_WRITE or MUST_WRITE will be used to update the values stored in the token.
setStatus(String) - Method in class com.onlinepayments.domain.Capture: Current high-level status of the payment in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.CaptureResponse: Current high-level status of the payment in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.GetHostedCheckoutResponse: This is the status of the hosted checkout.
setStatus(String) - Method in class com.onlinepayments.domain.MandateResponse
setStatus(String) - Method in class com.onlinepayments.domain.OperationOutput: Current high-level status of the payment in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Current high-level status of the payment in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The state of the payment link: * ACTIVE: The payment link is ready to be used.
setStatus(String) - Method in class com.onlinepayments.domain.PaymentResponse: Current high-level status of the payment in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.PayoutResponse: Current high-level status of the payout in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.PayoutResult: Current high-level status of the payout in a human-readable form.
setStatus(String) - Method in class com.onlinepayments.domain.RefundResponse: Current high-level status of the payment in a human-readable form.
setStatusCategory(String) - Method in class com.onlinepayments.domain.OrderStatusOutput: Highlevel status of the payment, payout or refund.
setStatusCategory(String) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Highlevel status of the payment, payout or refund.
setStatusCategory(String) - Method in class com.onlinepayments.domain.PayoutStatusOutput: Highlevel status of the payment, payout or refund.
setStatusCode(Integer) - Method in class com.onlinepayments.domain.CaptureStatusOutput: Numeric status code of the legacy API.
setStatusCode(Integer) - Method in class com.onlinepayments.domain.OrderStatusOutput: Numeric status code of the legacy API.
setStatusCode(Integer) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Numeric status code of the legacy API.
setStatusCode(Integer) - Method in class com.onlinepayments.domain.PayoutStatusOutput: Numeric status code of the legacy API.
setStatusCodeChangeDateTime(String) - Method in class com.onlinepayments.domain.OrderStatusOutput: Timestamp of the latest status change
setStatusCodeChangeDateTime(String) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Timestamp of the latest status change
setStatusOutput(CaptureStatusOutput) - Method in class com.onlinepayments.domain.Capture: This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current payment resource.
setStatusOutput(CaptureStatusOutput) - Method in class com.onlinepayments.domain.CaptureResponse: This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current payment resource.
setStatusOutput(PaymentStatusOutput) - Method in class com.onlinepayments.domain.OperationOutput: This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.
setStatusOutput(PaymentStatusOutput) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.
setStatusOutput(PaymentStatusOutput) - Method in class com.onlinepayments.domain.PaymentResponse: This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.
setStatusOutput(PayoutStatusOutput) - Method in class com.onlinepayments.domain.PayoutResponse
setStatusOutput(PayoutStatusOutput) - Method in class com.onlinepayments.domain.PayoutResult
setStatusOutput(OrderStatusOutput) - Method in class com.onlinepayments.domain.RefundResponse
setStopoverCode(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Possible values are: * permitted = Stopover permitted * non-permitted = Stopover not permitted This field is used by the following payment products: cards, 840
setStreet(String) - Method in class com.onlinepayments.domain.Address: Street name
setStreet(String) - Method in class com.onlinepayments.domain.AddressPersonal: Street name
setStreet(String) - Method in class com.onlinepayments.domain.MandateAddress: Streetname.
setSubsequentcardPaymentMethodSpecificInput(SubsequentCardPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.SubsequentPaymentRequest: Object containing the specific input details for subsequent card payments
setSubsequentType(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: Determines the type of the subsequent that will be used.
setSurchargeAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Surcharge: Object containing amount and ISO currency code attributes
setSurchargeAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.SurchargeSpecificInput: Object containing amount and ISO currency code attributes
setSurchargeAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.SurchargeSpecificOutput: Object containing amount and ISO currency code attributes
setSurchargeProductTypeId(String) - Method in class com.onlinepayments.domain.SurchargeRate: The name of the applicable surcharge rates for the relevant payment product
setSurchargeProductTypeVersion(String) - Method in class com.onlinepayments.domain.SurchargeRate: A specific version identifier of the surcharge rates as applied for this request
setSurchargeRate(SurchargeRate) - Method in class com.onlinepayments.domain.Surcharge: A summary of surcharge details used in the calculation of the surcharge amount.
setSurchargeRate(SurchargeRate) - Method in class com.onlinepayments.domain.SurchargeSpecificOutput: A summary of surcharge details used in the calculation of the surcharge amount.
setSurcharges(List<Surcharge>) - Method in class com.onlinepayments.domain.CalculateSurchargeResponse: List of surcharge calculations matching the bin and paymentProductId if supplied
setSurchargeSpecificInput(SurchargeSpecificInput) - Method in class com.onlinepayments.domain.Order: Object containing specific input required to apply surcharging to an order.
setSurchargeSpecificOutput(SurchargeSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing specific surcharging attributes applied to an order.
setSurchargeSpecificOutput(SurchargeSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing specific surcharging attributes applied to an order.
setSurname(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Surname of the passenger This field is used by the following payment products: cards, 840
setSurname(String) - Method in class com.onlinepayments.domain.LoanRecipient: Surname of the recipient of the loan.
setSurname(String) - Method in class com.onlinepayments.domain.MandatePersonalName: Surname(s) or last name(s) of the customer.
setSurname(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Surname of the PayPal account holder
setSurname(String) - Method in class com.onlinepayments.domain.PersonalName: Surname(s) or last name(s) of the customer
setSurname(String) - Method in class com.onlinepayments.domain.PersonalNameToken
setSurnamePrefix(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Surname prefix or middle name of the passenger This field is used by the following payment products: 840
setTargetAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.DccProposal: Object containing amount and ISO currency code attributes
setTaxAmount(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: Tax on the line item, with the last two digits implied as decimal places
setTaxes(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Taxes for this leg of the trip This field is used by the following payment products: 840
setTermsAndConditions(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
setThreeDSecure(ThreeDSecure) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific data regarding 3-D Secure
setThreeDSecure(ThreeDSecureBase) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific data regarding 3-D Secure
setThreeDSecure(GPayThreeDSecure) - Method in class com.onlinepayments.domain.MobilePaymentProduct320SpecificInput: Object containing specific data regarding 3-D Secure
setThreeDSecure(PaymentProduct130SpecificThreeDSecure) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificInput: Object containing specific data regarding 3-D Secure
setThreeDSecureResults(ThreeDSecureResults) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: 3D Secure results object
setThreeDSecureResults(ThreeDSecureResults) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: 3D Secure results object
setThreeDSecureVersion(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The 3-D Secure version used for the authentication.
setTicketCurrency(String) - Method in class com.onlinepayments.domain.AirlineData: Three-letter ISO currency code representing the currency in which ticket purchase amount is expressed.
setTicketDeliveryMethod(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Delivery method of the ticket
setTicketNumber(String) - Method in class com.onlinepayments.domain.AirlineData: The ticket or document number contains: * Airline code: 3-digit airline code number * Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains * Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten * TICKETNUMBER can be replaced with PNR if the ticket number is unavailable This field is used by the following payment products: cards, 840
setTimezoneOffsetUtcMinutes(String) - Method in class com.onlinepayments.domain.CustomerDevice: Offset in minutes of timezone of the client versus the UTC.
setTitle(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Deprecated: This field is not used by any payment product Title of the passenger (this property is used for fraud screening on the payment platform)
setTitle(String) - Method in class com.onlinepayments.domain.MandatePersonalInformation: Object containing the title of the customer (Mr, Miss or Mrs).
setTitle(String) - Method in class com.onlinepayments.domain.PersonalName: Title of customer
setToken(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: ID of the token to use to create the payment.
setToken(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: ID of the token to use to create the payment.
setToken(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: ID of the token.
setToken(String) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: ID of the token
setToken(String) - Method in class com.onlinepayments.domain.CardSource: An identifier that represents card details that have been previously stored
setToken(String) - Method in class com.onlinepayments.domain.CreatedTokenResponse: ID of the token
setToken(TokenResponse) - Method in class com.onlinepayments.domain.GetHostedTokenizationResponse
setToken(String) - Method in class com.onlinepayments.domain.PaymentCreationOutput: ID of the token.
setToken(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: ID of the token to use to create the payment.
setToken(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: ID of the token.
setToken(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: ID of the token to use to create the payment.
setToken(TokenResponse) - Method in class com.onlinepayments.domain.WebhooksEvent
setTokenizationSucceeded(Boolean) - Method in class com.onlinepayments.domain.PaymentCreationOutput: Indicates if tokenization was successful or not.
setTokenize(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Indicates if this transaction should be tokenized * true - Tokenize the transaction.
setTokenize(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Indicates if this transaction should be tokenized * true - Tokenize the transaction.
setTokenize(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Indicates if this transaction should be tokenized * true - Tokenize the transaction.
setTokens(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
setTokens(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
setTokens(List<String>) - Method in class com.onlinepayments.domain.SessionRequest: List of previously stored tokens linked to the customer that wants to checkout.
setTokenStatus(String) - Method in class com.onlinepayments.domain.CreatedTokenResponse: This is the status of the token in the hosted tokenization session.
setTokenStatus(String) - Method in class com.onlinepayments.domain.GetHostedTokenizationResponse: This is the status of the token in the hosted tokenization session.
setTooltip(PaymentProductFieldTooltip) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Object that contains an optional tooltip to assist the customer
setTotalAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Surcharge: Object containing amount and ISO currency code attributes
setTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
setTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
setTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
setTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundRedirectMethodSpecificOutput
setTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
setTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
setTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
setTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundRedirectMethodSpecificOutput
setTotalFare(Integer) - Method in class com.onlinepayments.domain.AirlineData: Total fare for all legs on the ticket, excluding taxes and fees.
setTotalFee(Integer) - Method in class com.onlinepayments.domain.AirlineData: Total fee for all legs on the ticket.
setTotalTaxes(Integer) - Method in class com.onlinepayments.domain.AirlineData: Total taxes for all legs on the ticket.
setTransaction(Transaction) - Method in class com.onlinepayments.domain.CurrencyConversionRequest
setTransactionChannel(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Indicates the channel via which the payment is created.
setTransactionChannel(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Indicates the channel via which the payment is created.
setTransactionChannel(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: Indicates the channel via which the payment is created.
setTransactionType(String) - Method in class com.onlinepayments.domain.OrderTypeInformation: Identifies the type of transaction being authenticated.
setTravelAgencyName(String) - Method in class com.onlinepayments.domain.AirlineData: Name of the travel agency issuing the ticket.
setType(String) - Method in class com.onlinepayments.domain.AmountBreakdown: Type of the amount.
setType(String) - Method in class com.onlinepayments.domain.PaymentLinkEvent: The type of event that occurred.
setType(String) - Method in class com.onlinepayments.domain.PaymentProductField
setType(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: The type of the display element.
setType(String) - Method in class com.onlinepayments.domain.PaymentProductFieldFormElement: Type of form element to be used.
setType(String) - Method in class com.onlinepayments.domain.ProtectionEligibility: - ItemNotReceivedEligible - Merchant is protected by PayPal's Seller Protection Policy for Item Not Received - UnauthorizedPaymentEligible - Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment - Ineligible - Merchant is not protected under the Seller Protection Policy
setType(String) - Method in class com.onlinepayments.domain.Shipping: Indicates the merchandise delivery timeframe.
setType(String) - Method in class com.onlinepayments.domain.ShippingMethod: Shipping method type
setType(String) - Method in class com.onlinepayments.domain.WebhooksEvent
setTypeInformation(OrderTypeInformation) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object that holds the purchase and usage type indicators
setUniqueMandateReference(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: The unique identifier of the mandate
setUniqueMandateReference(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: The unique identifier of the mandate
setUniqueMandateReference(String) - Method in class com.onlinepayments.domain.MandateResponse: The unique identifier of the mandate
setUnit(String) - Method in class com.onlinepayments.domain.OrderLineDetails: Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
setUnscheduledCardOnFileRequestor(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Indicates which party initiated the unscheduled recurring transaction.
setUnscheduledCardOnFileRequestor(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Indicates which party initiated the unscheduled recurring transaction.
setUnscheduledCardOnFileSequenceIndicator(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: * first = This transaction is the first of a series of unscheduled recurring transactions * subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.
setUnscheduledCardOnFileSequenceIndicator(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: * first = This transaction is the first of a series of unscheduled recurring transactions * subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.
setUsecase(String) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Indicates the type of payment for which an authentication is requested
setUserAgent(String) - Method in class com.onlinepayments.domain.CustomerDevice: User-Agent of the client device/browser from the HTTP Headers.
setUsername(String) - Method in class com.onlinepayments.ProxyConfiguration
setUsesRedirectionTo3rdParty(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct: Indicates whether the payment product requires redirection to a third party to complete the payment.
setUtcTimestamp(String) - Method in class com.onlinepayments.domain.CustomerAccountAuthentication: Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
setUtcTimestamp(String) - Method in class com.onlinepayments.domain.ThreeDSecureData: Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
setValidators(PaymentProductFieldValidators) - Method in class com.onlinepayments.domain.PaymentProductFieldDataRestrictions: Object containing the details of the validations on the field
setValue(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Value of the key or property
setValue(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: the value of the display element.
setValue(String) - Method in class com.onlinepayments.domain.ValueMappingElement: Value corresponding to the key
setValueMapping(List<ValueMappingElement>) - Method in class com.onlinepayments.domain.PaymentProductFieldFormElement: Deprecated: This field is not used by any payment product
setVariant(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal.
setVariant(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal.
setVariant(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificOutput: Using the Back-Office it is possible to upload multiple templates of your HostedCheckout payment pages, including customized templates from Merchant Portal.
setVersion(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure Protocol version used during this transaction.
setWorkPhoneNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: International version of the work phone number of the customer including the leading + (i.e.
setXid(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The transaction ID that is used for the 3D Authentication
setXid(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Transaction ID for the Authentication
setZip(String) - Method in class com.onlinepayments.domain.Address: Zip code
setZip(String) - Method in class com.onlinepayments.domain.AddressPersonal: Zip code
setZip(String) - Method in class com.onlinepayments.domain.LoanRecipient: Zip code of the recipient of the loan
setZip(String) - Method in class com.onlinepayments.domain.MandateAddress: Zip code.
Shipping - Class in com.onlinepayments.domain: Object containing information regarding shipping / delivery
Shipping() - Constructor for class com.onlinepayments.domain.Shipping
ShippingMethod - Class in com.onlinepayments.domain: Object containing information regarding shipping method
ShippingMethod() - Constructor for class com.onlinepayments.domain.ShippingMethod
ShoppingCart - Class in com.onlinepayments.domain: Shopping cart data, including items and specific amounts.
ShoppingCart() - Constructor for class com.onlinepayments.domain.ShoppingCart
ShoppingCartExtension - Class in com.onlinepayments.domain
ShoppingCartExtension(String, String, String) - Constructor for class com.onlinepayments.domain.ShoppingCartExtension
ShoppingCartExtension(String, String, String, String) - Constructor for class com.onlinepayments.domain.ShoppingCartExtension
ShowFormData - Class in com.onlinepayments.domain: Object returned for the SHOW_FORM actionType.
ShowFormData() - Constructor for class com.onlinepayments.domain.ShowFormData
SignatureValidationException - Exception in com.onlinepayments.webhooks: Represents an error while validating webhooks signatures.
SignatureValidationException(String) - Constructor for exception com.onlinepayments.webhooks.SignatureValidationException
SignatureValidationException(Throwable) - Constructor for exception com.onlinepayments.webhooks.SignatureValidationException
SignatureValidationException(String, Throwable) - Constructor for exception com.onlinepayments.webhooks.SignatureValidationException
storeSecretKey(String, String) - Method in class com.onlinepayments.webhooks.InMemorySecretKeyStore: Stores the given secret key for the given key id.
SubsequentCardPaymentMethodSpecificInput - Class in com.onlinepayments.domain: Object containing the specific input details for subsequent card payments
SubsequentCardPaymentMethodSpecificInput() - Constructor for class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
subsequentPayment(String, SubsequentPaymentRequest) - Method in class com.onlinepayments.merchant.payments.PaymentsClient: Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment
subsequentPayment(String, SubsequentPaymentRequest, CallContext) - Method in class com.onlinepayments.merchant.payments.PaymentsClient: Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment
subsequentPayment(String, SubsequentPaymentRequest) - Method in interface com.onlinepayments.merchant.payments.PaymentsClientInterface: Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment
subsequentPayment(String, SubsequentPaymentRequest, CallContext) - Method in interface com.onlinepayments.merchant.payments.PaymentsClientInterface: Resource /v2/{merchantId}/payments/{paymentId}/subsequent - Subsequent payment
SubsequentPaymentRequest - Class in com.onlinepayments.domain
SubsequentPaymentRequest() - Constructor for class com.onlinepayments.domain.SubsequentPaymentRequest
SubsequentPaymentResponse - Class in com.onlinepayments.domain: Object that contains details on the created payment in case one has been created.
SubsequentPaymentResponse() - Constructor for class com.onlinepayments.domain.SubsequentPaymentResponse
Surcharge - Class in com.onlinepayments.domain
Surcharge() - Constructor for class com.onlinepayments.domain.Surcharge
surchargeCalculation(CalculateSurchargeRequest) - Method in class com.onlinepayments.merchant.services.ServicesClient: Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
surchargeCalculation(CalculateSurchargeRequest, CallContext) - Method in class com.onlinepayments.merchant.services.ServicesClient: Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
surchargeCalculation(CalculateSurchargeRequest) - Method in interface com.onlinepayments.merchant.services.ServicesClientInterface: Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
surchargeCalculation(CalculateSurchargeRequest, CallContext) - Method in interface com.onlinepayments.merchant.services.ServicesClientInterface: Resource /v2/{merchantId}/services/surchargecalculation - Surcharge Calculation
SurchargeCalculationCard - Class in com.onlinepayments.domain: An object containing card number and payment product id, which is used to determine surcharge product type
SurchargeCalculationCard() - Constructor for class com.onlinepayments.domain.SurchargeCalculationCard
SurchargeRate - Class in com.onlinepayments.domain: A summary of surcharge details used in the calculation of the surcharge amount.
SurchargeRate() - Constructor for class com.onlinepayments.domain.SurchargeRate
SurchargeSpecificInput - Class in com.onlinepayments.domain: Object containing specific input required to apply surcharging to an order.
SurchargeSpecificInput() - Constructor for class com.onlinepayments.domain.SurchargeSpecificInput
SurchargeSpecificOutput - Class in com.onlinepayments.domain: Object containing specific surcharging attributes applied to an order.
SurchargeSpecificOutput() - Constructor for class com.onlinepayments.domain.SurchargeSpecificOutput
SysOutCommunicatorLogger - Class in com.onlinepayments.logging: A communicator logger that prints its message to System.out.

A B C D E F G H I J L M N O P R S T U V W