Create hosted checkout

POST https://{domainname}/v1/{merchantId}/hostedcheckouts

Hosted Checkouts

Using hostedCheckouts you can process transactions using MyCheckout, our easy to use hosted responsive payment pages. Your consumers will be able to complete the payment process using MyCheckout that is hosted by us. Using these pages to capture card details and process card transactions will greatly reduce not only your integration efforts, but it will also reduce your 'PCI exposure' to the lowest level (SAQ-A).

The layout and look and feel of the MyCheckout Pages can be managed through the Configuration Center. Here you will find the powerful, yet very intuitive MyCheckout editor that lets you create multiple variations of your hosted payment pages hosted by us. If you have created multiple versions you are able to direct your consumers to specific variants through this API. This allows you easily test out different variations or continue specific campaigns all the way through to the payment pages.

The MyCheckout pages automatically adapt based on screen width of your consumers device. Clients that do not support JavaScript to be run on the client will still be able to make payments (although they will lack all the client side validation and automatic formatting to assist them). Please note that both the responsive nature and the support for clients without JavaScript support might not apply to 3rd party payment pages that the consumer might be redirected to to complete the payment.

MyCheckout is also modular in its setup, allowing you to specify exactly what you want us to do as part of your checkout flow. You decide if we should display the payment product selection and/or the confirmation page after a successful payment.

In case a payment product that requires the consumer to (manually) push the funds was selected, you will have the option to show these instructions again at a later moment. You could show them on your website in an area where the consumer can track the progress of their order. To avoid multiple payments you should however avoid showing them again for transactions that have already been paid.

Request

You can start a hostedCheckout flow by posting the relevant details to the endpoint. We will then return you all the details you need to redirect the consumer to us, retrieve the status and recognize the consumer when he/she returns to your website.

The hosted checkout allows the use of three distinct components:

Presenting a (filtered) list of payment products that the consumer can choose from;
Handling of the actual payment, potentially involving data capture, redirection and/or the displaying of payment instructions;
Presenting a confirmation/failure page after the payment.

Step 1 and 3 from the above list are optional. When no or partial filtering is provided, the first page the consumer will see is a payment product selection page. However, the hosted checkout will start as if a payment product had been selected if that specific payment product is the only entry in the request's restriction filters.

By providing payment product ids and groups in the hostedCheckoutSpecificInput's paymentProductFilters object, you can reduce the list of available payment products by either excluding or restricting to certain products. Note that at least one viable payment product must be left after filtering and that exclusion is leading, meaning that restricting and excluding the same product will lead to exclusion.

By setting the tokensOnly boolean to true, as part of the paymentProductFilters object, the consumer may only complete the payment using one of the accounts on file provided in the tokens property of hostedCheckoutSpecificInput.

By setting the showResultPage boolean to false, as part of the hostedCheckoutSpecificInput, the system will skip the confirmation/failure page after the consumer has completed the payment. This setting is true by default and the results page will be presented to the user.

In case the payment product selection page needs to be skipped the hostedCheckout call needs to contain one of the following objects in which all payment products have been categorized. These will also be used if the consumer selects a related payment product.

Bank transfer payments - bankTransferPaymentMethodSpecificInput
All payment products where consumers are asked to push their payment to a specific bank account. We will display payment instructions to the consumer.
Card payments - cardPaymentMethodSpecificInput
All credit and debit card products fall into this category if they allow for direct submission of card data without a redirect to a third party to capture the card details.
Cash payments - cashPaymentMethodSpecificInput
All payment products that allow the consumer to pay with cash at a physical location. The consumer is presented with instructions on how to make these kind of payments. In some cases we presents these instruction, while in other cases the instructions will be displayed by a 3rd party after a redirect.
Redirect payments - redirectPaymentMethodSpecificInput
All payment products that involve a redirect to a 3rd party to complete the payment directly online, like iDeal and PayPal.

A generic transaction can be submitted using the order and the fraudFields objects.

