W-Index (onlinepayments-sdk-java 4.18.0 API)

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

W

Webhooks - Class in com.onlinepayments.webhooks: Online Payments platform factory for several webhooks components.
WebhooksEvent - Class in com.onlinepayments.domain
WebhooksEvent() - Constructor for class com.onlinepayments.domain.WebhooksEvent
WebhooksHelper - Class in com.onlinepayments.webhooks: Online Payments platform webhooks helper.
WebhooksHelper(Marshaller, SecretKeyStore) - Constructor for class com.onlinepayments.webhooks.WebhooksHelper
WebhooksHelperBuilder - Class in com.onlinepayments.webhooks: Builder for a WebhooksHelper object.
WebhooksHelperBuilder() - Constructor for class com.onlinepayments.webhooks.WebhooksHelperBuilder
withAcceptedByUser(Boolean) - Method in class com.onlinepayments.domain.CurrencyConversion: Dynamic Currency Conversion(DCC) Proposal accepted by user
withAcceptedByUser(Boolean) - Method in class com.onlinepayments.domain.CurrencyConversionInput: Dynamic Currency Conversion(DCC) Proposal accepted by user
withAcceptHeader(String) - Method in class com.onlinepayments.domain.CustomerDevice: The accept-header of the customer client from the HTTP Headers.
withAccount(CustomerAccount) - Method in class com.onlinepayments.domain.Customer: Object containing data related to the account the customer has with you
withAccountHolderName(String) - Method in class com.onlinepayments.domain.CustomerBankAccount: Name of account holder
withAccountId(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Username with which the PayPal account holder has registered at PayPal
withAccountNumber(String) - Method in class com.onlinepayments.domain.LoanRecipient: Should be filled with the last 10 digits of the bank account number of the recipient of the loan.
withAccountOnFile(AccountOnFile) - Method in class com.onlinepayments.domain.PaymentProductGroup
withAccountsOnFile(List<AccountOnFile>) - Method in class com.onlinepayments.domain.PaymentProduct: List of tokens for that payment product
withAccountType(String) - Method in class com.onlinepayments.domain.Customer: Type of the customer account that is used to place this order.
withAcquiredAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing amount and ISO currency code attributes
withAcquiredAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing amount and ISO currency code attributes
withAcquirerExemption(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Indicates the Acquirer TRA exemption
withAcquirerInformation(AcquirerInformation) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Information about the acquirer used to process the transaction
withAcquirerSelectionInformation(AcquirerSelectionInformation) - Method in class com.onlinepayments.domain.AcquirerInformation: Information about the acquirer selection
withAcsTransactionId(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Identifier of the authenticated transaction at the ACS/Issuer.
withAcsTransactionId(String) - Method in class com.onlinepayments.domain.ThreeDSecureData: The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
withAcsTransactionId(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Authenticated Transaction Identifier at the ACS/Issuer.
withActionType(String) - Method in class com.onlinepayments.domain.MandateMerchantAction: Action merchants needs to take in the online mandate process.
withActionType(String) - Method in class com.onlinepayments.domain.MerchantAction: Action merchants needs to take in the online payment process.
withAdditionalInfo(String) - Method in class com.onlinepayments.domain.Address: Second line of street or additional address information
withAdditionalInfo(String) - Method in class com.onlinepayments.domain.AddressPersonal: Second line of street or additional address information
withAdditionalInput(AdditionalOrderInput) - Method in class com.onlinepayments.domain.Order: Object containing additional input on the order
withAdditionalRequestHeader(RequestHeader) - Method in class com.onlinepayments.MetaDataProviderBuilder: Adds an additional request header.
withAddress(AddressPersonal) - Method in class com.onlinepayments.domain.Shipping: Object containing address information
withAddressIndicator(String) - Method in class com.onlinepayments.domain.Shipping: Indicates shipping method chosen for the transaction.
withAddressSelectionAtPayPal(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput: Indicates whether to use PayPal Express Checkout Shortcut.
withAdValoremRate(Float) - Method in class com.onlinepayments.domain.SurchargeRate: A percentage rate defined on a merchant's configuration used in the calculation of a surcharge amount.
withAgentNumericCode(String) - Method in class com.onlinepayments.domain.AirlineData: Numeric code identifying the agent This field is used by the following payment products: 840
withAirlineClass(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Reservation Booking Designator This field is used by the following payment products: cards
withAirlineData(AirlineData) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object that holds airline specific data
withAirlineLoyaltyStatus(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Airline loyalty program level for the passenger on the itinerary.
withAlias(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: An alias for the mandate.
withAlias(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: An alias for the mandate.
withAlias(String) - Method in class com.onlinepayments.domain.MandateResponse: An alias for the mandate.
withAlias(String) - Method in class com.onlinepayments.domain.TokenCard: An alias for the token.
withAlias(String) - Method in class com.onlinepayments.domain.TokenEWallet: Deprecated: This field is not used by any payment product An alias for the token.
withAllowDynamicLinking(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
withAllowDynamicLinking(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: * true - Default - Allows subsequent payments to use PSD2 dynamic linking from this payment (including Card On File).
withAllowedNumberOfPaymentAttempts(Integer) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: The maximum number of times a customer can try to pay before the payment is definitely declined.
withAllowedValues(List<String>) - Method in class com.onlinepayments.domain.FixedListValidator
withAllowsRecurring(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct: Indicates if the product supports recurring payments * true - This payment product supports recurring payments * false - This payment product does not support recurring transactions and can only be used for one-off payments
withAllowsTokenization(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct: Indicates if the payment details can be tokenized for future re-use * true - Payment details from payments done with this payment product can be tokenized for future re-use * false - Payment details from payments done with this payment product can not be tokenized
withAlwaysShow(Boolean) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: * true - Indicates that this field is advised to be captured to increase the success rates even-though it isn't marked as required.
withAmount(Long) - Method in class com.onlinepayments.domain.AmountBreakdown: Amount in cents and always having 2 decimals
withAmount(Long) - Method in class com.onlinepayments.domain.AmountOfMoney: Amount in the smallest currency unit, i.e.: * EUR is a 2-decimals currency, the value 1234 will result in EUR 12.34 * KWD is a 3-decimals currency, the value 1234 will result in KWD 1.234 * JPY is a zero-decimal currency, the value 1234 will result in JPY 1234
withAmount(Long) - Method in class com.onlinepayments.domain.CapturePaymentRequest: Here you can specify the amount that you want to capture (specified in cents, where single digit currencies are presumed to have 2 digits).
withAmount(Long) - 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
withAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentLinkOrderInput: Object containing amount and ISO currency code attributes
withAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentLinkOrderOutput: Object containing amount and ISO currency code attributes
withAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Transaction: Object containing amount and ISO currency code attributes
withAmount(Long) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Whole amount in cents (not containing any decimals)
withAmount(Long) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Whole amount in cents (not containing any decimals)
withAmount(Long) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: Amount in cents and always having 2 decimals
withAmount(Long) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Whole amount in cents (not containing any decimals)
withAmount(Long) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Whole amount in cents (not containing any decimals)
withAmountBreakdown(List<AmountBreakdown>) - Method in class com.onlinepayments.domain.ShoppingCart: Deprecated: Use order.shipping.shippingCost for shipping cost.
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CalculateSurchargeRequest: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CancelPaymentRequest: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.GiftCardPurchase: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.LineItem: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.OperationOutput: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.Order: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentContext: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.PayoutOutput: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.RefundOutput: Object containing amount and ISO currency code attributes
withAmountOfMoney(AmountOfMoney) - Method in class com.onlinepayments.domain.RefundRequest: Object containing amount and ISO currency code attributes
withAmountPaid(Long) - Method in class com.onlinepayments.domain.CaptureOutput: Amount that has been paid.
withAmountPaid(Long) - Method in class com.onlinepayments.domain.PaymentOutput: Amount that has been paid.
withAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundOutput
withAPIEndpoint(URI) - Method in class com.onlinepayments.CommunicatorBuilder: Sets the Online Payments platform API endpoint URI to use.
withApiEndpoint(URI) - Method in class com.onlinepayments.CommunicatorConfiguration
withApiKeyId(String) - Method in class com.onlinepayments.CommunicatorConfiguration
withAppliedExemption(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
withAppliedExemption(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Exemption requested and applied in the authorization
withAppSwitchLink(String) - Method in class com.onlinepayments.domain.PaymentProduct5404: Contains a application switch url that should open WeChat Pay application in mobile device (intended to be used by a device with the WeChat Pay app)
withArrivalAirport(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Arrival airport/city code This field is used by the following payment products: 840
withArrivalTime(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The arrival time in the local time zone Format: HH:MM This field is used by the following payment products: 840
withAskConsumerConsent(Boolean) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Indicate if the tokenization form should contain a checkbox asking the user to give consent for storing their information for future payments.
withAssetUrl(String) - Method in class com.onlinepayments.domain.SessionResponse: The datacenter-specific base url for assets.
withAttributeKey(String) - Method in class com.onlinepayments.domain.LabelTemplateElement: Name of the attribute that is shown to the customer on selection pages or screens
withAttributes(List<AccountOnFileAttribute>) - Method in class com.onlinepayments.domain.AccountOnFile
withAuthenticatedAmount(Long) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Allows amount to be authenticated to be different from amount authorized.
withAuthentication(CustomerAccountAuthentication) - Method in class com.onlinepayments.domain.CustomerAccount: Object containing data on the authentication used by the customer to access their account
withAuthenticationAmount(Long) - Method in class com.onlinepayments.domain.ThreeDSecure: Allows amount to be authenticated to be different from amount authorized.
withAuthenticationStatus(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: One-letter authentication status returned by DS.
withAuthenticator(Authenticator) - Method in class com.onlinepayments.CommunicatorBuilder: Sets the Authenticator to use.
withAuthorisationCode(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Card Authorization code as returned by the acquirer
withAuthorisationCode(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Card Authorization code as returned by the acquirer
withAuthorisationCode(String) - Method in class com.onlinepayments.domain.PaymentProduct5001SpecificOutput: The reference returned by redsys to identify the transaction
withAuthorisationCode(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Card Authorization code as returned by the acquirer
withAuthorizationMode(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Determines the type of the authorization that will be used.
withAuthorizationMode(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Determines the type of the authorization that will be used.
withAuthorizationMode(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput: Determines the type of the authorization that will be used.
withAuthorizationMode(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Determines the type of the authorization that will be used.
withAuthorizationMode(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: Determines the type of the authorization that will be used.
withAuthorizationType(AuthorizationType) - Method in class com.onlinepayments.CommunicatorConfiguration
withAvsResult(String) - Method in class com.onlinepayments.domain.CardFraudResults: Result of the Address Verification Service checks.
withBankAccountIban(BankAccountIban) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing IBAN information
withBaseAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.DccProposal: Object containing amount and ISO currency code attributes
withBic(String) - Method in class com.onlinepayments.domain.CustomerBankAccount: Bank Identification Code
withBillingAddress(Address) - Method in class com.onlinepayments.domain.Customer: Object containing billing address details
withBillingAddress(Address) - Method in class com.onlinepayments.domain.CustomerToken: Object containing billing address details
withBillingAddress(Address) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Object containing billing address details
withBin(String) - Method in class com.onlinepayments.domain.CardEssentials: The first digits of the credit card number from left to right with a minimum of 6 digits.
withBin(String) - Method in class com.onlinepayments.domain.GetIINDetailsRequest: The first digits of the credit card number from left to right with a minimum of 6 digits.
withBlackListData(String) - Method in class com.onlinepayments.domain.FraudFields: Additional black list input
withBrand(String) - Method in class com.onlinepayments.domain.PaymentProduct5100SpecificInput: Indicate whether to use a specific Cpay brand.
withBrand(String) - Method in class com.onlinepayments.domain.PaymentProduct5402SpecificOutput: The specific meal voucher brand used for the transaction
withBrowserData(BrowserData) - Method in class com.onlinepayments.domain.CustomerDevice: Object containing information regarding the browser of the customer
withBuyerCompliantBankMessage(String) - Method in class com.onlinepayments.domain.PaymentProduct3208SpecificOutput: This field indicates the text that must be returned and shown to the buyer to be compliant with the law regulating this payment product.
withBuyerCompliantBankMessage(String) - Method in class com.onlinepayments.domain.PaymentProduct3209SpecificOutput: This field indicates the text that must be returned and shown to the buyer to be compliant with the law regulating this payment product.
withCaptureOutput(CaptureOutput) - Method in class com.onlinepayments.domain.Capture: Object containing capture details
withCaptureOutput(CaptureOutput) - Method in class com.onlinepayments.domain.CaptureResponse: Object containing capture details
withCaptures(List<Capture>) - Method in class com.onlinepayments.domain.CapturesResponse: The list of all captures performed on the requested payment.
withCard(Card) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing card details
withCard(CardEssentials) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Object containing card details
withCard(Card) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: Object containing card details
withCard(SurchargeCalculationCard) - Method in class com.onlinepayments.domain.CardSource: An object containing card number and payment product id, which is used to determine surcharge product type
withCard(CardWithoutCvv) - Method in class com.onlinepayments.domain.CompletePaymentCardPaymentMethodSpecificInput
withCard(CardWithoutCvv) - Method in class com.onlinepayments.domain.CreatedTokenResponse
withCard(TokenCardSpecificInput) - Method in class com.onlinepayments.domain.CreateTokenRequest: Object containing the token details for a card
withCard(CardInfo) - Method in class com.onlinepayments.domain.DccCardSource
withCard(Card) - Method in class com.onlinepayments.domain.TokenData: Object containing card details
withCard(TokenCard) - Method in class com.onlinepayments.domain.TokenResponse: Object containing card details
withCardholderName(String) - Method in class com.onlinepayments.domain.Card: The card holder's name on the card.
withCardholderName(String) - Method in class com.onlinepayments.domain.CardWithoutCvv: The card holder's name on the card.
withCardholderName(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: Card holder's name on the card.
withCardNumber(String) - Method in class com.onlinepayments.domain.Card: The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
withCardNumber(String) - Method in class com.onlinepayments.domain.CardEssentials: The masked credit/debit card number
withCardNumber(String) - Method in class com.onlinepayments.domain.CardInfo: Provide the complete credit/debit card number (also known as the PAN) for the most accurate results.
withCardNumber(String) - Method in class com.onlinepayments.domain.CardWithoutCvv: The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
withCardNumber(String) - Method in class com.onlinepayments.domain.SurchargeCalculationCard: The complete credit/debit card number (also know as the PAN) The card number is always obfuscated in any of our responses
withCardOnFileRecurringExpiration(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: The end date of the last scheduled payment in a series of transactions.
withCardOnFileRecurringFrequency(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Period of payment occurrence for recurring and installment payments.
withCardPaymentMethodSpecificInput(CompletePaymentCardPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CompletePaymentRequest
withCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputBase) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for card payments
withCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for card payments
withCardPaymentMethodSpecificInput(CardPaymentMethodSpecificInputForHostedCheckout) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Object containing card payment specific data for hosted checkout
withCardPaymentMethodSpecificOutput(CardPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the card payment method details
withCardPaymentMethodSpecificOutput(CardPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the card payment method details
withCardPayoutMethodSpecificInput(CardPayoutMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object containing the payout details for a card
withCardRefundMethodSpecificOutput(RefundCardMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
withCardSource(CardSource) - Method in class com.onlinepayments.domain.CalculateSurchargeRequest: Contains elements from which card number can be obtained.
withCardSource(DccCardSource) - Method in class com.onlinepayments.domain.CurrencyConversionRequest
withCardType(String) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: The card's type as categorised by the payment method.
withCardType(String) - Method in class com.onlinepayments.domain.IINDetail: The card's type as categorised by the payment method.
withCardWithoutCvv(CardWithoutCvv) - Method in class com.onlinepayments.domain.TokenCardData
withCarrierCode(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: IATA carrier code This field is used by the following payment products: cards, 840
withCategory(String) - Method in class com.onlinepayments.domain.APIError: Category the error belongs to.
withCavv(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
withCavv(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Cardholder Authentication Verification Value.
withCavvAlgorithm(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
withChallengeCanvasSize(String) - Method in class com.onlinepayments.domain.GPayThreeDSecure: Dimensions of the challenge window that potentially will be displayed to the customer.
withChallengeCanvasSize(String) - Method in class com.onlinepayments.domain.ThreeDSecure: Dimensions of the challenge window that potentially will be displayed to the customer.
withChallengeCanvasSize(String) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Dimensions of the challenge window that potentially will be displayed to the customer.
withChallengeIndicator(String) - Method in class com.onlinepayments.domain.GPayThreeDSecure: Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
withChallengeIndicator(String) - Method in class com.onlinepayments.domain.ThreeDSecure: Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
withChallengeIndicator(String) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Allows you to indicate if you want the customer to be challenged for extra security on this transaction.
withChallengeIndicator(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Challenge Indicator used for this transaction.
withChangeDate(String) - Method in class com.onlinepayments.domain.CustomerAccount: The last date (YYYYMMDD) on which the customer made changes to their account with you.
withChangedDuringCheckout(Boolean) - 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 The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
withCheckInDate(String) - Method in class com.onlinepayments.domain.LodgingData: The date the guest checks into (or plans to check in to) the facility.
withCity(String) - Method in class com.onlinepayments.domain.Address: City
withCity(String) - Method in class com.onlinepayments.domain.AddressPersonal: City
withCity(String) - Method in class com.onlinepayments.domain.MandateAddress: City Required for Create mandate and Create payment calls.
withClientApiUrl(String) - Method in class com.onlinepayments.domain.SessionResponse: The datacenter-specific base url for client requests.
withClientMetaInfo(String) - Method in class com.onlinepayments.Client: Returns a new Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
withClientMetaInfo(String) - Method in interface com.onlinepayments.ClientInterface: Returns a new Client which uses the passed meta data for the X-GCS-ClientMetaInfo header.
withClientSessionId(String) - Method in class com.onlinepayments.domain.SessionResponse: The identifier of the session that has been created.
withCoBrands(List<IINDetail>) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: List of IIN details
withCode(String) - Method in class com.onlinepayments.domain.AirlineData: Airline numeric code This field is used by the following payment products: 840
withCode(String) - Method in class com.onlinepayments.domain.APIError: Deprecated: Use errorCode instead.
withColorDepth(Integer) - Method in class com.onlinepayments.domain.BrowserData: ColorDepth in bits.
withCompanyInformation(CompanyInformation) - Method in class com.onlinepayments.domain.Customer: Object containing company information
withCompanyInformation(CompanyInformation) - Method in class com.onlinepayments.domain.CustomerToken: Object containing company information
withCompanyName(String) - Method in class com.onlinepayments.domain.MandateCustomer: Name of company, as a customer
withCompanyName(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Name of the company in case the PayPal account is owned by a business
withComputedToken(String) - Method in class com.onlinepayments.domain.ExternalTokenLinked: The computed token
withConjunctionTicket(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage This field is used by the following payment products: 840
withConnection(Connection) - Method in class com.onlinepayments.CommunicatorBuilder: Sets the Connection to use.
withConnectionRequestTimeout(int) - Method in class com.onlinepayments.CommunicatorConfiguration
withConnectTimeout(int) - Method in class com.onlinepayments.CommunicatorConfiguration
withContactDetails(ContactDetails) - Method in class com.onlinepayments.domain.Customer: Object containing contact details like email address and phone number
withContactDetails(MandateContactDetails) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing contact details like email address and phone number
withCountryCode(String) - Method in class com.onlinepayments.domain.Address: ISO 3166-1 alpha-2 country code
withCountryCode(String) - Method in class com.onlinepayments.domain.AddressPersonal: ISO 3166-1 alpha-2 country code
withCountryCode(String) - Method in class com.onlinepayments.domain.CardEssentials: ISO 3166-1 alpha-2 country code
withCountryCode(String) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: The ISO 3166-1 alpha-2 country code of the country where the card was issued.
withCountryCode(String) - Method in class com.onlinepayments.domain.MandateAddress: ISO 3166-1 alpha-2 country code.
withCountryCode(String) - Method in class com.onlinepayments.domain.PaymentContext: The country the payment takes place in
withCountryCode(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: ISO 3166-1 alpha-2 country code
withCountryCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: ISO 3166-1 alpha-2 country code of the transaction
withCountryCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: ISO 3166-1 alpha-2 country code of the transaction
withCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: ISO 3166-1 alpha-2 country code
withCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: ISO 3166-1 alpha-2 country code of the transaction
withCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: ISO 3166-1 alpha-2 country code of the transaction
withCountryCode(String) - Method in class com.onlinepayments.merchant.products.GetProductDirectoryParams: ISO 3166-1 alpha-2 country code
withCouponNumber(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The coupon number associated with this leg of the trip.
withCreateDate(String) - Method in class com.onlinepayments.domain.CustomerAccount: The date (YYYYMMDD) on which the customer created their account with you
withCreateDate(String) - Method in class com.onlinepayments.domain.PaymentAccountOnFile: The date (YYYYMMDD) when the payment account on file was first created.
withCreatedPaymentOutput(CreatedPaymentOutput) - Method in class com.onlinepayments.domain.GetHostedCheckoutResponse: This object will return the details of the payment after the payment is cancelled by the customer, rejected or authorized
withCreationOutput(PaymentCreationOutput) - Method in class com.onlinepayments.domain.CompletePaymentResponse: Object containing the details of the created payment.
withCreationOutput(PaymentCreationOutput) - Method in class com.onlinepayments.domain.CreatePaymentResponse: Object containing the details of the created payment.
withCreditCardSpecificInput(CreditCardSpecificInputHostedTokenization) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest
withCryptogram(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: The 3D secure online payment cryptogram.
withCurrencyCode(String) - Method in class com.onlinepayments.domain.AmountOfMoney: Three-letter ISO currency code representing the currency for the amount
withCurrencyCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Three-letter ISO currency code representing the currency for the amount
withCurrencyCode(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Three-letter ISO currency code representing the currency for the amount
withCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: Three-letter ISO currency code representing the currency for the amount
withCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Three-letter ISO currency code representing the currency for the amount
withCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Three-letter ISO currency code representing the currency for the amount
withCurrencyCode(String) - Method in class com.onlinepayments.merchant.products.GetProductDirectoryParams: Three-letter ISO currency code representing the currency of the transaction
withCurrencyConversion(CurrencyConversionInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput
withCurrencyConversion(CurrencyConversion) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
withCurrencyConversion(CurrencyConversion) - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
withCurrencyConversionSpecificInput(CurrencyConversionSpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for Dynamic Currency Conversion.
withCustom(String) - Method in class com.onlinepayments.domain.RedirectPaymentProduct840SpecificInput: Free text field that you can use to support reconciliation flow.
withCustomer(MandateCustomer) - Method in class com.onlinepayments.domain.CreateMandateRequest: Customer object containing customer specific inputs.
withCustomer(MandateCustomer) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Customer object containing customer specific inputs.
withCustomer(MandateCustomer) - Method in class com.onlinepayments.domain.MandateResponse: Customer object containing customer specific inputs.
withCustomer(Customer) - Method in class com.onlinepayments.domain.Order: Object containing the details of the customer
withCustomer(CustomerOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the details of the customer
withCustomer(CustomerToken) - Method in class com.onlinepayments.domain.TokenEWallet
withCustomerAccount(PaymentProduct840CustomerAccount) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Object containing the details of the PayPal account
withCustomerAccount(RefundPaymentProduct840CustomerAccount) - Method in class com.onlinepayments.domain.RefundPaymentProduct840SpecificOutput
withCustomerAccountStatus(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Status of the PayPal account * verified - PayPal has verified the funding means for this account * unverified - PayPal has not verified the funding means for this account
withCustomerAccountStatus(String) - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount
withCustomerAddress(Address) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Object containing billing address details
withCustomerAddressStatus(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Status of the customer's shipping address as registered by PayPal * none - Status is unknown at PayPal * confirmed - The address has been confirmed * unconfirmed - The address has not been confirmed
withCustomerAddressStatus(String) - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount
withCustomerBankAccount(CustomerBankAccount) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Data of customer bank account
withCustomerBankAccount(CustomerBankAccount) - Method in class com.onlinepayments.domain.RedirectPaymentProduct5406SpecificInput: Data of customer bank account
withCustomerBankAccount(CustomerBankAccount) - Method in class com.onlinepayments.domain.RedirectPaymentProduct5408SpecificInput: Data of customer bank account
withCustomerId(String) - Method in class com.onlinepayments.domain.SessionResponse: The session is built up around the customer in the form of the customerId.
withCustomerIpAddress(String) - Method in class com.onlinepayments.domain.FraudFields: Deprecated: Use order.customer.device.ipAddress instead.
withCustomerReference(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: The unique identifier of a customer
withCustomerReference(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: The unique identifier of a customer
withCustomerReference(String) - Method in class com.onlinepayments.domain.MandateResponse: The unique identifier of a customer
withCvv(String) - Method in class com.onlinepayments.domain.Card: Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.
withCvvMandatoryForExistingToken(Boolean) - Method in class com.onlinepayments.domain.CreditCardValidationRulesHostedTokenization: Determines whether the Card Verification Value must be provided for existing tokens.
withCvvMandatoryForNewToken(Boolean) - Method in class com.onlinepayments.domain.CreditCardValidationRulesHostedTokenization: Determines whether the Card Verification Value must be provided for new tokens.
withCvvResult(String) - Method in class com.onlinepayments.domain.CardFraudResults: Result of the Card Verification Value checks.
withData(TokenCardData) - Method in class com.onlinepayments.domain.TokenCard
withData(TokenData) - Method in class com.onlinepayments.domain.TokenCardSpecificInput: Object containing the token details for a card
withDataRestrictions(PaymentProductFieldDataRestrictions) - Method in class com.onlinepayments.domain.PaymentProductField: Object containing data restrictions that apply to this field, like minimum and/or maximum length
withDate(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Date of the leg Format: YYYYMMDD This field is used by the following payment products: cards, 840
withDateOfBirth(String) - Method in class com.onlinepayments.domain.LoanRecipient: The date of birth of the customer of the recipient of the loan.
withDateOfBirth(String) - Method in class com.onlinepayments.domain.PersonalInformation: The date of birth of the customer of the recipient of the loan.
withDateTime(String) - Method in class com.onlinepayments.domain.PaymentLinkEvent: The date and time the change occurred.
withDccEnabled(Boolean) - Method in class com.onlinepayments.domain.CurrencyConversionSpecificInput: Indicates if this transaction is Dynamic Currency Conversion (DCC) enabled.
withDccSessionId(String) - Method in class com.onlinepayments.domain.CurrencyConversionInput: Dynamic Currency Conversion(DCC) Session Id that was previously returned by rate enquiry (/dccrate).
withDccSessionId(String) - Method in class com.onlinepayments.domain.CurrencyConversionResponse: The identifier of the Dynamic Currency Conversion(DCC) session that has been created.
withDecryptedPaymentData(DecryptedPaymentData) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: The payment data if you do the decryption of the encrypted payment data yourself.
withDepartureTime(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The departure time in the local time at the departure airport Format: HH:MM This field is used by the following payment products: 840
withDescription(String) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: A note related to the created payment link.
withDescription(String) - Method in class com.onlinepayments.domain.LineItemInvoiceData: Shopping cart item description
withDescriptor(String) - Method in class com.onlinepayments.domain.OrderReferences: Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer.
withDetails(String) - Method in class com.onlinepayments.domain.PaymentLinkEvent: Details of the events.
withDetails(String) - Method in class com.onlinepayments.domain.ShippingMethod: Details about the shipping method
withDevice(CustomerDevice) - Method in class com.onlinepayments.domain.Customer: Object containing information on the device and browser of the customer
withDevice(CustomerDeviceOutput) - Method in class com.onlinepayments.domain.CustomerOutput: Object containing information on the device and browser of the customer
withDeviceFingerprint(String) - Method in class com.onlinepayments.domain.CustomerDevice: Device fingerprint used for fraud detection
withDirectoryServerTransactionId(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication Example: d4c849f8-24c6-4673-bf34-d0f822c81b16
withDisclaimerDisplay(String) - Method in class com.onlinepayments.domain.DccProposal: Card scheme disclaimer to present to the cardholder
withDisclaimerReceipt(String) - Method in class com.onlinepayments.domain.DccProposal: Card scheme disclaimer to print within cardholder receipt
withDiscount(Discount) - Method in class com.onlinepayments.domain.Order: Object to apply a discount to the total basket by adding a discount line.
withDiscountAmount(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: Discount on the line item, with the last two digits implied as decimal places
withDisplayElements(List<PaymentProductFieldDisplayElement>) - Method in class com.onlinepayments.domain.ValueMappingElement
withDisplayHints(AccountOnFileDisplayHints) - Method in class com.onlinepayments.domain.AccountOnFile: Object containing information for the client on how best to display this field
withDisplayHints(PaymentProductDisplayHints) - Method in class com.onlinepayments.domain.PaymentProduct: Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
withDisplayHints(PaymentProductFieldDisplayHints) - Method in class com.onlinepayments.domain.PaymentProductField: Object containing display hints for this field, like the order, mask, preferred keyboard
withDisplayHints(PaymentProductDisplayHints) - Method in class com.onlinepayments.domain.PaymentProductGroup: Object containing display hints like the order of the product when shown in a list, the name of the product and the logo
withDisplayHintsList(List<PaymentProductDisplayHints>) - Method in class com.onlinepayments.domain.PaymentProduct: List of display hints
withDisplayHintsList(List<PaymentProductDisplayHints>) - Method in class com.onlinepayments.domain.PaymentProductGroup: List of display hints
withDisplayOrder(Integer) - Method in class com.onlinepayments.domain.PaymentProductDisplayHints: Determines the order in which the payment products and groups should be shown (sorted ascending)
withDisplayOrder(Integer) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: The order in which the fields should be shown (ascending)
withDpan(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: The device specific PAN.
withDpan(String) - Method in class com.onlinepayments.domain.MobilePaymentData: The obfuscated DPAN.
withDsTransactionId(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure Directory Server Transaction Identifier used for this transaction.
withEci(Integer) - Method in class com.onlinepayments.domain.DecryptedPaymentData: Electronic Commerce Indicator.
withEci(Integer) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION * 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * 1 = Authentication attempted (MasterCard) * 2 = Successful authentication (MasterCard) * 5 = Successful authentication (Visa, Diners Club, Amex) * 6 = Authentication attempted (Visa, Diners Club, Amex) * 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction) * (empty) = Not checked or not enrolled
withEci(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Indicates Authentication validation results returned after AuthenticationValidation
withEligibility(String) - Method in class com.onlinepayments.domain.ProtectionEligibility: * Eligible - Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received * PartiallyEligible - Merchant is protected by PayPal's Seller Protection Policy for Item Not Received * Ineligible — Merchant is not protected under the Seller Protection Policy
withEmailAddress(String) - Method in class com.onlinepayments.domain.ContactDetails: Email address of the customer
withEmailAddress(String) - Method in class com.onlinepayments.domain.MandateContactDetails: Email address of the customer
withEmailAddress(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withEmailAddress(String) - Method in class com.onlinepayments.domain.Shipping: Email address linked to the shipping
withEncryptedCustomerInput(String) - Method in class com.onlinepayments.domain.CardSource: Data that was encrypted client side containing all customer entered data elements like card data.
withEncryptedCustomerInput(String) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Data that was encrypted client side containing all customer entered data elements like card data.
withEncryptedCustomerInput(String) - Method in class com.onlinepayments.domain.DccCardSource: Data that was encrypted client-side that contains all customer-entered data elements, such as card data.
withEncryptedPaymentData(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: The payment data if we will do the decryption of the encrypted payment data.
withEndorsementOrRestriction(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax.
withEntries(List<DirectoryEntry>) - Method in class com.onlinepayments.domain.ProductDirectory: List of entries in the directory
withEphemeralKey(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Ephemeral Key A unique generated key used by Apple to encrypt data.
withErrorCode(String) - Method in class com.onlinepayments.domain.APIError: Error code
withErrorId(String) - Method in class com.onlinepayments.domain.ErrorResponse: Unique reference, for debugging purposes, of this error response
withErrorId(String) - Method in class com.onlinepayments.domain.PaymentErrorResponse: Unique reference, for debugging purposes, of this error response
withErrorId(String) - Method in class com.onlinepayments.domain.PayoutErrorResponse
withErrorId(String) - Method in class com.onlinepayments.domain.RefundErrorResponse
withErrors(List<APIError>) - Method in class com.onlinepayments.domain.ErrorResponse: List of one or more errors
withErrors(List<APIError>) - Method in class com.onlinepayments.domain.OrderStatusOutput
withErrors(List<APIError>) - Method in class com.onlinepayments.domain.PaymentErrorResponse
withErrors(List<APIError>) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Contains the set of errors
withErrors(List<APIError>) - Method in class com.onlinepayments.domain.PayoutErrorResponse: Contains the set of errors
withErrors(List<APIError>) - Method in class com.onlinepayments.domain.RefundErrorResponse
withEWallet(TokenEWallet) - Method in class com.onlinepayments.domain.TokenResponse: Object containing eWallet details
withEWalletRefundMethodSpecificOutput(RefundEWalletMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
withExchangeRate(Float) - Method in class com.onlinepayments.domain.RateDetails: Expressed as a percentage, applied to convert the original amount into the resulting amount without charge
withExchangeTicket(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: New ticket number that is issued when a ticket is exchanged This field is used by the following payment products: 840
withExclude(PaymentProductFilter) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedCheckout: Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment.
withExclude(PaymentProductFilterHostedTokenization) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedTokenization: Contains the payment product ids that should be excluded from the payment products available for the payment.
withExemptionEngineFlow(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Detailed description of the Exemption Engine outcomes
withExemptionRequest(String) - Method in class com.onlinepayments.domain.GPayThreeDSecure: In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
withExemptionRequest(String) - Method in class com.onlinepayments.domain.ThreeDSecure: In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
withExemptionRequest(String) - Method in class com.onlinepayments.domain.ThreeDSecureBase: In PSD2, the ExemptionRequest field is used by merchants requesting an exemption when not using authentication on a transaction, in order to keep the conversion up.
withExistingUniqueMandateReference(String) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput: The unique reference of the existing mandate to use in this payment.
withExistingUniqueMandateReference(String) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase: The unique reference of the existing mandate to use in this payment.
withExpirationDate(String) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: The date after which the payment link will not be usable to complete the payment.
withExpirationDate(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The date after which the payment link will not be usable to complete the payment.
withExpirationDate(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withExpiredCardTokens(List<String>) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: Tokens referencing expired cards are returned in this array.
withExpiryDate(String) - Method in class com.onlinepayments.domain.Card: Expiry date of the card Format: MMYY
withExpiryDate(String) - Method in class com.onlinepayments.domain.CardEssentials: Expiry date of the card Format: MMYY
withExpiryDate(String) - Method in class com.onlinepayments.domain.CardWithoutCvv: Expiry date of the card Format: MMYY
withExpiryDate(String) - Method in class com.onlinepayments.domain.DecryptedPaymentData: Expiry date of the card Format: MMYY.
withExpiryDate(String) - Method in class com.onlinepayments.domain.MobilePaymentData: Expiry date of the tokenized card.
withExternalCardholderAuthenticationData(ExternalCardholderAuthenticationData) - Method in class com.onlinepayments.domain.ThreeDSecure: Object containing 3D secure details.
withExternalReference(String) - Method in class com.onlinepayments.domain.PaymentCreationOutput: The external reference identifier for this transaction.
withExternalTokenLinked(ExternalTokenLinked) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput
withExternalTokenLinked(ExternalTokenLinked) - Method in class com.onlinepayments.domain.CreatedTokenResponse
withExternalTokenLinked(ExternalTokenLinked) - Method in class com.onlinepayments.domain.TokenResponse
withExtraMerchantData(String) - Method in class com.onlinepayments.domain.RedirectPaymentProduct3306SpecificInput: In some cases, Klarna require additional information regarding the customer and the purchase in order to make a correct risk assessment.
withFallbackLevel(Integer) - Method in class com.onlinepayments.domain.AcquirerSelectionInformation: Specifies whether a fallback occurred from the primary choice of the acquirer selection service.
withFare(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Deprecated: Use legFare instead.
withFareBasis(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Fare Basis/Ticket Designator This field is used by the following payment products: 840
withFaxNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: International version of the fax number of the customer including the leading + (i.e.
withFee(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Fee for this leg of the trip This field is used by the following payment products: 840
withFields(List<PaymentProductField>) - Method in class com.onlinepayments.domain.PaymentProduct: Object containing all the fields and their details that are associated with this payment product.
withFirstName(String) - Method in class com.onlinepayments.domain.AirlinePassenger: First name of the passenger This field is used by the following payment products: cards, 840
withFirstName(String) - Method in class com.onlinepayments.domain.MandatePersonalName: Given name(s) or first name(s) of the customer.
withFirstName(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: First name of the PayPal account holder
withFirstName(String) - Method in class com.onlinepayments.domain.PersonalName: Given name(s) or first name(s) of the customer
withFirstName(String) - Method in class com.onlinepayments.domain.PersonalNameToken
withFirstUsageDate(String) - Method in class com.onlinepayments.domain.Shipping: Date (YYYYMMDD) when the shipping details for this transaction were first used.
withFiscalNumber(String) - Method in class com.onlinepayments.domain.Customer: Fiscal registration number of the customer or the tax registration number of the company for a business customer.
withFixedList(FixedListValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withFlightDate(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Date of the Flight Format: YYYYMMDD
withFlightIndicator(String) - Method in class com.onlinepayments.domain.AirlineData: Indicator representing the type of flight on the itinerary.
withFlightLegs(List<AirlineFlightLeg>) - Method in class com.onlinepayments.domain.AirlineData: Object that holds the data on the individual legs of the flight ticket
withFlightNumber(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: The flight number assigned by the airline carrier with no leading spaces Should be a numeric string This field is used by the following payment products: cards, 840
withFlow(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: 3D Secure Flow used during this transaction.
withFlow(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure Flow used during this transaction.
withFormElement(PaymentProductFieldFormElement) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Object detailing the type of form element that should be used to present the field
withFraudFields(FraudFields) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing additional data that will be used to assess the risk of fraud
withFraudFields(FraudFields) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing additional data that will be used to assess the risk of fraud
withFraudResults(CardFraudResults) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Fraud results contained in the CardFraudResults object
withFraudResults(CardFraudResults) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Fraud results contained in the CardFraudResults object
withFraudResults(FraudResults) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Object containing the results of the fraud screening
withFraudResults(FraudResults) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput: Object containing the results of the fraud screening
withFraudServiceResult(String) - Method in class com.onlinepayments.domain.CardFraudResults: Resulting advice of the fraud prevention checks.
withFraudServiceResult(String) - Method in class com.onlinepayments.domain.FraudResults: Resulting advice of the fraud prevention checks.
withGateway(String) - Method in class com.onlinepayments.domain.PaymentProduct320SpecificData: The gateway identifier.
withGender(String) - Method in class com.onlinepayments.domain.PersonalInformation: The gender of the customer, possible values are: * male * female * unknown or empty
withGeneratedToken(String) - Method in class com.onlinepayments.domain.ExternalTokenLinked: The generated token
withGiftCardPurchase(GiftCardPurchase) - Method in class com.onlinepayments.domain.ShoppingCart: Object containing information on purchased gift card(s)
withGroupCards(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputForHostedCheckout: * true - Hosted Checkout will allow to show cards grouped as one payment method * false - Default - Hosted Checkout will show cards as separate payment methods
withGroups(List<String>) - Method in class com.onlinepayments.domain.PaymentProductFilter: List containing all payment product groups that should either be restricted to in or excluded from the payment context.
withGTSComputedToken(String) - Method in class com.onlinepayments.domain.ExternalTokenLinked: Deprecated: Use the field ComputedToken instead.
withHadSuspiciousActivity(Boolean) - Method in class com.onlinepayments.domain.CustomerAccount: Specifies if you have experienced suspicious activity on the account of the customer true = you have experienced suspicious activity (including previous fraud) on the customer account used for this transaction false = you have experienced no suspicious activity (including previous fraud) on the customer account used for this transaction
withHost(String) - Method in class com.onlinepayments.ProxyConfiguration
withHostedCheckoutId(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: The ID of the Hosted Checkout Session in which the payment was made.
withHostedCheckoutId(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificOutput: The ID of the Hosted Checkout Session in which the payment was made.
withHostedCheckoutSpecificInput(HostedCheckoutSpecificInput) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing hosted checkout specific data
withHostedCheckoutSpecificOutput(HostedCheckoutSpecificOutput) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Hosted Checkout specific information.
withHostedCheckoutSpecificOutput(HostedCheckoutSpecificOutput) - Method in class com.onlinepayments.domain.PaymentResponse: Hosted Checkout specific information.
withHostedTokenizationId(String) - Method in class com.onlinepayments.domain.CardSource: An Id of a hosted tokenization session
withHostedTokenizationId(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: The ID of the Hosted Tokenization Session
withHostedTokenizationId(String) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Use this field after a successful Hosted Tokenization session to create a payment with the tokenized payment method details.
withHostedTokenizationId(String) - Method in class com.onlinepayments.domain.DccCardSource: An Id of a hosted tokenization session
withHostedTokenizationUrl(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: The URL you can use in your JavaScript when instantiating the Tokenizer.
withHouseNumber(String) - Method in class com.onlinepayments.domain.Address: House number
withHouseNumber(String) - Method in class com.onlinepayments.domain.AddressPersonal: House number
withHouseNumber(String) - Method in class com.onlinepayments.domain.MandateAddress: House number
withHtmlContent(String) - Method in class com.onlinepayments.domain.GetPrivacyPolicyResponse: HTML content to be displayed to the user.
withHttpsProtocols(Collection<String>) - Method in class com.onlinepayments.CommunicatorConfiguration
withHttpsProtocols(String...) - Method in class com.onlinepayments.CommunicatorConfiguration
withHttpStatusCode(Integer) - Method in class com.onlinepayments.domain.APIError: HTTP status code for this error that can be used to determine the type of error
withIban(String) - Method in class com.onlinepayments.domain.BankAccountIban: The IBAN is the International Bank Account Number.
withIban(String) - Method in class com.onlinepayments.domain.CustomerBankAccount: The IBAN is the International Bank Account Number.
withIban(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withId(Integer) - Method in class com.onlinepayments.domain.AccountOnFile
withId(String) - Method in class com.onlinepayments.domain.APIError: ID of the error.
withId(String) - Method in class com.onlinepayments.domain.Capture
withId(String) - Method in class com.onlinepayments.domain.CaptureResponse: Our unique payment transaction identifier
withId(String) - Method in class com.onlinepayments.domain.OperationOutput: Our unique payment transaction identifier
withId(String) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Our unique payment transaction identifier
withId(Integer) - Method in class com.onlinepayments.domain.PaymentProduct: The ID of the payment product in our system
withId(String) - Method in class com.onlinepayments.domain.PaymentProductField
withId(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: The ID of the display element.
withId(String) - Method in class com.onlinepayments.domain.PaymentProductGroup: The ID of the payment product group in our system
withId(String) - Method in class com.onlinepayments.domain.PaymentResponse: Our unique payment transaction identifier
withId(String) - Method in class com.onlinepayments.domain.PayoutResponse
withId(String) - Method in class com.onlinepayments.domain.PayoutResult
withId(String) - Method in class com.onlinepayments.domain.RefundResponse: Our unique payment transaction identifier
withId(String) - Method in class com.onlinepayments.domain.TokenResponse: ID of the token
withIdempotenceKey(String) - Method in class com.onlinepayments.CallContext: Sets the idempotence key to use for the next request for which this call context is used.
withImage(String) - Method in class com.onlinepayments.domain.PaymentProductFieldTooltip: Deprecated: This field is not used by any payment product Relative URL that can be used to retrieve an image for the tooltip image.
withInitialSchemeTransactionId(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: The unique scheme transactionId of the initial transaction that was performed with SCA.
withInitialSchemeTransactionId(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: The unique scheme transactionId of the initial transaction that was performed with SCA.
withInitialSchemeTransactionId(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: The unique scheme transactionId of the initial transaction that was performed with SCA.
withInstantPaymentOnly(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentProduct5408SpecificInput: * true - customer is allowed to do only instant payment for Account to Account Bank transfer payments * false - customer is allowed to choose between instant or standard payment after the bank selection page for Account to Account Bank transfer payments
withIntegrator(String) - Method in class com.onlinepayments.CommunicatorConfiguration
withInvalidTokens(List<String>) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: Tokens that are submitted in the request are validated.
withInvalidTokens(List<String>) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: Tokens that are submitted in the request are validated.
withInvalidTokens(List<String>) - Method in class com.onlinepayments.domain.SessionResponse: Tokens that are submitted in the request are validated.
withInvertedExchangeRate(Float) - Method in class com.onlinepayments.domain.RateDetails: Exchange rate, expressed as a percentage, applied to convert the resulting amount into the original amount
withInvoiceData(LineItemInvoiceData) - Method in class com.onlinepayments.domain.LineItem: Object containing the line items of the invoice or shopping cart
withInvoiceNumber(String) - Method in class com.onlinepayments.domain.AirlineData: Airline tracing number This field is used by the following payment products: cards
withIpAddress(String) - Method in class com.onlinepayments.domain.CustomerDevice: The IP address of the customer client from the HTTP Headers.
withIpAddressCountryCode(String) - Method in class com.onlinepayments.domain.CustomerDeviceOutput: ISO 3166-1 alpha-2 country code
withIsAllowedInContext(Boolean) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: Populated only if you submitted a payment context.
withIsAllowedInContext(Boolean) - Method in class com.onlinepayments.domain.IINDetail: Populated only if you submitted a payment context.
withIsAuthorized(Boolean) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Indicates if the transaction has been authorized
withIsCancellable(Boolean) - Method in class com.onlinepayments.domain.OrderStatusOutput: Flag indicating if the payment can be cancelled * true * false
withIsCancellable(Boolean) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Flag indicating if the payment can be cancelled
withIsCancellable(Boolean) - Method in class com.onlinepayments.domain.PayoutStatusOutput: Flag indicating if the payout can be cancelled * true * false
withIsETicket(Boolean) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product * true = The ticket is an E-Ticket * false = the ticket is not an E-Ticket'
withIsFinal(Boolean) - Method in class com.onlinepayments.domain.CancelPaymentRequest: This property indicates whether this will be the final operation.
withIsFinal(Boolean) - Method in class com.onlinepayments.domain.CapturePaymentRequest: This property indicates whether this will be the final operation.
withIsFirstUsage(Boolean) - Method in class com.onlinepayments.domain.Shipping: Indicator if this shipping address is used for the first time to ship an order true = the shipping details are used for the first time with this transaction false = the shipping details have been used for other transactions in the past
withIsNewToken(Boolean) - Method in class com.onlinepayments.domain.CreatedTokenResponse: Indicates if a new token was created * true - A new token was created * false - A token with the same card number already exists and is returned.
withIsNewToken(Boolean) - Method in class com.onlinepayments.domain.PaymentCreationOutput: Indicates if a new token was created * true - A new token was created * false - A token with the same card number already exists and is returned.
withIsPreOrder(Boolean) - Method in class com.onlinepayments.domain.ShoppingCart: The customer is pre-ordering one or more items
withIsRecurring(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: * true - Indicates that the transactions is part of a scheduled recurring sequence.
withIsRecurring(Boolean) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: * true - Only payment products that support recurring payments will be shown.
withIsRecurring(Boolean) - Method in class com.onlinepayments.domain.PaymentContext: True if the payment is recurring
withIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: This allows you to filter payment products based on their support for recurring payments.
withIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: This allows you to filter payment products based on their support for recurring payments.
withIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.products.GetPaymentProductNetworksParams: This allows you to filter networks based on their support for recurring or not * true * false
withIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: This allows you to filter payment products based on their support for recurring payments.
withIsRecurring(Boolean) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: This allows you to filter payment products based on their support for recurring payments.
withIsRefundable(Boolean) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Flag indicating if the payment can be refunded
withIsRequired(Boolean) - Method in class com.onlinepayments.domain.PaymentProductFieldDataRestrictions: * true - Indicates that this field is required * false - Indicates that this field is optional
withIsRestrictedTicket(Boolean) - Method in class com.onlinepayments.domain.AirlineData: Indicates if the ticket is refundable or not.
withIssueDate(String) - Method in class com.onlinepayments.domain.AirlineData: This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
withIssuerId(String) - Method in class com.onlinepayments.domain.DirectoryEntry: Unique ID of the issuing bank of the customer
withIssuerId(String) - Method in class com.onlinepayments.domain.RedirectPaymentProduct809SpecificInput: Unique ID of the issuing bank of the customer
withIssuerList(String) - Method in class com.onlinepayments.domain.DirectoryEntry: To be used to sort the issuers.
withIssuerName(String) - Method in class com.onlinepayments.domain.DirectoryEntry: Name of the issuing bank as it should be presented to the customer
withIsTemporary(Boolean) - Method in class com.onlinepayments.domain.TokenResponse: Temporary tokens have a lifespan of two hours and can only be used once.
withIsThirdParty(Boolean) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product * true - The payer is the ticket holder * false - The payer is not the ticket holder
withItems(List<LineItem>) - Method in class com.onlinepayments.domain.ShoppingCart: Shopping cart data
withJavaEnabled(Boolean) - Method in class com.onlinepayments.domain.BrowserData: true =Java is enabled in the browser false = Java is not enabled in the browser Value is returned from the navigator.javaEnabled property.
withJavaScriptEnabled(Boolean) - Method in class com.onlinepayments.domain.BrowserData: * true = JavaScript is enabled in the browser.
withKey(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Name of the key or property
withLabel(String) - Method in class com.onlinepayments.domain.PaymentProductDisplayHints: Name of the payment product or group based on the locale that was included in the request
withLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: The label of the display element.
withLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Label/Name of the field to be used in the user interface
withLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldTooltip: A text explaining the field in more detail.
withLabelTemplate(List<LabelTemplateElement>) - Method in class com.onlinepayments.domain.AccountOnFileDisplayHints: Array of attribute keys and their mask
withLanguage(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: The language code of the customer.
withLanguage(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: The language code of the customer.
withLegFare(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Fee for this leg of the trip This field is used by the following payment products: 840
withLength(LengthValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withLiability(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Determines the Fraud liability.
withLink(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Deprecated: This field is not used by any payment product Link that should be used to replace the '{link}' variable in the label.
withLoanRecipient(LoanRecipient) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object containing specific data regarding the recipient of a loan in the UK
withLocale(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Locale used in the GUI towards the consumer.
withLocale(String) - Method in class com.onlinepayments.domain.Customer: The locale that the customer should be addressed in (for 3rd parties).
withLocale(String) - Method in class com.onlinepayments.domain.CustomerDevice: Locale of the client device/browser.
withLocale(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Locale used in the GUI towards the consumer.
withLocale(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupParams: Deprecated: This field has no effect.
withLocale(String) - Method in class com.onlinepayments.merchant.productgroups.GetProductGroupsParams: Deprecated: This field has no effect.
withLocale(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductParams: Locale used in the GUI towards the consumer.
withLocale(String) - Method in class com.onlinepayments.merchant.products.GetPaymentProductsParams: Locale used in the GUI towards the consumer.
withLocale(String) - Method in class com.onlinepayments.merchant.services.GetPrivacyPolicyParams: Locale in which the privacy policy will be returned.
withLodgingData(LodgingData) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object that holds lodging specific data
withLogo(String) - Method in class com.onlinepayments.domain.AccountOnFileDisplayHints: Partial URL that you can reference for the image of this payment product.
withLogo(String) - Method in class com.onlinepayments.domain.PaymentProductDisplayHints: Partial URL that you can reference for the image of this payment product.
withLuhn(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withMandate(MandateResponse) - Method in class com.onlinepayments.domain.CreateMandateResponse: Object containing the created mandate.
withMandate(MandateResponse) - Method in class com.onlinepayments.domain.GetMandateResponse: Object containing the created mandate.
withMandate(CreateMandateWithReturnUrl) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInput: Object containing information to create a SEPA Direct Debit mandate.
withMandate(CreateMandateRequest) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentProduct771SpecificInputBase: Object containing information to create a SEPA Direct Debit mandate.
withMandateAddress(MandateAddress) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing billing address details.
withMandateReference(String) - Method in class com.onlinepayments.domain.PaymentProduct771SpecificOutput: Unique reference to a Mandate
withMarkUpRate(Float) - Method in class com.onlinepayments.domain.RateDetails: The markup is the percentage added to the exchange rate by a provider when they sell you currency.
withMarshaller(Marshaller) - Method in class com.onlinepayments.CommunicatorBuilder: Sets the Marshaller to use.
withMarshaller(Marshaller) - Method in class com.onlinepayments.webhooks.WebhooksHelperBuilder: Sets the Marshaller to use.
withMask(String) - Method in class com.onlinepayments.domain.LabelTemplateElement: Regular mask for the attributeKey Note: The mask is optional as not every field has a mask
withMask(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: A mask that can be used in the input field.
withMaxConnections(int) - Method in class com.onlinepayments.CommunicatorConfiguration
withMaxLength(Integer) - Method in class com.onlinepayments.domain.LengthValidator
withMaxValue(Integer) - Method in class com.onlinepayments.domain.RangeValidator
withMerchantAction(MerchantAction) - Method in class com.onlinepayments.domain.CompletePaymentResponse: Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment
withMerchantAction(MandateMerchantAction) - Method in class com.onlinepayments.domain.CreateMandateResponse: Object that contains the action, including the needed data, that you should perform next, showing the redirect to a third party to complete the payment or like showing instructions.
withMerchantAction(MerchantAction) - Method in class com.onlinepayments.domain.CreatePaymentResponse: Object that contains the action, including the needed data, that you should perform next, like showing instructions, showing the transaction results or redirect to a third party to complete the payment
withMerchantCustomerId(String) - Method in class com.onlinepayments.domain.AirlineData: Your ID of the customer in the context of the airline data This field is used by the following payment products: 840
withMerchantCustomerId(String) - Method in class com.onlinepayments.domain.Customer: Your identifier for the customer.
withMerchantFinanceCode(String) - Method in class com.onlinepayments.domain.PaymentProduct3208SpecificInput: This field indicates the finance code provided by the merchant after the buyer has selected the proper financing option.
withMerchantFinanceCode(String) - Method in class com.onlinepayments.domain.PaymentProduct3209SpecificInput: This field indicates the finance code provided by the merchant after the buyer has selected the proper financing option.
withMerchantFraudRate(Integer) - Method in class com.onlinepayments.domain.ThreeDSecure: Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
withMerchantFraudRate(Integer) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Merchant fraud rate in the EEA (all EEA card fraud divided by all EEA card volumes) calculated as per PSD2 RTS.
withMerchantParameters(String) - Method in class com.onlinepayments.domain.CaptureOutput: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
withMerchantParameters(String) - Method in class com.onlinepayments.domain.OrderReferences: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
withMerchantParameters(String) - Method in class com.onlinepayments.domain.PaymentOutput: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
withMerchantParameters(String) - Method in class com.onlinepayments.domain.PaymentReferences: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
withMerchantParameters(String) - Method in class com.onlinepayments.domain.RefundOutput: It allows you to store additional parameters for the transaction in the format you prefer (e.g.-> key-value query string, JSON, etc.) These parameters are then echoed back to you in API GET calls and Webhook notifications.
withMerchantReference(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: Your unique reference of the transaction that is also returned in our report files.
withMerchantReference(String) - Method in class com.onlinepayments.domain.OrderReferences: Your unique reference of the transaction that is also returned in our report files.
withMerchantReference(String) - Method in class com.onlinepayments.domain.PaymentLinkOrderInput: Your unique reference of the transaction that is also returned in our report files.
withMerchantReference(String) - Method in class com.onlinepayments.domain.PaymentLinkOrderOutput: Your unique reference of the transaction that is also returned in our report files.
withMerchantReference(String) - Method in class com.onlinepayments.domain.PaymentReferences: Your unique reference of the transaction that is also returned in our report files.
withMerchantScore(String) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Score calculated by the 3DS Requestor and provided to CB Scoring service only.
withMessage(String) - Method in class com.onlinepayments.domain.APIError: Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
withMetaDataProvider(MetaDataProvider) - Method in class com.onlinepayments.CommunicatorBuilder: Sets the MetaDataProvider to use.
withMethod(String) - Method in class com.onlinepayments.domain.CustomerAccountAuthentication: Authentication used by the customer on your website Possible values are * guest = no login occurred, customer is logged in as guest * merchant-credentials = the customer logged in using credentials that are specific to you * federated-id = the customer logged in using a federated ID * issuer-credentials = the customer logged in using credentials from the card issuer (of the card used in this transaction) * third-party-authentication = the customer logged in using third-party authentication * fido-authentication = the customer logged in using a FIDO authenticator
withMethod(ShippingMethod) - Method in class com.onlinepayments.domain.Shipping: Object containing information regarding shipping method
withMethod(String) - Method in class com.onlinepayments.domain.ThreeDSecureData: Method of authentication used for this transaction.
withMinLength(Integer) - Method in class com.onlinepayments.domain.LengthValidator
withMinValue(Integer) - Method in class com.onlinepayments.domain.RangeValidator
withMobilePaymentMethodSpecificInput(MobilePaymentMethodHostedCheckoutSpecificInput) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for mobile payments
withMobilePaymentMethodSpecificInput(MobilePaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for mobile payments
withMobilePaymentMethodSpecificOutput(MobilePaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the mobile payment method details
withMobilePaymentMethodSpecificOutput(MobilePaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the mobile payment method details
withMobilePhoneNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: International version of the mobile phone number of the customer including the leading + (i.e.
withMobileRefundMethodSpecificOutput(RefundMobileMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
withMode(String) - Method in class com.onlinepayments.domain.SurchargeSpecificInput: The surcharge mode which defines how a merchant will apply surcharging.
withMode(String) - Method in class com.onlinepayments.domain.SurchargeSpecificOutput: The surcharge mode which defines how a merchant will apply surcharging.
withMustWriteReason(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Deprecated: This field is not used by any payment product The reason why the status is MUST_WRITE.
withName(String) - Method in class com.onlinepayments.domain.AcquirerInformation: Name of the acquirer used to process the transaction
withName(PersonalName) - Method in class com.onlinepayments.domain.AddressPersonal: Object containing the name details of the customer
withName(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Name of the airline
withName(String) - Method in class com.onlinepayments.domain.CompanyInformation: Name of company, as a customer
withName(MandatePersonalName) - Method in class com.onlinepayments.domain.MandatePersonalInformation: Object containing the name details of the customer.
withName(PersonalName) - Method in class com.onlinepayments.domain.PersonalInformation: Object containing the name details of the customer
withName(PersonalNameToken) - Method in class com.onlinepayments.domain.PersonalInformationToken
withName(String) - Method in class com.onlinepayments.domain.ShippingMethod: Name of the shipping method
withNetAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Surcharge: Object containing amount and ISO currency code attributes
withNetwork(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: The card network that was used for a mobile payment method operation
withNetwork(String) - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput: The card network that was used for a mobile payment method operation
withNetworks(List<String>) - Method in class com.onlinepayments.domain.PaymentProduct302SpecificData: The networks that can be used in the current payment context.
withNetworks(List<String>) - Method in class com.onlinepayments.domain.PaymentProduct320SpecificData: The networks that can be used in the current payment context.
withNetworks(List<String>) - Method in class com.onlinepayments.domain.PaymentProductNetworksResponse: Array containing network entries for a payment product.
withNumber(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Deprecated: This field is not used by any payment product Sequence number of the flight leg
withNumberOfCardOnFileCreationAttemptsLast24Hours(Integer) - Method in class com.onlinepayments.domain.PaymentAccountOnFile: Number of attempts made to add new card to the customer account in the last 24 hours
withNumberOfGiftCards(Integer) - Method in class com.onlinepayments.domain.GiftCardPurchase: Number of gift cards that are purchased through this transaction
withNumberOfItems(Integer) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Number of purchased items or services.
withNumberOfPaymentAttemptsLast24Hours(Integer) - Method in class com.onlinepayments.domain.CustomerPaymentActivity: Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
withNumberOfPaymentAttemptsLastYear(Integer) - Method in class com.onlinepayments.domain.CustomerPaymentActivity: Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
withNumberOfPurchasesLast6Months(Integer) - Method in class com.onlinepayments.domain.CustomerPaymentActivity: Number of successful purchases made by this customer with you in the last 6 months
withObfuscate(Boolean) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: * true - The data in this field should be obfuscated as it is entered, just like a password field * false - The data in this field does not need to be obfuscated
withOmnichannelPayoutSpecificInput(OmnichannelPayoutSpecificInput) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object containing the additional payout details for a Omnichannel merchants
withOperations(List<OperationOutput>) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Object that contains the complete list of operations executed on the payment.
withOrder(Order) - Method in class com.onlinepayments.domain.CompletePaymentRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
withOrder(Order) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
withOrder(Order) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
withOrder(Order) - Method in class com.onlinepayments.domain.SubsequentPaymentRequest: Order object containing order related data Please note that this object is required to be able to submit the amount.
withOrderLineDetails(OrderLineDetails) - Method in class com.onlinepayments.domain.LineItem: Object containing additional information that when supplied can have a beneficial effect on the discountrates
withOriginAirport(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Origin airport/city code This field is used by the following payment products: cards, 840
withPairingToken(String) - Method in class com.onlinepayments.domain.PaymentProduct5407: A numeric token, which the user has to copy or type into the TWINT app in order to pair it with the merchant for the payment process.
withPartialPan(String) - Method in class com.onlinepayments.domain.LoanRecipient: Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.
withPartialRedirectUrl(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: The partial URL as generated by our system.
withPartialRedirectUrl(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationResponse: Deprecated.
withPassengerClass(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: PassengerClass if this leg This field is used by the following payment products: 840
withPassengerName(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: Use passengers instead Name of passenger
withPassengers(List<AirlinePassenger>) - Method in class com.onlinepayments.domain.AirlineData: Object that holds the data on the individual passengers This field is used by the following payment products: cards, 840
withPassengerType(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Type of passenger on the itinerary.
withPassword(String) - Method in class com.onlinepayments.ProxyConfiguration
withPasswordChangeDate(String) - Method in class com.onlinepayments.domain.CustomerAccount: The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
withPasswordChangedDuringCheckout(Boolean) - Method in class com.onlinepayments.domain.CustomerAccount: Indicates if the password of an account is changed during this checkout true = the customer made changes to their password of the account used during this checkout false = the customer did not change anything to their password of the account used during this checkout
withPayerId(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
withPayerId(String) - Method in class com.onlinepayments.domain.RefundPaymentProduct840CustomerAccount: The unique identifier of a PayPal account and will never change in the life cycle of a PayPal account
withPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CancelPaymentResponse: Object that holds the payment related properties
withPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CompletePaymentResponse: Object that holds the payment related properties
withPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CreatedPaymentOutput: Object that holds the payment related properties
withPayment(PaymentResponse) - Method in class com.onlinepayments.domain.CreatePaymentResponse: Object that holds the payment related properties
withPayment(PaymentResponse) - Method in class com.onlinepayments.domain.SubsequentPaymentResponse: Object that holds the payment related properties
withPaymentAccountOnFile(PaymentAccountOnFile) - Method in class com.onlinepayments.domain.CustomerAccount: Object containing information on the payment account data on file (tokens)
withPaymentAccountReference(String) - 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.
withPaymentActivity(CustomerPaymentActivity) - Method in class com.onlinepayments.domain.CustomerAccount: Object containing data on the purchase history of the customer with you
withPaymentContext(PaymentContext) - Method in class com.onlinepayments.domain.GetIINDetailsRequest
withPaymentData(MobilePaymentData) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Object containing payment details
withPaymentEndDate(String) - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput: The end date of the payment validity
withPaymentId(String) - 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.
withPaymentId(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The unique payment transaction identifier.
withPaymentLinkEvents(List<PaymentLinkEvent>) - Method in class com.onlinepayments.domain.PaymentLinkResponse
withPaymentLinkId(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The unique link identifier.
withPaymentLinkOrder(PaymentLinkOrderInput) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: An object containing the details of the related payment input.
withPaymentLinkOrder(PaymentLinkOrderOutput) - Method in class com.onlinepayments.domain.PaymentLinkResponse: An object containing the details of the related payment output.
withPaymentMethod(String) - Method in class com.onlinepayments.domain.CaptureOutput: Payment method identifier used by the our payment engine.
withPaymentMethod(String) - Method in class com.onlinepayments.domain.OperationOutput: Payment method identifier used by the our payment engine.
withPaymentMethod(String) - Method in class com.onlinepayments.domain.PaymentOutput: Payment method identifier used by the our payment engine.
withPaymentMethod(String) - Method in class com.onlinepayments.domain.PaymentProduct: Payment method identifier used by the our payment engine.
withPaymentMethod(String) - Method in class com.onlinepayments.domain.RefundOutput: Payment method identifier used by the our payment engine.
withPaymentOption(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: The specific payment option for the payment.
withPaymentOption(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: The specific payment option for the payment.
withPaymentOption(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: The specific payment option for the payment.
withPaymentOutput(PaymentOutput) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Object containing payment details
withPaymentOutput(PaymentOutput) - Method in class com.onlinepayments.domain.PaymentResponse: Object containing payment details
withPaymentProduct130SpecificInput(PaymentProduct130SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific input required for CB payments
withPaymentProduct130SpecificInput(PaymentProduct130SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for CB payments
withPaymentProduct302SpecificData(PaymentProduct302SpecificData) - Method in class com.onlinepayments.domain.PaymentProduct
withPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific input required for OneyDuplo Leroy Merlin payments.
withPaymentProduct3208SpecificInput(PaymentProduct3208SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for OneyDuplo Leroy Merlin payments.
withPaymentProduct3208SpecificOutput(PaymentProduct3208SpecificOutput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: OneyDuplo Leroy Merlin specific details
withPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific input required for OneyDuplo Alcampo payments.
withPaymentProduct3209SpecificInput(PaymentProduct3209SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for OneyDuplo Alcampo payments.
withPaymentProduct3209SpecificOutput(PaymentProduct3209SpecificOutput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: OneyDuplo Alcampo specific details
withPaymentProduct320SpecificData(PaymentProduct320SpecificData) - Method in class com.onlinepayments.domain.PaymentProduct
withPaymentProduct320SpecificInput(MobilePaymentProduct320SpecificInput) - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput: Object containing information specific to Google Pay.
withPaymentProduct320SpecificInput(MobilePaymentProduct320SpecificInput) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Object containing information specific to Google Pay.
withPaymentProduct3306SpecificInput(RedirectPaymentProduct3306SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input required for Klarna payments (Payment product ID 3306)
withPaymentProduct5001SpecificOutput(PaymentProduct5001SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Bizum (payment product 5001) specific details
withPaymentProduct5100SpecificInput(PaymentProduct5100SpecificInput) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific input required for Cpay payments.
withPaymentProduct5402SpecificOutput(PaymentProduct5402SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Meal vouchers (payment product 5402) specific details
withPaymentProduct5404(PaymentProduct5404) - Method in class com.onlinepayments.domain.ShowFormData: Contains the third party data for payment product 5404 (WeChat Pay)
withPaymentProduct5406SpecificInput(RedirectPaymentProduct5406SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input for EPS payments (Payment product ID 5406)
withPaymentProduct5407(PaymentProduct5407) - Method in class com.onlinepayments.domain.ShowFormData: Contains the third party data for payment product 5407 (Twint)
withPaymentProduct5408SpecificInput(RedirectPaymentProduct5408SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input for Account to Account payments (Payment product ID 5408)
withPaymentProduct5500SpecificOutput(PaymentProduct5500SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Multibanco (payment product 5500) specific details
withPaymentProduct771SpecificInput(SepaDirectDebitPaymentProduct771SpecificInput) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput: Object containing information specific to SEPA Direct Debit
withPaymentProduct771SpecificInput(SepaDirectDebitPaymentProduct771SpecificInputBase) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase: Object containing information specific to SEPA Direct Debit
withPaymentProduct771SpecificOutput(PaymentProduct771SpecificOutput) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput: Output that is SEPA Direct Debit specific (i.e.
withPaymentProduct809SpecificInput(RedirectPaymentProduct809SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input required for iDeal payments (Payment product ID 809)
withPaymentProduct840SpecificInput(RedirectPaymentProduct840SpecificInput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing specific input required for PayPal payments (Payment product ID 840)
withPaymentProduct840SpecificOutput(PaymentProduct840SpecificOutput) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: PayPal (payment product 840) specific details
withPaymentProduct840SpecificOutput(RefundPaymentProduct840SpecificOutput) - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
withPaymentProductFilters(PaymentProductFiltersHostedTokenization) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: Contains the payment product ids that will be used for manipulating the payment products available for the payment to the customer.
withPaymentProductFilters(PaymentProductFiltersHostedCheckout) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
withPaymentProductGroup(String) - Method in class com.onlinepayments.domain.PaymentProduct: The payment product group that has this payment product, if there is any.
withPaymentProductGroups(List<PaymentProductGroup>) - Method in class com.onlinepayments.domain.GetPaymentProductGroupsResponse: Array containing payment product groups and their characteristics
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.AccountOnFile: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardInfo: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.CreateTokenRequest: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.GetIINDetailsResponse: The payment product identifier associated with the card.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.IINDetail: The payment product identifier associated with the card.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.MobilePaymentMethodHostedCheckoutSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificInputBase: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SepaDirectDebitPaymentMethodSpecificOutput: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.Surcharge: The payment product identifier.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.SurchargeCalculationCard: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.domain.TokenResponse: Payment product identifier - Please see Products documentation for a full overview of possible values.
withPaymentProductId(Integer) - Method in class com.onlinepayments.merchant.services.GetPrivacyPolicyParams: ID of the specific payment product for which you wish to retrieve the privacy policy.
withPaymentProducts(List<PaymentProduct>) - Method in class com.onlinepayments.domain.GetPaymentProductsResponse: Array containing payment products and their characteristics
withPaymentReference(String) - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput: The reference to be used within the Multibanco network to confirm the payment
withPaymentResult(CreatePaymentResponse) - Method in class com.onlinepayments.domain.PaymentErrorResponse: Object that contains details on the created payment in case one has been created.
withPaymentStartDate(String) - Method in class com.onlinepayments.domain.PaymentProduct5500SpecificOutput: The start date of the payment validity
withPaymentStatusCategory(String) - Method in class com.onlinepayments.domain.CreatedPaymentOutput
withPayoutOutput(PayoutOutput) - Method in class com.onlinepayments.domain.PayoutResponse
withPayoutOutput(PayoutOutput) - Method in class com.onlinepayments.domain.PayoutResult
withPayoutReason(String) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: Allows you to additionally specify the reason for initiating the payout for authorization purposes.
withPayoutReason(String) - Method in class com.onlinepayments.domain.PayoutOutput: Allows you to additionally specify the reason for initiating the payout for authorization purposes.
withPayoutResult(PayoutResult) - Method in class com.onlinepayments.domain.PayoutErrorResponse
withPersonalInformation(PersonalInformation) - Method in class com.onlinepayments.domain.Customer: Object containing personal information like name, date of birth and gender.
withPersonalInformation(PersonalInformationToken) - Method in class com.onlinepayments.domain.CustomerToken
withPersonalInformation(MandatePersonalInformation) - Method in class com.onlinepayments.domain.MandateCustomer: Object containing personal information of the customer.
withPhoneNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: International version of the phone number of the customer including the leading + (i.e.
withPlaceholderLabel(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: A placeholder value for the form element
withPlaceOfIssue(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
withPnr(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Passenger name record
withPointOfSale(String) - Method in class com.onlinepayments.domain.AirlineData: IATA point of sale name This field is used by the following payment products: 840
withPort(int) - Method in class com.onlinepayments.ProxyConfiguration
withPosCityCode(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product City code of the point of sale
withPreferredInputType(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: The type of keyboard that can best be used to fill out the value of this field.
withPreOrderItemAvailabilityDate(String) - Method in class com.onlinepayments.domain.ShoppingCart: Date (YYYYMMDD) when the preordered item becomes available
withPriorThreeDSecureData(ThreeDSecureData) - Method in class com.onlinepayments.domain.ThreeDSecure: Object containing data regarding the customer authentication that occurred prior to the current transaction
withPriorThreeDSecureData(ThreeDSecureData) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Object containing data regarding the customer authentication that occurred prior to the current transaction
withProductCategories(List<String>) - Method in class com.onlinepayments.domain.FraudFields: List of product categories that are being purchased.
withProductCode(String) - Method in class com.onlinepayments.domain.OrderLineDetails: Product or UPC Code
withProductName(String) - Method in class com.onlinepayments.domain.OrderLineDetails: The name of the product.
withProductPrice(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: The price of one unit of the product, the value should be zero or greater
withProducts(List<Integer>) - Method in class com.onlinepayments.domain.PaymentProductFilter: List containing all payment product ids that should either be restricted to in or excluded from the payment context.
withProducts(List<Integer>) - Method in class com.onlinepayments.domain.PaymentProductFilterHostedTokenization: List containing all payment product ids that should either be restricted to in or excluded from the payment context.
withProductType(String) - Method in class com.onlinepayments.domain.OrderLineDetails: Code used to classify items that are purchased
withPropertyName(String) - Method in class com.onlinepayments.domain.APIError: Returned only if the error relates to a value that was missing or incorrect.
withProposal(DccProposal) - Method in class com.onlinepayments.domain.CurrencyConversion: Details of currency conversion to be proposed to the cardholder
withProposal(DccProposal) - Method in class com.onlinepayments.domain.CurrencyConversionResponse: Details of currency conversion to be proposed to the cardholder
withProtectionEligibility(ProtectionEligibility) - Method in class com.onlinepayments.domain.PaymentProduct840SpecificOutput: Kind of seller protection in force for the PayPal transaction
withProxyConfiguration(ProxyConfiguration) - Method in class com.onlinepayments.CommunicatorConfiguration
withPublicKeyHash(String) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: Public Key Hash A unique identifier to retrieve key used by Apple to encrypt information.
withPurchaseType(String) - Method in class com.onlinepayments.domain.OrderTypeInformation: Possible values are: * physical (tangible goods shipped to the customers) * digital (digital services like ebooks, streaming...)
withQrCode(String) - Method in class com.onlinepayments.domain.PaymentProduct5407: Contains a base64 encoded PNG image.
withQrCodeUrl(String) - Method in class com.onlinepayments.domain.PaymentProduct5404: Contains a QR code url that can be used to build a QR code (intended to be scanned by a device with the WeChat Pay app)
withQuantity(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
withQuotationDateTime(String) - Method in class com.onlinepayments.domain.RateDetails: Date and time at which the exchange rate has been quoted
withRange(RangeValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withRate(RateDetails) - Method in class com.onlinepayments.domain.DccProposal
withRecipientName(String) - Method in class com.onlinepayments.domain.CreatePaymentLinkRequest: The payment link recipient name.
withRecipientName(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The payment link recipient name.
withRecurrenceType(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: Specifies whether the mandate is for one-off or recurring payments.
withRecurrenceType(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Specifies whether the mandate is for one-off or recurring payments.
withRecurrenceType(String) - Method in class com.onlinepayments.domain.MandateResponse: Specifies whether the mandate is for one-off or recurring payments.
withRecurring(CardRecurrenceDetails) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing data related to recurring
withRecurring(CardRecurrenceDetails) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing data related to recurring
withRecurringPaymentSequenceIndicator(String) - Method in class com.onlinepayments.domain.CardRecurrenceDetails: * first = This transaction is the first of a series of recurring transactions * recurring = This transaction is a subsequent transaction in a series of recurring transactions Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions.
withRedirectData(MandateRedirectData) - Method in class com.onlinepayments.domain.MandateMerchantAction: Object containing all data needed to redirect the customer
withRedirectData(RedirectData) - Method in class com.onlinepayments.domain.MerchantAction: Object containing all data needed to redirect the customer
withRedirectionData(RedirectionData) - Method in class com.onlinepayments.domain.GPayThreeDSecure: Object containing browser specific redirection related data
withRedirectionData(RedirectionData) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Object containing browser specific redirection related data
withRedirectionData(RedirectionData) - Method in class com.onlinepayments.domain.ThreeDSecure: Object containing browser specific redirection related data
withRedirectionUrl(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The URL that will redirect the customer to the Hosted Checkout page to process the payment.
withRedirectPaymentMethodSpecificInput(RedirectPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
withRedirectPaymentMethodSpecificInput(RedirectPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
withRedirectPaymentMethodSpecificOutput(RedirectPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the redirect payment product details
withRedirectPaymentMethodSpecificOutput(RedirectPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the redirect payment product details
withRedirectRefundMethodSpecificOutput(RefundRedirectMethodSpecificOutput) - Method in class com.onlinepayments.domain.RefundOutput
withRedirectUrl(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: The full hosted checkout URL as generated by our system.
withRedirectURL(String) - Method in class com.onlinepayments.domain.MandateRedirectData: The URL that the customer should be redirected to.
withRedirectURL(String) - Method in class com.onlinepayments.domain.RedirectData: The URL that the customer should be redirected to.
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.CaptureOutput: Object that holds all reference properties that are linked to this transaction
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.CapturePaymentRequest: Object that holds all reference properties that are linked to this transaction
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.CreatePayoutRequest: Object that holds all reference properties that are linked to this transaction
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.OperationOutput: Object that holds all reference properties that are linked to this transaction
withReferences(OrderReferences) - Method in class com.onlinepayments.domain.Order: Object that holds all reference properties that are linked to this transaction
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.PaymentOutput: Object that holds all reference properties that are linked to this transaction
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.RefundOutput: Object that holds all reference properties that are linked to this transaction
withReferences(PaymentReferences) - Method in class com.onlinepayments.domain.RefundRequest: Object that holds all reference properties that are linked to this transaction
withRefundOutput(RefundOutput) - Method in class com.onlinepayments.domain.RefundResponse: Object containing refund details
withRefundResult(RefundResponse) - Method in class com.onlinepayments.domain.RefundErrorResponse: This object has the numeric representation of the current refund status, timestamp of last status change and performable action on the current refund resource.
withRefunds(List<RefundResponse>) - Method in class com.onlinepayments.domain.RefundsResponse: The list of all refunds performed on the requested payment.
withRegularExpression(RegularExpressionValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withRegularExpression(String) - Method in class com.onlinepayments.domain.RegularExpressionValidator
withReOrderIndicator(Boolean) - Method in class com.onlinepayments.domain.ShoppingCart: Indicates whether the cardholder is reordering previously purchased item(s) true = the customer is re-ordering at least one of the items again false = this is the first time the customer is ordering these items
withRequiresApproval(Boolean) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificInput: * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically
withRequiresApproval(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API * false = the payment does not require approval, and the funds will be captured automatically
withRestrictTo(PaymentProductFilter) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedCheckout: Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment.
withRestrictTo(PaymentProductFilterHostedTokenization) - Method in class com.onlinepayments.domain.PaymentProductFiltersHostedTokenization: Contains the payment product ids that should be excluded from the payment products available for the payment.
withResult(String) - Method in class com.onlinepayments.domain.AcquirerSelectionInformation: Result of the acquirer selection operation
withResult(CurrencyConversionResult) - Method in class com.onlinepayments.domain.CurrencyConversionResponse: Result of a requested currency conversion
withResult(String) - Method in class com.onlinepayments.domain.CurrencyConversionResult: Functional response to the request: * Allowed: Dynamic currency conversion may be offered to the cardholder * InvalidCard: The card is not valid for dynamic currency conversion * InvalidMerchant: The card acceptor has not been recognised * NoRate: Exchange rates are not available * NotAvailable: Dynamic currency conversion is not available for other reason
withResult(String) - Method in class com.onlinepayments.domain.Surcharge: Token describing result.
withResult(String) - Method in class com.onlinepayments.domain.TestConnection
withResultReason(String) - Method in class com.onlinepayments.domain.CurrencyConversionResult: Plain text explaining the result of the currency conversion request
withRetriable(Boolean) - Method in class com.onlinepayments.domain.APIError: Flag indicating if the request is retriable.
withRETURNMAC(String) - Method in class com.onlinepayments.domain.CreateHostedCheckoutResponse: When the customer is returned to your site we will append this property and value to the query-string.
withRETURNMAC(String) - Method in class com.onlinepayments.domain.MandateRedirectData: A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment.
withRETURNMAC(String) - Method in class com.onlinepayments.domain.RedirectData: A Message Authentication Code (MAC) is used to authenticate the redirection back to merchant after the payment
withReturnUrl(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: The URL that the customer is redirect to after the payment flow has finished.
withReturnUrl(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: Return URL to use if the mandate signing requires redirection.
withReturnUrl(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Return URL to use if the mandate signing requires redirection.
withReturnUrl(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: The URL that the customer is redirect to after the payment flow has finished.
withReturnUrl(String) - Method in class com.onlinepayments.domain.RedirectionData: The URL that the customer is redirected to after the payment flow has finished.
withRuleName(String) - Method in class com.onlinepayments.domain.AcquirerSelectionInformation: Name of the rule used to select the acquirer
withScheme(String) - Method in class com.onlinepayments.ProxyConfiguration
withSchemeEci(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure ECI (Electronic Commerce Indicator) depending on the Scheme.
withSchemeReferenceData(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication.
withSchemeReferenceData(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication.
withSchemeReferenceData(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: This is the unique Scheme Reference Data from the initial transaction that was performed with a Strong Customer Authentication.
withSchemeRiskScore(Integer) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: Global score calculated by the Carte Bancaire (130) Scoring platform.
withScreenHeight(String) - Method in class com.onlinepayments.domain.BrowserData: Height of the screen in pixels.
withScreenWidth(String) - Method in class com.onlinepayments.domain.BrowserData: Width of the screen in pixels.
withSecretApiKey(String) - Method in class com.onlinepayments.CommunicatorConfiguration
withSecretKeyStore(SecretKeyStore) - Method in class com.onlinepayments.webhooks.WebhooksHelperBuilder: Sets the SecretKeyStore to use.
withSecureCorporatePayment(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecure: Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
withSecureCorporatePayment(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecureBase: Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies Logically this field should only be set to yes if the acquirer exemption field is blank.
withSepaDirectDebitPaymentMethodSpecificInput(SepaDirectDebitPaymentMethodSpecificInputBase) - Method in class com.onlinepayments.domain.CreateHostedCheckoutRequest: Object containing the specific input details for SEPA direct debit payments
withSepaDirectDebitPaymentMethodSpecificInput(SepaDirectDebitPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.CreatePaymentRequest: Object containing the specific input details for SEPA direct debit payments
withSepaDirectDebitPaymentMethodSpecificOutput(SepaDirectDebitPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing the SEPA direct debit details
withSepaDirectDebitPaymentMethodSpecificOutput(SepaDirectDebitPaymentMethodSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing the SEPA direct debit details
withSessionTimeout(Integer) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: The number of minutes after which the session will expire.
withShipping(Shipping) - Method in class com.onlinepayments.domain.Order: Object containing information regarding shipping / delivery
withShippingCost(Long) - Method in class com.onlinepayments.domain.Shipping: Cost associated with the shipping of the order.
withShippingCostTax(Long) - Method in class com.onlinepayments.domain.Shipping: Tax amount of the shipping cost.
withShoppingCart(ShoppingCart) - Method in class com.onlinepayments.domain.Order: Shopping cart data, including items and specific amounts.
withShoppingCartExtension(ShoppingCartExtension) - Method in class com.onlinepayments.CommunicatorConfiguration
withShoppingCartExtension(ShoppingCartExtension) - Method in class com.onlinepayments.MetaDataProviderBuilder: Sets the shopping cart extension to use.
withShowFormData(ShowFormData) - Method in class com.onlinepayments.domain.MerchantAction: Object returned for the SHOW_FORM actionType.
withShowResultPage(Boolean) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: * true - Default - Hosted Checkout will show a result page to the customer when applicable.
withSignatureType(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: Specifies whether the mandate is unsigned or signed by SMS.
withSignatureType(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: Specifies whether the mandate is unsigned or signed by SMS.
withSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Deprecated: Use threeDSecure.skipAuthentication instead.
withSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.GPayThreeDSecure: * true = 3D Secure authentication will be skipped for this transaction.
withSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecure: * true = 3D Secure authentication will be skipped for this transaction.
withSkipAuthentication(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecureBase: * true = 3D Secure authentication will be skipped for this transaction.
withSkipSoftDecline(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecure: * true = Soft Decline retry mechanism will be skipped for this transaction.
withSkipSoftDecline(Boolean) - Method in class com.onlinepayments.domain.ThreeDSecureBase: * true = Soft Decline retry mechanism will be skipped for this transaction.
withSocketTimeout(int) - Method in class com.onlinepayments.CommunicatorConfiguration
withSource(String) - Method in class com.onlinepayments.domain.RateDetails: Indicates the exchange rate source name.
withSpecificRate(Integer) - Method in class com.onlinepayments.domain.SurchargeRate: A specific, fixed rate in cents defined on a merchant's configuration that is used in the calculation of a surcharge amount.
withSpeed(Integer) - Method in class com.onlinepayments.domain.ShippingMethod: Number of hours to delivery
withState(String) - Method in class com.onlinepayments.domain.Address: Full name of the state or province
withState(String) - Method in class com.onlinepayments.domain.AddressPersonal: Full name of the state or province
withStatus(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Possible values: * READ_ONLY - attribute cannot be updated and should be presented in that way to the user * CAN_WRITE - attribute can be updated and should be presented as an editable field, for example an expiration date that will expire very soon * MUST_WRITE - attribute should be updated and must be presented as an editable field, for example an expiration date that has already expired Any updated values that are entered for CAN_WRITE or MUST_WRITE will be used to update the values stored in the token.
withStatus(String) - Method in class com.onlinepayments.domain.Capture: Current high-level status of the payment in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.CaptureResponse: Current high-level status of the payment in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.GetHostedCheckoutResponse: This is the status of the hosted checkout.
withStatus(String) - Method in class com.onlinepayments.domain.MandateResponse
withStatus(String) - Method in class com.onlinepayments.domain.OperationOutput: Current high-level status of the payment in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: Current high-level status of the payment in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.PaymentLinkResponse: The state of the payment link: * ACTIVE: The payment link is ready to be used.
withStatus(String) - Method in class com.onlinepayments.domain.PaymentResponse: Current high-level status of the payment in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.PayoutResponse: Current high-level status of the payout in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.PayoutResult: Current high-level status of the payout in a human-readable form.
withStatus(String) - Method in class com.onlinepayments.domain.RefundResponse: Current high-level status of the payment in a human-readable form.
withStatusCategory(String) - Method in class com.onlinepayments.domain.OrderStatusOutput: Highlevel status of the payment, payout or refund.
withStatusCategory(String) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Highlevel status of the payment, payout or refund.
withStatusCategory(String) - Method in class com.onlinepayments.domain.PayoutStatusOutput: Highlevel status of the payment, payout or refund.
withStatusCode(Integer) - Method in class com.onlinepayments.domain.CaptureStatusOutput: Numeric status code of the legacy API.
withStatusCode(Integer) - Method in class com.onlinepayments.domain.OrderStatusOutput: Numeric status code of the legacy API.
withStatusCode(Integer) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Numeric status code of the legacy API.
withStatusCode(Integer) - Method in class com.onlinepayments.domain.PayoutStatusOutput: Numeric status code of the legacy API.
withStatusCodeChangeDateTime(String) - Method in class com.onlinepayments.domain.OrderStatusOutput: Timestamp of the latest status change
withStatusCodeChangeDateTime(String) - Method in class com.onlinepayments.domain.PaymentStatusOutput: Timestamp of the latest status change
withStatusOutput(CaptureStatusOutput) - Method in class com.onlinepayments.domain.Capture: This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current payment resource.
withStatusOutput(CaptureStatusOutput) - Method in class com.onlinepayments.domain.CaptureResponse: This object has the numeric representation of the current capture status, timestamp of last status change and performable action on the current payment resource.
withStatusOutput(PaymentStatusOutput) - Method in class com.onlinepayments.domain.OperationOutput: This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.
withStatusOutput(PaymentStatusOutput) - Method in class com.onlinepayments.domain.PaymentDetailsResponse: This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.
withStatusOutput(PaymentStatusOutput) - Method in class com.onlinepayments.domain.PaymentResponse: This object has the numeric representation of the current payment status, timestamp of last status change and performable action on the current payment resource.
withStatusOutput(PayoutStatusOutput) - Method in class com.onlinepayments.domain.PayoutResponse
withStatusOutput(PayoutStatusOutput) - Method in class com.onlinepayments.domain.PayoutResult
withStatusOutput(OrderStatusOutput) - Method in class com.onlinepayments.domain.RefundResponse
withStopoverCode(String) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Possible values are: * permitted = Stopover permitted * non-permitted = Stopover not permitted This field is used by the following payment products: cards, 840
withStreet(String) - Method in class com.onlinepayments.domain.Address: Street name
withStreet(String) - Method in class com.onlinepayments.domain.AddressPersonal: Street name
withStreet(String) - Method in class com.onlinepayments.domain.MandateAddress: Streetname.
withSubsequentcardPaymentMethodSpecificInput(SubsequentCardPaymentMethodSpecificInput) - Method in class com.onlinepayments.domain.SubsequentPaymentRequest: Object containing the specific input details for subsequent card payments
withSubsequentType(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: Determines the type of the subsequent that will be used.
withSurchargeAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Surcharge: Object containing amount and ISO currency code attributes
withSurchargeAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.SurchargeSpecificInput: Object containing amount and ISO currency code attributes
withSurchargeAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.SurchargeSpecificOutput: Object containing amount and ISO currency code attributes
withSurchargeProductTypeId(String) - Method in class com.onlinepayments.domain.SurchargeRate: The name of the applicable surcharge rates for the relevant payment product
withSurchargeProductTypeVersion(String) - Method in class com.onlinepayments.domain.SurchargeRate: A specific version identifier of the surcharge rates as applied for this request
withSurchargeRate(SurchargeRate) - Method in class com.onlinepayments.domain.Surcharge: A summary of surcharge details used in the calculation of the surcharge amount.
withSurchargeRate(SurchargeRate) - Method in class com.onlinepayments.domain.SurchargeSpecificOutput: A summary of surcharge details used in the calculation of the surcharge amount.
withSurcharges(List<Surcharge>) - Method in class com.onlinepayments.domain.CalculateSurchargeResponse: List of surcharge calculations matching the bin and paymentProductId if supplied
withSurchargeSpecificInput(SurchargeSpecificInput) - Method in class com.onlinepayments.domain.Order: Object containing specific input required to apply surcharging to an order.
withSurchargeSpecificOutput(SurchargeSpecificOutput) - Method in class com.onlinepayments.domain.CaptureOutput: Object containing specific surcharging attributes applied to an order.
withSurchargeSpecificOutput(SurchargeSpecificOutput) - Method in class com.onlinepayments.domain.PaymentOutput: Object containing specific surcharging attributes applied to an order.
withSurname(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Surname of the passenger This field is used by the following payment products: cards, 840
withSurname(String) - Method in class com.onlinepayments.domain.LoanRecipient: Surname of the recipient of the loan.
withSurname(String) - Method in class com.onlinepayments.domain.MandatePersonalName: Surname(s) or last name(s) of the customer.
withSurname(String) - Method in class com.onlinepayments.domain.PaymentProduct840CustomerAccount: Surname of the PayPal account holder
withSurname(String) - Method in class com.onlinepayments.domain.PersonalName: Surname(s) or last name(s) of the customer
withSurname(String) - Method in class com.onlinepayments.domain.PersonalNameToken
withSurnamePrefix(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Surname prefix or middle name of the passenger This field is used by the following payment products: 840
withTargetAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.DccProposal: Object containing amount and ISO currency code attributes
withTaxAmount(Long) - Method in class com.onlinepayments.domain.OrderLineDetails: Tax on the line item, with the last two digits implied as decimal places
withTaxes(Integer) - Method in class com.onlinepayments.domain.AirlineFlightLeg: Taxes for this leg of the trip This field is used by the following payment products: 840
withTermsAndConditions(EmptyValidator) - Method in class com.onlinepayments.domain.PaymentProductFieldValidators
withThreeDSecure(ThreeDSecure) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Object containing specific data regarding 3-D Secure
withThreeDSecure(ThreeDSecureBase) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Object containing specific data regarding 3-D Secure
withThreeDSecure(GPayThreeDSecure) - Method in class com.onlinepayments.domain.MobilePaymentProduct320SpecificInput: Object containing specific data regarding 3-D Secure
withThreeDSecure(PaymentProduct130SpecificThreeDSecure) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificInput: Object containing specific data regarding 3-D Secure
withThreeDSecureResults(ThreeDSecureResults) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: 3D Secure results object
withThreeDSecureResults(ThreeDSecureResults) - Method in class com.onlinepayments.domain.MobilePaymentMethodSpecificOutput: 3D Secure results object
withThreeDSecureVersion(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The 3-D Secure version used for the authentication.
withTicketCurrency(String) - Method in class com.onlinepayments.domain.AirlineData: Three-letter ISO currency code representing the currency in which ticket purchase amount is expressed.
withTicketDeliveryMethod(String) - Method in class com.onlinepayments.domain.AirlineData: Deprecated: This field is not used by any payment product Delivery method of the ticket
withTicketNumber(String) - Method in class com.onlinepayments.domain.AirlineData: The ticket or document number contains: * Airline code: 3-digit airline code number * Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains * Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten * TICKETNUMBER can be replaced with PNR if the ticket number is unavailable This field is used by the following payment products: cards, 840
withTimezoneOffsetUtcMinutes(String) - Method in class com.onlinepayments.domain.CustomerDevice: Offset in minutes of timezone of the client versus the UTC.
withTitle(String) - Method in class com.onlinepayments.domain.AirlinePassenger: Deprecated: This field is not used by any payment product Title of the passenger (this property is used for fraud screening on the payment platform)
withTitle(String) - Method in class com.onlinepayments.domain.MandatePersonalInformation: Object containing the title of the customer (Mr, Miss or Mrs).
withTitle(String) - Method in class com.onlinepayments.domain.PersonalName: Title of customer
withToken(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: ID of the token to use to create the payment.
withToken(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: ID of the token to use to create the payment.
withToken(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificOutput: ID of the token.
withToken(String) - Method in class com.onlinepayments.domain.CardPayoutMethodSpecificInput: ID of the token
withToken(String) - Method in class com.onlinepayments.domain.CardSource: An identifier that represents card details that have been previously stored
withToken(String) - Method in class com.onlinepayments.domain.CreatedTokenResponse: ID of the token
withToken(String) - Method in class com.onlinepayments.domain.DccCardSource: An identifier that represents card details that have previously been stored
withToken(TokenResponse) - Method in class com.onlinepayments.domain.GetHostedTokenizationResponse
withToken(String) - Method in class com.onlinepayments.domain.PaymentCreationOutput: ID of the token.
withToken(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: ID of the token to use to create the payment.
withToken(String) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificOutput: ID of the token.
withToken(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: ID of the token to use to create the payment.
withTokenizationSucceeded(Boolean) - Method in class com.onlinepayments.domain.PaymentCreationOutput: Indicates if tokenization was successful or not.
withTokenize(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Indicates if this transaction should be tokenized * true - Tokenize the transaction.
withTokenize(Boolean) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Indicates if this transaction should be tokenized * true - Tokenize the transaction.
withTokenize(Boolean) - Method in class com.onlinepayments.domain.RedirectPaymentMethodSpecificInput: Indicates if this transaction should be tokenized * true - Tokenize the transaction.
withTokens(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
withTokens(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: String containing comma separated tokens (no spaces) associated with the customer of this hosted session.
withTokens(List<String>) - Method in class com.onlinepayments.domain.SessionRequest: List of previously stored tokens linked to the customer that wants to checkout.
withTokenStatus(String) - Method in class com.onlinepayments.domain.CreatedTokenResponse: This is the status of the token in the hosted tokenization session.
withTokenStatus(String) - Method in class com.onlinepayments.domain.GetHostedTokenizationResponse: This is the status of the token in the hosted tokenization session.
withTooltip(PaymentProductFieldTooltip) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayHints: Object that contains an optional tooltip to assist the customer
withTotalAmount(AmountOfMoney) - Method in class com.onlinepayments.domain.Surcharge: Object containing amount and ISO currency code attributes
withTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
withTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
withTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
withTotalAmountPaid(Long) - Method in class com.onlinepayments.domain.RefundRedirectMethodSpecificOutput
withTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundCardMethodSpecificOutput
withTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundEWalletMethodSpecificOutput
withTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundMobileMethodSpecificOutput
withTotalAmountRefunded(Long) - Method in class com.onlinepayments.domain.RefundRedirectMethodSpecificOutput
withTotalFare(Integer) - Method in class com.onlinepayments.domain.AirlineData: Total fare for all legs on the ticket, excluding taxes and fees.
withTotalFee(Integer) - Method in class com.onlinepayments.domain.AirlineData: Total fee for all legs on the ticket.
withTotalTaxes(Integer) - Method in class com.onlinepayments.domain.AirlineData: Total taxes for all legs on the ticket.
withTransaction(Transaction) - Method in class com.onlinepayments.domain.CurrencyConversionRequest
withTransactionChannel(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Indicates the channel via which the payment is created.
withTransactionChannel(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Indicates the channel via which the payment is created.
withTransactionChannel(String) - Method in class com.onlinepayments.domain.SubsequentCardPaymentMethodSpecificInput: Indicates the channel via which the payment is created.
withTransactionType(String) - Method in class com.onlinepayments.domain.OrderTypeInformation: Identifies the type of transaction being authenticated.
withTravelAgencyName(String) - Method in class com.onlinepayments.domain.AirlineData: Name of the travel agency issuing the ticket.
withType(String) - Method in class com.onlinepayments.domain.AmountBreakdown: Type of the amount.
withType(String) - Method in class com.onlinepayments.domain.PaymentLinkEvent: The type of event that occurred.
withType(String) - Method in class com.onlinepayments.domain.PaymentProductField
withType(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: The type of the display element.
withType(String) - Method in class com.onlinepayments.domain.PaymentProductFieldFormElement: Type of form element to be used.
withType(String) - Method in class com.onlinepayments.domain.ProtectionEligibility: - ItemNotReceivedEligible - Merchant is protected by PayPal's Seller Protection Policy for Item Not Received - UnauthorizedPaymentEligible - Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment - Ineligible - Merchant is not protected under the Seller Protection Policy
withType(String) - Method in class com.onlinepayments.domain.Shipping: Indicates the merchandise delivery timeframe.
withType(String) - Method in class com.onlinepayments.domain.ShippingMethod: Shipping method type
withTypeInformation(OrderTypeInformation) - Method in class com.onlinepayments.domain.AdditionalOrderInput: Object that holds the purchase and usage type indicators
withUniqueMandateReference(String) - Method in class com.onlinepayments.domain.CreateMandateRequest: The unique identifier of the mandate
withUniqueMandateReference(String) - Method in class com.onlinepayments.domain.CreateMandateWithReturnUrl: The unique identifier of the mandate
withUniqueMandateReference(String) - Method in class com.onlinepayments.domain.MandateResponse: The unique identifier of the mandate
withUnit(String) - Method in class com.onlinepayments.domain.OrderLineDetails: Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
withUnscheduledCardOnFileRequestor(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: Indicates which party initiated the unscheduled recurring transaction.
withUnscheduledCardOnFileRequestor(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: Indicates which party initiated the unscheduled recurring transaction.
withUnscheduledCardOnFileSequenceIndicator(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInput: * first = This transaction is the first of a series of unscheduled recurring transactions * subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.
withUnscheduledCardOnFileSequenceIndicator(String) - Method in class com.onlinepayments.domain.CardPaymentMethodSpecificInputBase: * first = This transaction is the first of a series of unscheduled recurring transactions * subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions Note: this property is not allowed if isRecurring is true.
withUsecase(String) - Method in class com.onlinepayments.domain.PaymentProduct130SpecificThreeDSecure: Indicates the type of payment for which an authentication is requested
withUserAgent(String) - Method in class com.onlinepayments.domain.CustomerDevice: User-Agent of the client device/browser from the HTTP Headers.
withUsername(String) - Method in class com.onlinepayments.ProxyConfiguration
withUsesRedirectionTo3rdParty(Boolean) - Method in class com.onlinepayments.domain.PaymentProduct: Indicates whether the payment product requires redirection to a third party to complete the payment.
withUtcTimestamp(String) - Method in class com.onlinepayments.domain.CustomerAccountAuthentication: Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
withUtcTimestamp(String) - Method in class com.onlinepayments.domain.ThreeDSecureData: Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
withValidationRules(CreditCardValidationRulesHostedTokenization) - Method in class com.onlinepayments.domain.CreditCardSpecificInputHostedTokenization
withValidators(PaymentProductFieldValidators) - Method in class com.onlinepayments.domain.PaymentProductFieldDataRestrictions: Object containing the details of the validations on the field
withValue(String) - Method in class com.onlinepayments.domain.AccountOnFileAttribute: Value of the key or property
withValue(String) - Method in class com.onlinepayments.domain.PaymentProductFieldDisplayElement: the value of the display element.
withValue(String) - Method in class com.onlinepayments.domain.ValueMappingElement: Value corresponding to the key
withValueMapping(List<ValueMappingElement>) - Method in class com.onlinepayments.domain.PaymentProductFieldFormElement: Deprecated: This field is not used by any payment product
withVariant(String) - Method in class com.onlinepayments.domain.CreateHostedTokenizationRequest: It is possible to upload multiple templates of your payment pages using the Merchant Portal.
withVariant(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificInput: It is possible to upload multiple templates of your payment pages using the Merchant Portal.
withVariant(String) - Method in class com.onlinepayments.domain.HostedCheckoutSpecificOutput: It is possible to upload multiple templates of your payment pages using the Merchant Portal.
withVersion(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: 3D Secure Protocol version used during this transaction.
withWorkPhoneNumber(String) - Method in class com.onlinepayments.domain.ContactDetails: International version of the work phone number of the customer including the leading + (i.e.
withXid(String) - Method in class com.onlinepayments.domain.ExternalCardholderAuthenticationData: The transaction ID that is used for the 3D Authentication
withXid(String) - Method in class com.onlinepayments.domain.ThreeDSecureResults: Transaction ID for the Authentication
withZip(String) - Method in class com.onlinepayments.domain.Address: Zip code
withZip(String) - Method in class com.onlinepayments.domain.AddressPersonal: Zip code
withZip(String) - Method in class com.onlinepayments.domain.LoanRecipient: Zip code of the recipient of the loan
withZip(String) - Method in class com.onlinepayments.domain.MandateAddress: Zip code.

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