Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
G
- get(String, List<RequestHeader>, ParamRequest, BodyHandler, CallContext) - Method in interface com.onlinepayments.Communicator
-
Corresponds to the HTTP GET method.
- get(String, List<RequestHeader>, ParamRequest, BodyHandler, CallContext) - Method in class com.onlinepayments.DefaultCommunicator
-
Corresponds to the HTTP GET method.
- get(String, List<RequestHeader>, ParamRequest, Class<O>, CallContext) - Method in interface com.onlinepayments.Communicator
-
Corresponds to the HTTP GET method.
- get(String, List<RequestHeader>, ParamRequest, Class<O>, CallContext) - Method in class com.onlinepayments.DefaultCommunicator
-
Corresponds to the HTTP GET method.
- get(URI, List<RequestHeader>, ResponseHandler<R>) - Method in interface com.onlinepayments.communication.Connection
-
Send a GET request to the Online Payments platform.
- get(URI, List<RequestHeader>, ResponseHandler<R>) - Method in class com.onlinepayments.communication.DefaultConnection
- getAcceptedByUser() - Method in class com.onlinepayments.domain.CurrencyConversion
-
Dynamic Currency Conversion(DCC) Proposal accepted by user
- getAcceptedByUser() - Method in class com.onlinepayments.domain.CurrencyConversionInput
-
Dynamic Currency Conversion(DCC) Proposal accepted by user
- getAcceptHeader() - Method in class com.onlinepayments.domain.CustomerDevice
-
The accept-header of the customer client from the HTTP Headers.
- getAccount() - Method in class com.onlinepayments.domain.Customer
-
Object containing data related to the account the customer has with you
- getAccountHolderName() - Method in class com.onlinepayments.domain.CustomerBankAccount
-
Name of account holder
- getAccountId() - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount
-
Username with which the PayPal account holder has registered at PayPal
- getAccountNumber() - 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.
- getAccountNumber() - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput
-
The account number used for this transaction
- getAccountOnFile() - Method in class com.onlinepayments.domain.PaymentProductGroup
- getAccountsOnFile() - Method in class com.onlinepayments.domain.PaymentProduct
-
List of tokens for that payment product
- getAccountType() - Method in class com.onlinepayments.domain.Customer
-
Type of the customer account that is used to place this order.
- getAcquiredAmount() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing amount and ISO currency code attributes
- getAcquiredAmount() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing amount and ISO currency code attributes
- getAcquirerExemption() - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure
-
Indicates the Acquirer TRA exemption
- getAcquirerInformation() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
Information about the acquirer used to process the transaction
- getAcquirerSelectionInformation() - Method in class com.onlinepayments.domain.AcquirerInformation
-
Information about the acquirer selection
- getAcsReferenceNumber() - Method in class com.onlinepayments.domain.MobileThreeDSecureChallengeParameters
-
The unique identifier assigned by the EMVCo Secretariat upon testing and approval.
- getAcsSignedContent() - Method in class com.onlinepayments.domain.MobileThreeDSecureChallengeParameters
-
Contains the JWS object created by the ACS for the challenge (ARes).
- getAcsTransactionId() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
Identifier of the authenticated transaction at the ACS/Issuer.
- getAcsTransactionId() - Method in class com.onlinepayments.domain.MobileThreeDSecureChallengeParameters
-
The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer).
- getAcsTransactionId() - 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)
- getAcsTransactionId() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Authenticated Transaction Identifier at the ACS/Issuer.
- getActionType() - Method in class com.onlinepayments.domain.MandateMerchantAction
-
Action merchants needs to take in the online mandate process.
- getActionType() - Method in class com.onlinepayments.domain.MerchantAction
-
Action merchants needs to take in the online payment process.
- getAdditionalInfo() - Method in class com.onlinepayments.domain.Address
-
Second line of street or additional address information
- getAdditionalInfo() - Method in class com.onlinepayments.domain.AddressPersonal
-
Second line of street or additional address information
- getAdditionalInput() - Method in class com.onlinepayments.domain.Order
-
Object containing additional input on the order
- getAddress() - Method in class com.onlinepayments.domain.Shipping
-
Object containing address information
- getAddressIndicator() - Method in class com.onlinepayments.domain.Shipping
-
Indicates shipping method chosen for the transaction.
- getAddressSelectionAtPayPal() - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput
-
Indicates whether to use PayPal Express Checkout Shortcut.
- getAdValoremRate() - Method in class com.onlinepayments.domain.SurchargeRate
-
A percentage rate defined on a merchant's configuration used in the calculation of a surcharge amount.
- getAgentNumericCode() - Method in class com.onlinepayments.domain.AirlineData
-
Numeric code identifying the agent This field is used by the following payment products: 840
- getAirlineClass() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Reservation Booking Designator This field is used by the following payment products: cards
- getAirlineData() - Method in class com.onlinepayments.domain.AdditionalOrderInput
-
Object that holds airline specific data
- getAirlineLoyaltyStatus() - Method in class com.onlinepayments.domain.AirlinePassenger
-
Airline loyalty program level for the passenger on the itinerary.
- getAlias() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
An alias for the mandate.
- getAlias() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
An alias for the mandate.
- getAlias() - Method in class com.onlinepayments.domain.MandateResponse
-
An alias for the mandate.
- getAlias() - Method in class com.onlinepayments.domain.TokenCard
-
An alias for the token.
- getAlias() - Method in class com.onlinepayments.domain.TokenEWallet
-
Deprecated.This field is not used by any payment product An alias for the token. This can be used to visually represent the token.
- getAllowDynamicLinking() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File). false - Indicates that the dynamic linking (including Card On File data) will be ignored.
- getAllowDynamicLinking() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File). false - Indicates that the dynamic linking (including Card On File data) will be ignored.
- getAllowedNumberOfPaymentAttempts() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
The maximum number of times a customer can try to pay before the payment is definitely declined.
- getAllowedValues() - Method in class com.onlinepayments.domain.FixedListValidator
- getAllowsAuthentication() - Method in class com.onlinepayments.domain.PaymentProduct
-
True when 3DS authentication is supported or required for the product
- getAllowsRecurring() - 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
- getAllowsTokenization() - 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
- getAlwaysShow() - 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.
- getAmount() - Method in class com.onlinepayments.domain.AmountBreakdown
-
Amount in cents and always having 2 decimals
- getAmount() - 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
- getAmount() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
A required value that’s the monetary amount of the line item.
- getAmount() - 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).
- getAmount() - Method in class com.onlinepayments.domain.Discount
-
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
- getAmount() - Method in class com.onlinepayments.domain.PaymentLinkOrderInput
-
Object containing amount and ISO currency code attributes
- getAmount() - Method in class com.onlinepayments.domain.PaymentLinkOrderOutput
-
Object containing amount and ISO currency code attributes
- getAmount() - Method in class com.onlinepayments.domain.Transaction
-
Object containing amount and ISO currency code attributes
- getAmount() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams
-
Whole amount in cents (not containing any decimals)
- getAmount() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams
-
Whole amount in cents (not containing any decimals)
- getAmount() - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams
-
Amount in cents and always having 2 decimals
- getAmount() - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams
-
Whole amount in cents (not containing any decimals)
- getAmount() - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams
-
Whole amount in cents (not containing any decimals)
- getAmountBreakdown() - Method in class com.onlinepayments.domain.ShoppingCart
-
Deprecated.Use order.shipping.shippingCost for shipping cost. Other amounts are not used. Determines how the total amount is split into amount types
- getAmountOfMoney() - Method in class com.onlinepayments.domain.CalculateSurchargeRequest
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.CancelPaymentRequest
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.CreatePayoutRequest
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.GiftCardPurchase
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.LineItem
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.OperationOutput
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.Order
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.PaymentContext
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.PayoutOutput
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.RefundOutput
-
Object containing amount and ISO currency code attributes
- getAmountOfMoney() - Method in class com.onlinepayments.domain.RefundRequest
-
Object containing amount and ISO currency code attributes
- getAmountPaid() - Method in class com.onlinepayments.domain.CaptureOutput
-
Deprecated.Amount that has been paid. This is deprecated. Use acquiredAmount instead.
- getAmountPaid() - Method in class com.onlinepayments.domain.PaymentOutput
-
Deprecated.Amount that has been paid. This is deprecated. Use acquiredAmount instead.
- getAmountPaid() - Method in class com.onlinepayments.domain.RefundOutput
- getApiEndpoint() - Method in class com.onlinepayments.CommunicatorConfiguration
-
Returns the Online Payments platform API endpoint URI.
- getApiKeyId() - Method in class com.onlinepayments.CommunicatorConfiguration
-
Returns an id used for authorization.
- getApiVersion() - Method in class com.onlinepayments.domain.WebhooksEvent
- getApplePayRecurringPaymentRequest() - Method in class com.onlinepayments.domain.MobilePaymentProduct302SpecificInput
-
Object containing information specific to Apple Pay recurrung request.
- getAppliedExemption() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
- getAppliedExemption() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Exemption requested and applied in the authorization
- getAppSwitchLink() - 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)
- getArrivalAirport() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Arrival airport/city code This field is used by the following payment products: 840
- getArrivalTime() - 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
- getAskConsumerConsent() - 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.
- getAssetUrl() - Method in class com.onlinepayments.domain.SessionResponse
-
The datacenter-specific base url for assets.
- getAttributeKey() - Method in class com.onlinepayments.domain.LabelTemplateElement
-
Name of the attribute that is shown to the customer on selection pages or screens
- getAttributes() - Method in class com.onlinepayments.domain.AccountOnFile
- getAuthenticatedAmount() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
The amount to be authenticated.
- getAuthentication() - Method in class com.onlinepayments.domain.CustomerAccount
-
Object containing data on the authentication used by the customer to access their account
- getAuthenticationAmount() - Method in class com.onlinepayments.domain.ThreeDSecure
-
The amount to be authenticated.
- getAuthenticationAmount() - Method in class com.onlinepayments.domain.ThreeDSecureBase
-
The amount to be authenticated.
- getAuthenticationStatus() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
One-letter authentication status returned by DS.
- getAuthorisationCode() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
Card Authorization code as returned by the acquirer
- getAuthorisationCode() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput
-
Card Authorization code as returned by the acquirer
- getAuthorisationCode() - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput
-
The reference returned by redsys to identify the transaction
- getAuthorisationCode() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Card Authorization code as returned by the acquirer
- getAuthorization(String, URI, List<RequestHeader>) - Method in interface com.onlinepayments.authentication.Authenticator
-
Returns a value that can be used for the "Authorization" header.
- getAuthorization(String, URI, List<RequestHeader>) - Method in class com.onlinepayments.authentication.V1HmacAuthenticator
- getAuthorizationMode() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Determines the type of the authorization that will be used.
- getAuthorizationMode() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Determines the type of the authorization that will be used.
- getAuthorizationMode() - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput
-
Determines the type of the authorization that will be used.
- getAuthorizationMode() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
Determines the type of the authorization that will be used.
- getAuthorizationMode() - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
-
Determines the type of the authorization that will be used.
- getAuthorizationType() - Method in class com.onlinepayments.CommunicatorConfiguration
- getAvsResult() - Method in class com.onlinepayments.domain.CardFraudResults
-
Result of the Address Verification Service checks.
- getBankAccountIban() - Method in class com.onlinepayments.domain.MandateCustomer
-
Object containing IBAN information
- getBankAccountIban() - Method in class com.onlinepayments.domain.MandateCustomerResponse
-
Object containing IBAN information
- getBaseAmount() - Method in class com.onlinepayments.domain.DccProposal
-
Object containing amount and ISO currency code attributes
- getBic() - Method in class com.onlinepayments.domain.CustomerBankAccount
-
Bank Identification Code
- getBillingAddress() - Method in class com.onlinepayments.domain.Customer
-
Object containing billing address details.
- getBillingAddress() - Method in class com.onlinepayments.domain.CustomerToken
-
Object containing billing address details.
- getBillingAddress() - Method in class com.onlinepayments.domain.PaymentProduct3203SpecificOutput
-
Object containing address information
- getBillingAddress() - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput
-
Object containing billing address details.
- getBillingAgreement() - Method in class com.onlinepayments.domain.ApplePayRecurringPaymentRequest
-
A localized billing agreement that the payment sheet displays to the user before the user authorizes the payment.
- getBin() - 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.
- getBin() - 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.
- getBirthCity() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
The city of the address where the customer was born
- getBirthCountry() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
ISO 3166-1 alpha-2 country code of the address where the customer was born
- getBirthZipCode() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
The zip code of the address where the customer was born
- getBlackListData() - Method in class com.onlinepayments.domain.FraudFields
-
Additional black list input
- getBody() - Method in exception class com.onlinepayments.communication.ResponseException
- getBoundary() - Method in class com.onlinepayments.communication.MultipartFormDataObject
- getBrand() - Method in class com.onlinepayments.domain.PaymentProduct5100SpecificInput
-
Indicate whether to use a specific Cpay brand.
- getBrand() - Method in class com.onlinepayments.domain.PaymentProduct5402SpecificOutput
-
The specific meal voucher brand used for the transaction
- getBrowserData() - Method in class com.onlinepayments.domain.CustomerDevice
-
Object containing information regarding the browser of the customer
- getBuyerCompliantBankMessage() - 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.
- getBuyerCompliantBankMessage() - 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.
- getCaptureId() - Method in class com.onlinepayments.domain.RefundRequest
-
The identifier of the capture that is used for partial refund.
- getCaptureOutput() - Method in class com.onlinepayments.domain.Capture
-
Object containing capture details
- getCaptureOutput() - Method in class com.onlinepayments.domain.CaptureResponse
-
Object containing capture details
- getCaptures() - Method in class com.onlinepayments.domain.CapturesResponse
-
The list of all captures performed on the requested payment.
- getCaptures(String) - Method in class com.onlinepayments.merchant.captures.CapturesClient
-
Resource /v2/{merchantId}/payments/{paymentId}/captures - Get captures of payment
- getCaptures(String) - Method in interface com.onlinepayments.merchant.captures.CapturesClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId}/captures - Get captures of payment
- getCaptures(String, CallContext) - Method in class com.onlinepayments.merchant.captures.CapturesClient
-
Resource /v2/{merchantId}/payments/{paymentId}/captures - Get captures of payment
- getCaptures(String, CallContext) - Method in interface com.onlinepayments.merchant.captures.CapturesClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId}/captures - Get captures of payment
- getCard() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing card details
- getCard() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
Object containing card details
- getCard() - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput
-
Object containing card details
- getCard() - Method in class com.onlinepayments.domain.CardSource
-
An object containing card number and payment product id, which is used to determine surcharge product type
- getCard() - Method in class com.onlinepayments.domain.CompletePaymentCardPaymentMethodSpecificInput
- getCard() - Method in class com.onlinepayments.domain.CreatedTokenResponse
- getCard() - Method in class com.onlinepayments.domain.CreateTokenRequest
-
Object containing the token details for a card
- getCard() - Method in class com.onlinepayments.domain.DccCardSource
- getCard() - Method in class com.onlinepayments.domain.TokenData
-
Object containing card details
- getCard() - Method in class com.onlinepayments.domain.TokenResponse
-
Object containing card details
- getCardholderName() - Method in class com.onlinepayments.domain.Card
-
The card holder's name on the card.
- getCardholderName() - Method in class com.onlinepayments.domain.CardWithoutCvv
-
The card holder's name on the card.
- getCardholderName() - Method in class com.onlinepayments.domain.DecryptedPaymentData
-
Card holder's name on the card.
- getCardNumber() - 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
- getCardNumber() - Method in class com.onlinepayments.domain.CardEssentials
-
The masked credit/debit card number
- getCardNumber() - Method in class com.onlinepayments.domain.CardInfo
-
The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
- getCardNumber() - Method in class com.onlinepayments.domain.CardWithoutCvv
-
The obfuscated card number
- getCardNumber() - 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
- getCardOnFileRecurringExpiration() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
The end date of the last scheduled payment in a series of transactions.
- getCardOnFileRecurringFrequency() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Period of payment occurrence for recurring and installment payments.
- getCardPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CompletePaymentRequest
- getCardPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest
-
Object containing the specific input details for card payments
- getCardPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Object containing the specific input details for card payments
- getCardPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentRequest
-
Object containing the specific input details for card payments
- getCardPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
Object containing card payment specific data for hosted checkout
- getCardPaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing the card payment method details
- getCardPaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing the card payment method details
- getCardPayoutMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePayoutRequest
-
Object containing the payout details for a card
- getCardRefundMethodSpecificOutput() - Method in class com.onlinepayments.domain.RefundOutput
- getCardSource() - Method in class com.onlinepayments.domain.CalculateSurchargeRequest
-
Contains elements from which card number can be obtained.
- getCardSource() - Method in class com.onlinepayments.domain.CurrencyConversionRequest
- getCardType() - Method in class com.onlinepayments.domain.GetIINDetailsResponse
-
The card's type as categorised by the payment method.
- getCardType() - Method in class com.onlinepayments.domain.IINDetail
-
The card's type as categorised by the payment method.
- getCardWithoutCvv() - Method in class com.onlinepayments.domain.TokenCardData
- getCarrierCode() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
IATA carrier code This field is used by the following payment products: cards, 840
- getCategory() - Method in class com.onlinepayments.domain.APIError
-
Category the error belongs to.
- getCavv() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
- getCavv() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Cardholder Authentication Verification Value.
- getCavvAlgorithm() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
- getChallengeCanvasSize() - Method in class com.onlinepayments.domain.GPayThreeDSecure
-
Dimensions of the challenge window that potentially will be displayed to the customer.
- getChallengeCanvasSize() - Method in class com.onlinepayments.domain.ThreeDSecure
-
Dimensions of the challenge window that potentially will be displayed to the customer.
- getChallengeCanvasSize() - Method in class com.onlinepayments.domain.ThreeDSecureBase
-
Dimensions of the challenge window that potentially will be displayed to the customer.
- getChallengeIndicator() - 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.
- getChallengeIndicator() - 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.
- getChallengeIndicator() - 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.
- getChallengeIndicator() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Challenge Indicator used for this transaction.
- getChangeDate() - Method in class com.onlinepayments.domain.CustomerAccount
-
The last date (YYYYMMDD) on which the customer made changes to their account with you.
- getChangedDuringCheckout() - Method in class com.onlinepayments.domain.CustomerAccount
-
true = the customer made changes to their account during this checkout false = the customer did nnot change anything to their account during this checkout/n
- getChannel() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
The channel used by the customer
- getCheckInDate() - Method in class com.onlinepayments.domain.LodgingData
-
The date the guest checks into (or plans to check in to) the facility.
- getCheckoutType() - Method in class com.onlinepayments.domain.RedirectPaymentProduct3203SpecificInput
-
Determines the type of the checkout that will be used for PostFinancePay.
- getCity() - Method in class com.onlinepayments.domain.Address
-
City
- getCity() - Method in class com.onlinepayments.domain.AddressPersonal
-
City
- getCity() - Method in class com.onlinepayments.domain.MandateAddress
-
City Required for Create mandate and Create payment calls.
- getCity() - Method in class com.onlinepayments.domain.MandateAddressResponse
-
City
- getClickToPay() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputForHostedCheckout
-
true - Hosted Checkout will show Click to Pay, with cards grouped as one payment method false - Default - Hosted Checkout will show cards as separate payment methods without Click to Pay
- getClientApiUrl() - Method in class com.onlinepayments.domain.SessionResponse
-
The datacenter-specific base url for client requests.
- getClientHeaders() - Method in class com.onlinepayments.ApiResource
- getClientSessionId() - Method in class com.onlinepayments.domain.SessionResponse
-
The identifier of the session that has been created.
- getCoBrands() - Method in class com.onlinepayments.domain.GetIINDetailsResponse
-
List of IIN details
- getCobrandSelectionIndicator() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
For cobranded cards, this field indicates the brand selection method: default - The holder implicitly accepted the default brand. alternative - The holder explicitly selected an alternative brand. notApplicable - The card is not cobranded.
- getCobrandSelectionIndicator() - Method in class com.onlinepayments.domain.TokenCardData
-
For cobranded cards, this field indicates the brand selection method: default - The holder implicitly accepted the default brand. alternative - The holder explicitly selected an alternative brand. notApplicable - The card is not cobranded.
- getCobrandSelectionIndicator() - Method in class com.onlinepayments.domain.TokenData
-
For cobranded cards, this field indicates the brand selection method: default - The holder implicitly accepted the default brand. alternative - The holder explicitly selected an alternative brand. notApplicable - The card is not cobranded.
- getCode() - Method in class com.onlinepayments.domain.AirlineData
-
Airline numeric code This field is used by the following payment products: 840
- getCode() - Method in class com.onlinepayments.domain.APIError
-
Deprecated.Use errorCode instead. Error code
- getColorDepth() - Method in class com.onlinepayments.domain.BrowserData
-
ColorDepth in bits.
- getCompanyInformation() - Method in class com.onlinepayments.domain.Customer
-
Object containing company information
- getCompanyInformation() - Method in class com.onlinepayments.domain.CustomerToken
-
Object containing company information
- getCompanyName() - Method in class com.onlinepayments.domain.AddressPersonal
-
Company Name
- getCompanyName() - Method in class com.onlinepayments.domain.MandateCustomer
-
Name of company, as a customer
- getCompanyName() - Method in class com.onlinepayments.domain.MandateCustomerResponse
-
Name of company, as a customer
- getCompanyName() - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount
-
Name of the company in case the PayPal account is owned by a business
- getComputedToken() - Method in class com.onlinepayments.domain.ExternalTokenLinked
-
The computed token
- getConjunctionTicket() - 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
- getConnectTimeout() - Method in class com.onlinepayments.CommunicatorConfiguration
- getContactDetails() - Method in class com.onlinepayments.domain.Customer
-
Object containing contact details like email address and phone number
- getContactDetails() - Method in class com.onlinepayments.domain.MandateCustomer
-
Object containing email address
- getContactDetails() - Method in class com.onlinepayments.domain.MandateCustomerResponse
-
Object containing email address
- getContent() - Method in class com.onlinepayments.domain.UploadableFile
- getContentLength() - Method in class com.onlinepayments.domain.UploadableFile
- getContentType() - Method in class com.onlinepayments.communication.MultipartFormDataObject
- getContentType() - Method in class com.onlinepayments.domain.UploadableFile
- getCountryCode() - Method in class com.onlinepayments.domain.Address
-
ISO 3166-1 alpha-2 country code
- getCountryCode() - Method in class com.onlinepayments.domain.AddressPersonal
-
ISO 3166-1 alpha-2 country code
- getCountryCode() - Method in class com.onlinepayments.domain.CardEssentials
-
ISO 3166-1 alpha-2 country code
- getCountryCode() - Method in class com.onlinepayments.domain.GetIINDetailsResponse
-
The ISO 3166-1 alpha-2 country code of the country where the card was issued.
- getCountryCode() - Method in class com.onlinepayments.domain.MandateAddress
-
ISO 3166-1 alpha-2 country code.
- getCountryCode() - Method in class com.onlinepayments.domain.MandateAddressResponse
-
ISO 3166-1 alpha-2 country code.
- getCountryCode() - Method in class com.onlinepayments.domain.PaymentContext
-
The country the payment takes place in
- getCountryCode() - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount
-
ISO 3166-1 alpha-2 country code
- getCountryCode() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams
-
ISO 3166-1 alpha-2 country code of the transaction
- getCountryCode() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams
-
ISO 3166-1 alpha-2 country code of the transaction
- getCountryCode() - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams
-
ISO 3166-1 alpha-2 country code
- getCountryCode() - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams
-
ISO 3166-1 alpha-2 country code of the transaction
- getCountryCode() - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams
-
ISO 3166-1 alpha-2 country code of the transaction
- getCountryCode() - Method in class com.onlinepayments.merchant.products.GetProductDirectoryParams
-
ISO 3166-1 alpha-2 country code
- getCouponNumber() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
The coupon number associated with this leg of the trip.
- getCreated() - Method in class com.onlinepayments.domain.WebhooksEvent
- getCreateDate() - Method in class com.onlinepayments.domain.CustomerAccount
-
The date (YYYYMMDD) on which the customer created their account with you
- getCreateDate() - Method in class com.onlinepayments.domain.PaymentAccountOnFile
-
The date (YYYYMMDD) when the payment account on file was first created.
- getCreatedPaymentOutput() - 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
- getCreatePaymentResponse() - Method in exception class com.onlinepayments.DeclinedPaymentException
- getCreationOutput() - Method in class com.onlinepayments.domain.CompletePaymentResponse
-
Object containing the details of the created payment.
- getCreationOutput() - Method in class com.onlinepayments.domain.CreatePaymentResponse
-
Object containing the details of the created payment.
- getCreator() - Method in class com.onlinepayments.domain.ShoppingCartExtension
- getCreditCardSpecificInput() - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest
- getCryptogram() - Method in class com.onlinepayments.domain.DecryptedPaymentData
-
The 3D secure online payment cryptogram.
- getCurrencyCode() - Method in class com.onlinepayments.domain.AmountOfMoney
-
Three-letter ISO currency code representing the currency for the amount
- getCurrencyCode() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams
-
Three-letter ISO currency code representing the currency for the amount
- getCurrencyCode() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams
-
Three-letter ISO currency code representing the currency for the amount
- getCurrencyCode() - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams
-
Three-letter ISO currency code representing the currency for the amount
- getCurrencyCode() - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams
-
Three-letter ISO currency code representing the currency for the amount
- getCurrencyCode() - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams
-
Three-letter ISO currency code representing the currency for the amount
- getCurrencyCode() - Method in class com.onlinepayments.merchant.products.GetProductDirectoryParams
-
Three-letter ISO currency code representing the currency of the transaction
- getCurrencyConversion() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
- getCurrencyConversion() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
- getCurrencyConversion() - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
- getCurrencyConversionSpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific input required for Dynamic Currency Conversion.
- getCustom() - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput
-
Free text field that you can use to support reconciliation flow.
- getCustomer() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
Customer object containing customer specific inputs.
- getCustomer() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
Customer object containing customer specific inputs.
- getCustomer() - Method in class com.onlinepayments.domain.MandateResponse
-
Customer object containing customer specific outputs.
- getCustomer() - Method in class com.onlinepayments.domain.Order
-
Object containing the details of the customer
- getCustomer() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing the details of the customer
- getCustomer() - Method in class com.onlinepayments.domain.TokenEWallet
- getCustomerAccount() - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput
-
Object containing the details of the PayPal account
- getCustomerAccount() - Method in class com.onlinepayments.domain.RefundPaymentProduct840SpecificOutput
- getCustomerAccountStatus() - 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
- getCustomerAccountStatus() - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount
- getCustomerAddress() - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput
-
Object containing billing address details.
- getCustomerAddressStatus() - 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
- getCustomerAddressStatus() - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount
- getCustomerBankAccount() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Data of customer bank account
- getCustomerBankAccount() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5406SpecificInput
-
Data of customer bank account
- getCustomerBankAccount() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5408SpecificInput
-
Data of customer bank account
- getCustomerId() - Method in class com.onlinepayments.domain.SessionResponse
-
The session is built up around the customer in the form of the customerId.
- getCustomerIpAddress() - Method in class com.onlinepayments.domain.FraudFields
-
Deprecated.Use order.customer.device.ipAddress instead. The IP Address of the customer that is making the payment
- getCustomerReference() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
The unique identifier of a customer
- getCustomerReference() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
The unique identifier of a customer
- getCustomerReference() - Method in class com.onlinepayments.domain.MandateResponse
-
The unique identifier of a customer
- getCvv() - 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.
- getCvvMandatoryForExistingToken() - Method in class com.onlinepayments.domain.CreditCardValidationRulesHostedTokenization
-
Determines whether the Card Verification Value must be provided for existing tokens.
- getCvvMandatoryForNewToken() - Method in class com.onlinepayments.domain.CreditCardValidationRulesHostedTokenization
-
Determines whether the Card Verification Value must be provided for new tokens.
- getCvvResult() - Method in class com.onlinepayments.domain.CardFraudResults
-
Result of the Card Verification Value checks.
- getData() - Method in class com.onlinepayments.domain.CustomerAccountAuthentication
-
Data about the authentication procedure of the customer to their account with you
- getData() - Method in class com.onlinepayments.domain.TokenCard
- getData() - Method in class com.onlinepayments.domain.TokenCardSpecificInput
-
Object containing the token details for a card
- getDataRestrictions() - Method in class com.onlinepayments.domain.PaymentProductField
-
Object containing data restrictions that apply to this field, like minimum and/or maximum length
- getDate() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Date of the leg Format: YYYYMMDD This field is used by the following payment products: cards, 840
- getDateOfBirth() - Method in class com.onlinepayments.domain.LoanRecipient
-
The date of birth of the customer of the recipient of the loan.
- getDateOfBirth() - Method in class com.onlinepayments.domain.PersonalInformation
-
The date of birth of the customer of the recipient of the loan.
- getDateTime() - Method in class com.onlinepayments.domain.PaymentLinkEvent
-
The date and time the change occurred.
- getDccEnabled() - Method in class com.onlinepayments.domain.CurrencyConversionSpecificInput
-
Indicates if this transaction is Dynamic Currency Conversion (DCC) enabled.
- getDccRateInquiry(CurrencyConversionRequest) - Method in class com.onlinepayments.merchant.services.ServicesClient
-
Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
- getDccRateInquiry(CurrencyConversionRequest) - Method in interface com.onlinepayments.merchant.services.ServicesClientInterface
-
Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
- getDccRateInquiry(CurrencyConversionRequest, CallContext) - Method in class com.onlinepayments.merchant.services.ServicesClient
-
Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
- getDccRateInquiry(CurrencyConversionRequest, CallContext) - Method in interface com.onlinepayments.merchant.services.ServicesClientInterface
-
Resource /v2/{merchantId}/services/dccrate - Get currency conversion quote
- getDccSessionId() - Method in class com.onlinepayments.domain.CurrencyConversionInput
-
Dynamic Currency Conversion(DCC) Session Id that was previously returned by rate enquiry (/dccrate).
- getDccSessionId() - Method in class com.onlinepayments.domain.CurrencyConversionResponse
-
The identifier of the Dynamic Currency Conversion(DCC) session that has been created.
- getDecryptedPaymentData() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
The payment data if you do the decryption of the encrypted payment data yourself.
- getDepartureTime() - 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
- getDescription() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Deprecated.A note related to the created payment link. Use paymentLinkSpecificInput/description instead.
- getDescription() - Method in class com.onlinepayments.domain.LineItemInvoiceData
-
Shopping cart item description
- getDescription() - Method in class com.onlinepayments.domain.PaymentLinkSpecificInput
-
A note related to the created payment link.
- getDescriptor() - Method in class com.onlinepayments.domain.CreatePayoutRequest
-
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.
- getDescriptor() - 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.
- getDetails() - Method in class com.onlinepayments.domain.PaymentLinkEvent
-
Details of the events.
- getDetails() - Method in class com.onlinepayments.domain.ShippingMethod
-
Details about the shipping method
- getDevice() - Method in class com.onlinepayments.domain.Customer
-
Object containing information on the device and browser of the customer
- getDevice() - Method in class com.onlinepayments.domain.CustomerOutput
-
Object containing information on the device and browser of the customer
- getDeviceChannel() - Method in class com.onlinepayments.domain.ThreeDSecure
-
Determines whether the call is coming from an application or from a browser * AppBased - Call is coming from an application.
- getDeviceFingerprint() - Method in class com.onlinepayments.domain.CustomerDevice
-
The session ID for the device fingerprint must match the one sent in the device fingerprint script.
- getDirectoryServerTransactionId() - 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
- getDisclaimerDisplay() - Method in class com.onlinepayments.domain.DccProposal
-
Card scheme disclaimer to present to the cardholder
- getDisclaimerReceipt() - Method in class com.onlinepayments.domain.DccProposal
-
Card scheme disclaimer to print within cardholder receipt
- getDiscount() - Method in class com.onlinepayments.domain.Order
-
Object to apply a discount to the total basket by adding a discount line.
- getDiscount() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object to apply a discount to the total basket by adding a discount line.
- getDiscountAmount() - Method in class com.onlinepayments.domain.OrderLineDetails
-
Discount on the line item, with the last two digits implied as decimal places
- getDisplayElements() - Method in class com.onlinepayments.domain.ValueMappingElement
- getDisplayHints() - Method in class com.onlinepayments.domain.AccountOnFile
-
Object containing information for the client on how best to display this field
- getDisplayHints() - 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
- getDisplayHints() - Method in class com.onlinepayments.domain.PaymentProductField
-
Object containing display hints for this field, like the order, mask, preferred keyboard
- getDisplayHints() - 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
- getDisplayHintsList() - Method in class com.onlinepayments.domain.PaymentProduct
- getDisplayHintsList() - Method in class com.onlinepayments.domain.PaymentProductGroup
- getDisplayOrder() - Method in class com.onlinepayments.domain.PaymentProductDisplayHints
-
Determines the order in which the payment products and groups should be shown (sorted ascending)
- getDisplayOrder() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
The order in which the fields should be shown (ascending)
- getDispositionFilename(List<ResponseHeader>) - Static method in class com.onlinepayments.communication.ResponseHeader
- getDpan() - Method in class com.onlinepayments.domain.DecryptedPaymentData
-
The device specific PAN.
- getDpan() - Method in class com.onlinepayments.domain.MobilePaymentData
-
The obfuscated DPAN.
- getDsTransactionId() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
3D Secure Directory Server Transaction Identifier used for this transaction.
- getEci() - Method in class com.onlinepayments.domain.DecryptedPaymentData
-
Electronic Commerce Indicator.
- getEci() - 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
- getEci() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Indicates Authentication validation results returned after AuthenticationValidation
- getEligibility() - 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
- getEmailAddress() - Method in class com.onlinepayments.domain.ContactDetails
-
Email address of the customer
- getEmailAddress() - Method in class com.onlinepayments.domain.MandateContactDetails
-
Email address of the customer
- getEmailAddress() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getEmailAddress() - Method in class com.onlinepayments.domain.Shipping
-
Email address linked to the shipping
- getEncryptedCustomerInput() - Method in class com.onlinepayments.domain.CardSource
-
Data that was encrypted client side containing all customer entered data elements like card data.
- getEncryptedCustomerInput() - Method in class com.onlinepayments.domain.CreatePaymentRequest
-
Data that was encrypted client side containing all customer entered data elements like card data.
- getEncryptedCustomerInput() - Method in class com.onlinepayments.domain.DccCardSource
-
Data that was encrypted client-side that contains all customer-entered data elements, such as card data.
- getEncryptedPaymentData() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
The payment data if we will do the decryption of the encrypted payment data.
- getEndorsementOrRestriction() - 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.
- getEntityId() - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput
-
The reference to be used during Multibanco payment for reconciliation matter
- getEntries() - Method in class com.onlinepayments.domain.ProductDirectory
-
List of entries in the directory
- getEphemeralKey() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
Ephemeral Key A unique generated key used by Apple to encrypt data.
- getErrorCode() - Method in class com.onlinepayments.domain.APIError
-
Error code
- getErrorId() - Method in exception class com.onlinepayments.ApiException
- getErrorId() - Method in class com.onlinepayments.domain.ErrorResponse
-
Unique reference, for debugging purposes, of this error response
- getErrorId() - Method in class com.onlinepayments.domain.PaymentErrorResponse
-
Unique reference, for debugging purposes, of this error response
- getErrorId() - Method in class com.onlinepayments.domain.PayoutErrorResponse
- getErrorId() - Method in class com.onlinepayments.domain.RefundErrorResponse
- getErrors() - Method in exception class com.onlinepayments.ApiException
- getErrors() - Method in class com.onlinepayments.domain.ErrorResponse
-
List of one or more errors
- getErrors() - Method in class com.onlinepayments.domain.OrderStatusOutput
- getErrors() - Method in class com.onlinepayments.domain.PaymentErrorResponse
- getErrors() - Method in class com.onlinepayments.domain.PaymentStatusOutput
- getErrors() - Method in class com.onlinepayments.domain.PayoutErrorResponse
- getErrors() - Method in class com.onlinepayments.domain.RefundErrorResponse
- getEventApiVersion() - Method in exception class com.onlinepayments.webhooks.ApiVersionMismatchException
- getEWallet() - Method in class com.onlinepayments.domain.TokenResponse
-
Object containing eWallet details
- getEWalletRefundMethodSpecificOutput() - Method in class com.onlinepayments.domain.RefundOutput
- getExchangeRate() - Method in class com.onlinepayments.domain.RateDetails
-
Expressed as a percentage, applied to convert the original amount into the resulting amount without charge
- getExchangeTicket() - 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
- getExclude() - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedCheckout
-
The payment product ids to be be excluded or restricted to from the payment products available for the payment.
- getExclude() - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedTokenization
-
The payment product ids to be be excluded or restricted to from the payment products available for the payment.
- getExemptionEngineFlow() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Detailed description of the Exemption Engine outcomes
- getExemptionRequest() - 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.
- getExemptionRequest() - 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.
- getExemptionRequest() - 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.
- getExistingUniqueMandateReference() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput
-
The unique reference of the existing mandate to use in this payment.
- getExistingUniqueMandateReference() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase
-
The unique reference of the existing mandate to use in this payment.
- getExpirationDate() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Deprecated.The date after which the payment link will not be usable to complete the payment. The date sent cannot be more than 6 months in the future or a past date. It must also contain the UTC offset. Use paymentLinkSpecificInput/expirationDate instead.
- getExpirationDate() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
The date after which the payment link will not be usable to complete the payment.
- getExpirationDate() - Method in class com.onlinepayments.domain.PaymentLinkSpecificInput
-
The date after which the payment link will not be usable to complete the payment.
- getExpirationDate() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getExpiredCardTokens() - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse
-
Tokens referencing expired cards are returned in this array.
- getExpiryDate() - Method in class com.onlinepayments.domain.Card
-
Expiry date of the card Format: MMYY
- getExpiryDate() - Method in class com.onlinepayments.domain.CardEssentials
-
Expiry date of the card Format: MMYY
- getExpiryDate() - Method in class com.onlinepayments.domain.CardWithoutCvv
-
Expiry date of the card Format: MMYY
- getExpiryDate() - Method in class com.onlinepayments.domain.DecryptedPaymentData
-
Expiry date of the card Format: MMYY.
- getExpiryDate() - Method in class com.onlinepayments.domain.MobilePaymentData
-
Expiry date of the tokenized card.
- getExtensionId() - Method in class com.onlinepayments.domain.ShoppingCartExtension
- getExternalCardholderAuthenticationData() - Method in class com.onlinepayments.domain.ThreeDSecure
-
Object containing 3D secure details.
- getExternalReference() - Method in class com.onlinepayments.domain.PaymentCreationOutput
-
The external reference identifier for this transaction.
- getExternalTokenLinked() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
- getExternalTokenLinked() - Method in class com.onlinepayments.domain.CreatedTokenResponse
- getExternalTokenLinked() - Method in class com.onlinepayments.domain.TokenResponse
- getExtraMerchantData() - 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.
- getFallbackLevel() - Method in class com.onlinepayments.domain.AcquirerSelectionInformation
-
Specifies whether a fallback occurred from the primary choice of the acquirer selection service.
- getFare() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Deprecated.Use legFare instead. Fare of this leg
- getFareBasis() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Fare Basis/Ticket Designator This field is used by the following payment products: 840
- getFaxNumber() - Method in class com.onlinepayments.domain.ContactDetails
-
International version of the fax number of the customer including the leading + (i.e.
- getFee() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Fee for this leg of the trip This field is used by the following payment products: 840
- getFeedbacks() - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest
-
This section will contain feedback Urls to provide feedback on the payment.
- getFeedbacks() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
This section will contain feedback Urls to provide feedback on the payment.
- getFeedbacks() - Method in class com.onlinepayments.domain.CreatePaymentRequest
-
This section will contain feedback Urls to provide feedback on the payment.
- getFeedbacks() - Method in class com.onlinepayments.domain.CreatePayoutRequest
-
This section will contain feedback Urls to provide feedback on the payment.
- getFields() - Method in class com.onlinepayments.domain.PaymentProduct
-
Object containing all the fields and their details that are associated with this payment product.
- getFileName() - Method in class com.onlinepayments.domain.UploadableFile
- getFiles() - Method in class com.onlinepayments.communication.MultipartFormDataObject
- getFirstName() - Method in class com.onlinepayments.domain.AirlinePassenger
-
First name of the passenger This field is used by the following payment products: cards, 840
- getFirstName() - Method in class com.onlinepayments.domain.MandatePersonalName
-
Given name(s) or first name(s) of the customer.
- getFirstName() - Method in class com.onlinepayments.domain.MandatePersonalNameResponse
-
Given name(s) or first name(s) of the customer.
- getFirstName() - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount
-
First name of the PayPal account holder
- getFirstName() - Method in class com.onlinepayments.domain.PersonalName
-
Given name(s) or first name(s) of the customer
- getFirstName() - Method in class com.onlinepayments.domain.PersonalNameToken
- getFirstUsageDate() - Method in class com.onlinepayments.domain.Shipping
-
Date (YYYYMMDD) when the shipping details for this transaction were first used.
- getFiscalNumber() - 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.
- getFixedList() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getFlightDate() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.This field is not used by any payment product Date of the Flight Format: YYYYMMDD
- getFlightIndicator() - Method in class com.onlinepayments.domain.AirlineData
-
Indicator representing the type of flight on the itinerary.
- getFlightLegs() - Method in class com.onlinepayments.domain.AirlineData
-
Object that holds the data on the individual legs of the flight ticket
- getFlightNumber() - 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
- getFlow() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
3D Secure Flow used during this transaction.
- getFlow() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
3D Secure Flow used during this transaction.
- getForceAuthentication() - Method in class com.onlinepayments.domain.PaymentProduct3012SpecificInput
-
Indicate whether 3D Secure authentication should be forced.
- getFormElement() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
Object detailing the type of form element that should be used to present the field
- getFraudFields() - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest
-
Object containing additional data that will be used to assess the risk of fraud
- getFraudFields() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Object containing additional data that will be used to assess the risk of fraud
- getFraudFields() - Method in class com.onlinepayments.domain.CreatePaymentRequest
-
Object containing additional data that will be used to assess the risk of fraud
- getFraudResults() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
Fraud results contained in the CardFraudResults object
- getFraudResults() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput
-
Fraud results contained in the CardFraudResults object
- getFraudResults() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Object containing the results of the fraud screening
- getFraudResults() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput
-
Object containing the results of the fraud screening
- getFraudServiceResult() - Method in class com.onlinepayments.domain.CardFraudResults
-
Resulting advice of the fraud prevention checks.
- getFraudServiceResult() - Method in class com.onlinepayments.domain.FraudResults
-
Resulting advice of the fraud prevention checks.
- getGateway() - Method in class com.onlinepayments.domain.PaymentProduct320SpecificData
-
The gateway identifier.
- getGender() - Method in class com.onlinepayments.domain.PersonalInformation
-
The gender of the customer.
- getGeneratedToken() - Method in class com.onlinepayments.domain.ExternalTokenLinked
-
The generated token
- getGiftCardPurchase() - Method in class com.onlinepayments.domain.ShoppingCart
-
Object containing information on purchased gift card(s)
- getGroupCards() - 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
- getGroups() - 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.
- getGTSComputedToken() - Method in class com.onlinepayments.domain.ExternalTokenLinked
-
Deprecated.Use the field ComputedToken instead.
- getHadSuspiciousActivity() - Method in class com.onlinepayments.domain.CustomerAccount
-
Specifies if you have experienced suspicious activity on the account of the customer
- getHeader(String) - Method in exception class com.onlinepayments.communication.ResponseException
- getHeader(List<RequestHeader>, String) - Static method in class com.onlinepayments.communication.RequestHeader
- getHeader(List<ResponseHeader>, String) - Static method in class com.onlinepayments.communication.ResponseHeader
- getHeaderDateString() - Static method in class com.onlinepayments.DefaultCommunicator
-
Returns the date in the preferred format for the HTTP date header (RFC1123).
- getHeaders() - Method in exception class com.onlinepayments.communication.ResponseException
- getHeaders(HttpResponse) - Method in class com.onlinepayments.communication.DefaultConnection
- getHeaderValue(String) - Method in exception class com.onlinepayments.communication.ResponseException
- getHeaderValue(List<RequestHeader>, String) - Static method in class com.onlinepayments.communication.RequestHeader
- getHeaderValue(List<ResponseHeader>, String) - Static method in class com.onlinepayments.communication.ResponseHeader
- getHide() - 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.
- getHide() - 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.
- getHide() - 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.
- getHide() - 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.
- getHost() - Method in class com.onlinepayments.ProxyConfiguration
- getHostedCheckout(String) - Method in class com.onlinepayments.merchant.hostedcheckout.HostedCheckoutClient
-
Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
- getHostedCheckout(String) - Method in interface com.onlinepayments.merchant.hostedcheckout.HostedCheckoutClientInterface
-
Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
- getHostedCheckout(String, CallContext) - Method in class com.onlinepayments.merchant.hostedcheckout.HostedCheckoutClient
-
Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
- getHostedCheckout(String, CallContext) - Method in interface com.onlinepayments.merchant.hostedcheckout.HostedCheckoutClientInterface
-
Resource /v2/{merchantId}/hostedcheckouts/{hostedCheckoutId} - Get hosted checkout status
- getHostedCheckoutId() - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse
-
The ID of the Hosted Checkout Session in which the payment was made.
- getHostedCheckoutId() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificOutput
-
The ID of the Hosted Checkout Session in which the payment was made.
- GetHostedCheckoutResponse - Class in com.onlinepayments.domain
- GetHostedCheckoutResponse() - Constructor for class com.onlinepayments.domain.GetHostedCheckoutResponse
- getHostedCheckoutSpecificInput() - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest
-
Object containing hosted checkout specific data
- getHostedCheckoutSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Object containing hosted checkout specific data
- getHostedCheckoutSpecificOutput() - Method in class com.onlinepayments.domain.PaymentDetailsResponse
-
Hosted Checkout specific information.
- getHostedCheckoutSpecificOutput() - Method in class com.onlinepayments.domain.PaymentResponse
-
Hosted Checkout specific information.
- getHostedTokenization(String) - Method in class com.onlinepayments.merchant.hostedtokenization.HostedTokenizationClient
-
Resource /v2/{merchantId}/hostedtokenizations/{hostedTokenizationId} - Get hosted tokenization session
- getHostedTokenization(String) - Method in interface com.onlinepayments.merchant.hostedtokenization.HostedTokenizationClientInterface
-
Resource /v2/{merchantId}/hostedtokenizations/{hostedTokenizationId} - Get hosted tokenization session
- getHostedTokenization(String, CallContext) - Method in class com.onlinepayments.merchant.hostedtokenization.HostedTokenizationClient
-
Resource /v2/{merchantId}/hostedtokenizations/{hostedTokenizationId} - Get hosted tokenization session
- getHostedTokenization(String, CallContext) - Method in interface com.onlinepayments.merchant.hostedtokenization.HostedTokenizationClientInterface
-
Resource /v2/{merchantId}/hostedtokenizations/{hostedTokenizationId} - Get hosted tokenization session
- getHostedTokenizationId() - Method in class com.onlinepayments.domain.CardSource
-
An Id of a hosted tokenization session
- getHostedTokenizationId() - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse
-
The ID of the Hosted Tokenization Session
- getHostedTokenizationId() - 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.
- getHostedTokenizationId() - Method in class com.onlinepayments.domain.DccCardSource
-
An Id of a hosted tokenization session
- GetHostedTokenizationResponse - Class in com.onlinepayments.domain
- GetHostedTokenizationResponse() - Constructor for class com.onlinepayments.domain.GetHostedTokenizationResponse
- getHostedTokenizationUrl() - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse
-
The URL you can use in your JavaScript when instantiating the Tokenizer.
- getHouseNumber() - Method in class com.onlinepayments.domain.Address
-
House number
- getHouseNumber() - Method in class com.onlinepayments.domain.AddressPersonal
-
House number
- getHouseNumber() - Method in class com.onlinepayments.domain.MandateAddress
-
House number
- getHouseNumber() - Method in class com.onlinepayments.domain.MandateAddressResponse
-
House number
- getHtmlContent() - Method in class com.onlinepayments.domain.GetPrivacyPolicyResponse
-
HTML content to be displayed to the user.
- getHttpsProtocols() - Method in class com.onlinepayments.CommunicatorConfiguration
- getHttpStatusCode() - Method in class com.onlinepayments.domain.APIError
-
HTTP status code for this error that can be used to determine the type of error
- getIban() - Method in class com.onlinepayments.domain.BankAccountIban
-
The IBAN is the International Bank Account Number.
- getIban() - Method in class com.onlinepayments.domain.CustomerBankAccount
-
The IBAN is the International Bank Account Number.
- getIban() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getId() - Method in class com.onlinepayments.domain.AccountOnFile
- getId() - Method in class com.onlinepayments.domain.APIError
-
ID of the error.
- getId() - Method in class com.onlinepayments.domain.Capture
- getId() - Method in class com.onlinepayments.domain.CaptureResponse
-
Our unique payment transaction identifier
- getId() - Method in class com.onlinepayments.domain.OperationOutput
-
Our unique payment transaction identifier
- getId() - Method in class com.onlinepayments.domain.PaymentDetailsResponse
-
Our unique payment transaction identifier
- getId() - Method in class com.onlinepayments.domain.PaymentProduct
-
The ID of the payment product in our system
- getId() - Method in class com.onlinepayments.domain.PaymentProductField
- getId() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement
-
The ID of the display element.
- getId() - Method in class com.onlinepayments.domain.PaymentProductGroup
-
The ID of the payment product group in our system
- getId() - Method in class com.onlinepayments.domain.PaymentResponse
-
Our unique payment transaction identifier
- getId() - Method in class com.onlinepayments.domain.PayoutResponse
- getId() - Method in class com.onlinepayments.domain.PayoutResult
- getId() - Method in class com.onlinepayments.domain.RefundResponse
-
Our unique payment transaction identifier
- getId() - Method in class com.onlinepayments.domain.TokenResponse
-
ID of the token
- getId() - Method in class com.onlinepayments.domain.WebhooksEvent
- getIdempotenceKey() - Method in class com.onlinepayments.CallContext
- getIdempotenceKey() - Method in exception class com.onlinepayments.IdempotenceException
- getIdempotenceRequestTimestamp() - Method in class com.onlinepayments.CallContext
- getIdempotenceRequestTimestamp() - Method in exception class com.onlinepayments.IdempotenceException
- getIdempotenceResponseDateTime() - Method in class com.onlinepayments.CallContext
- getIINDetails(GetIINDetailsRequest) - Method in class com.onlinepayments.merchant.services.ServicesClient
-
Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
- getIINDetails(GetIINDetailsRequest) - Method in interface com.onlinepayments.merchant.services.ServicesClientInterface
-
Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
- getIINDetails(GetIINDetailsRequest, CallContext) - Method in class com.onlinepayments.merchant.services.ServicesClient
-
Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
- getIINDetails(GetIINDetailsRequest, CallContext) - Method in interface com.onlinepayments.merchant.services.ServicesClientInterface
-
Resource /v2/{merchantId}/services/getIINdetails - Get IIN details
- GetIINDetailsRequest - Class in com.onlinepayments.domain
- GetIINDetailsRequest() - Constructor for class com.onlinepayments.domain.GetIINDetailsRequest
- GetIINDetailsResponse - Class in com.onlinepayments.domain
- GetIINDetailsResponse() - Constructor for class com.onlinepayments.domain.GetIINDetailsResponse
- getImage() - 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.
- getInitialSchemeTransactionId() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
The unique scheme transactionId of the initial transaction that was performed with SCA.
- getInitialSchemeTransactionId() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
The unique scheme transactionId of the initial transaction that was performed with SCA.
- getInitialSchemeTransactionId() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
The unique scheme transactionId of the initial transaction that was performed with SCA.
- getInstantPaymentOnly() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5408SpecificInput
-
true - consumer can only use instant payment for Account to Account Bank transfer payments false - consumer can only use standard payment for Account to Account Bank transfer payments
- getIntegrator() - Method in class com.onlinepayments.CommunicatorConfiguration
- getInvalidTokens() - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse
- getInvalidTokens() - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse
-
Tokens that are submitted in the request are validated.
- getInvalidTokens() - Method in class com.onlinepayments.domain.SessionResponse
- getInvertedExchangeRate() - Method in class com.onlinepayments.domain.RateDetails
-
Exchange rate, expressed as a percentage, applied to convert the resulting amount into the original amount
- getInvoiceData() - Method in class com.onlinepayments.domain.LineItem
-
Object containing the line items of the invoice or shopping cart
- getInvoiceNumber() - Method in class com.onlinepayments.domain.AirlineData
-
Airline tracing number This field is used by the following payment products: cards
- getIpAddress() - Method in class com.onlinepayments.domain.CustomerDevice
-
The IP address of the customer client from the HTTP Headers.
- getIpAddressCountryCode() - Method in class com.onlinepayments.domain.CustomerDeviceOutput
-
ISO 3166-1 alpha-2 country code
- getIsAllowedInContext() - Method in class com.onlinepayments.domain.GetIINDetailsResponse
-
Populated only if you submitted a payment context.
- getIsAllowedInContext() - Method in class com.onlinepayments.domain.IINDetail
-
Populated only if you submitted a payment context.
- getIsAuthorized() - Method in class com.onlinepayments.domain.PaymentStatusOutput
-
Indicates if the transaction has been authorized
- getIsCancellable() - Method in class com.onlinepayments.domain.OrderStatusOutput
-
Flag indicating if the payment can be cancelled true false
- getIsCancellable() - Method in class com.onlinepayments.domain.PaymentStatusOutput
-
Flag indicating if the payment can be cancelled
- getIsCancellable() - Method in class com.onlinepayments.domain.PayoutStatusOutput
-
Flag indicating if the payout can be cancelled true false
- getIsDeferredPayment() - Method in class com.onlinepayments.domain.PaymentProduct3012SpecificInput
-
Indicate whether its a deferred payment.
- getIsETicket() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.Deprecated
- getIsFinal() - Method in class com.onlinepayments.domain.CancelPaymentRequest
-
This property indicates whether this will be the final operation.
- getIsFinal() - Method in class com.onlinepayments.domain.CapturePaymentRequest
-
This property indicates whether this will be the final operation.
- getIsFirstUsage() - Method in class com.onlinepayments.domain.Shipping
-
Indicator if this shipping address is used for the first time to ship an order
- getIsNewToken() - 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.
- getIsNewToken() - 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.
- getIsPreOrder() - Method in class com.onlinepayments.domain.ShoppingCart
-
The customer is pre-ordering one or more items
- getIsRecurring() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
true - Indicates that the transactions is part of a scheduled recurring sequence.
- getIsRecurring() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
true - Only payment products that support recurring payments will be shown.
- getIsRecurring() - Method in class com.onlinepayments.domain.PaymentContext
-
True if the payment is recurring
- getIsRecurring() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams
-
This allows you to filter payment products based on their support for recurring payments.
- getIsRecurring() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams
-
This allows you to filter payment products based on their support for recurring payments.
- getIsRecurring() - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams
-
This allows you to filter networks based on their support for recurring or not true false
- getIsRecurring() - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams
-
This allows you to filter payment products based on their support for recurring payments.
- getIsRecurring() - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams
-
This allows you to filter payment products based on their support for recurring payments.
- getIsRefundable() - Method in class com.onlinepayments.domain.PaymentStatusOutput
-
Flag indicating if the payment can be refunded
- getIsRequired() - Method in class com.onlinepayments.domain.PaymentProductFieldDataRestrictions
-
true - Indicates that this field is required false - Indicates that this field is optional
- getIsRestrictedTicket() - Method in class com.onlinepayments.domain.AirlineData
-
Indicates if the ticket is refundable or not.
- getIssueDate() - 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.
- getIssuerId() - Method in class com.onlinepayments.domain.DirectoryEntry
-
Unique ID of the issuing bank of the customer
- getIssuerId() - Method in class com.onlinepayments.domain.RedirectPaymentProduct809SpecificInput
-
Unique ID of the issuing bank of the customer
- getIssuerList() - Method in class com.onlinepayments.domain.DirectoryEntry
-
To be used to sort the issuers.
- getIssuerName() - Method in class com.onlinepayments.domain.DirectoryEntry
-
Name of the issuing bank as it should be presented to the customer
- getIsTemporary() - Method in class com.onlinepayments.domain.TokenResponse
-
Temporary tokens have a lifespan of two hours and can only be used once.
- getIsThirdParty() - 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
- getIsWipTransaction() - Method in class com.onlinepayments.domain.PaymentProduct3012SpecificInput
-
Indicate whether its wallet initiated payment.
- getItems() - Method in class com.onlinepayments.domain.ShoppingCart
-
Shopping cart data
- getJavaEnabled() - Method in class com.onlinepayments.domain.BrowserData
-
true =Java is enabled in the browser
- getJavaScriptEnabled() - Method in class com.onlinepayments.domain.BrowserData
-
true = JavaScript is enabled in the browser. false = JavaScript is not enabled in the browser.
- getJavaScriptSdkFlow() - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput
-
To be enabled when Javascript SDK integration is implemented on S2S flow false = When this flag is disabled the field RedirectionURL is returned by CreatePayment call and should be used in merchant implementation to redirect buyer to PayPal. true = When this flag is enabled the field orderID is returned by CreatePayment call and should be utilized in case merchant has integrated JS SDK button on their S2S implementation Default value is false.
- getKey() - Method in class com.onlinepayments.domain.AccountOnFileAttribute
-
Name of the key or property
- getKey() - Method in class com.onlinepayments.domain.ValidateCredentialsRequest
-
The webhook key and without any change applied to it.
- getKeyId() - Method in exception class com.onlinepayments.webhooks.SecretKeyNotAvailableException
- getLabel() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
A required value that’s a short, localized description of the line item.
- getLabel() - Method in class com.onlinepayments.domain.PaymentProductDisplayHints
-
Name of the payment product or group based on the locale that was included in the request
- getLabel() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement
-
The label of the display element.
- getLabel() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
Label/Name of the field to be used in the user interface
- getLabel() - Method in class com.onlinepayments.domain.PaymentProductFieldTooltip
-
A text explaining the field in more detail.
- getLabelTemplate() - Method in class com.onlinepayments.domain.AccountOnFileDisplayHints
-
Array of attribute keys and their mask
- getLanguage() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
The language code of the customer.
- getLanguage() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
The language code of the customer.
- getLegFare() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Fee for this leg of the trip This field is used by the following payment products: 840
- getLength() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getLiability() - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput
-
Determines the Fraud liability.
- getLiability() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Determines the Fraud liability.
- getLink() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
Deprecated.Deprecated
- getLoanRecipient() - Method in class com.onlinepayments.domain.AdditionalOrderInput
-
Object containing specific data regarding the recipient of a loan in the UK
- getLocale() - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest
-
Locale used in the GUI towards the consumer.
- getLocale() - Method in class com.onlinepayments.domain.Customer
-
The locale that the customer should be addressed in (for 3rd parties).
- getLocale() - Method in class com.onlinepayments.domain.CustomerDevice
-
Locale of the client device/browser.
- getLocale() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
Locale used in the GUI towards the consumer.
- getLocale() - Method in class com.onlinepayments.merchant.privacypolicy.GetPrivacyPolicyParams
-
Locale in which the privacy policy will be returned.
- getLocale() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams
-
Deprecated: This field has no effect.
- getLocale() - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams
-
Deprecated: This field has no effect.
- getLocale() - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams
-
Locale used in the GUI towards the consumer.
- getLocale() - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams
-
Locale used in the GUI towards the consumer.
- getLodgingData() - Method in class com.onlinepayments.domain.AdditionalOrderInput
-
Object that holds lodging specific data
- getLogo() - Method in class com.onlinepayments.domain.AccountOnFileDisplayHints
-
Partial URL that you can reference for the image of this payment product.
- getLogo() - Method in class com.onlinepayments.domain.PaymentProductDisplayHints
-
Partial URL that you can reference for the image of this payment product.
- getLoyaltyCardNumber() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
The number of customer's loyalty card or program
- getLuhn() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getManagementUrl() - Method in class com.onlinepayments.domain.ApplePayRecurringPaymentRequest
-
A URL to a web page where the user can update or delete the payment method for the recurring payment.
- getMandate() - Method in class com.onlinepayments.domain.CreateMandateResponse
-
Object containing the created mandate.
- getMandate() - Method in class com.onlinepayments.domain.GetMandateResponse
-
Object containing the created mandate.
- getMandate() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput
-
Object containing information to create a SEPA Direct Debit mandate.
- getMandate() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase
-
Object containing information to create a SEPA Direct Debit mandate.
- getMandate(String) - Method in class com.onlinepayments.merchant.mandates.MandatesClient
-
Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
- getMandate(String) - Method in interface com.onlinepayments.merchant.mandates.MandatesClientInterface
-
Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
- getMandate(String, CallContext) - Method in class com.onlinepayments.merchant.mandates.MandatesClient
-
Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
- getMandate(String, CallContext) - Method in interface com.onlinepayments.merchant.mandates.MandatesClientInterface
-
Resource /v2/{merchantId}/mandates/{uniqueMandateReference} - Get mandate
- getMandateAddress() - Method in class com.onlinepayments.domain.MandateCustomer
-
Object containing consumer address details.
- getMandateAddress() - Method in class com.onlinepayments.domain.MandateCustomerResponse
-
Object containing consumer address details
- getMandatePdf() - Method in class com.onlinepayments.domain.MandateResponse
-
The mandate PDF in base64 encoded string
- getMandateReference() - Method in class com.onlinepayments.domain.PaymentProduct771SpecificOutput
-
Unique reference to a Mandate
- GetMandateResponse - Class in com.onlinepayments.domain
- GetMandateResponse() - Constructor for class com.onlinepayments.domain.GetMandateResponse
- getMarkUpRate() - 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.
- getMarshaller() - Method in interface com.onlinepayments.Communicator
- getMarshaller() - Method in class com.onlinepayments.DefaultCommunicator
- getMask() - Method in class com.onlinepayments.domain.LabelTemplateElement
-
Regular mask for the attributeKey Note: The mask is optional as not every field has a mask
- getMask() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
A mask that can be used in the input field.
- getMaxConnections() - Method in class com.onlinepayments.CommunicatorConfiguration
- getMaxLength() - Method in class com.onlinepayments.domain.LengthValidator
- getMaxValue() - Method in class com.onlinepayments.domain.RangeValidator
- getMerchantAction() - 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
- getMerchantAction() - 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.
- getMerchantAction() - 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
- getMerchantCustomerId() - 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
- getMerchantCustomerId() - Method in class com.onlinepayments.domain.Customer
-
Your identifier for the customer.
- getMerchantFinanceCode() - 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.
- getMerchantFinanceCode() - 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.
- getMerchantFraudRate() - 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.
- getMerchantFraudRate() - 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.
- getMerchantId() - Method in class com.onlinepayments.domain.WebhooksEvent
- getMerchantParameters() - 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.
- getMerchantParameters() - 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.
- getMerchantParameters() - 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.
- getMerchantParameters() - 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.
- getMerchantParameters() - 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.
- getMerchantReference() - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse
-
Your unique reference of the transaction that is also returned in our report files.
- getMerchantReference() - Method in class com.onlinepayments.domain.OperationPaymentReferences
-
Your unique reference of the transaction that is also returned in our report files.
- getMerchantReference() - Method in class com.onlinepayments.domain.OrderReferences
-
Your unique reference of the transaction that is also returned in our report files.
- getMerchantReference() - Method in class com.onlinepayments.domain.PaymentLinkOrderInput
-
Your unique reference of the transaction that is also returned in our report files.
- getMerchantReference() - Method in class com.onlinepayments.domain.PaymentLinkOrderOutput
-
Your unique reference of the transaction that is also returned in our report files.
- getMerchantReference() - Method in class com.onlinepayments.domain.PaymentReferences
-
Your unique reference of the transaction that is also returned in our report files.
- getMerchantScore() - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure
-
Score calculated by the 3DS Requestor and provided to CB Scoring service only.
- getMessage() - 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
- getMessage() - Method in class com.onlinepayments.logging.LogMessageBuilder
- getMessage() - Method in class com.onlinepayments.logging.RequestLogMessageBuilder
- getMessage() - Method in class com.onlinepayments.logging.ResponseLogMessageBuilder
- getMetaData() - Method in class com.onlinepayments.domain.OtherDetails
-
Information used by the following PaymentProducts [5300] to provide details on the item such as the color, size, etc.
- getMethod() - 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 cico-b-connect-token = the customer logged in using Check-in/Check-out b.connect
- getMethod() - Method in class com.onlinepayments.domain.Shipping
-
Object containing information regarding shipping method
- getMethod() - Method in class com.onlinepayments.domain.ThreeDSecureData
-
Method of authentication used for this transaction.
- getMinLength() - Method in class com.onlinepayments.domain.LengthValidator
- getMinValue() - Method in class com.onlinepayments.domain.RangeValidator
- getMobilePaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest
-
Object containing the specific input details for mobile payments
- getMobilePaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Object containing the specific input details for mobile payments
- getMobilePaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentRequest
-
Object containing the specific input details for mobile payments
- getMobilePaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing the mobile payment method details
- getMobilePaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing the mobile payment method details
- getMobilePhoneNumber() - Method in class com.onlinepayments.domain.ContactDetails
-
International version of the mobile phone number of the customer including the leading + (i.e.
- getMobilePhoneNumber() - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput
-
The mobile phone number used for this transaction
- getMobileRefundMethodSpecificOutput() - Method in class com.onlinepayments.domain.RefundOutput
- getMobileThreeDSecureChallengeParameters() - Method in class com.onlinepayments.domain.MerchantAction
-
Mobile 3D Secure Challenge Parameters
- getMode() - Method in class com.onlinepayments.domain.SurchargeSpecificInput
-
The surcharge mode which defines how a merchant will apply surcharging.
- getMode() - Method in class com.onlinepayments.domain.SurchargeSpecificOutput
-
The surcharge mode which defines how a merchant will apply surcharging.
- getMultiplePaymentInformation() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Container announcing forecoming subsequent payments.
- getMultiplePaymentInformation() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Container announcing forecoming subsequent payments.
- getMustWriteReason() - Method in class com.onlinepayments.domain.AccountOnFileAttribute
-
Deprecated.Deprecated
- getName() - Method in class com.onlinepayments.communication.RequestHeader
- getName() - Method in class com.onlinepayments.communication.RequestParam
- getName() - Method in class com.onlinepayments.communication.ResponseHeader
- getName() - Method in class com.onlinepayments.domain.AcquirerInformation
-
Name of the acquirer used to process the transaction
- getName() - Method in class com.onlinepayments.domain.AddressPersonal
-
Object containing the name details of the customer
- getName() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.This field is not used by any payment product Name of the airline
- getName() - Method in class com.onlinepayments.domain.CompanyInformation
-
Name of company, as a customer.
- getName() - Method in class com.onlinepayments.domain.MandatePersonalInformation
-
Object containing the name details of the customer.
- getName() - Method in class com.onlinepayments.domain.MandatePersonalInformationResponse
-
Object containing the name details of the customer.
- getName() - Method in class com.onlinepayments.domain.PersonalInformation
-
Object containing the name details of the customer
- getName() - Method in class com.onlinepayments.domain.PersonalInformationToken
- getName() - Method in class com.onlinepayments.domain.ShippingMethod
-
Name of the shipping method
- getName() - Method in class com.onlinepayments.domain.ShoppingCartExtension
- getNetAmount() - Method in class com.onlinepayments.domain.Surcharge
-
Object containing amount and ISO currency code attributes
- getNetwork() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput
-
The card network that was used for a mobile payment method operation
- getNetwork() - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
-
The card network that was used for a mobile payment method operation
- getNetworks() - Method in class com.onlinepayments.domain.PaymentProduct302SpecificData
-
The networks that can be used in the current payment context.
- getNetworks() - Method in class com.onlinepayments.domain.PaymentProduct320SpecificData
-
The networks that can be used in the current payment context.
- getNetworks() - Method in class com.onlinepayments.domain.PaymentProductNetworksResponse
- getNumber() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Deprecated.This field is not used by any payment product Sequence number of the flight leg
- getNumberOfCardOnFileCreationAttemptsLast24Hours() - Method in class com.onlinepayments.domain.PaymentAccountOnFile
-
Number of attempts made to add new card to the customer account in the last 24 hours
- getNumberOfGiftCards() - Method in class com.onlinepayments.domain.GiftCardPurchase
-
Number of gift cards that are purchased through this transaction
- getNumberOfItems() - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure
-
Number of purchased items or services.
- getNumberOfPaymentAttemptsLast24Hours() - 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
- getNumberOfPaymentAttemptsLastYear() - 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
- getNumberOfPurchasesLast6Months() - Method in class com.onlinepayments.domain.CustomerPaymentActivity
-
Number of successful purchases made by this customer with you in the last 6 months
- getObfuscate() - 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
- getOmnichannelPayoutSpecificInput() - Method in class com.onlinepayments.domain.CreatePayoutRequest
-
Object containing the additional payout details for a Omnichannel merchants
- getOperationCode() - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput
-
The reference returned by redsys to identify the operation
- getOperationReferences() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object that holds all reference properties that are linked to this transaction
- getOperationReferences() - Method in class com.onlinepayments.domain.CapturePaymentRequest
-
Object that holds all reference properties that are linked to this transaction
- getOperationReferences() - Method in class com.onlinepayments.domain.OperationOutput
-
Object that holds all reference properties that are linked to this transaction
- getOperationReferences() - Method in class com.onlinepayments.domain.RefundOutput
-
Object that holds all reference properties that are linked to this transaction
- getOperationReferences() - Method in class com.onlinepayments.domain.RefundRequest
-
Object that holds all reference properties that are linked to this transaction
- getOperations() - Method in class com.onlinepayments.domain.PaymentDetailsResponse
-
Object that contains the complete list of operations executed on the payment.
- getOrder() - 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.
- getOrder() - 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.
- getOrder() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Order object containing order related data Please note that this object is required to be able to submit the amount.
- getOrder() - 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.
- getOrder() - 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.
- getOrderLineDetails() - Method in class com.onlinepayments.domain.LineItem
-
Object containing additional information that when supplied can have a beneficial effect on the discountrates
- getOrganizationEntityType() - Method in class com.onlinepayments.domain.RedirectPaymentProduct3302SpecificInput
-
This parameter defines the legal form of a business and is mandatory in B2B transactions, Accurate classification ensures compliance and optimized payment handling.
- getOrganizationRegistrationId() - Method in class com.onlinepayments.domain.RedirectPaymentProduct3302SpecificInput
-
Unique identifier given by relevant authority verifying a business's legal registration.
- getOriginAirport() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Origin airport/city code This field is used by the following payment products: cards, 840
- getOtherDetails() - Method in class com.onlinepayments.domain.LineItem
-
Other information for specific payment methods.
- getPairingToken() - 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.
- getPartialPan() - 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.
- getPartialRedirectUrl() - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse
-
The partial URL as generated by our system.
- getPartialRedirectUrl() - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse
-
Deprecated.Deprecated
- getPassengerClass() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
PassengerClass if this leg This field is used by the following payment products: 840
- getPassengerName() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.Use passengers instead Name of passenger
- getPassengers() - 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
- getPassengerType() - Method in class com.onlinepayments.domain.AirlinePassenger
-
Type of passenger on the itinerary.
- getPassword() - Method in class com.onlinepayments.ProxyConfiguration
- getPasswordChangeDate() - 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
- getPasswordChangedDuringCheckout() - Method in class com.onlinepayments.domain.CustomerAccount
-
Indicates if the password of an account is changed during this checkout
- getPayerId() - 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
- getPayerId() - 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
- getPayLater() - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput
-
Indicates whether to allow PayPal Pay Later option.
- getPayment() - Method in class com.onlinepayments.domain.CancelPaymentResponse
-
Object that holds the payment related properties
- getPayment() - Method in class com.onlinepayments.domain.CompletePaymentResponse
-
Object that holds the payment related properties
- getPayment() - Method in class com.onlinepayments.domain.CreatedPaymentOutput
-
Object that holds the payment related properties
- getPayment() - Method in class com.onlinepayments.domain.CreatePaymentResponse
-
Object that holds the payment related properties
- getPayment() - Method in class com.onlinepayments.domain.SubsequentPaymentResponse
-
Object that holds the payment related properties
- getPayment() - Method in class com.onlinepayments.domain.WebhooksEvent
- getPayment(String) - Method in class com.onlinepayments.merchant.payments.PaymentsClient
-
Resource /v2/{merchantId}/payments/{paymentId} - Get payment
- getPayment(String) - Method in interface com.onlinepayments.merchant.payments.PaymentsClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId} - Get payment
- getPayment(String, CallContext) - Method in class com.onlinepayments.merchant.payments.PaymentsClient
-
Resource /v2/{merchantId}/payments/{paymentId} - Get payment
- getPayment(String, CallContext) - Method in interface com.onlinepayments.merchant.payments.PaymentsClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId} - Get payment
- getPaymentAccountOnFile() - Method in class com.onlinepayments.domain.CustomerAccount
-
Object containing information on the payment account data on file (tokens)
- getPaymentAccountReference() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
The Payment Account Reference is a unique alphanumeric identifier that links a PAN with all subsequent PANs for the same payment account (e.g., following card replacement) and all EMV payment tokens associated with that account.
- getPaymentActivity() - Method in class com.onlinepayments.domain.CustomerAccount
-
Object containing data on the purchase history of the customer with you
- getPaymentContext() - Method in class com.onlinepayments.domain.GetIINDetailsRequest
- getPaymentData() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput
-
Object containing payment details
- getPaymentDescription() - Method in class com.onlinepayments.domain.ApplePayRecurringPaymentRequest
-
A description of the recurring payment that Apple Pay displays to the user in the payment sheet.
- getPaymentDetails(String) - Method in class com.onlinepayments.merchant.payments.PaymentsClient
-
Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details
- getPaymentDetails(String) - Method in interface com.onlinepayments.merchant.payments.PaymentsClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details
- getPaymentDetails(String, CallContext) - Method in class com.onlinepayments.merchant.payments.PaymentsClient
-
Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details
- getPaymentDetails(String, CallContext) - Method in interface com.onlinepayments.merchant.payments.PaymentsClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId}/details - Get payment details
- getPaymentEndDate() - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput
-
The end date of the payment validity
- getPaymentId() - Method in class com.onlinepayments.domain.OmnichannelPayoutSpecificInput
-
The Payment Id of the transaction (either in-store or online), from which you request to make a refund.
- getPaymentId() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
The unique payment transaction identifier.
- getPaymentLinkById(String) - Method in class com.onlinepayments.merchant.paymentlinks.PaymentLinksClient
-
Resource /v2/{merchantId}/paymentlinks/{paymentLinkId} - Get payment link by ID
- getPaymentLinkById(String) - Method in interface com.onlinepayments.merchant.paymentlinks.PaymentLinksClientInterface
-
Resource /v2/{merchantId}/paymentlinks/{paymentLinkId} - Get payment link by ID
- getPaymentLinkById(String, CallContext) - Method in class com.onlinepayments.merchant.paymentlinks.PaymentLinksClient
-
Resource /v2/{merchantId}/paymentlinks/{paymentLinkId} - Get payment link by ID
- getPaymentLinkById(String, CallContext) - Method in interface com.onlinepayments.merchant.paymentlinks.PaymentLinksClientInterface
-
Resource /v2/{merchantId}/paymentlinks/{paymentLinkId} - Get payment link by ID
- getPaymentLinkEvents() - Method in class com.onlinepayments.domain.PaymentLinkResponse
- getPaymentLinkId() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
The unique link identifier.
- getPaymentLinkOrder() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
An object containing the details of the related payment input.
- getPaymentLinkOrder() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
An object containing the details of the related payment output.
- getPaymentLinkSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
An object containing details specific to payment link creation
- getPaymentMethod() - Method in class com.onlinepayments.domain.CaptureOutput
-
Payment method identifier used by the our payment engine.
- getPaymentMethod() - Method in class com.onlinepayments.domain.OperationOutput
-
Payment method identifier used by the our payment engine.
- getPaymentMethod() - Method in class com.onlinepayments.domain.PaymentOutput
-
Payment method identifier used by the our payment engine.
- getPaymentMethod() - Method in class com.onlinepayments.domain.PaymentProduct
-
Payment method identifier used by the our payment engine.
- getPaymentMethod() - Method in class com.onlinepayments.domain.RefundOutput
-
Payment method identifier used by the our payment engine.
- getPaymentNumber() - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
-
This payment's ordinal number in the sequence of payments.
- getPaymentOption() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
The specific payment option for the payment.
- getPaymentOption() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
The specific payment option for the payment.
- getPaymentOption() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
The specific payment option for the payment.
- getPaymentOutput() - Method in class com.onlinepayments.domain.PaymentDetailsResponse
-
Object containing payment details
- getPaymentOutput() - Method in class com.onlinepayments.domain.PaymentResponse
-
Object containing payment details
- getPaymentPattern() - Method in class com.onlinepayments.domain.MultiplePaymentInformation
-
Typology of multiple payment.
- getPaymentProduct(Integer, GetPaymentProductParams) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
- getPaymentProduct(Integer, GetPaymentProductParams) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
- getPaymentProduct(Integer, GetPaymentProductParams, CallContext) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
- getPaymentProduct(Integer, GetPaymentProductParams, CallContext) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products/{paymentProductId} - Get payment product
- getPaymentProduct130SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing specific input required for CB payments
- getPaymentProduct130SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific input required for CB payments
- getPaymentProduct3012() - Method in class com.onlinepayments.domain.ShowFormData
-
Contains the third party data for payment product 3012 (Bancontact)
- getPaymentProduct3012SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing specific input required for bancontact.
- getPaymentProduct3012SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific input required for bancontact.
- getPaymentProduct302SpecificData() - Method in class com.onlinepayments.domain.PaymentProduct
- getPaymentProduct302SpecificInput() - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput
-
Object containing information specific to Apple Pay.
- getPaymentProduct3203SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input for PostFinancePay payments (Payment product ID 3203).
- getPaymentProduct3203SpecificOutput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
PostFinancePay (payment product 3203) specific details
- getPaymentProduct3208SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing specific input required for OneyDuplo Leroy Merlin payments.
- getPaymentProduct3208SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific input required for OneyDuplo Leroy Merlin payments.
- getPaymentProduct3208SpecificOutput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
OneyDuplo Leroy Merlin specific details
- getPaymentProduct3209SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing specific input required for OneyDuplo Alcampo payments.
- getPaymentProduct3209SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific input required for OneyDuplo Alcampo payments.
- getPaymentProduct3209SpecificOutput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
OneyDuplo Alcampo specific details
- getPaymentProduct320SpecificData() - Method in class com.onlinepayments.domain.PaymentProduct
- getPaymentProduct320SpecificInput() - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput
-
Object containing information specific to Google Pay.
- getPaymentProduct320SpecificInput() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
Object containing information specific to Google Pay.
- getPaymentProduct3302SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input required for Klarna PayLater payment (Payment product ID 3302)
- getPaymentProduct3306SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input required for Klarna payments (Payment product ID 3306)
- getPaymentProduct5001SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input required for Bizum payments
- getPaymentProduct5001SpecificOutput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Bizum (payment product 5001) specific details
- getPaymentProduct5100SpecificInput() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific input required for Cpay payments.
- getPaymentProduct5300SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Pledg (payment product 5300) specific details
- getPaymentProduct5402SpecificOutput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Meal vouchers (payment product 5402) specific details
- getPaymentProduct5404() - Method in class com.onlinepayments.domain.ShowFormData
-
Contains the third party data for payment product 5404 (WeChat Pay)
- getPaymentProduct5406SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input for EPS payments (Payment product ID 5406)
- getPaymentProduct5407() - Method in class com.onlinepayments.domain.ShowFormData
-
Contains the third party data for payment product 5407 (Twint)
- getPaymentProduct5408SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input for Account to Account payments (Payment product ID 5408)
- getPaymentProduct5410SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
iDealin3 (payment product 5410) specific details
- getPaymentProduct5500SpecificOutput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Multibanco (payment product 5500) specific details
- getPaymentProduct771SpecificInput() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput
-
Object containing information specific to SEPA Direct Debit
- getPaymentProduct771SpecificInput() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase
-
Object containing information specific to SEPA Direct Debit
- getPaymentProduct771SpecificOutput() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput
-
Output that is SEPA Direct Debit specific (i.e.
- getPaymentProduct809SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input required for iDeal payments (Payment product ID 809)
- getPaymentProduct840SpecificInput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing specific input required for PayPal payments (Payment product ID 840)
- getPaymentProduct840SpecificOutput() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
PayPal (payment product 840) specific details
- getPaymentProduct840SpecificOutput() - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
- getPaymentProductFilters() - 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.
- getPaymentProductFilters() - 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.
- getPaymentProductGroup() - Method in class com.onlinepayments.domain.PaymentProduct
-
The payment product group that has this payment product, if there is any.
- getPaymentProductGroups() - Method in class com.onlinepayments.domain.GetPaymentProductGroupsResponse
- GetPaymentProductGroupsResponse - Class in com.onlinepayments.domain
- GetPaymentProductGroupsResponse() - Constructor for class com.onlinepayments.domain.GetPaymentProductGroupsResponse
- getPaymentProductId() - Method in class com.onlinepayments.domain.AccountOnFile
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.CardInfo
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.CreateTokenRequest
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.GetIINDetailsResponse
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.IINDetail
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.Surcharge
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.SurchargeCalculationCard
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.domain.TokenResponse
-
Payment product identifier - Please see Products documentation for a full overview of possible values.
- getPaymentProductId() - Method in class com.onlinepayments.merchant.privacypolicy.GetPrivacyPolicyParams
-
ID of the specific payment product for which you wish to retrieve the privacy policy.
- getPaymentProductNetworks(Integer, GetPaymentProductNetworksParams) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
- getPaymentProductNetworks(Integer, GetPaymentProductNetworksParams) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
- getPaymentProductNetworks(Integer, GetPaymentProductNetworksParams, CallContext) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
- getPaymentProductNetworks(Integer, GetPaymentProductNetworksParams, CallContext) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products/{paymentProductId}/networks - Get payment product networks
- GetPaymentProductNetworksParams - Class in com.onlinepayments.merchant.products
-
Query parameters for Get payment product networks (/v2/{merchantId}/products/{paymentProductId}/networks)
- GetPaymentProductNetworksParams() - Constructor for class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams
- GetPaymentProductParams - Class in com.onlinepayments.merchant.products
-
Query parameters for Get payment product (/v2/{merchantId}/products/{paymentProductId})
- GetPaymentProductParams() - Constructor for class com.onlinepayments.merchant.products.GetPaymentProductParams
- getPaymentProductPreferredOrder() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputForHostedCheckout
-
This array contains the payment product identifiers representing the brands.
- getPaymentProductPreferredOrder() - Method in class com.onlinepayments.domain.CreditCardSpecificInputHostedTokenization
-
This array contains the payment product identifiers representing the brands.
- getPaymentProducts() - Method in class com.onlinepayments.domain.GetPaymentProductsResponse
- getPaymentProducts(GetPaymentProductsParams) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products - Get payment products
- getPaymentProducts(GetPaymentProductsParams) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products - Get payment products
- getPaymentProducts(GetPaymentProductsParams, CallContext) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products - Get payment products
- getPaymentProducts(GetPaymentProductsParams, CallContext) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products - Get payment products
- GetPaymentProductsParams - Class in com.onlinepayments.merchant.products
-
Query parameters for Get payment products (/v2/{merchantId}/products)
- GetPaymentProductsParams() - Constructor for class com.onlinepayments.merchant.products.GetPaymentProductsParams
- GetPaymentProductsResponse - Class in com.onlinepayments.domain
- GetPaymentProductsResponse() - Constructor for class com.onlinepayments.domain.GetPaymentProductsResponse
- getPaymentReference() - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput
-
The reference to be used within the Multibanco network to confirm the payment
- getPaymentResult() - Method in class com.onlinepayments.domain.PaymentErrorResponse
-
Object that contains details on the created payment in case one has been created.
- getPaymentStartDate() - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput
-
The start date of the payment validity
- getPaymentStatusCategory() - Method in class com.onlinepayments.domain.CreatedPaymentOutput
- getPaymentTiming() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
The time that the payment occurs as part of a successful transaction.
- getPayout() - Method in class com.onlinepayments.domain.WebhooksEvent
- getPayout(String) - Method in class com.onlinepayments.merchant.payouts.PayoutsClient
-
Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
- getPayout(String) - Method in interface com.onlinepayments.merchant.payouts.PayoutsClientInterface
-
Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
- getPayout(String, CallContext) - Method in class com.onlinepayments.merchant.payouts.PayoutsClient
-
Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
- getPayout(String, CallContext) - Method in interface com.onlinepayments.merchant.payouts.PayoutsClientInterface
-
Resource /v2/{merchantId}/payouts/{payoutId} - Get payout
- getPayoutOutput() - Method in class com.onlinepayments.domain.PayoutResponse
- getPayoutOutput() - Method in class com.onlinepayments.domain.PayoutResult
- getPayoutReason() - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput
-
Allows you to additionally specify the reason for initiating the payout for authorization purposes.
- getPayoutReason() - Method in class com.onlinepayments.domain.PayoutOutput
-
Allows you to additionally specify the reason for initiating the payout for authorization purposes.
- getPayoutResult() - Method in exception class com.onlinepayments.DeclinedPayoutException
- getPayoutResult() - Method in class com.onlinepayments.domain.PayoutErrorResponse
- getPersonalInformation() - Method in class com.onlinepayments.domain.Customer
-
Object containing personal information like name, date of birth and gender.
- getPersonalInformation() - Method in class com.onlinepayments.domain.CustomerToken
- getPersonalInformation() - Method in class com.onlinepayments.domain.MandateCustomer
-
Object containing personal information of the customer.
- getPersonalInformation() - Method in class com.onlinepayments.domain.MandateCustomerResponse
-
Object containing personal information of the customer
- getPhoneNumber() - Method in class com.onlinepayments.domain.ContactDetails
-
International version of the phone number of the customer including the leading + (i.e.
- getPlaceholderLabel() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
A placeholder value for the form element
- getPlaceOfIssue() - 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.
- getPlatformIdentifier() - Method in class com.onlinepayments.communication.DefaultMetadataProvider
- getPnr() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.Use passengers instead.
- getPointOfSale() - Method in class com.onlinepayments.domain.AirlineData
-
IATA point of sale name This field is used by the following payment products: 840
- getPort() - Method in class com.onlinepayments.ProxyConfiguration
- getPosCityCode() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.This field is not used by any payment product City code of the point of sale
- getPreferredInputType() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
The type of keyboard that can best be used to fill out the value of this field.
- getPreOrderItemAvailabilityDate() - Method in class com.onlinepayments.domain.ShoppingCart
-
Date (YYYYMMDD) when the preordered item becomes available
- getPriorThreeDSecureData() - Method in class com.onlinepayments.domain.ThreeDSecure
-
Object containing data regarding the customer authentication that occurred prior to the current transaction
- getPriorThreeDSecureData() - Method in class com.onlinepayments.domain.ThreeDSecureBase
-
Object containing data regarding the customer authentication that occurred prior to the current transaction
- getPrivacyPolicy(GetPrivacyPolicyParams) - Method in class com.onlinepayments.merchant.privacypolicy.PrivacyPolicyClient
-
Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
- getPrivacyPolicy(GetPrivacyPolicyParams) - Method in interface com.onlinepayments.merchant.privacypolicy.PrivacyPolicyClientInterface
-
Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
- getPrivacyPolicy(GetPrivacyPolicyParams, CallContext) - Method in class com.onlinepayments.merchant.privacypolicy.PrivacyPolicyClient
-
Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
- getPrivacyPolicy(GetPrivacyPolicyParams, CallContext) - Method in interface com.onlinepayments.merchant.privacypolicy.PrivacyPolicyClientInterface
-
Resource /v2/{merchantId}/services/privacypolicy - Get Privacy Policy
- GetPrivacyPolicyParams - Class in com.onlinepayments.merchant.privacypolicy
-
Query parameters for Get Privacy Policy (/v2/{merchantId}/services/privacypolicy)
- GetPrivacyPolicyParams() - Constructor for class com.onlinepayments.merchant.privacypolicy.GetPrivacyPolicyParams
- GetPrivacyPolicyResponse - Class in com.onlinepayments.domain
- GetPrivacyPolicyResponse() - Constructor for class com.onlinepayments.domain.GetPrivacyPolicyResponse
- getProductBrand() - Method in class com.onlinepayments.domain.OrderLineDetails
-
The brand of the product.
- getProductCategories() - Method in class com.onlinepayments.domain.FraudFields
-
List of product categories that are being purchased.
- getProductCode() - Method in class com.onlinepayments.domain.OrderLineDetails
-
Product or UPC Code
- getProductDirectory(Integer, GetProductDirectoryParams) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
- getProductDirectory(Integer, GetProductDirectoryParams) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
- getProductDirectory(Integer, GetProductDirectoryParams, CallContext) - Method in class com.onlinepayments.merchant.products.ProductsClient
-
Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
- getProductDirectory(Integer, GetProductDirectoryParams, CallContext) - Method in interface com.onlinepayments.merchant.products.ProductsClientInterface
-
Resource /v2/{merchantId}/products/{paymentProductId}/directory - Get payment product directory
- GetProductDirectoryParams - Class in com.onlinepayments.merchant.products
-
Query parameters for Get payment product directory (/v2/{merchantId}/products/{paymentProductId}/directory)
- GetProductDirectoryParams() - Constructor for class com.onlinepayments.merchant.products.GetProductDirectoryParams
- getProductGroup(String, GetProductGroupParams) - Method in class com.onlinepayments.merchant.productgroups.ProductGroupsClient
-
Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
- getProductGroup(String, GetProductGroupParams) - Method in interface com.onlinepayments.merchant.productgroups.ProductGroupsClientInterface
-
Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
- getProductGroup(String, GetProductGroupParams, CallContext) - Method in class com.onlinepayments.merchant.productgroups.ProductGroupsClient
-
Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
- getProductGroup(String, GetProductGroupParams, CallContext) - Method in interface com.onlinepayments.merchant.productgroups.ProductGroupsClientInterface
-
Resource /v2/{merchantId}/productgroups/{paymentProductGroupId} - Get product group
- GetProductGroupParams - Class in com.onlinepayments.merchant.productgroups
-
Query parameters for Get product group (/v2/{merchantId}/productgroups/{paymentProductGroupId})
- GetProductGroupParams() - Constructor for class com.onlinepayments.merchant.productgroups.GetProductGroupParams
- getProductGroups(GetProductGroupsParams) - Method in class com.onlinepayments.merchant.productgroups.ProductGroupsClient
-
Resource /v2/{merchantId}/productgroups - Get product groups
- getProductGroups(GetProductGroupsParams) - Method in interface com.onlinepayments.merchant.productgroups.ProductGroupsClientInterface
-
Resource /v2/{merchantId}/productgroups - Get product groups
- getProductGroups(GetProductGroupsParams, CallContext) - Method in class com.onlinepayments.merchant.productgroups.ProductGroupsClient
-
Resource /v2/{merchantId}/productgroups - Get product groups
- getProductGroups(GetProductGroupsParams, CallContext) - Method in interface com.onlinepayments.merchant.productgroups.ProductGroupsClientInterface
-
Resource /v2/{merchantId}/productgroups - Get product groups
- GetProductGroupsParams - Class in com.onlinepayments.merchant.productgroups
-
Query parameters for Get product groups (/v2/{merchantId}/productgroups)
- GetProductGroupsParams() - Constructor for class com.onlinepayments.merchant.productgroups.GetProductGroupsParams
- getProductName() - Method in class com.onlinepayments.domain.OrderLineDetails
-
The name of the product.
- getProductPrice() - Method in class com.onlinepayments.domain.OrderLineDetails
-
The price of one unit of the product, the value should be zero or greater
- getProducts() - Method in class com.onlinepayments.domain.PaymentProductFilter
- getProducts() - Method in class com.onlinepayments.domain.PaymentProductFilterHostedTokenization
- getProductType() - Method in class com.onlinepayments.domain.OrderLineDetails
-
Code used to classify items that are purchased
- getPropertyName() - Method in class com.onlinepayments.domain.APIError
-
Returned only if the error relates to a value that was missing or incorrect.
- getProposal() - Method in class com.onlinepayments.domain.CurrencyConversion
-
Details of currency conversion to be proposed to the cardholder
- getProposal() - Method in class com.onlinepayments.domain.CurrencyConversionResponse
-
Details of currency conversion to be proposed to the cardholder
- getProtectionEligibility() - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput
-
Kind of seller protection in force for the PayPal transaction
- getProxyConfiguration() - Method in class com.onlinepayments.CommunicatorConfiguration
- getPublicKeyHash() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput
-
Public Key Hash A unique identifier to retrieve key used by Apple to encrypt information.
- getPurchaseType() - Method in class com.onlinepayments.domain.OrderTypeInformation
-
Possible values are: physical (tangible goods shipped to the customers) digital (digital services like ebooks, streaming...)
- getQrCode() - Method in class com.onlinepayments.domain.PaymentProduct3012
-
Contains a value which can be used to build a QR code (intended to be scanned by a device with the Bancontact app)
- getQrCode() - Method in class com.onlinepayments.domain.PaymentProduct5407
-
Contains a base64 encoded PNG image.
- getQrCodeUrl() - 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)
- getQuantity() - 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
- getQuotationDateTime() - Method in class com.onlinepayments.domain.RateDetails
-
Date and time at which the exchange rate has been quoted
- getRange() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getRate() - Method in class com.onlinepayments.domain.DccProposal
- getRecipientName() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Deprecated.The payment link recipient name. Use paymentLinkSpecificInput/recipientName instead.
- getRecipientName() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
The payment link recipient name.
- getRecipientName() - Method in class com.onlinepayments.domain.PaymentLinkSpecificInput
-
The payment link recipient name.
- getRecurrenceType() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
Specifies whether the mandate is for one-off or recurring payments.
- getRecurrenceType() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
Specifies whether the mandate is for one-off or recurring payments.
- getRecurrenceType() - Method in class com.onlinepayments.domain.MandateResponse
-
Specifies whether the mandate is for one-off or recurring payments.
- getRecurring() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing data related to recurring
- getRecurring() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing data related to recurring
- getRecurringPaymentEndDate() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
The date of the final payment.
- getRecurringPaymentIntervalCount() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
The number of interval units that make up the total payment interval.
- getRecurringPaymentIntervalUnit() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
The amount of time — in calendar units, such as day, month, or year — that represents a fraction of the total payment interval.
- getRecurringPaymentSequenceIndicator() - 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
- getRecurringPaymentStartDate() - Method in class com.onlinepayments.domain.ApplePayLineItem
-
The date of the first payment.
- getRedirectData() - Method in class com.onlinepayments.domain.MandateMerchantAction
-
Object containing all data needed to redirect the customer
- getRedirectData() - Method in class com.onlinepayments.domain.MerchantAction
-
Object containing all data needed to redirect the customer
- getRedirectionData() - Method in class com.onlinepayments.domain.GPayThreeDSecure
-
Object containing browser specific redirection related data
- getRedirectionData() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Object containing browser specific redirection related data
- getRedirectionData() - Method in class com.onlinepayments.domain.ThreeDSecure
-
Object containing browser specific redirection related data
- getRedirectionUrl() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
The URL that will redirect the customer to the Hosted Checkout page to process the payment.
- getRedirectPaymentMethodSpecificInput() - 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
- getRedirectPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
- getRedirectPaymentMethodSpecificInput() - 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
- getRedirectPaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing the redirect payment product details
- getRedirectPaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing the redirect payment product details
- getRedirectRefundMethodSpecificOutput() - Method in class com.onlinepayments.domain.RefundOutput
- getRedirectUrl() - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse
-
The full hosted checkout URL as generated by our system.
- getRedirectURL() - Method in class com.onlinepayments.domain.MandateRedirectData
-
The URL that the customer should be redirected to.
- getRedirectURL() - Method in class com.onlinepayments.domain.RedirectData
-
The URL that the customer should be redirected to.
- getReferences() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object that holds all reference properties that are linked to this transaction.
- getReferences() - Method in class com.onlinepayments.domain.CapturePaymentRequest
-
Object that holds all reference properties that are linked to this transaction.
- getReferences() - Method in class com.onlinepayments.domain.CreatePayoutRequest
-
Object that holds all reference properties that are linked to this transaction.
- getReferences() - Method in class com.onlinepayments.domain.OperationOutput
-
Object that holds all reference properties that are linked to this transaction.
- getReferences() - Method in class com.onlinepayments.domain.Order
-
Object that holds all reference properties that are linked to this transaction
- getReferences() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object that holds all reference properties that are linked to this transaction.
- getReferences() - Method in class com.onlinepayments.domain.RefundOutput
-
Object that holds all reference properties that are linked to this transaction.
- getReferences() - Method in class com.onlinepayments.domain.RefundRequest
-
Object that holds all reference properties that are linked to this transaction.
- getRefund() - Method in class com.onlinepayments.domain.WebhooksEvent
- getRefundOutput() - Method in class com.onlinepayments.domain.RefundResponse
-
Object containing refund details
- getRefundResponse() - Method in exception class com.onlinepayments.DeclinedRefundException
- getRefundResult() - 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.
- getRefunds() - Method in class com.onlinepayments.domain.RefundsResponse
-
The list of all refunds performed on the requested payment.
- getRefunds(String) - Method in class com.onlinepayments.merchant.refunds.RefundsClient
-
Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
- getRefunds(String) - Method in interface com.onlinepayments.merchant.refunds.RefundsClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
- getRefunds(String, CallContext) - Method in class com.onlinepayments.merchant.refunds.RefundsClient
-
Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
- getRefunds(String, CallContext) - Method in interface com.onlinepayments.merchant.refunds.RefundsClientInterface
-
Resource /v2/{merchantId}/payments/{paymentId}/refunds - Get refunds of payment
- getRegularBilling() - Method in class com.onlinepayments.domain.ApplePayRecurringPaymentRequest
-
Object containing specific data regarding Apple Pay recurring payment.
- getRegularExpression() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getRegularExpression() - Method in class com.onlinepayments.domain.RegularExpressionValidator
- getReOrderIndicator() - Method in class com.onlinepayments.domain.ShoppingCart
-
Indicates whether the cardholder is reordering previously purchased item(s)
- getRequiresApproval() - 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
- getRequiresApproval() - 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
- getResponseBody() - Method in exception class com.onlinepayments.ApiException
- getRestrictTo() - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedCheckout
-
The payment product ids to be be excluded or restricted to from the payment products available for the payment.
- getRestrictTo() - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedTokenization
-
The payment product ids to be be excluded or restricted to from the payment products available for the payment.
- getResult() - Method in class com.onlinepayments.domain.AcquirerSelectionInformation
-
Result of the acquirer selection operation
- getResult() - Method in class com.onlinepayments.domain.CurrencyConversionResponse
-
Result of a requested currency conversion
- getResult() - 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
- getResult() - Method in class com.onlinepayments.domain.Surcharge
-
Token describing result.
- getResult() - Method in class com.onlinepayments.domain.TestConnection
- getResult() - Method in class com.onlinepayments.domain.ValidateCredentialsResponse
-
The webhooks validation was OK (Valid) or not OK (Invalid).
- getResultReason() - Method in class com.onlinepayments.domain.CurrencyConversionResult
-
Plain text explaining the result of the currency conversion request
- getRetriable() - Method in class com.onlinepayments.domain.APIError
-
Flag indicating if the request is retriable.
- getRETURNMAC() - 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.
- getRETURNMAC() - Method in class com.onlinepayments.domain.MandateRedirectData
-
A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment.
- getRETURNMAC() - Method in class com.onlinepayments.domain.RedirectData
-
A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
- getReturnUrl() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
The URL that the customer is redirect to after the payment flow has finished.
- getReturnUrl() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
Return URL to use if the mandate signing requires redirection.
- getReturnUrl() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
Return URL to use if the mandate signing requires redirection.
- getReturnUrl() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
The URL that the customer is redirect to after the payment flow has finished.
- getReturnUrl() - Method in class com.onlinepayments.domain.RedirectionData
-
The URL that the customer is redirected to after the payment flow has finished.
- getRuleName() - Method in class com.onlinepayments.domain.AcquirerSelectionInformation
-
Name of the rule used to select the acquirer
- getScheme() - Method in class com.onlinepayments.ProxyConfiguration
- getSchemeEci() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme.
- getSchemeReferenceData() - 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.
- getSchemeReferenceData() - 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.
- getSchemeReferenceData() - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
-
Deprecated.Deprecated
- getSchemeRiskScore() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
Global score calculated by the Carte Bancaire (130) Scoring platform.
- getScreenHeight() - Method in class com.onlinepayments.domain.BrowserData
-
Height of the screen in pixels.
- getScreenWidth() - Method in class com.onlinepayments.domain.BrowserData
-
Width of the screen in pixels.
- getSdkApiVersion() - Method in exception class com.onlinepayments.webhooks.ApiVersionMismatchException
- getSdkIdentifier() - Method in class com.onlinepayments.communication.DefaultMetadataProvider
- getSecondInstallmentPaymentDate() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
The date of the second installment (YYYYMMDD)
- getSecondInstallmentPaymentDate() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5410SpecificInput
-
The date of the second installment (YYYYMMDD)
- getSecret() - Method in class com.onlinepayments.domain.ValidateCredentialsRequest
-
Send here the hashed webhooks key secret in the same way as the check is done in your system.
- getSecretApiKey() - Method in class com.onlinepayments.CommunicatorConfiguration
-
Returns a secret used for authorization.
- getSecretKey(String) - Method in class com.onlinepayments.webhooks.InMemorySecretKeyStore
- getSecretKey(String) - Method in interface com.onlinepayments.webhooks.SecretKeyStore
- getSecureCorporatePayment() - 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.
- getSecureCorporatePayment() - 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.
- getSepaDirectDebitPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest
-
Object containing the specific input details for SEPA direct debit payments
- getSepaDirectDebitPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest
-
Object containing the specific input details for SEPA direct debit payments
- getSepaDirectDebitPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.CreatePaymentRequest
-
Object containing the specific input details for SEPA direct debit payments
- getSepaDirectDebitPaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing the SEPA direct debit details
- getSepaDirectDebitPaymentMethodSpecificOutput() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing the SEPA direct debit details
- getServerMetadataHeaders() - Method in class com.onlinepayments.communication.DefaultMetadataProvider
- getServerMetadataHeaders() - Method in interface com.onlinepayments.communication.MetadataProvider
- getSessionDuration() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5300SpecificInput
-
The duration of the session in seconds
- getSessionTimeout() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
The number of minutes after which the session will expire.
- getShipping() - Method in class com.onlinepayments.domain.Order
-
Object containing information regarding shipping / delivery
- getShippingAddress() - Method in class com.onlinepayments.domain.PaymentProduct3203SpecificOutput
-
Object containing address information
- getShippingCost() - Method in class com.onlinepayments.domain.Shipping
-
Cost associated with the shipping of the order.
- getShippingCostTax() - Method in class com.onlinepayments.domain.Shipping
-
Tax amount of the shipping cost.
- getShoppingCart() - Method in class com.onlinepayments.domain.Order
-
Shopping cart data, including items and specific amounts.
- getShoppingCartExtension() - Method in class com.onlinepayments.CommunicatorConfiguration
- getShowFormData() - Method in class com.onlinepayments.domain.MerchantAction
-
Object returned for the SHOW_FORM actionType.
- getShowResultPage() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
true - Default - Hosted Checkout will show a result page to the customer when applicable. false - Hosted Checkout will redirect the customer back to the provided returnUrl when this is possible.
- getSignatureType() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
Specifies whether the mandate is tick box, unsigned or signed by SMS.
- getSignatureType() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
Specifies whether the mandate is tick box, unsigned or signed by SMS.
- getSkipAuthentication() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Deprecated.Use threeDSecure.skipAuthentication instead. * true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. * false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
- getSkipAuthentication() - Method in class com.onlinepayments.domain.GPayThreeDSecure
-
true = 3D Secure authentication will be skipped for this transaction.
- getSkipAuthentication() - Method in class com.onlinepayments.domain.ThreeDSecure
-
true = 3D Secure authentication will be skipped for this transaction.
- getSkipAuthentication() - Method in class com.onlinepayments.domain.ThreeDSecureBase
-
true = 3D Secure authentication will be skipped for this transaction.
- getSkipSoftDecline() - Method in class com.onlinepayments.domain.ThreeDSecure
-
true = Soft Decline retry mechanism will be skipped for this transaction.
- getSkipSoftDecline() - Method in class com.onlinepayments.domain.ThreeDSecureBase
-
true = Soft Decline retry mechanism will be skipped for this transaction.
- getSocketTimeout() - Method in class com.onlinepayments.CommunicatorConfiguration
- getSource() - Method in class com.onlinepayments.domain.RateDetails
-
Indicates the exchange rate source name.
- getSpecificRate() - 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.
- getSpeed() - Method in class com.onlinepayments.domain.ShippingMethod
-
Number of hours to delivery
- getState() - Method in class com.onlinepayments.domain.Address
-
ISO 3166-2 country subdivision code
- getState() - Method in class com.onlinepayments.domain.AddressPersonal
-
ISO 3166-2 country subdivision code
- getStatus() - 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.
- getStatus() - Method in class com.onlinepayments.domain.Capture
-
Current high-level status of the payment in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.CaptureResponse
-
Current high-level status of the payment in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.GetHostedCheckoutResponse
-
This is the status of the hosted checkout.
- getStatus() - Method in class com.onlinepayments.domain.MandateResponse
- getStatus() - Method in class com.onlinepayments.domain.OperationOutput
-
Current high-level status of the payment in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.PaymentDetailsResponse
-
Current high-level status of the payment in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.PaymentLinkResponse
-
The state of the payment link: ACTIVE: The payment link is ready to be used. PAID: The payment has been completed. CANCELLED: The payment link has been manually cancelled. EXPIRED: The payment link is not usable anymore.
- getStatus() - Method in class com.onlinepayments.domain.PaymentResponse
-
Current high-level status of the payment in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.PayoutResponse
-
Current high-level status of the payout in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.PayoutResult
-
Current high-level status of the payout in a human-readable form.
- getStatus() - Method in class com.onlinepayments.domain.RefundResponse
-
Current high-level status of the payment in a human-readable form.
- getStatusCategory() - Method in class com.onlinepayments.domain.OrderStatusOutput
-
Highlevel status of the payment, payout or refund.
- getStatusCategory() - Method in class com.onlinepayments.domain.PaymentStatusOutput
-
Highlevel status of the payment, payout or refund.
- getStatusCategory() - Method in class com.onlinepayments.domain.PayoutStatusOutput
-
Highlevel status of the payment, payout or refund.
- getStatusCode() - Method in exception class com.onlinepayments.ApiException
- getStatusCode() - Method in exception class com.onlinepayments.communication.ResponseException
- getStatusCode() - Method in class com.onlinepayments.domain.CaptureStatusOutput
-
Numeric status code of the legacy API.
- getStatusCode() - Method in class com.onlinepayments.domain.OrderStatusOutput
-
Numeric status code of the legacy API.
- getStatusCode() - Method in class com.onlinepayments.domain.PaymentStatusOutput
-
Numeric status code of the legacy API.
- getStatusCode() - Method in class com.onlinepayments.domain.PayoutStatusOutput
-
Numeric status code of the legacy API.
- getStatusCodeChangeDateTime() - Method in class com.onlinepayments.domain.OrderStatusOutput
-
Timestamp of the latest status change
- getStatusCodeChangeDateTime() - Method in class com.onlinepayments.domain.PaymentStatusOutput
-
Timestamp of the latest status change
- getStatusOutput() - 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.
- getStatusOutput() - 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.
- getStatusOutput() - 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.
- getStatusOutput() - 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.
- getStatusOutput() - 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.
- getStatusOutput() - Method in class com.onlinepayments.domain.PayoutResponse
- getStatusOutput() - Method in class com.onlinepayments.domain.PayoutResult
- getStatusOutput() - Method in class com.onlinepayments.domain.RefundResponse
- getStopoverCode() - 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
- getStreet() - Method in class com.onlinepayments.domain.Address
-
Street name
- getStreet() - Method in class com.onlinepayments.domain.AddressPersonal
-
Street name
- getStreet() - Method in class com.onlinepayments.domain.MandateAddress
-
Streetname.
- getStreet() - Method in class com.onlinepayments.domain.MandateAddressResponse
-
Streetname
- getSubsequentcardPaymentMethodSpecificInput() - Method in class com.onlinepayments.domain.SubsequentPaymentRequest
-
Object containing the specific input details for subsequent card payments
- getSubsequentPaymentProduct5001SpecificInput() - Method in class com.onlinepayments.domain.SubsequentPaymentRequest
-
specific data required for Bizum subsequent payment
- getSubsequentType() - Method in class com.onlinepayments.domain.RedirectPaymentProduct5001SpecificInput
-
Determines the type of the subsequent that will be used.
- getSubsequentType() - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
-
Determines the type of the subsequent that will be used.
- getSubsequentType() - Method in class com.onlinepayments.domain.SubsequentPaymentProduct5001SpecificInput
-
Determines the type of the subsequent that will be used.
- getSurchargeAmount() - Method in class com.onlinepayments.domain.Surcharge
-
Object containing amount and ISO currency code attributes
- getSurchargeAmount() - Method in class com.onlinepayments.domain.SurchargeSpecificInput
-
Object containing amount and ISO currency code attributes
- getSurchargeAmount() - Method in class com.onlinepayments.domain.SurchargeSpecificOutput
-
Object containing amount and ISO currency code attributes
- getSurchargeMode() - Method in class com.onlinepayments.domain.SurchargeForPaymentLink
-
The surcharge mode which defines how a merchant will apply surcharging.
- getSurchargeProductTypeId() - Method in class com.onlinepayments.domain.SurchargeRate
-
The name of the applicable surcharge rates for the relevant payment product
- getSurchargeProductTypeVersion() - Method in class com.onlinepayments.domain.SurchargeRate
-
A specific version identifier of the surcharge rates as applied for this request
- getSurchargeRate() - Method in class com.onlinepayments.domain.Surcharge
-
A summary of surcharge details used in the calculation of the surcharge amount.
- getSurchargeRate() - Method in class com.onlinepayments.domain.SurchargeSpecificOutput
-
A summary of surcharge details used in the calculation of the surcharge amount.
- getSurcharges() - Method in class com.onlinepayments.domain.CalculateSurchargeResponse
- getSurchargeSpecificInput() - Method in class com.onlinepayments.domain.Order
-
Object containing specific input required to apply surcharging to an order.
- getSurchargeSpecificInput() - Method in class com.onlinepayments.domain.PaymentLinkOrderInput
-
Object containing details how surcharge will be applied to a payment link.
- getSurchargeSpecificOutput() - Method in class com.onlinepayments.domain.CaptureOutput
-
Object containing specific surcharging attributes applied to an order.
- getSurchargeSpecificOutput() - Method in class com.onlinepayments.domain.PaymentLinkOrderOutput
-
Object containing details how surcharge will be applied to a payment link.
- getSurchargeSpecificOutput() - Method in class com.onlinepayments.domain.PaymentOutput
-
Object containing specific surcharging attributes applied to an order.
- getSurname() - Method in class com.onlinepayments.domain.AirlinePassenger
-
Surname of the passenger This field is used by the following payment products: cards, 840
- getSurname() - Method in class com.onlinepayments.domain.LoanRecipient
-
Surname of the recipient of the loan.
- getSurname() - Method in class com.onlinepayments.domain.MandatePersonalName
-
Surname(s) or last name(s) of the customer.
- getSurname() - Method in class com.onlinepayments.domain.MandatePersonalNameResponse
-
Surname(s) or last name(s) of the customer.
- getSurname() - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount
-
Surname of the PayPal account holder
- getSurname() - Method in class com.onlinepayments.domain.PersonalName
-
Surname(s) or last name(s) of the customer
- getSurname() - Method in class com.onlinepayments.domain.PersonalNameToken
- getSurnamePrefix() - 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
- getTargetAmount() - Method in class com.onlinepayments.domain.DccProposal
-
Object containing amount and ISO currency code attributes
- getTaxAmount() - Method in class com.onlinepayments.domain.OrderLineDetails
-
Tax on the line item, with the last two digits implied as decimal places
- getTaxes() - Method in class com.onlinepayments.domain.AirlineFlightLeg
-
Taxes for this leg of the trip This field is used by the following payment products: 840
- getTermsAndConditions() - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
- getThreeDSecure() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Object containing specific data regarding 3-D Secure
- getThreeDSecure() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Object containing specific data regarding 3-D Secure
- getThreeDSecure() - Method in class com.onlinepayments.domain.MobilePaymentProduct320SpecificInput
-
Object containing specific data regarding 3-D Secure
- getThreeDSecure() - Method in class com.onlinepayments.domain.PaymentProduct130SpecificInput
-
Object containing specific data regarding 3-D Secure
- getThreeDSecureResults() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
3D Secure results object
- getThreeDSecureResults() - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput
-
3D Secure results object
- getThreeDSecureVersion() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
The 3-D Secure version used for the authentication.
- getThreeDServerTransactionId() - Method in class com.onlinepayments.domain.MobileThreeDSecureChallengeParameters
-
The 3-D Secure version 2 transaction ID that is used for the 3D Authentication
- getTicketCurrency() - Method in class com.onlinepayments.domain.AirlineData
-
Three-letter ISO currency code representing the currency in which ticket purchase amount is expressed.
- getTicketDeliveryMethod() - Method in class com.onlinepayments.domain.AirlineData
-
Deprecated.This field is not used by any payment product Delivery method of the ticket
- getTicketNumber() - 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
- getTimezoneOffsetUtcMinutes() - Method in class com.onlinepayments.domain.CustomerDevice
-
Offset in minutes of timezone of the client versus the UTC.
- getTitle() - 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)
- getTitle() - Method in class com.onlinepayments.domain.MandatePersonalInformation
-
Object containing the title of the customer (Mr, Miss or Mrs)
- getTitle() - Method in class com.onlinepayments.domain.MandatePersonalInformationResponse
-
Object containing the title of the customer (Mr, Miss or Mrs)
- getTitle() - Method in class com.onlinepayments.domain.PersonalName
-
Title of customer
- getToken() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
ID of the token to use to create the payment.
- getToken() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
ID of the token to use to create the payment.
- getToken() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
-
ID of the token.
- getToken() - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput
-
ID of the token
- getToken() - Method in class com.onlinepayments.domain.CardSource
-
An identifier that represents card details that have been previously stored
- getToken() - Method in class com.onlinepayments.domain.CreatedTokenResponse
-
ID of the token
- getToken() - Method in class com.onlinepayments.domain.DccCardSource
-
An identifier that represents card details that have previously been stored
- getToken() - Method in class com.onlinepayments.domain.GetHostedTokenizationResponse
- getToken() - Method in class com.onlinepayments.domain.PaymentCreationOutput
-
ID of the token.
- getToken() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
ID of the token to use to create the payment.
- getToken() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput
-
ID of the token.
- getToken() - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
-
Deprecated.ID of the token to use to create the payment.
- getToken() - Method in class com.onlinepayments.domain.WebhooksEvent
- getToken(String) - Method in class com.onlinepayments.merchant.tokens.TokensClient
-
Resource /v2/{merchantId}/tokens/{tokenId} - Get token
- getToken(String) - Method in interface com.onlinepayments.merchant.tokens.TokensClientInterface
-
Resource /v2/{merchantId}/tokens/{tokenId} - Get token
- getToken(String, CallContext) - Method in class com.onlinepayments.merchant.tokens.TokensClient
-
Resource /v2/{merchantId}/tokens/{tokenId} - Get token
- getToken(String, CallContext) - Method in interface com.onlinepayments.merchant.tokens.TokensClientInterface
-
Resource /v2/{merchantId}/tokens/{tokenId} - Get token
- getTokenizationSucceeded() - Method in class com.onlinepayments.domain.PaymentCreationOutput
-
Indicates if tokenization was successful or not.
- getTokenize() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Indicates if this transaction should be tokenized true - Tokenize the transaction.
- getTokenize() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Indicates if this transaction should be tokenized true - Tokenize the transaction.
- getTokenize() - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput
-
Indicates if this transaction should be tokenized true - Tokenize the transaction. false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
- getTokens() - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest
-
String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
- getTokens() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
- getTokens() - Method in class com.onlinepayments.domain.SessionRequest
-
List of previously stored tokens linked to the customer that wants to checkout.
- getTokenStatus() - Method in class com.onlinepayments.domain.CreatedTokenResponse
-
This is the status of the token in the hosted tokenization session.
- getTokenStatus() - Method in class com.onlinepayments.domain.GetHostedTokenizationResponse
-
This is the status of the token in the hosted tokenization session.
- getTooltip() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints
-
Object that contains an optional tooltip to assist the customer
- getTotalAmount() - Method in class com.onlinepayments.domain.Surcharge
-
Object containing amount and ISO currency code attributes
- getTotalAmountPaid() - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
- getTotalAmountPaid() - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
- getTotalAmountPaid() - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
- getTotalAmountPaid() - Method in class com.onlinepayments.domain.RefundRedirectMethodSpecificOutput
- getTotalAmountRefunded() - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
- getTotalAmountRefunded() - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
- getTotalAmountRefunded() - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
- getTotalAmountRefunded() - Method in class com.onlinepayments.domain.RefundRedirectMethodSpecificOutput
- getTotalFare() - Method in class com.onlinepayments.domain.AirlineData
-
Total fare for all legs on the ticket, excluding taxes and fees.
- getTotalFee() - Method in class com.onlinepayments.domain.AirlineData
-
Total fee for all legs on the ticket.
- getTotalNumberOfPayments() - Method in class com.onlinepayments.domain.MultiplePaymentInformation
-
Total number of payments.
- getTotalTaxes() - Method in class com.onlinepayments.domain.AirlineData
-
Total taxes for all legs on the ticket.
- getTransaction() - Method in class com.onlinepayments.domain.CurrencyConversionRequest
- getTransactionChannel() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Indicates the channel via which the payment is created.
- getTransactionChannel() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Indicates the channel via which the payment is created.
- getTransactionChannel() - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput
-
Indicates the channel via which the payment is created.
- getTransactionType() - Method in class com.onlinepayments.domain.OrderTypeInformation
-
Identifies the type of transaction being authenticated.
- getTravelAgencyName() - Method in class com.onlinepayments.domain.AirlineData
-
Name of the travel agency issuing the ticket.
- getTravelData() - Method in class com.onlinepayments.domain.OtherDetails
-
Information used by the following PaymentProducts [5110,5111,5112,5125,3104,3107,3108,3109].
- getTrialBilling() - Method in class com.onlinepayments.domain.ApplePayRecurringPaymentRequest
-
Object containing specific data regarding Apple Pay recurring payment.
- getType() - Method in class com.onlinepayments.domain.AmountBreakdown
-
Type of the amount.
- getType() - Method in class com.onlinepayments.domain.PaymentLinkEvent
-
The type of event that occurred.
- getType() - Method in class com.onlinepayments.domain.PaymentProductField
- getType() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement
-
The type of the display element.
- getType() - Method in class com.onlinepayments.domain.PaymentProductFieldFormElement
-
Type of form element to be used.
- getType() - 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
- getType() - Method in class com.onlinepayments.domain.Shipping
-
Indicates the merchandise delivery timeframe.
- getType() - Method in class com.onlinepayments.domain.ShippingMethod
-
Shipping method type
- getType() - Method in class com.onlinepayments.domain.WebhooksEvent
- getTypeInformation() - Method in class com.onlinepayments.domain.AdditionalOrderInput
-
Object that holds the purchase and usage type indicators
- getUniqueMandateReference() - Method in class com.onlinepayments.domain.CreateMandateRequest
-
The unique identifier of the mandate
- getUniqueMandateReference() - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl
-
The unique identifier of the mandate
- getUniqueMandateReference() - Method in class com.onlinepayments.domain.MandateResponse
-
The unique identifier of the mandate
- getUnit() - Method in class com.onlinepayments.domain.OrderLineDetails
-
Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
- getUnscheduledCardOnFileRequestor() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
-
Indicates which party initiated the unscheduled recurring transaction.
- getUnscheduledCardOnFileRequestor() - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase
-
Indicates which party initiated the unscheduled recurring transaction.
- getUnscheduledCardOnFileSequenceIndicator() - 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.
- getUnscheduledCardOnFileSequenceIndicator() - 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.
- getUrl() - Method in class com.onlinepayments.domain.SendTestRequest
-
Url to which the dummy webhook would be sent.
- getUrlIntent() - Method in class com.onlinepayments.domain.PaymentProduct3012
-
Contains URL intent that can be used as the link of an "open the app" button on a device
- getUsecase() - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure
-
Indicates the type of payment for which an authentication is requested
- getUserAgent() - Method in class com.onlinepayments.domain.CustomerDevice
-
User-Agent of the client device/browser from the HTTP Headers.
- getUsername() - Method in class com.onlinepayments.ProxyConfiguration
- getUsesRedirectionTo3rdParty() - Method in class com.onlinepayments.domain.PaymentProduct
-
Indicates whether the payment product requires redirection to a third party to complete the payment.
- getUtcTimestamp() - Method in class com.onlinepayments.domain.CustomerAccountAuthentication
-
Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
- getUtcTimestamp() - Method in class com.onlinepayments.domain.ThreeDSecureData
-
Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
- getValidationRules() - Method in class com.onlinepayments.domain.CreditCardSpecificInputHostedTokenization
- getValidators() - Method in class com.onlinepayments.domain.PaymentProductFieldDataRestrictions
-
Object containing the details of the validations on the field
- getValue() - Method in class com.onlinepayments.communication.RequestHeader
- getValue() - Method in class com.onlinepayments.communication.RequestParam
- getValue() - Method in class com.onlinepayments.communication.ResponseHeader
- getValue() - Method in class com.onlinepayments.domain.AccountOnFileAttribute
-
Value of the key or property
- getValue() - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement
-
the value of the display element.
- getValue() - Method in class com.onlinepayments.domain.ValueMappingElement
-
Value corresponding to the key
- getValueMapping() - Method in class com.onlinepayments.domain.PaymentProductFieldFormElement
-
Deprecated.This field is not used by any payment product
- getValues() - Method in class com.onlinepayments.communication.MultipartFormDataObject
- getVariant() - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest
-
It is possible to upload multiple templates of your payment pages using the Merchant Portal.
- getVariant() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput
-
It is possible to upload multiple templates of your payment pages using the Merchant Portal.
- getVariant() - Method in class com.onlinepayments.domain.HostedCheckoutSpecificOutput
-
It is possible to upload multiple templates of your payment pages using the Merchant Portal.
- getVatId() - Method in class com.onlinepayments.domain.RedirectPaymentProduct3302SpecificInput
-
Tax identification number used to validate a business's VAT compliance.
- getVersion() - Method in class com.onlinepayments.domain.ShoppingCartExtension
- getVersion() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
3D Secure Protocol version used during this transaction.
- getWebhookUrl() - Method in class com.onlinepayments.domain.Feedbacks
-
The URL where the webhook will be dispatched for all status change events related to this payment.
- getWipMerchantAuthenticationMethod() - Method in class com.onlinepayments.domain.PaymentProduct3012SpecificInput
-
Indicates how the cardholder was authenticated to the Merchant Wallet in the context of the transaction to which the BEPAF is attached 01 = Username/password or PIN login successfully performed by cardholder. 02 = Authentication through Secret/Private Key in Secure Hardware Solution was successfully performed. 04 = Authentication through Secret/Private Key in Secure Software Solution (for example, mobile App) was successfully performed. 08 = Location-based Authentication was successfully performed. 10 = Environmental Authentication in Secure Software Solution (mobile App) was successfully performed. 20 = Behavioral Analysis was successfully performed. 40 = Biometrics Authentication was successfully performed. 80 = Out of band user authentication was successfully performed.
- getWorkPhoneNumber() - Method in class com.onlinepayments.domain.ContactDetails
-
International version of the work phone number of the customer including the leading + (i.e.
- getXid() - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData
-
The transaction ID that is used for the 3D Authentication
- getXid() - Method in class com.onlinepayments.domain.ThreeDSecureResults
-
Transaction ID for the Authentication
- getZip() - Method in class com.onlinepayments.domain.Address
-
Zip code
- getZip() - Method in class com.onlinepayments.domain.AddressPersonal
-
Zip code
- getZip() - Method in class com.onlinepayments.domain.LoanRecipient
-
Zip code of the recipient of the loan
- getZip() - Method in class com.onlinepayments.domain.MandateAddress
-
Zip code.
- getZip() - Method in class com.onlinepayments.domain.MandateAddressResponse
-
Zip code
- GiftCardPurchase - Class in com.onlinepayments.domain
- GiftCardPurchase() - Constructor for class com.onlinepayments.domain.GiftCardPurchase
- GPayThreeDSecure - Class in com.onlinepayments.domain
- GPayThreeDSecure() - Constructor for class com.onlinepayments.domain.GPayThreeDSecure
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form