PayloadCreateHostedCheckoutRequest

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
bankTransferPaymentMethodSpecificInput	object	no	read close
close Description Object containing the specific input details for bank transfer payments SDK Object type BankTransferPaymentMethodSpecificInputBase
additionalReference	string (20)	no	read close
close Description Your additional reference identifier for this transaction. Data supplied in this property will also be returned in our report files, allowing you to reconcile the incoming funds.
paymentProductId	integer (5)	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
cardPaymentMethodSpecificInput	object	no	read close
close Description Object containing the specific input details for card payments SDK Object type CardPaymentMethodSpecificInputBase
acquirerPromotionCode	string (32)	no	read close
close Description In case you have been provided with a promotion code by an acquirer, you can use this property to flag the transaction as being part of a specific card payment product promotion.
authorizationMode	enum	no	read close
close Description Determines the type of the authorization that will be used. Allowed values: FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days. PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount. SALE - The payment creation results in an authorization that is already captured at the moment of approval. Only used with some acquirers, ingnored for acquirers that don't support this. In case the acquirer doesn't allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.
customerReference	string (17)	no	read close
close Description Reference of the customer for the payment (purchase order #, etc.) Only used with some acquirers.
initialSchemeTransactionId	string (100)	no	read close
close Description The unique scheme transactionId of the initial transaction that was performed with SCA. In case this is unknown a scheme transactionId of an earlier transaction part of the same sequence can be used as a fall-back. Strongly advised to be submitted for any MerchantInitiated or recurring transaction (a subsequent one).
paymentProductId	integer (5)	no	read close
close Description Deprecated for Hosted Checkouts: This property is deprecated for the hosted checkout flow. Use hostedCheckoutSpecificInput.paymentProductFilters instead. Payment product identifier Please see payment products for a full overview of possible values.
recurring	object	no	read close
close Description Object containing data related to recurring SDK Object type CardRecurrenceDetails
endDate	string (8)	depends	read close
close Description Date in YYYYMMDD after which there will be no further charges. If no value is provided we will set a default value of five years after we processed the first recurring transaction. Depends on: This property is required when isRecurring is set to true, property recurringPaymentSequenceIndicator is set to first and 3-D Secure version 2 is enabled for the merchant.
minFrequency	integer (4)	depends	read close
close Description Minimum number of days between authorizations. If no value is provided we will set a default value of 30 days. Depends on: This property is required when isRecurring is set to true, property recurringPaymentSequenceIndicator is set to first and 3-D Secure version 2 is enabled for the merchant.
recurringPaymentSequenceIndicator	string	depends	read close
close Description 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 last = This transaction is the last of a series of recurring transactions for payments that are processed by the WL Online Payment Acceptance platform 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. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response. Depends on: This property is required when isRecurring is set to true.
recurringPaymentSequenceIndicator	string	no	read close
close Deprecated: Use recurring.recurringPaymentSequenceIndicator instead. Description 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: This property will default to first when isRecurring is set to true. 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. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
requiresApproval	boolean	no	read close
close Description Deprecated for Ogone: This flag is deprecated for the Ogone payment platform. Use CardPaymentMethodSpecificInput.authorizationMode instead. Value 'true' of this property is mapped to authorizationMode FINAL_AUTHORIZATION and value 'false' is mapped to authorizationMode SALE. true = the payment requires approval before the funds will be captured false = the payment does not require approval, and the funds will be captured automatically If true, payments with status PENDING_APPROVAL can be captured with the Approve payment API and payments with the status PENDING_CAPTURE can be captured using the Capture payment API
skipAuthentication	boolean	no	read close
close Deprecated: Use threeDSecureBase.skipAuthentication instead. Description true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
skipFraudService	boolean	no	read close
close Description true = Fraud scoring will be skipped for this transaction false = Fraud scoring will not be skipped for this transaction Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.
threeDSecure	object	no	read close
close Description Object containing specific data regarding 3-D Secure SDK Object type ThreeDSecureBase
authenticationAmount	object	no	read close
close Description Allows you to send in an authentication amount which can be greater or equal to the order amount. The currency code of the authentication amount should be the same as the currency code of the order amount. In case you don't provide an authentication amount we will use the order amount for the authentication automatically. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
authenticationFlow	string	no	read close
close Description Indicates whether a transaction is performed in-app using an EMVco certified mobile SDK or inside a browser. Allowed values: browser = Customer is using a browser to complete the checkout (default) in-app = Customer is using an app with a 3-D Secure SDK to complete the checkout Note: We will add support for the in-app flow in a future release.
challengeCanvasSize	string	depends	read close
close Description Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are: 250x400 (default) 390x400 500x600 600x400 full-screen . Depends on: Required for 3-D Secure version 2 for the browser flow.
challengeIndicator	string	no	read close
close Description Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values: no-preference - You have no preference whether or not to challenge the customer (default) no-challenge-requested - you prefer the cardholder not to be challenged challenge-requested - you prefer the customer to be challenged challenge-required - you require the customer to be challenged
exemptionRequest	string	no	read close
close Description Type of strong customer authentication (SCA) exemption requested for this transaction. Possible values: none - No exemption flagging is to be used of this transaction (Default). automatic - Our systems will determine the best possible exemption based on the transaction parameters and the risk scores. transaction-risk-analysis - You have determined that this transaction is of low risk and are willing to take the liability. Please note that your fraud rate needs to stay below thresholds to allow your use of this exemption. low-value - The value of the transaction is below 30 EUR. Please note that the issuer will still require every 5th low-value transaction pithing 24 hours to be strongly authenticated. The issuer will also keep track of the cumulative amount authorized on the card. When this exceeds 100 EUR strong customer authentication is also required. whitelist - You have been whitelisted by the customer at the issuer.
priorThreeDSecureData	object	no	read close
close Description Object containing data regarding the customer authentication that occurred prior to the current transaction SDK Object type ThreeDSecureData
acsTransactionId	string (36)	no	read close
close Description The ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
method	string	no	read close
close Description Method of authentication used for this transaction. Possible values: frictionless = The authentication went without a challenge challenged = Cardholder was challenged avs-verified = The authentication was verified by AVS other = Another issuer method was used to authenticate this transaction
utcTimestamp	string (12)	no	read close
close Description Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
sdkData	object	no	read close
close Description Object containing 3-D Secure in-app SDK data. SDK Object type SdkDataInput
deviceRenderOptions	object	no	read close
close Description Object containing rendering options of the device. SDK Object type DeviceRenderOptions
sdkInterface	string	no	read close
close Description Lists all of the SDK Interface types that the device supports for displaying specific challenge user interfaces within the SDK. native = The app supports only a native user interface html = The app supports only an HTML user interface both = Both Native and HTML user interfaces are supported by the app
sdkUiType	string	no	read close
close Deprecated: Please use cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkUiTypes Description Lists all UI types that the device supports for displaying specific challenge user interfaces within the SDK. text = Text interface single-select = Select a single option multi-select = Select multiple options oob = Out of ounds html-other = HTML Other (only valid when cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkInterface is set to html)
sdkUiTypes	array	no	read close
close Description Lists all UI types that the device supports for displaying specific challenge user interfaces within the SDK. text = Text interface single-select = Select a single option multi-select = Select multiple options oob = Out of ounds html-other = HTML Other (only valid when cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkInterface is set to html)
sdkAppId	string (36)	no	read close
close Description Universally unique ID created upon all installations and updates of your app on a c Device. This will be newly generated and stored by the 3DS SDK for each installation or update
sdkEncryptedData	string (64000)	no	read close
close Description JWE Object containing data encrypted by the 3-D Secure SDK
sdkEphemeralPublicKey	string (256)	no	read close
close Description Public key component of the ephemeral key pair generated by the 3-D Secure SDK and used to establish session keys between the 3-D Secure SDK and ACS.
sdkMaxTimeout	string (2)	no	read close
close Description Indicates maximum amount of time (in minutes) for all exchanges. Minimum amount of minutes is 5.
sdkReferenceNumber	string (32)	no	read close
close Description Identifies the vendor and version for the 3-D Secure SDK that is integrated in your app, assigned by EMVCo when the 3-D Secure SDK is approved.
sdkTransactionId	string (36)	no	read close
close Description Universally unique transaction identifier assigned by the 3-D Secure SDK to identify a single transaction.
skipAuthentication	boolean	no	read close
close Description true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
transactionRiskLevel	string	no	read close
close Description In case you performed your own risk analysis, you can send us the results. This will be used by us in case you submit the value automatic for the exemptionRequest property. Possible values for this property are: low = the risk-level of this transaction has been determined to be low medium = the risk-level of this transaction has been determined to be medium high = the risk-level of this transaction has been determined to be high
token	string (40)	no	read close
close Description ID of the token that holds previously stored card data
tokenize	boolean	no	read close
close Description Indicates if this transaction should be tokenized true - Tokenize the transaction. false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
transactionChannel	enum	no	read close
close Description Indicates the channel via which the payment is created. Allowed values: ECOMMERCE - The transaction is a regular E-Commerce transaction. MAIL - The transaction is a Mail Order. MOTO - The transaction is a Mail Order/Telephone Order. TELEPHONE - The transaction is a Telephone Order. Defaults to ECOMMERCE.
unscheduledCardOnFileIndicator	string	no	read close
close Deprecated: Use unscheduledCardOnFileSequenceIndicator instead. Description 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.
unscheduledCardOnFileRequestor	string	depends	read close
close Description Indicates which party initiated the unscheduled recurring transaction. Allowed values: merchantInitiated - Merchant Initiated Transaction. cardholderInitiated - Cardholder Initiated Transaction. Notes: This property is not allowed if isRecurring is true. When a customer has chosen to use a token on a hosted checkout this property is set to "cardholderInitiated". Depends on: Required when unscheduledCardOnFileSequenceIndicator is 'subsequent'. Otherwise it must not be 'merchantInitiated'.
unscheduledCardOnFileSequenceIndicator	string	no	read close
close Description 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 Notes: This property is not allowed if isRecurring is true. On a hosted checkout this property is set to "first" if the customer asks to remember the payment details and to "subsequent" in all other cases.
cashPaymentMethodSpecificInput	object	no	read close
close Description Object containing the specific input details for cash payments SDK Object type CashPaymentMethodSpecificInputBase
paymentProductId	integer (5)	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
eInvoicePaymentMethodSpecificInput	object	no	read close
close Description Object containing the specific input details for eInvoice payments SDK Object type EInvoicePaymentMethodSpecificInputBase
paymentProductId	integer (5)	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
requiresApproval	boolean	no	read close
close Description 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
fraudFields	object	no depends no no yes	read close
close Description Object containing additional data that will be used to assess the risk of fraud Depends on: Required by the TechProcess platform. SDK Object type FraudFields
addressesAreIdentical	boolean	no	read close
close Deprecated: For risk assessments there is no replacement. For other calls, please use order.shipping.addressIndicator to indicate that the billing and shipping address are identical. Description Indicates that invoice and shipping addresses are equal.
blackListData	string (50)	no	read close
close Description Additional black list input
cardOwnerAddress	object	no	read close
close Deprecated: This should be the same as order.customer.billingAddress Description The address that belongs to the owner of the card SDK Object type Address
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Deprecated Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Deprecated Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Deprecated Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Deprecated Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Deprecated Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
customerIpAddress	string (45)	no depends no depends yes	read close
close Description The IP Address of the customer that is making the payment. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments with products 863 (WeChat Pay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments with products 863 (WeChat Pay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
defaultFormFill	string	no	read close
close Deprecated: Use order.customer.device.defaultFormFill instead Description Degree of default form fill, with the following possible values: automatically - All fields filled automatically automatically-but-modified - All fields filled automatically, but some fields were modified manually manually - All fields were entered manually
deviceFingerprintActivated	boolean	no	read close
close Deprecated: No replacement Description Indicates that the device fingerprint has been used while processing the order.
deviceFingerprintTransactionId	string	no	read close
close Deprecated: Use order.customer.device.deviceFingerprintTransactionId instead Description One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
giftCardType	string	no	read close
close Description One of the following gift card types: celebrate-fall - Celebrate Fall grandparents-day - Grandparent's Day independence-day - Independence Day anniversary - Anniversary birthday - Birthday congratulations - Congratulations april-fools-day - April Fool's Day easter - Easter fathers-day - Father's Day graduation - Graduation holiday - Holiday seasons-greetings - Season's Greetings passover - Passover kwanzaa - Kwanzaa halloween - Halloween mothers-day - Mother's Day new-years-day - New Year's Day bosses-day - Bosses' Day st-patricks-day - St. Patrick's Day sweetest-day - Sweetest Day christmas - Christmas baby-shower - Baby Shower thanksgiving - Thanksgiving other - Other valentines-day - Valentine's Day wedding - Wedding secretarys-day - Secretary's Day chinese-new-year - Chinese New Year hanukkah - Hanukkah
giftMessage	string (160)	no	read close
close Description Gift message
hasForgottenPwd	boolean	no	read close
close Deprecated: Use order.customer.account.hasForgottenPassword instead Description Specifies if the customer (initially) had forgotten their password true - The customer has forgotten their password false - The customer has not forgotten their password
hasPassword	boolean	no	read close
close Deprecated: Use order.customer.account.hasPassword instead Description Specifies if the customer entered a password to gain access to an account registered with the you true - The customer has used a password to gain access false - The customer has not used a password to gain access
isPreviousCustomer	boolean	no	read close
close Deprecated: Use order.customer.isPreviousCustomer instead Description Specifies if the customer has a history of online shopping with the merchant true - The customer is a known returning customer false - The customer is new/unknown customer
orderTimezone	string (2)	no depends no no yes	read close
close Description Timezone in which the order was placed. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the TechProcess platform.
shipComments	string (160)	no	read close
close Deprecated: Use order.shipping.comments instead Description Comments included during shipping
shipmentTrackingNumber	string (19)	no	read close
close Deprecated: Use order.shipping.trackingNumber instead Description Shipment tracking number
shippingDetails	object	no	read close
close Deprecated: No replacement Description Details on how the order is shipped to the customer SDK Object type FraudFieldsShippingDetails
methodDetails	string (50)	no	read close
close Deprecated: No replacement Description Details regarding the shipping method
methodSpeed	integer	no	read close
close Deprecated: No replacement Description Shipping method speed indicator
methodType	integer	no	read close
close Deprecated: No replacement Description Shipping method type indicator
userData	array	no	read close
close Description Array of up to 16 userData properties, each with a max length of 256 characters, that can be used for fraudscreening
website	string (60)	no	read close
close Deprecated: Use merchant.websiteUrl instead Description The website from which the purchase was made
hostedCheckoutSpecificInput	object	no	read close
close Description Object containing hosted checkout specific data SDK Object type HostedCheckoutSpecificInput
isRecurring	boolean	no	read close
close Description true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence. false - Only payment products that support one-off payments will be shown. The default value for this property is false.
locale	string (6)	no	read close
close Description Locale to use to present the MyCheckout payment pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
paymentProductFilters	object	no	read close
close Description 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. SDK Object type PaymentProductFiltersHostedCheckout
exclude	object	no	read close
close Description Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment. Note that excluding a payment product will ensure exclusion, even if the payment product is also present in the restrictTo filter, and that excluding a payment product group will exclude all payment products that are a part of that group, even if one or more of them are present in the restrictTo filters. SDK Object type PaymentProductFilter
groups	array	no	read close
close Description List containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called 'cards'.
products	array	no	read close
close Description List containing all payment product ids that should either be restricted to in or excluded from the payment context.
restrictTo	object	no	read close
close Description Contains the payment product ids and payment product groups that should be at most contained in the payment products available for completing the payment. Note that the list of payment products available for completing the payment will only contain payment products present in these filters, but not all payment products in these filters might be present in the list. Some of them might not be allowed in context or they might be present in the exclude filters. SDK Object type PaymentProductFilter
groups	array	no	read close
close Description List containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called 'cards'.
products	array	no	read close
close Description List containing all payment product ids that should either be restricted to in or excluded from the payment context.
tokensOnly	boolean	no	read close
close Description true - The customer may only complete the payment using one of the provided accounts on file. false -The customer can complete the payment using any way they like, as long as it is allowed in the payment context. Default. Note that the request must contain at least one valid account on file with an allowed payment product (not excluded and allowed in context) if this property is set to true, else the request will fail.
recurringPaymentsData	object	no	read close
close Description The object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information. Note: The data in this object is only meant for displaying recurring payments-related data on your checkout page. You still need to submit all the recurring payment-related data in the corresponding payment product-specific input. (example: cardPaymentMethodSpecificInput.recurring and cardPaymentMethodSpecificInput.isRecurring) SDK Object type RecurringPaymentsData
recurringInterval	object	yes	read close
close Description The object containing the frequency and interval between recurring payments. SDK Object type Frequency
interval	enum	yes	read close
close Description The interval between recurring payments specified as days, weeks, quarters, or years.
intervalFrequency	integer (4)	yes	read close
close Description The number of days, weeks, months, quarters, or years between recurring payments.
trialInformation	object	no	read close
close Description The object containing data of the trial period: no-cost or discounted time-constrained trial subscription period. SDK Object type TrialInformation
amountOfMoneyAfterTrial	object	yes	read close
close Description The object containing the amount and ISO currency code attributes of money to be paid after the trial period ends. Note: The property order.amountOfMoney should be populated with the amount to be paid during or for the trial period (no-cost or discounted time-constrained trial subscription period). SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
endDate	string (8)	depends	read close
close Description The date that the trial period ends in YYYYMMDD format. Depends on: Either trialInformation.endDate or trialInformation.trialPeriod needs to be provided for that.
isRecurring	boolean	no	read close
close Description The property specifying if there will be recurring charges throughout the trial period (when the trial period involves a temporary discounted rate). True = there will be recurring charges during the trial period False = there will not be recurring charges during the trial period
trialPeriod	object	depends	read close
close Description The object containing information on the trial period duration and the interval between payments during that period. Depends on: Either trialInformation.endDate or trialInformation.trialPeriod needs to be provided for that. SDK Object type TrialPeriod
duration	integer (4)	yes	read close
close Description The number of days, weeks, months, or years before the trial period ends.
interval	enum	yes	read close
close Description The interval for the trial period to finish specified as days, weeks, months, quarters, or years.
trialPeriodRecurring	object	no	read close
close Description The object containing the frequency and interval between recurring payments. Note: This object should only be populated if the frequency of recurring payments between the trial and regular periods is different. If you do not populated this object, then the same interval frequency and interval of recurringPaymentsData.recurringInterval will be used SDK Object type Frequency
interval	enum	yes	read close
close Description The interval between recurring payments specified as days, weeks, quarters, or years.
intervalFrequency	integer (4)	yes	read close
close Description The number of days, weeks, months, quarters, or years between recurring payments.
returnCancelState	boolean	no	read close
close Description This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result. If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS. The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change.
returnUrl	string (512)	no	read close
close Description The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the https:// protocol. IP addresses are not supported, neither localhost. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected.
showResultPage	boolean	no	read close
close Description true - MyCheckout will show a result page to the customer when applicable. Default. false - MyCheckout will redirect the customer back to the provided returnUrl when this is possible. The default value for this property is true.
tokens	string	no	read close
close Description String containing comma separated tokens (no spaces) associated with the customer of this hosted checkout. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the checkout.
validateShoppingCart	boolean	no	read close
close Description By default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off for a hosted checkout on the Ogone Payment Platform, in which case the rendering of the shopping cart will be skipped if any required information is missing. Use this when you want fraud-checks to be performed on the shopping cart, but do not want to suply all data needed for displaying it in the hosted checkout. The default value for this property is true.
variant	string	no	read close
close Description Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID of the variant.
merchant	object	no depends no no yes	read close
close Description Object containing information on you, the merchant Depends on: Required by the TechProcess platform. SDK Object type Merchant
configurationId	string	no	read close
close Description In case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.
contactWebsiteUrl	string (2048)	no	read close
close Description URL to find contact or support details to contact in case of questions.
seller	object	no	read close
close Description Object containing seller details SDK Object type Seller
address	object	no	read close
close Description Object containing the seller address details SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
channelCode	string (3)	no	read close
close Description This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
description	string (32)	no	read close
close Description Description of the seller
externalReferenceId	string (15)	no	read close
close Description Seller ID assigned by the Merchant Aggregator
geocode	string (5)	no	read close
close Description The sellers geocode
id	string (40)	no depends no yes no	read close
close Description The sellers identifier Depends on: Required by the GlobalCollect platform.
invoiceNumber	string (12)	no	read close
close Description Invoice number of the payment
isForeignRetailer	boolean	no	read close
close Description Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values: true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar) false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
mcc	string (5)	no	read close
close Description Merchant category code
name	string (128)	no depends no yes no	read close
close Description Name of the seller Depends on: Required by the GlobalCollect platform.
phoneNumber	string (32)	no	read close
close Description Main Phone Number
type	string	no depends no yes no	read close
close Description Seller type. Possible values: passport dni arg-identity-card civic-notebook enrollment-book cuil cuit general-register election-title cpf cnpj ssn citizen-ship col-identity-card alien-registration Depends on: Required by the GlobalCollect platform.
websiteUrl	string (60)	no depends no no yes	read close
close Description The website from which the purchase was made. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the TechProcess platform.
mobilePaymentMethodSpecificInput	object	depends	read close
close Description Object containing reference data for Google Pay (paymentProductId 320) and Apple Pay (paymentProductID 302). Depends on: This object is only required for hosted checkout requests where Google Pay (paymentProductId 320) or Apple Pay (paymentProductID 302) are available and the properties included in this object are not provided in the configuration center or need to be overwritten. SDK Object type MobilePaymentMethodSpecificInputHostedCheckout
authorizationMode	enum	no	read close
close Description Determines the type of the authorization that will be used. Allowed values: FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days. PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount. SALE - The payment creation results in an authorization that is already captured at the moment of approval. Only used with some acquirers, ingnored for acquirers that don't support this. In case the acquirer doesn't allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.
customerReference	string (17)	no	read close
close Description Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.
paymentProduct302SpecificInput	object	no	read close
close Description Object containing information specific to Apple Pay SDK Object type MobilePaymentProduct302SpecificInputHostedCheckout
businessName	string (64)	no	read close
close Description Used as an input for the Apple Pay payment button. Your default business name is configured in the Configuration Center. In case you want to use another business name than the one configured in the Configuration Center, provide your company name in a human readable form.
paymentProduct320SpecificInput	object	depends	read close
close Description Object containing information specific to Google Pay (paymentProductId 320) Depends on: This object is only required for hosted checkout requests where Google Pay (paymentProductId 320) is available and the properties included in this object are not provided in the configuration center or need to be overwritten. SDK Object type MobilePaymentProduct320SpecificInputHostedCheckout
merchantName	string	depends	read close
close Description Used as an input for the Google Pay payment sheet. Provide your company name in a human readable form. Depends on: In case no merchantName is provided in the configuration center it is required when Google Pay (paymentProductId 320) is available as a payment product for the Hosted Checkout session that is created.
merchantOrigin	string	depends	read close
close Description Used as an input for the Google Pay payment sheet. Provide the url of your webshop. For international (non-ASCII) domains, please use Punycode. Depends on: In case no merchantOrigin is provided in the configuration center it is required when Google Pay (paymentProductId 320) is available as a payment product for the Hosted Checkout session that is created.
threeDSecure	object	no depends yes depends no	read close
close Description Object containing specific data regarding 3-D Secure Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the browser flow. Required by the Ogone platform. Depends on: Required for 3-D Secure version 2 for the browser flow. SDK Object type GPayThreeDSecure
challengeCanvasSize	string	depends	read close
close Description Dimensions of the challenge window that potentially will be displayed to the customer. The challenge content is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the customer browser window. Possible values are: 250x400 (default) 390x400 500x600 600x400 full-screen . Depends on: Required for 3-D Secure version 2 for the browser flow.
challengeIndicator	string	no	read close
close Description Allows you to indicate if you want the customer to be challenged for extra security on this transaction. Possible values: no-preference - You have no preference whether or not to challenge the customer (default) no-challenge-requested - you prefer the cardholder not to be challenged challenge-requested - you prefer the customer to be challenged challenge-required - you require the customer to be challenged
exemptionRequest	string	no	read close
close Description Type of strong customer authentication (SCA) exemption requested for this transaction. Possible values: none - No exemption flagging is to be used of this transaction (Default). automatic - Our systems will determine the best possible exemption based on the transaction parameters and the risk scores. transaction-risk-analysis - You have determined that this transaction is of low risk and are willing to take the liability. Please note that your fraud rate needs to stay below thresholds to allow your use of this exemption. low-value - The value of the transaction is below 30 EUR. Please note that the issuer will still require every 5th low-value transaction pithing 24 hours to be strongly authenticated. The issuer will also keep track of the cumulative amount authorized on the card. When this exceeds 100 EUR strong customer authentication is also required. whitelist - You have been whitelisted by the customer at the issuer.
redirectionData	object	no depends yes depends no	read close
close Deprecated: No replacement Description Object containing browser specific redirection related data Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the browser flow. Required by the Ogone platform. Depends on: Required for 3-D Secure version 2 for the browser flow. SDK Object type RedirectionData
returnUrl	string (512)	depends	read close
close Deprecated: No replacement Description The URL that the customer is redirect to after the payment flow has finished. You can add any number of key value pairs in the query string that, for instance help you to identify the customer when they return to your site. Please note that we will also append some additional key value pairs that will also help you with this identification process. Note: The provided URL should be absolute and contain the https:// protocol. IP addresses are not supported, neither localhost. For use on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered on the device first. URLs without a protocol will be rejected. Depends on: Required for the creation of a payment using the /payments API. Required for 3-D Secure version 2 for the browser flow.
variant	string	no	read close
close Deprecated: No replacement Description Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. The redirection flow for 3-D Secure uses the MyCheckout payment pages to display the following types of pages: Redirection page - All redirection using a POST method will load a page in the browser of the customer that performs the actual redirection. This page contains a message to the customer explaining what is happening. MethodURL page - Certain Issuers will use a specific flow in case of 3-D Secure version 2 to directly collect information from the customer browser. This page contains a spinner indicating that this process is going on in. By specifying a specific variant you can force the use of another variant than the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID instead of the name of the variant. Note: In case you have defined a Dynamic 3D Secure rule that takes the variant into account this will only work if you explicitly specify the ID using this property.
skipAuthentication	boolean	no	read close
close Description true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring. false = 3D Secure authentication will not be skipped for this transaction. Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
paymentProductId	integer (5)	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
requiresApproval	boolean	no	read close
close Description 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
skipFraudService	boolean	no	read close
close Description true = Fraud scoring will be skipped for this transaction false = Fraud scoring will not be skipped for this transaction Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.
order	object	yes	read close
close Description Order object containing order related data SDK Object type Order
additionalInput	object	no depends no depends yes	read close
close Description Object containing additional input on the order Depends on: Required by the GlobalCollect platform for payments done with payment product 120 - UATP. Required by the GlobalCollect platform for hosted checkouts where payment product 120 - UATP is allowed. Required by the TechProcess platform. Depends on: Required for payments done with payment product 120 - UATP. Required for hosted checkouts where payment product 120 - UATP is allowed. SDK Object type AdditionalOrderInput
accountFundingRecipient	object	depends	read close
close Description Object containing specific data regarding the recipient of an account funding transaction Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. SDK Object type AccountFundingRecipient
accountNumber	string (50)	depends	read close
close Description Should be populated with the value of the corresponding accountNumberType of the recipient. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995 when order.additionalInput.accountFundingRecipient.accountNumberType is routingNumber, IBAN or bicNumber. When order.additionalInput.accountFundingRecipient.accountNumberType is set to cash then this property can be empty. When order.additionalInput.accountFundingRecipient.accountNumberType is set to giftCard then Gift card number to be filled.
accountNumberType	string	depends	read close
close Description Defines the account number type of the recipient. Possible values are: cash = Mode of payment is cash to the recipient. walletId = Digital wallet ID. routingNumber = Routing Transit Number is a code used by financial institutions to identify other financial institutions. iban = International Bank Account Number, is a standard international numbering system for identifying bank accounts. bicNumber = Bank Identification Code is a number that is used to identify a specific bank. giftCard = Gift card is a type of prepaid card that contains a specific amount of money that can be used at participating stores and marketplaces. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995 when order.additionalInput.accountFundingRecipient.accountNumber is provided.
address	object	no	read close
close Description Object containing the address details of the recipient of an account funding transaction. SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
dateOfBirth	string (8)	depends	read close
close Description The date of birth of the recipient Format: YYYYMMDD Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
name	object	depends	read close
close Description Object containing the name details of the recipient of an account funding transaction. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. SDK Object type AfrName
firstName	string (15)	yes	read close
close Description Given name(s) or first name(s) of the recipient of an account funding transaction.
surname	string (70)	yes	read close
close Description Surname(s) or last name(s) of the customer
partialPan	string (10)	depends	read close
close Description Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers. Depends on: Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.
airlineData	object	no depends no depends depends	read close
close Description Object that holds airline specific data Depends on: Required by the GlobalCollect platform for payments done with payment product 120 - UATP. Required by the GlobalCollect platform for hosted checkouts where payment product 120 - UATP is allowed. Required by the TechProcess platform for airline merchants. Depends on: Required for payments done with payment product 120 - UATP. Required for hosted checkouts where payment product 120 - UATP is allowed. Depends on: Required for airline merchants. SDK Object type AirlineData
agentNumericCode	string (8)	no	read close
close Description Numeric code identifying the agent
code	string (3)	no	read close
close Description Airline numeric code
flightDate	string (8)	no depends no no depends	read close
close Description Date of the Flight Format: YYYYMMDD Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
flightLegs	array of object	no depends no no depends	read close
close Description Object that holds the data on the individual legs of the ticket Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
items	object	no	read close
close SDK Object type AirlineFlightLeg
airlineClass	string	no	read close
close Description Reservation Booking Designator
arrivalAirport	string (3)	no depends no no depends	read close
close Description Arrival airport/city code Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
arrivalTime	string	no	read close
close Description The arrival time in the local time zone Format: HH:MM
carrierCode	string (2)	no	read close
close Description IATA carrier code
conjunctionTicket	string (14)	no	read close
close Description Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
couponNumber	string (1)	no	read close
close Description The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
date	string (8)	no depends no no depends	read close
close Description Date of the leg Format: YYYYMMDD Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
departureTime	string (6)	depends	read close
close Description The departure time in the local time at the departure airport Format: HH:MM Depends on: Required for PayPal (840) when Airline data is submitted
endorsementOrRestriction	string (20)	no	read close
close Description An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
exchangeTicket	string (15)	no	read close
close Description New ticket number that is issued when a ticket is exchanged
fare	string (12)	no	read close
close Description Fare of this leg
fareBasis	string (15)	no	read close
close Description Fare Basis/Ticket Designator
fee	integer	no	read close
close Description Fee for this leg of the trip
flightNumber	string (4)	depends	read close
close Description The flight number assigned by the airline carrier with no leading spaces Should be a numeric string Depends on: Required for PayPal (840) when Airline data is submitted
number	integer (5)	no	read close
close Description Sequence number of the flight leg
originAirport	string (3)	no depends no no depends	read close
close Description Origin airport/city code Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
passengerClass	string	no	read close
close Description PassengerClass if this leg
serviceClass	enum	no	read close
close Deprecated: Use passengerClass instead Description ServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform). Possible values are: economy premium-economy business first
stopoverCode	string	depends	read close
close Description Possible values are: permitted = Stopover permitted non-permitted = Stopover not permitted Depends on: Required for PayPal (840) when Airline data is submitted
taxes	integer	no	read close
close Description Taxes for this leg of the trip
invoiceNumber	string (6)	no	read close
close Description Airline tracing number
isETicket	boolean	no	read close
close Description true = The ticket is an E-Ticket false = the ticket is not an E-Ticket
isRegisteredCustomer	boolean	no	read close
close Deprecated: Use order.customer.accountType instead Description true = a registered known customer false = unknown customer
isRestrictedTicket	boolean	no	read close
close Description true - Restricted, the ticket is non-refundable false - No restrictions, the ticket is (partially) refundable
isThirdParty	boolean	no	read close
close Description true - The payer is the ticket holder false - The payer is not the ticket holder
issueDate	string (8)	no	read close
close Description 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. Format: YYYYMMDD
merchantCustomerId	string (16)	no	read close
close Description Your ID of the customer in the context of the airline data
name	string (20)	no	read close
close Description Name of the airline
numberInParty	integer	no	read close
close Description Total number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.
passengerName	string (49)	no depends no no depends	read close
close Description Name of passenger Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
passengers	array of object	no	read close
close Description Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
items	object	no	read close
close SDK Object type AirlinePassenger
firstName	string (15)	no	read close
close Description First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surname	string (70)	no	read close
close Description Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
surnamePrefix	string (15)	no	read close
close Description Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
title	string (35)	no	read close
close Description Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
placeOfIssue	string (15)	no	read close
close Description Place of issue For sales in the US the last two characters (pos 14-15) must be the US state code.
pnr	string (127)	no depends no no depends	read close
close Description Passenger name record Depends on: Required by the TechProcess platform for airline merchants. Depends on: Required for airline merchants.
pointOfSale	string (25)	no	read close
close Description IATA point of sale name
posCityCode	string (10)	no	read close
close Description city code of the point of sale
ticketDeliveryMethod	string	no	read close
close Description Possible values: e-ticket city-ticket-office airport-ticket-office ticket-by-mail ticket-on-departure
ticketNumber	string (13)	no	read close
close Description The ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it 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
totalFare	integer	no	read close
close Description Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
totalFee	integer	no	read close
close Description Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
totalTaxes	integer	no	read close
close Description Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
travelAgencyName	string (25)	no	read close
close Description Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
installments	object	no	read close
close Description Object containing data related to installments which can be used for card payments and only with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages. SDK Object type Installments
amountOfMoneyPerInstallment	object	no	read close
close Description The amount that will be paid per installment. The total amount of amountOfMoneyPerInstallment x numberOfInstallments can not be higher than the total amount of this transaction, although we will not validate that. For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
amountOfMoneyTotal	object	no	read close
close Description Object containing the total amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
frequencyOfInstallments	string	no	read close
close Description The frequency in which the installments will be collected from the customer. The possible values are: daily weekly monthly (default) quarterly For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid.
installmentPlanCode	integer	no	read close
close Description The code for the installment plan. The possible values are: 43 No-interest, 3 month Installmentplan 46No-interest, 6 month Installmentplan 49No-interest, 9 month Installmentplan 52No-interest, 12 month Installmentplan
interestRate	string	no	read close
close Description The interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75% For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer.
numberOfInstallments	integer (5)	no depends no yes no	read close
close Description The number of installments in which this transaction will be paid, which can be used for card payments at supported acquirers, or with specific payment products. Only used with some acquirers. In case you send in the details of this object, only the payment products (or combination of card products and acquirers) that support installments will be shown on the MyCheckout hosted payment pages. If this property is not provided the customer will not see details on the installment plan in a HostedCheckout. For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), there is a maximum of 12 installments. Depends on: Required by the GlobalCollect platform.
level3SummaryData	object	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown instead Description Object that holds Level3 summary data SDK Object type Level3SummaryData
discountAmount	integer (12)	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown with type DISCOUNT instead Description Discount on the entire transaction, with the last 2 digits are implied decimal places
dutyAmount	integer (12)	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown with type DUTY instead Description Duty on the entire transaction, with the last 2 digits are implied decimal places
shippingAmount	integer (12)	no	read close
close Deprecated: Use order.shoppingCart.amountBreakdown with type SHIPPING instead Description Shippingcost on the entire transaction, with the last 2 digits are implied decimal places
loanRecipient	object	depends	read close
close Deprecated: No replacement Description Object containing specific data regarding the recipient of a loan in the UK Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers. SDK Object type LoanRecipient
accountNumber	string (10)	depends	read close
close Deprecated: No replacement Description Should be filled with the last 10 digits of the bank account number of the recipient of the loan. Depends on: Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
dateOfBirth	string (8)	depends	read close
close Deprecated: No replacement Description The date of birth of the customer of the recipient of the loan. Format: YYYYMMDD Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
partialPan	string (10)	depends	read close
close Deprecated: No replacement Description Should be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan. Depends on: Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
surname	string (12)	depends	read close
close Deprecated: No replacement Description Surname of the recipient of the loan. Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
zip	string (10)	depends	read close
close Deprecated: No replacement Description Zip code of the recipient of the loan Depends on: Required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
lodgingData	object	no	read close
close Description Object that holds lodging specific data SDK Object type LodgingData
charges	array of object	no	read close
close Description Object that holds lodging related charges
items	object	no	read close
close SDK Object type LodgingCharge
chargeAmount	integer (12)	no	read close
close Description Amount of additional charges associated with the stay of the guest. Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
chargeAmountCurrencyCode	string (3)	no	read close
close Description Currency for Charge amount. The code should be in 3 letter ISO format.
chargeType	string	no	read close
close Description Type of additional charges associated with the stay of the guest. Allowed values: lodging telephone restaurant minibar giftshop laundry transport gratuity conferenceRoom audiovisual banquet internet earlyDeparture roomService loungeBar other
checkInDate	string (8)	no	read close
close Description The date the guest checks into (or plans to check in to) the facility. Format: YYYYMMDD
checkOutDate	string (8)	no	read close
close Description The date the guest checks out of (or plans to check out of) the facility. Format: YYYYMMDD
folioNumber	string (25)	no	read close
close Description The Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.
isConfirmedReservation	boolean	no	read close
close Description Indicates whether the room reservation is confirmed. true - The room reservation is confirmed false - The room reservation is not confirmed
isFacilityFireSafetyConform	boolean	no	read close
close Description Defines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation. true - The facility conform to the requirements false - The facility doesn't conform to the requirements
isNoShow	boolean	no	read close
close Description Indicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee. true - The customer is a no show false - Not applicable
isPreferenceSmokingRoom	boolean	no	read close
close Description Indicated the preference of the customer for a smoking or non-smoking room. true - A smoking room is preferred false - A non-smoking room is preferred
numberOfAdults	integer (3)	no	read close
close Description The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
numberOfNights	integer (4)	no	read close
close Description The number of nights for the lodging stay
numberOfRooms	integer (4)	no	read close
close Description The number of rooms rented for the lodging stay
programCode	string	no	read close
close Description Code that corresponds to the category of lodging charges detailed in this message. Allowed values: lodging - (Default) Submitted charges are for lodging noShow - Submitted charges are for the failure of the guest(s) to check in for reserved a room advancedDeposit - Submitted charges are for an Advanced Deposit to reserve one or more rooms If no value is submitted the default value lodging is used.
propertyCustomerServicePhoneNumber	string (20)	no	read close
close Description The international customer service phone number of the facility
propertyPhoneNumber	string (20)	no	read close
close Description The local phone number of the facility in an international phone number format
renterName	string (26)	no	read close
close Description Name of the person or business entity charged for the reservation and/or lodging stay
rooms	array of object	no	read close
close Description Object that holds lodging related room data
items	object	no	read close
close SDK Object type LodgingRoom
dailyRoomRate	string (12)	no	read close
close Description Daily room rate exclusive of any taxes and fees Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomRateCurrencyCode	string (3)	no	read close
close Description Currency for Daily room rate. The code should be in 3 letter ISO format
dailyRoomTaxAmount	string (12)	no	read close
close Description Daily room tax Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
dailyRoomTaxAmountCurrencyCode	string (3)	no	read close
close Description Currency for Daily room tax. The code should be in 3 letter ISO format
numberOfNightsAtRoomRate	integer (4)	no	read close
close Description Number of nights charged at the rate in the dailyRoomRate property
roomLocation	string (10)	no	read close
close Description Location of the room within the facility, e.g. Park or Garden etc.
roomNumber	string (6)	no	read close
close Description Room number
typeOfBed	string (12)	no	read close
close Description Size of bed, e.g., king, queen, double.
typeOfRoom	string (12)	no	read close
close Description Describes the type of room, e.g., standard, deluxe, suite.
numberOfInstallments	integer (5)	no	read close
close Deprecated: Use installments.numberOfInstallments instead. Description The number of installments in which this transaction will be paid, which can be used for card payments. Only used with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.
orderDate	string (14)	no	read close
close Description Date and time of order Format: YYYYMMDDHH24MISS
typeInformation	object	no	read close
close Description Object that holds the purchase and usage type indicators SDK Object type OrderTypeInformation
fundingType	string	depends	read close
close Description Identifies the funding type being authenticated. Possible values are: personToPerson = When it is person to person funding (P2P) agentCashOut = When fund is being paid out to final recipient in Cash by company's agent. businessToConsumer = When fund is being transferred from business to consumer (B2C) businessToBusiness = When fund is being transferred from business to business (B2B) prefundingStagedWallet = When funding is being used to load the funds into the wallet account. storedValueDigitalWallet = When funding is being used to load the funds into a stored value digital wallet. fundingGiftCardForPersonalUse = When funding a gift card for personal use. fundingGiftCardForSomeoneElse = When funding a gift card for someone else. Depends on: Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995.
paymentCode	string	no	read close
close Description Payment code to support account funding transactions. Possible values are: accountManagement paymentAllowance settlementOfAnnuity unemploymentDisabilityBenefit businessExpenses bonusPayment busTransportRelatedBusiness cashManagementTransfer paymentOfCableTVBill governmentInstituteIssued creditCardPayment creditCardBill charity collectionPayment commercialPayment commission compensation copyright debitCardPayment deposit dividend studyFees electricityBill energies generalFees ferry foreignExchange gasBill unemployedCompensation governmentPayment healthInsurance reimbursementCreditCard reimbursementDebitCard carInsurancePremium insuranceClaim installment insurancePremium investmentPayment intraCompany interest incomeTax investment laborInsurance licenseFree lifeInsurance loan medicalServices mobilePersonToBusiness mobilePersonToPerson mobileTopUp notSpecified other anotherTelecomBill payroll pensionFundContribution pensionPayment telephoneBill propertyInsurance generalLease rent railwayPayment royalties salary savingsPayment securities socialSecurity study subscription supplierPayment taxRefund taxPayment telecommunicationsBill tradeServices treasuryPayment travelPayment utilityBill valueAddedTaxPayment withHolding waterBill .
purchaseType	string	no	read close
close Description Possible values are: physical digital
transactionType	string	depends	read close
close Description Identifies the type of transaction being authenticated. Possible values are: purchase = The purpose of the transaction is to purchase goods or services (Default) check-acceptance = The purpose of the transaction is to accept a 'check'/'cheque' account-funding = The purpose of the transaction is to fund an account quasi-cash = The purpose of the transaction is to buy a quasi cash type product that is representative of actual cash such as money orders, traveler's checks, foreign currency, lottery tickets or casino gaming chips prepaid-activation-or-load = The purpose of the transaction is to activate or load a prepaid card Depends on: Required for merchants from Brazil in case order.amountOfMoney.amount is not 0. Merchants with MCC codes (V4829, V6012, M4829, V6051, M6540, 7995) need to indicate the transaction as account-funding.
usageType	string	no	read close
close Description Possible values are: private commercial
amountOfMoney	object	yes	read close
close Description Object containing amount and ISO currency code attributes SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
customer	object	depends	read close
close Description Object containing the details of the customer Depends on: Required, except when a token has been included in the request that includes at least the countryCode in the billingAddress. SDK Object type Customer
account	object	no	read close
close Description Object containing data related to the account the customer has with you SDK Object type CustomerAccount
authentication	object	no	read close
close Description Object containing data on the authentication used by the customer to access their account SDK Object type CustomerAccountAuthentication
data	string (20000)	no	read close
close Description Data that documents and supports a specific authentication process submitted using the order.customer.account.authentication.method property. The data submitted using this property will be used by the issuer to validate the used authentication method. For example, if the order.customer.account.authentication.method is: federated-id, then this element can carry information about the provider of the federated ID and related information. fido-authentication, then this element can carry the FIDO attestation data (including the signature). fido-authentication-with-signed-assurance-data, then this element can carry FIDO Attestation data with the FIDO assurance data signed. src-assurance-data, then this element can carry the SRC assurance data
method	string	depends	read close
close Description Authentication used by the customer on your website or app Possible values : 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 fido-authentication-with-signed-assurance-data = the customer logged in using a FIDO authenticator which also provides signed assurance data src-assurance-data = the customer authenticated themselves during a Secure Remote Commerce session Depends on: Required when order.customer.account.authentication.data is provided.
utcTimestamp	string (12)	no	read close
close Description Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
changeDate	string (8)	no	read close
close Description The last date (YYYYMMDD) on which the customer made changes to their account with you. These are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
changedDuringCheckout	boolean	no	read close
close Description true = the customer made changes to their account during this checkout false = the customer didn't change anything to their account during this checkout/n The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
createDate	string (8)	no	read close
close Description The date (YYYYMMDD) on which the customer created their account with you
hadSuspiciousActivity	boolean	no	read close
close Description 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
hasForgottenPassword	boolean	no	read close
close Description Specifies if the customer (initially) had forgotten their password true - The customer has forgotten their password false - The customer has not forgotten their password
hasPassword	boolean	no	read close
close Description Specifies if the customer entered a password to gain access to an account registered with the you true - The customer has used a password to gain access false - The customer has not used a password to gain access
passwordChangeDate	string (8)	no	read close
close Description The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
passwordChangedDuringCheckout	boolean	no	read close
close Description 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 alse = the customer didn't change anything to their password of the account used during this checkout
paymentAccountOnFile	object	no	read close
close Description Object containing information on the payment account data on file (tokens) SDK Object type PaymentAccountOnFile
createDate	string (8)	no	read close
close Description The date (YYYYMMDD) when the payment account on file was first created. In case a token is used for the transaction we will use the creation date of the token in our system in case you leave this property empty.
numberOfCardOnFileCreationAttemptsLast24Hours	integer (3)	no	read close
close Description Number of attempts made to add new card to the customer account in the last 24 hours
paymentAccountOnFileType	string	depends	read close
close Description Indicates the type of account. For example, for a multi-account card product. not-applicable = the card used doesn't support multiple card products credit = the card used is a credit card debit = the card used is a debit card Depends on: Required for merchants in Brazil
paymentActivity	object	no	read close
close Description Object containing data on the purchase history of the customer with you SDK Object type CustomerPaymentActivity
numberOfPaymentAttemptsLast24Hours	integer (3)	no	read close
close Description Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
numberOfPaymentAttemptsLastYear	integer (3)	no	read close
close Description Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
numberOfPurchasesLast6Months	integer (4)	no	read close
close Description Number of successful purchases made by this customer with you in the last 6 months
accountType	string	no	read close
close Description Type of the customer account that is used to place this order. Can have one of the following values: none - The account that was used to place the order with is a guest account or no account was used at all created - The customer account was created during this transaction existing - The customer account was an already existing account prior to this transaction
billingAddress	object	depends	read close
close Description Object containing billing address details Depends on: Required, except when a token has been included in the request that includes at least the countryCode. For Direct Debit UK (705) the city, street and zip properties are also required, except when a token has been included in the request that includes these properties. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540. Required for cross-border TechProcess merchants. SDK Object type Address
additionalInfo	string (50)	no	read close
close Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
companyInformation	object	depends depends no no depends	read close
close Description Object containing company information Depends on: Required for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits Brazil: Company (CNPJ) - 14 digits Depends on: Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits Brazil: Company (CNPJ) - 14 digits Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to true. Depends on: Required for cross-border payments when the property order.customer.isCompany is set to true. SDK Object type CompanyInformation
dateOfIncorporation	string (8)	no depends no no depends	read close
close Description The date of incorporation is the specific date when the company was registered with the relevant authority. Format: YYYYMMDD Depends on: Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to true. Depends on: Required for cross-border payments when the property order.customer.isCompany is set to true.
name	string (40)	depends depends no no no	read close
close Description Name of company, as a customer Depends on: Required for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits. Brazil: Company (CNPJ) - 14 digits. Depends on: Required by the WOPA platform for payments when the property order.customer.fiscalNumber is set to: Argentina: Company (CUIT) - 11 digits. Brazil: Company (CNPJ) - 14 digits.
vatNumber	string (17)	depends	read close
close Description Local VAT number of the company Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification
contactDetails	object	depends depends no depends yes	read close
close Description Object containing contact details like email address and phone number Depends on: Required for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), China UnionPay (paymentProductId 869), AfterPay Installments (paymentProductId 9000) or AfterPay Invoice (paymentProductId 9001). Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). Required by the WOPA platform for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Required by the TechProcess platform. Depends on: Required for payments with Trustly (paymentProductId 806), China UnionPay (paymentProductId 869), AfterPay Installments (paymentProductId 9000) or AfterPay Invoice (paymentProductId 9001). Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). SDK Object type ContactDetails
emailAddress	string (70)	depends depends no depends depends	read close
close Description Email address of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Required by the WOPA platform for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for payments.
emailMessageType	string	no	read close
close Description Preference for the type of email message markup plain-text html
faxNumber	string (20)	no	read close
close Description Fax number of the customer
mobilePhoneNumber	string (20)	depends depends no depends depends	read close
close Description International version of the mobile phone number of the customer including the leading + (i.e. +16127779311). Depends on: Required for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104) or Pix (paymentProductId 6105) if phoneNumber is not provided. Depends on: Required by the GlobalCollect platform for Create Payments API calls for paymentProductId 869 (China UnionPay). Optional for other cases like Create hostedCheckouts API calls, even when using paymentProductId 869 (China UnionPay) on the payment pages as the customer will be asked to fill this in. Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Required by the WOPA platform for payments with Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104) or Pix (paymentProductId 6105) if phoneNumber is not provided. Required by the TechProcess platform for for cross-border payments. Depends on: Required for Create Payments API calls for paymentProductId 869 (China UnionPay). Optional for other cases like Create hostedCheckouts API calls, even when using paymentProductId 869 (China UnionPay) on the payment pages as the customer will be asked to fill this in. Required for payments with product BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for for cross-border payments.
phoneNumber	string (20)	depends depends no depends depends	read close
close Description Phone number of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul) or 6104 (Bradesco) if mobilePhoneNumber is not provided. Depends on: Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments), 9001 (AfterPay Invoice), 1504 (Konbini). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul) or 6104 (Bradesco) if mobilePhoneNumber is not provided. Required by the TechProcess platform for payments. Depends on: Required for payments with product 9000 (AfterPay Installments), 9001 (AfterPay Invoice), 1504 (Konbini). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for payments.
workPhoneNumber	string (20)	no depends no depends no	read close
close Description International version of the work phone number of the customer including the leading + (i.e. +31235671500) Depends on: Required by the GlobalCollect platform for payments. One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber Depends on: Required for payments. One of the following properties is required for 3-D Secure version 2 for the authenticationFlow "browser": order.customer.contactDetails.phoneNumber order.customer.contactDetails.workPhoneNumber order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber
device	object	depends depends no no depends	read close
close Description Object containing information on the device and browser of the customer Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the TechProcess platform for payments. Depends on: Required for payments. SDK Object type CustomerDevice
acceptHeader	string (2048)	depends	read close
close Description The accept-header of the customer client from the HTTP Headers. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
browserData	object	depends depends no no no	read close
close Description Object containing information regarding the browser of the customer Depends on: Required for Required for 3-D Secure version 2 for the browser flow. Depends on: Required by the WOPA platform for Required for 3-D Secure version 2 for the browser flow. SDK Object type BrowserData
colorDepth	integer (2)	depends	read close
close Description ColorDepth in bits. Value is returned from the screen.colorDepth property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
innerHeight	string (6)	no	read close
close Description The innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
innerWidth	string (6)	no	read close
close Description The innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
javaEnabled	boolean	depends	read close
close Description true =Java is enabled in the browser false = Java is not enabled in the browser Value is returned from the navigator.javaEnabled property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
javaScriptEnabled	boolean	depends	read close
close Description true = JavaScript is enabled in the browser false = JavaScript is not enabled in the browser Note: Required in future 3-D Secure version 2.2. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
screenHeight	string (6)	depends	read close
close Description Height of the screen in pixels. Value is returned from the screen.height property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
screenWidth	string (6)	depends	read close
close Description Width of the screen in pixels. Value is returned from the screen.width property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser"
defaultFormFill	string	no	read close
close Description Degree of default form fill, with the following possible values: automatically - All fields filled automatically automatically-but-modified - All fields filled automatically, but some fields were modified manually manually - All fields were entered manually
deviceFingerprintTransactionId	string	no	read close
close Description One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
ipAddress	string (45)	depends depends depends depends depends	read close
close Description The IP address of the customer client from the HTTP Headers. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the TechProcess platform for payments. Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for payments.
locale	string (8)	depends depends depends depends no	read close
close Description Locale of the client device/browser. Returned in the browser from the navigator.language property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser".
timezoneOffsetUtcMinutes	string (6)	depends depends depends depends no	read close
close Description Offset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser".
userAgent	string (2048)	depends depends depends depends depends	read close
close Description User-Agent of the client device/browser from the HTTP Headers. As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different. Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required by the GlobalCollect platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the Ogone platform for 3-D Secure version 2 for the authenticationFlow "browser". Required by the TechProcess platform for payments. Required by the WOPA platform for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for 3-D Secure version 2 for the authenticationFlow "browser". Depends on: Required for payments.
fiscalNumber	string (14)	depends	read close
close Description The fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country: Argentina - Consumer (DNI) with a length of 7 or 8 digits Argentina - Company (CUIT) with a length of 11 digits Brazil - Consumer (CPF) with a length of 11 digits Brazil - Company (CNPJ) with a length of 14 digits Chile - Consumer (RUT) with a length of 9 digits Colombia - Consumer (NIT) with a length of 8, 9 or 10 digits Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits Dominican Republic - Consumer (RNC) with a length of 11 digits Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU)) with a length of 11 characters India - Consumer (PAN) with a length of 10 characters Mexico - Consumer (RFC) with a length of 13 digits Mexico - Company (RFC) with a length of 12 digits Norway - Consumer (fødselsnummer) with a length of 11 digits Peru - Consumer (RUC) with a length of 11 digits Sweden - Consumer (personnummer) with a length of 10 or 12 digits Uruguay - Consumer (CI) with a length of 8 digits Uruguay - Consumer (NIE) with a length of 9 digits Uruguay - Company (RUT) with a length of 12 digits Depends on: Required for payments done with payment products: 51 - Deposito Identificado 1503 - Boleto Bancario 840 - PayPal, but only for transactions done in Brazil 9000 - AfterPay Installments and 9001 - AfterPay Invoice, but only for transactions done in Denmark, Finland, Norway and Sweden 6101 - Banco do Brasil 6102 - Itaú 6103 - Banrisul 6104 - Bradesco 6105 - Pix 6107 - PicPay Required for cross-border TechProcess merchants.
isCompany	boolean	no	read close
close Description Indicates if the payer is a company or an individual true = This is a company false = This is an individual
isPreviousCustomer	boolean	no	read close
close Description Specifies if the customer has a history of online shopping with the merchant true - The customer is a known returning customer false - The customer is new/unknown customer
locale	string (6)	depends	read close
close Description The locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided. Depends on: This property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
merchantCustomerId	string (15)	depends	read close
close Description Your identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform. Depends on: Required for payments done with payment product 320 (Google Pay), payment product 806 (Trustly), 830 (paysafecard) and 865 (Worldline Account-to-Account Payments). Required for hosted checkouts where payment products 806 (Trustly), 830 (PaysafeCard) and 865 (Worldline Account-to-Account Payments) are allowed. Required for card payments and hosted checkouts with the unscheduledCardOnFileSequenceIndicator or unscheduledCardOnFileRequestor property set.
personalInformation	object	depends depends no depends depends	read close
close Description Object containing personal information like name, date of birth and gender. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Depends on: Required for payments. SDK Object type PersonalInformation
dateOfBirth	string (8)	no depends no depends depends	read close
close Description The date of birth of the customer Format: YYYYMMDD Depends on: Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification Required by the TechProcess platform for cross-border payments when the property order.customer.isCompany is set to false. Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH). One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification Depends on: Required for cross-border payments when the property order.customer.isCompany is set to false.
gender	string	no	read close
close Description The gender of the customer, possible values are: male female unknown or empty
identification	object	depends	read close
close Description Object containing identification documents information Depends on: One of the following properties is required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995: order.customer.personalInformation.dateOfBirth order.customer.contactDetails.emailAddress order.customer.contactDetails.mobilePhoneNumber order.customer.contactDetails.phoneNumber order.customer.companyInformation.vatNumber order.customer.personalInformation.identification SDK Object type PersonalIdentification
idIssuingCountryCode	string (2)	yes	read close
close Description ISO 3166-1 alpha-2 country code of the country that issued the identification document
idType	string	yes	read close
close Description Indicates the type of identification nationalIdentification = The provided idValue is a national identification number. passportNumber = The provided idValue is a passport number. driverLicense = The provided idValue is driving License of the individual. companyRegistrationNumber = The provided idValue is a company identifier. It verifies its legal existence as an incorporated entity. socialSecurityNumber =n The provided idValue is a social security number, issued to an individual by the individual's government. alienRegistrationNumber = The provided idValue is an alien registration number, provided by immigration services of a country. lawEnforcementIdentification = The provided idValue is an alien registration number, provided by immigration services of a country. militaryIdentification = The provided idValue is an identification issued to military personnel of a country.
idValue	string (70)	yes	read close
close Description The value of the identification
name	object	depends depends no depends depends	read close
close Description Object containing the name details of the customer Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
shippingAddress	object	no	read close
close Deprecated: Use order.shipping.address instead Description Object containing shipping address details SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information
city	string	no depends no no depends	read close
close Deprecated Description City Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no no depends	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
houseNumber	string (15)	no	read close
close Deprecated Description House number
name	object	no depends no no depends	read close
close Deprecated Description Object that holds the name elements Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Deprecated Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Deprecated Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Deprecated Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Deprecated Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state	string (35)	no depends no no depends	read close
close Deprecated Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Deprecated Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto)
street	string (50)	no depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
zip	string	no depends no depends depends	read close
close Deprecated Description Zip code Depends on: Required by the GlobalCollect platform for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
vatNumber	string (17)	no	read close
close Deprecated: Use companyInformation.vatNumber instead Description Local VAT number of the company
items	array of object	no	read close
close Deprecated: Use shoppingCart.items instead Description Shopping cart data
items	object	no	read close
close Deprecated SDK Object type LineItem
amountOfMoney	object	no depends depends depends yes	read close
close Deprecated Description Object containing amount and ISO currency code attributes Note: make sure you submit the amount and currency code for each line item Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the GlobalCollect platform for hosted checkout request. Required by the Ogone platform for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Required by the TechProcess platform. Depends on: Required for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). Required for hosted checkout request. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Deprecated Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Deprecated Description Three-letter ISO currency code representing the currency for the amount
invoiceData	object	no depends depends depends yes	read close
close Deprecated Description Object containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the Ogone platform for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Required by the TechProcess platform. Depends on: Required for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). SDK Object type LineItemInvoiceData
description	string (116)	depends	read close
close Deprecated Description Shopping cart item description Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly. This property is required for payments and hosted checkouts with product 869 (China UnionPay). Required by the TechProcess platform.
merchantLinenumber	string (5)	no	read close
close Deprecated Description Line number for printed invoice or order of items in the cart Should be a numeric string
merchantPagenumber	string (3)	no	read close
close Deprecated Description Page number for printed invoice Should be a numeric string
nrOfItems	string (4)	depends	read close
close Deprecated Description Quantity of the item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
pricePerItem	integer (12)	depends	read close
close Deprecated Description Price per item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
level3InterchangeInformation	object	no	read close
close Deprecated: Use orderLineDetails instead Description Object containing additional information that when supplied can have a beneficial effect on the discountrates SDK Object type LineItemLevel3InterchangeInformation
discountAmount	integer (12)	no	read close
close Deprecated Description Discount on the line item, with the last two digits are implied decimal places
lineAmountTotal	integer (12)	no	read close
close Deprecated Description Total amount for the line item
productCode	string (12)	no	read close
close Deprecated Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros
productPrice	integer (12)	no	read close
close Deprecated Description The price of one unit of the product, the value should be zero or greater
productType	string (12)	no	read close
close Deprecated Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros
quantity	integer (4)	no	read close
close Deprecated Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
taxAmount	integer (12)	no	read close
close Deprecated Description Tax on the line item, with the last two digits are implied decimal places
unit	string (12)	no	read close
close Deprecated Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
orderLineDetails	object	no depends no depends yes	read close
close Deprecated Description Object containing additional information that when supplied can have a beneficial effect on the discountrates Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type OrderLineDetails
discountAmount	integer (12)	no	read close
close Deprecated Description Discount on the line item, with the last two digits implied as decimal places
googleProductCategoryId	integer (10)	no	read close
close Deprecated Description The Google product category ID for the item.
lineAmountTotal	integer (12)	depends	read close
close Deprecated Description Total amount for the line item Depends on: This property is required for payments and hosted checkouts with product 869 (China UnionPay).
naicsCommodityCode	string (6)	no	read close
close Deprecated Description The UNSPC commodity code of the item.
productCategory	string (50)	no	read close
close Deprecated Description The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
productCode	string (12)	yes depends depends depends yes	read close
close Deprecated Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productName	string (120)	no depends no depends yes	read close
close Deprecated Description The name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productPrice	integer (12)	yes depends depends depends depends	read close
close Deprecated Description The price of one unit of the product, the value should be zero or greater Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for crobss-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for crobss-border merchants.
productSku	string (12)	no	read close
close Deprecated Description Product SKU number
productType	string (12)	depends	read close
close Deprecated Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros Depends on: This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). For the product 869(China UnionPay) this property's value should be one of the following: goods - (default) ticket hotel studyabroad transport
quantity	integer (4)	yes depends depends depends depends	read close
close Deprecated Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for cross-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
taxAmount	integer (12)	no	read close
close Deprecated Description Tax on the line item, with the last two digits implied as decimal places
unit	string (12)	no	read close
close Deprecated Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
references	object	depends	read close
close Description Object that holds all reference properties that are linked to this transaction Depends on: This object is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type OrderReferences
descriptor	string (256)	no	read close
close Description 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. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer: AIB - 22 characters American Express - 25 characters Atos Origin BNP - 15 characters Barclays - 25 characters Catella - 22 characters CBA - 20 characters Elavon - 25 characters First Data - 25 characters INICIS (INIPAY) - 22-30 characters JCB - 25 characters Merchant Solutions - 22-25 characters Payvision (EU & HK) - 25 characters SEB Euroline - 22 characters Sub1 Argentina - 15 characters Wells Fargo - 25 characters Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays For alternative payment products the maximum allowed length varies per payment product: 402 e-Przelewy - 30 characters 404 INICIS - 80 characters 802 Nordea ePayment Finland - 234 characters 809 iDeal - 32 characters 836 SOFORT - 42 characters 840 PayPal - 127 characters 841 WebMoney - 175 characters 849 Yandex - 64 characters 861 Alipay - 256 characters 863 WeChat Pay - 32 characters 880 BOKU - 20 characters 8580 Qiwi - 255 characters 1504 Konbini - 80 characters All other payment products don't support a descriptor.
invoiceData	object	no	read close
close Description Object containing additional invoice data SDK Object type OrderInvoiceData
additionalData	string (500)	no	read close
close Description Additional data for printed invoices
invoiceDate	string (14)	no	read close
close Description Date and time on invoice Format: YYYYMMDDHH24MISS
invoiceNumber	string (20)	no	read close
close Description Your invoice number (on printed invoice) that is also returned in our report files
textQualifiers	array	no	read close
close Description Array of 3 text qualifiers, each with a max length of 10 characters
merchantOrderId	integer (10)	no	read close
close Description Your order identifier Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.
merchantReference	string	no depends no depends yes	read close
close Description Note that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Note that the maximum length of this field for transactions processed on the WL Online Payment Acceptance Platform platform is 50. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
providerId	string	no	read close
close Description Provides an additional means of reconciliation for Gateway merchants
providerMerchantId	string	no	read close
close Description Provides an additional means of reconciliation, this is the MerchantId used at the provider
seller	object	no	read close
close Deprecated: Use merchant.seller instead Description Object containing seller details SDK Object type Seller
address	object	no	read close
close Deprecated Description Object containing the seller address details SDK Object type Address
additionalInfo	string (50)	no	read close
close Deprecated Description Additional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
city	string	depends depends no depends depends	read close
close Deprecated Description City Note: For payments with product 1503 the maximum length is not 40 but 20. Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705) except when a token has been included in the request that includes this value Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no yes yes	read close
close Deprecated Description ISO 3166-1 alpha-2 country code Depends on: Required by the GlobalCollect platform. Required by the TechProcess platform.
houseNumber	string (15)	depends	read close
close Deprecated Description House number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform Depends on: Required when address is included in Seller. Required for 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) and 6107 (PicPay).
state	string (35)	no depends no no depends	read close
close Deprecated Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Deprecated Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto), 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay).
street	string (50)	depends depends no depends depends	read close
close Deprecated Description Streetname Depends on: Required for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brasil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Required by the GlobalCollect platform when address is included in Seller. Required by the GlobalCollect platform for the creation of a Payout. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required when address is included in Seller. Required for the creation of a Payout. Depends on: Required for cross-border merchants.
zip	string	depends depends no depends depends	read close
close Deprecated Description Zip code Note: For payments with product 1503 the maximum length is not 10 but 8. Depends on: Required for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Depends on: Required by the GlobalCollect platform for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required by the GlobalCollect platform for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Required by the WOPA platform for payments with product 6101 (Banco do Brazil), 6102 (Itaú), 6103 (Banrisul), 6104 (Bradesco), 6105 (Pix) or 6107 (PicPay). Required by the TechProcess platform for cross-border merchants. Depends on: Required for Direct Debit UK (705) except when a token has been included in the request that includes this value. Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
channelCode	string (3)	no	read close
close Deprecated Description This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
description	string (32)	no	read close
close Deprecated Description Description of the seller
externalReferenceId	string (15)	no	read close
close Deprecated Description Seller ID assigned by the Merchant Aggregator
geocode	string (5)	no	read close
close Deprecated Description The sellers geocode
id	string (40)	no depends no yes no	read close
close Deprecated Description The sellers identifier Depends on: Required by the GlobalCollect platform.
invoiceNumber	string (12)	no	read close
close Deprecated Description Invoice number of the payment
isForeignRetailer	boolean	no	read close
close Deprecated Description Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values: true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar) false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
mcc	string (5)	no	read close
close Deprecated Description Merchant category code
name	string (128)	no depends no yes no	read close
close Deprecated Description Name of the seller Depends on: Required by the GlobalCollect platform.
phoneNumber	string (32)	no	read close
close Deprecated Description Main Phone Number
type	string	no depends no yes no	read close
close Deprecated Description Seller type. Possible values: passport dni arg-identity-card civic-notebook enrollment-book cuil cuit general-register election-title cpf cnpj ssn citizen-ship col-identity-card alien-registration Depends on: Required by the GlobalCollect platform.
shipping	object	no depends no no depends	read close
close Description Object containing information regarding shipping / delivery Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type Shipping
address	object	no depends no no depends	read close
close Description Object containing address information Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type AddressPersonal
additionalInfo	string (50)	no	read close
close Description Additional address information
city	string	no depends no no depends	read close
close Description City Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
countryCode	string (2)	no depends no no depends	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
houseNumber	string (15)	no	read close
close Description House number
name	object	no depends no no depends	read close
close Description Object that holds the name elements Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants. SDK Object type PersonalName
firstName	string (15)	depends depends no depends depends	read close
close Description Given name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required by the TechProcess platform for payments. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for payments.
surname	string (70)	depends depends depends depends depends	read close
close Description Surname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Depends on: Required by the GlobalCollect platform for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Required by the WOPA platform for payments with product Banco do Brasil (paymentProductId 6101), Itaú (paymentProductId 6102), Banrisul (paymentProductId 6103), Bradesco (paymentProductId 6104), Pix (paymentProductId 6105), PicPay (paymentProductId 6107) or SPEI (paymentProductId 6501). For payments made in Brazil, this property is only required when the property order.customer.fiscalNumber is Personal (CPF) - 11 digits. Required for the creation of a Payout. Required by the Ogone platform for the creation of a Payout. Required by the TechProcess platform for the creation of a payment. Depends on: Required for the creation of a Payout. Depends on: Required for payments with Trustly (paymentProductId 806), AfterPay Installments (paymentProductId 9000), AfterPay Invoice (paymentProductId 9001), BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596), Shinhan Card (paymentProductId 8597). Required for the creation of a Payout. Required for merchants that use Merchant Category Codes (MCC) V4829, V6012, M4829, V6051, M6540, 7995. Depends on: Required for the creation of a payment.
surnamePrefix	string (15)	no	read close
close Description Middle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
title	string (35)	depends	read close
close Description Title of customer Depends on: Required for payments with product 9000 (AfterPay Installments) or 9001 (AfterPay Invoice) in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state	string (35)	no depends no no depends	read close
close Description Full name of the state or province Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
stateCode	string	depends	read close
close Description ISO 3166-2 alpha-3 state code Notes: The maximum length for 3-D Secure version 2 is AN3 for payments that are processed by the GlobalCollect platform The maximum length for paymentProductId 1503 (Boleto) is AN2 for payments that are processed by the GlobalCollect platform The maximum length is 3 for payments that are processed by the WL Online Payment Acceptance platform Depends on: Required for payments with paymentProductId 1503 (Boleto)
street	string (50)	no depends no depends depends	read close
close Description Streetname Depends on: Required by the GlobalCollect platform for Invoice payments (201) Required by the GlobalCollect platform for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Invoice payments (201) Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
zip	string	no depends no depends depends	read close
close Description Zip code Depends on: Required by the GlobalCollect platform for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Required by the TechProcess platform for cross-border merchants. Depends on: Required for Required for Direct Debit UK (705), except when a token has been included in the request that includes this value. Depends on: Required for cross-border merchants.
addressIndicator	string	no	read close
close Description Indicates shipping method chosen for the transaction. Possible values: same-as-billing = the shipping address is the same as the billing address another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you different-than-billing = shipping address is different from the billing address ship-to-store = goods are shipped to a store (shipping address = store address) digital-goods = electronic delivery of digital goods travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped other = other means of delivery
comments	string (160)	no	read close
close Description Comments included during shipping
emailAddress	string (70)	no depends no no depends	read close
close Description Email address linked to the shipping Depends on: Required by the TechProcess platform for cross-border merchants. Depends on: Required for cross-border merchants.
firstUsageDate	string (8)	no	read close
close Description Date (YYYYMMDD) when the shipping details for this transaction were first used.
isFirstUsage	boolean	no	read close
close Description 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
shippedFromZip	string (10)	no	read close
close Description The zip/postal code of the location from which the goods were shipped.
trackingNumber	string (19)	no	read close
close Description Shipment tracking number
type	string	no	read close
close Description Indicates the merchandise delivery timeframe. Possible values: electronic = For electronic delivery (services or digital goods) same-day = For same day deliveries overnight = For overnight deliveries 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform
shoppingCart	object	no depends no depends yes	read close
close Description Shopping cart data, including items and specific amounts. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type ShoppingCart
amountBreakdown	array of object	no	read close
close Description Determines the type of the amount.
items	object	no	read close
close SDK Object type AmountBreakdown
amount	integer	yes	read close
close Description Amount in cents and always having 2 decimals
type	enum	yes	read close
close Description Type of the amount. Each type is only allowed to be provided once. Allowed values: AIRPORT_TAX - The amount of tax paid for the airport, with the last 2 digits implied as decimal places. CONSUMPTION_TAX - The amount of consumption tax paid by the customer, with the last 2 digits implied as decimal places. DISCOUNT - Discount on the entire transaction, with the last 2 digits implied as decimal places. DUTY - Duty on the entire transaction, with the last 2 digits implied as decimal places. HANDLING - Handling cost on the entire transaction, with the last 2 digits implied as decimal places. SHIPPING - Shipping cost on the entire transaction, with the last 2 digits implied as decimal places. TAX - Total tax paid on the entire transaction, with the last 2 digits implied as decimal places. VAT - Total amount of VAT paid on the transaction, with the last 2 digits implied as decimal places. BASE_AMOUNT - Order amount excluding all taxes, discount & shipping costs, with the last 2 digits implied as decimal places. Note: BASE_AMOUNT is only supported by the GlobalCollect and Ogone Payment Platforms.
giftCardPurchase	object	no	read close
close Description Object containing information on purchased gift card(s) SDK Object type GiftCardPurchase
amountOfMoney	object	no	read close
close Description Object containing information on an amount of money SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
numberOfGiftCards	integer (2)	no	read close
close Description Number of gift cards that are purchased through this transaction
isPreOrder	boolean	no	read close
close Description The customer is pre-ordering one or more items
items	array of object	no depends depends depends yes	read close
close Description Shopping cart data Depends on: Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
items	object	no	read close
close SDK Object type LineItem
amountOfMoney	object	no depends depends depends yes	read close
close Description Object containing amount and ISO currency code attributes Note: make sure you submit the amount and currency code for each line item Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the GlobalCollect platform for hosted checkout request. Required by the Ogone platform for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Required by the TechProcess platform. Depends on: Required for hosted checkout request, except when hostedCheckoutSpecificInput.validateShoppingCart is false. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). Required for hosted checkout request. SDK Object type AmountOfMoney
amount	integer (12)	yes	read close
close Description Amount in cents and always having 2 decimals
currencyCode	string (3)	yes	read close
close Description Three-letter ISO currency code representing the currency for the amount
invoiceData	object	no depends depends depends yes	read close
close Description Object containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with product 869 (China UnionPay). Required by the Ogone platform for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Required by the TechProcess platform. Depends on: Required for hosted checkouts with hostedCheckoutSpecificInput.validateShoppingCart is true or not provided. Depends on: Required for payments and hosted checkouts with product 869 (China UnionPay). SDK Object type LineItemInvoiceData
description	string (116)	depends	read close
close Description Shopping cart item description Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly. This property is required for payments and hosted checkouts with product 869 (China UnionPay). Required by the TechProcess platform.
merchantLinenumber	string (5)	no	read close
close Description Line number for printed invoice or order of items in the cart Should be a numeric string
merchantPagenumber	string (3)	no	read close
close Description Page number for printed invoice Should be a numeric string
nrOfItems	string (4)	depends	read close
close Description Quantity of the item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
pricePerItem	integer (12)	depends	read close
close Description Price per item Depends on: When you want your shopping cart to be displayed on our hostedCheckout pages this property is required for the cart to display correctly.
level3InterchangeInformation	object	no	read close
close Deprecated: Use orderLineDetails instead Description Object containing additional information that when supplied can have a beneficial effect on the discountrates SDK Object type LineItemLevel3InterchangeInformation
discountAmount	integer (12)	no	read close
close Deprecated Description Discount on the line item, with the last two digits are implied decimal places
lineAmountTotal	integer (12)	no	read close
close Deprecated Description Total amount for the line item
productCode	string (12)	no	read close
close Deprecated Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros
productPrice	integer (12)	no	read close
close Deprecated Description The price of one unit of the product, the value should be zero or greater
productType	string (12)	no	read close
close Deprecated Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros
quantity	integer (4)	no	read close
close Deprecated Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros
taxAmount	integer (12)	no	read close
close Deprecated Description Tax on the line item, with the last two digits are implied decimal places
unit	string (12)	no	read close
close Deprecated Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
orderLineDetails	object	no depends no depends yes	read close
close Description Object containing additional information that when supplied can have a beneficial effect on the discountrates Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). SDK Object type OrderLineDetails
discountAmount	integer (12)	no	read close
close Description Discount on the line item, with the last two digits implied as decimal places
googleProductCategoryId	integer (10)	no	read close
close Description The Google product category ID for the item.
lineAmountTotal	integer (12)	depends	read close
close Description Total amount for the line item Depends on: This property is required for payments and hosted checkouts with product 869 (China UnionPay).
naicsCommodityCode	string (6)	no	read close
close Description The UNSPC commodity code of the item.
productCategory	string (50)	no	read close
close Description The category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
productCode	string (12)	yes depends depends depends yes	read close
close Description Product or UPC Code, left justified Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for this property is required for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for for payments and hosted checkouts with products 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productName	string (120)	no depends no depends yes	read close
close Description The name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform. Depends on: Required by the GlobalCollect platform for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform. Depends on: Required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice).
productPrice	integer (12)	yes depends depends depends depends	read close
close Description The price of one unit of the product, the value should be zero or greater Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for crobss-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for crobss-border merchants.
productSku	string (12)	no	read close
close Description Product SKU number
productType	string (12)	depends	read close
close Description Code used to classify items that are purchased Note: Must not be all spaces or all zeros Depends on: This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). For the product 869(China UnionPay) this property's value should be one of the following: goods - (default) ticket hotel studyabroad transport
quantity	integer (4)	yes depends depends depends depends	read close
close Description Quantity of the units being purchased, should be greater than zero Note: Must not be all spaces or all zeros Depends on: Required by the WOPA platform. Required by the GlobalCollect platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the Ogone platform for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Required by the TechProcess platform for cross-border merchants. Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for This property is required for payments and hosted checkouts with products 869 (China UnionPay), 9000 (AfterPay Installments) and 9001 (AfterPay Invoice). Depends on: Required for cross-border merchants.
taxAmount	integer (12)	no	read close
close Description Tax on the line item, with the last two digits implied as decimal places
unit	string (12)	no	read close
close Description Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
preOrderItemAvailabilityDate	string (8)	no	read close
close Description Date (YYYYMMDD) when the preordered item becomes available
reOrderIndicator	boolean	no	read close
close Description 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
redirectPaymentMethodSpecificInput	object	no	read close
close Description Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal SDK Object type RedirectPaymentMethodSpecificInputBase
expirationPeriod	integer	no	read close
close Description This sets the maximum amount of minutes a customer has to complete the payment at the bank. After this period has expired it is impossible for the customer to make a payment and in case no payment has been made the transaction will be marked as unsuccessful and expired by the bank. Setting the expirationPeriod is convenient if you want to maximise the time a customer has to complete the payment. Please note that it is normal for a customer to take up to 5 minutes to complete a payment. Setting this value below 10 minutes is not advised. You can set this value in minutes with a maximum value of 60 minutes. If no input is provided the default value of 60 is used for the transaction. This value can be set for the following payment products 809 - iDeal 402 - e-Przelewy 836 - Sofort 863 - WeChat Pay 869 - China UnionPay 740 - PromptPay
paymentProduct4101SpecificInput	object	no	read close
close Description Object containing specific input required for payment product 4101 (UPI) SDK Object type RedirectPaymentProduct4101SpecificInputBase
displayName	string	depends	read close
close Description The merchant name as shown to the customer in some payment applications. Depends on: Required when merchant has payment product 4101 (UPI) as available payment product.
paymentProduct840SpecificInput	object	no	read close
close Description Object containing specific input required for PayPal payments (Payment product ID 840) SDK Object type RedirectPaymentProduct840SpecificInputBase
addressSelectionAtPayPal	boolean	no	read close
close Description For payments processed by Worldline's Ogone Payment Platform, indicates whether to allow the customer to select an address on the PayPal website. true = Address can be selected at PayPal false = No address can be selected at PayPal
paymentProductId	integer (5)	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
recurringPaymentSequenceIndicator	string	no	read close
close Description 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: Will default to first when isRecurring is set to true, with the following exception that it is set to recurring when the customer is making the payment using a PayPal token. 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. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
requiresApproval	boolean	no	read close
close Description 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 Note: This property is supported by the Ogone Payment Platform for all redirect payment methods and only for PayPal in GlobalCollect Payment Platform.
token	string (40)	no	read close
close Description ID of the token
tokenize	boolean	no	read close
close Description Indicates if this transaction should be tokenized true - Tokenize the transaction. Note: a challenged redirected PayPal payment on the GlobalCollect platform can't be tokenized in this way. In this case, use the 'Create a token from payment' functionality after your customer succesfully completes the redirection. false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
sepaDirectDebitPaymentMethodSpecificInput	object	depends	read close
close Description Object containing the specific input details for SEPA direct debit payments Depends on: Required for hosted checkouts with product 771. SDK Object type SepaDirectDebitPaymentMethodSpecificInputBase
paymentProduct771SpecificInput	object	depends	read close
close Description Object containing information specific to SEPA Direct Debit Depends on: Required for hosted checkouts with product 771. SDK Object type SepaDirectDebitPaymentProduct771SpecificInputBase
Group existingUniqueMandateReference	string	one of the group	read close
close Description The unique reference of the existing mandate to use in this payment. Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
Group mandate	object	one of the group	read close
close Description Object containing information to create a SEPA Direct Debit mandate. SDK Object type CreateMandateBase Property is part of a group Learn more Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call. If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.
alias	string	no	read close
close Description An alias for the mandate. This can be used to visually represent the mandate. Do not include any unobfuscated sensitive data in the alias. Default value if not provided is the obfuscated IBAN of the customer.
customer	object	depends	read close
close Description Customer object containing customer specific inputs Depends on: Required for Create mandate and Create payment calls SDK Object type MandateCustomer
bankAccountIban	object	depends	read close
close Description Object containing IBAN information Depends on: Required for Create mandate and Create payment calls SDK Object type BankAccountIban
accountHolderName	string (30)	depends	read close
close Description Name in which the account is held. Depends on: Required for the creation of a Payout Required for Create and Update token calls.
iban	string (50)	depends	read close
close Description The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits. Depends on: Required for the creation of a Payout Required for Create and Update token. Required for payments with product 9000 (AfterPay Installments) in Austria (AT) and Germany (DE). Required for Create mandate and Create payment with mandate calls
companyName	string (40)	no	read close
close Description Name of company, as a customer
contactDetails	object	no	read close
close Description Object containing contact details like email address and phone number SDK Object type MandateContactDetails
emailAddress	string (70)	no	read close
close Description Email address of the customer
mandateAddress	object	depends	read close
close Description Object containing billing address details Depends on: Required for Create mandate and Create payment calls. Required for Create hostedCheckout calls where the IBAN is also provided. SDK Object type MandateAddress
city	string (40)	depends	read close
close Description City Depends on: Required for Create mandate and Create payment calls. Required for Create hostedCheckout calls where the IBAN is also provided.
countryCode	string (2)	depends	read close
close Description ISO 3166-1 alpha-2 country code Depends on: Required for Create mandate and Create payment calls. Required for Create hostedCheckout calls where the IBAN is also provided.
houseNumber	string (15)	no	read close
close Description House number
street	string (50)	depends	read close
close Description Streetname Depends on: Required for Create mandate and Create payment calls. Required for Create hostedCheckout calls where the IBAN is also provided.
zip	string (10)	depends	read close
close Description Zip code Depends on: Required for Create mandate and Create payment calls. Required for Create hostedCheckout calls where the IBAN is also provided.
personalInformation	object	depends	read close
close Description Object containing personal information of the customer Depends on: Required for Create mandate and Create payment calls SDK Object type MandatePersonalInformation
name	object	depends	read close
close Description Object containing the name details of the customer Depends on: Required for create mandate and Create payment calls SDK Object type MandatePersonalName
firstName	string (15)	depends	read close
close Description Given name(s) or first name(s) of the customer Depends on: Required for create mandate and Create payment calls
surname	string (70)	depends	read close
close Description Surname(s) or last name(s) of the customer Depends on: Required for create mandate and Create payment calls
title	enum	depends	read close
close Description Object containing the title of the customer (Mr, Miss or Mrs) Depends on: Required for create mandate and Create payment calls
customerReference	string (35)	yes	read close
close Description The unique identifier of a customer
language	string	no	read close
close Description The language code of the customer, one of de, en, es, fr, it, nl, si, sk, sv.
recurrenceType	enum	yes	read close
close Description Specifies whether the mandate is for one-off or recurring payments. Possible values are: UNIQUE RECURRING
signatureType	enum	yes	read close
close Description Specifies whether the mandate is unsigned or singed by SMS. Possible values are: UNSIGNED SMS
uniqueMandateReference	string	no	read close
close Description The unique identifier of the mandate. If you do not provide one, we will generate one for you.
mandateReference	string (35)	no	read close
close Deprecated: Use existingUniqueMandateReference instead Description The unique mandate reference of the existing mandate to use in this payment.
paymentProductId	integer (5)	no	read close
close Description Payment product identifier Please see payment products for a full overview of possible values.
Property	Type	Required	Details

Request example

SDK: JSON

This scenario you will probably use the most

{
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "USD",
            "amount" : 2345
        },
        "customer" : {
            "merchantCustomerId" : "1234",
            "billingAddress" : {
                "countryCode" : "US"
            }
        }
    },
    "hostedCheckoutSpecificInput" : {
        "variant" : "testVariant",
        "locale" : "en_GB"
    }
}

{
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "EUR",
            "amount" : 2345
        },
        "customer" : {
            "billingAddress" : {
                "countryCode" : "NL"
            },
            "merchantCustomerId" : "YOURCUSTOMERID"
        }
    },
    "hostedCheckoutSpecificInput" : {
        "variant" : "100",
        "locale" : "nl_NL"
    }
}

{
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "USD",
            "amount" : 100
        },
        "customer" : {
            "billingAddress" : {
                "countryCode" : "US"
            },
            "merchantCustomerId" : "YOURCUSTOMERID"
        }
    },
    "hostedCheckoutSpecificInput" : {
        "variant" : "100",
        "locale" : "en_US"
    }
}

{
    "order" : {
        "amountOfMoney" : {
            "currencyCode" : "USD",
            "amount" : 2345
        },
        "customer" : {
            "billingAddress" : {
                "countryCode" : "US"
            },
            "merchantCustomerId" : "YOURCUSTOMERID"
        }
    },
    "hostedCheckoutSpecificInput" : {
        "variant" : "100",
        "locale" : "en_GB",
        "returnUrl" : "http://www.google.com"
    }
}

Default scenario

Responses

For every successfully created hosted checkout session an HTTP 201 response is returned.

Response 201 - CreatedCreateHostedCheckoutResponse

The response contains a partialRedirectUrl. Because you can create several subdomains under which your MyCheckout payment pages will be available, you will need to add the relevant subdomain and datacenter alias that you wish to use for the transaction in front of the returned partialRedirectUrl. Next to this you also need to add the protocol (https://) in front of the whole URL.

So the full redirect might be something like https://yourname.pay1.poweredbyglobalcollect.com/pay8915-53ebca407e6b4a1dbd086aad4f10354d:8915-28e5b79c889641c8ba770f1ba576c1fe:9798f4c44ac6406e8288494332d1daa0

Please note that, apart from the aforementioned, no more changes are required to the partialRedirectURL and that a GET must be used (to be sure, don't use a POST).

A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of the returned partialRedirectUrl to view your MyCheckout hosted payment pages. The partialRedirectUrl starts with either pay1 or pay2. The MyCheckout sessions are created in one of our data centers and due to latency issues we have made them sticky to the datacenter that they have been created: pay1 denotes our European and pay2 our US datacenter.

In the HTTP header the location is provided of the created hostedCheckout object so you can easily query its status, by simply performing a GET on the URI provided in this header.

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
RETURNMAC	string	no	read close
close Description When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.
hostedCheckoutId	string	no	read close
close Description This is the ID under which the data for this checkout can be retrieved.
invalidTokens	array	no	read close
close Description Tokens that are submitted in the request are validated. In case any of the tokens can't be used anymore they are returned in this array. You should most likely remove those tokens from your system.
merchantReference	string	no	read close
close Description If a payment is created during this hosted checkout, then it will use this merchantReference. This is the merchantReference you provided in the Create Hosted Checkout request, or if you did not provide one, a reference generated by Connect. This allows you to to link a webhook related to the created payment back to this hosted checkout using the webhook's paymentOutput.references.merchantReference. This property is intended primarily for hosted checkouts on the Ogone Payment Platform. On the GlobalCollect platform, you can also use hostedCheckoutSpecificOutput.hostedCheckoutId.
partialRedirectUrl	string	no	read close
close Description The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of this response value to view your MyCheckout hosted payment pages.
Property	Type	Required	Details

Response example

SDK: JSON

This scenario you will probably use the most

{
    "RETURNMAC" : "fecab85c-9b0e-42ee-a9d9-ebb69b0c2eb0",
    "hostedCheckoutId" : "15c09dac-bf44-486a-af6b-edfd8680a166",
    "partialRedirectUrl" : "pay1.checkout.worldline-solutions.com/checkout/1701-8cc800ebc3b84667a0b0c9b7981d5b6a:15c09dac-bf44-486a-af6b-edfd8680a166:af6276be66bc4743abfbaa48524c59aa?requestToken=89836363-f87c-4d17-8b11-270d7d9cda9a"
}

Default scenario

Response 400 - Bad requestErrorResponse

Property	Type	Required	Details
Properties Expand all properties Hide deprecated properties
errorId	string	yes	read close
close Description Unique reference, for debugging purposes, of this error response
errors	array of object	yes	read close
close Description List of one or more errors
items	object	no	read close
close Description Contains detailed information on one single error. SDK Object type APIError
category	string	no	read close
close Description Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values: CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform. PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform. IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
code	string	yes	read close
close Description Error code
httpStatusCode	integer	no	read close
close Description HTTP status code for this error that can be used to determine the type of error
id	string	no	read close
close Description ID of the error. This is a short human-readable message that briefly describes the error.
message	string	no	read close
close Description 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
propertyName	string	no	read close
close Description Returned only if the error relates to a value that was missing or incorrect. Contains a location path to the value as a JSonata query. Some common examples: a.b selects the value of property b of root property a, a[1] selects the first element of the array in root property a, a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
requestId	string	no	read close
close Description ID of the request that can be used for debugging purposes
Property	Type	Required	Details

Response example

SDK: JSON

This scenario you will probably use the most

{
    "errorId" : "15eabcd5-30b3-479b-ae03-67bb351c07e6-00000092",
    "errors" : [
        {
            "code" : "20000000",
            "propertyName" : "bankAccountBban.accountNumber",
            "message" : "PARAMETER_NOT_FOUND_IN_REQUEST"
        }
    ]
}

Default scenario

Create hosted checkout

Hosted Checkouts

Request

PayloadCreateHostedCheckoutRequest

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Depends on:

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Description

Description

Depends on:

Description

Description

Description

Description

Description

Depends on:

Depends on:

Depends on:

Depends on:

Description

Depends on:

Description

Depends on:

Description

Depends on:

Depends on: