This site requires javascript to be enabled.

  • Search AI-powered

Results for

xxx

Create payment

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

Payments

The payments REST services allow you to initiate a payment, retrieve the payment details or perform specific actions like refunding or requesting capture of a payment. A payment is identified by its paymentId. Some payment products allow a two step approach allowing you to control when the authorization takes place separate from when the funds are actually captured.

Request

You initiate a payment by posting all the required payment details. After you have done so one or more of the following things can take place:

  • Your payment request is rejected. This can happen for various reasons, but a detailed reason is always returned in the response to you. In some cases a payment object was created and you will find all the details in the response as well.
  • The data you submitted used to assess the risk of potential fraud. If this is deemed to great based on your configuration the transaction is either rejected or placed in a queue for your manual review. If the fraud risk is deemed to be within the acceptable set limits the processing is continued and one of the other possible outcomes listed here will be returned.
  • The data is sent to a third party for authorization
  • The consumer is required to authenticate themselves and a redirect to a third party is required, sometimes this also includes the actual authorization of the payment by the consumer while at the third party. The response will contain all the details required for you to redirect the consumer to the third party.
  • Payment instruction details are returned so you can provide the right instructions to your consumer on how to complete the payment.
  • The data is simply stored for future processing.

Please look at the flow diagram of each payment product that you would like to integrate to see what possible responses can be returned to you depending on the payment product.

The type of processing flow is also dependent on the individual configuration of your account(s). This will be chosen in conjunction with you to best match your business
Create payment supports idempotent requests

PayloadCreatePaymentRequest

Properties
Property Type Required Details
close

Description

Object containing the specific input details for bank transfer payments
  • SDK Object type
    BankTransferPaymentMethodSpecificInput
  • 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.

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.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the specific input details for card payments
  • SDK Object type
    CardPaymentMethodSpecificInput
  • 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.

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.
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-authorizations 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, ignored 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.
close

Description

Object containing card details. The card details will be ignored in case the property networkTokenData is present.
  • SDK Object type
    Card
close

Description

The complete credit/debit card number (also know as the PAN). The minimum input length is 12 digits.
The card number is always obfuscated in any of our responses
close

Description

The card holder's name on the card. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Card Verification Value, a 3 or 4 digit code used as an additional security feature for card not present transactions.
close

Description

Expiry date of the card
Format: MMYY
close

Description

Issue number on the card (if applicable)
close

Description

The first 2 digits of the card's PIN code. May be optionally submitted for South Korean cards (paymentProductIds 180, 181, 182, 183, 184, 185 and 186). Submitting this property may improve your authorization rate.
close

Description

Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.
close
Deprecated: Use threeDSecure.externalCardholderAuthenticationData instead.

Description

Object containing 3D secure details.
  • SDK Object type
    ExternalCardholderAuthenticationData
close
Deprecated

Description

Identifier of the authenticated transaction at the ACS/Issuer.
close
Deprecated

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
close
Deprecated

Description

The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
close
Deprecated

Description

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
close
Deprecated

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close
Deprecated

Description

Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION
  • 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • 1 = Authentication attempted (MasterCard)
  • 2 = Successful authentication (MasterCard)
  • 5 = Successful authentication (Visa, Diners Club, Amex)
  • 6 = Authentication attempted (Visa, Diners Club, Amex)
  • 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • (empty) = Not checked or not enrolled
close
Deprecated

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
close
Deprecated

Description

The 3-D Secure version used for the authentication. Possible values:
  • v1
  • v2
  • 1.0.2
  • 2.1.0
  • 2.2.0
close
Deprecated: No replacement

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close
Deprecated

Description

The 3D Secure authentication result from your 3D Secure provider.
close
Deprecated

Description

The transaction ID that is used for the 3D Authentication
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).
close

Description

Indicates if this transaction is of a one-off or a recurring type
  • true - This is recurring
  • false - This is one-off
close

Description

Indicates reason behind the merchant initiated transaction. These are industry specific.
Possible values:
  • delayedCharges - Delayed charges are performed to process a supplemental account charge after original services have been rendered and respective payment has been processed. This is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental payment after the original services are rendered.
  • noShow - Cardholders can use their cards to make a guaranteed reservation with certain merchant segments. A guaranteed reservation ensures that the reservation will be honored and allows a merchant to perform a No Show transaction to charge the cardholder a penalty according to the merchant’s cancellation policy. For merchants that accept token-based payment credentials to guarantee a reservation, it is necessary to perform a customer initiated (Account Verification) at the time of reservation to be able perform a No Show transaction later.
close

Description

Object holding data that describes a network token
  • SDK Object type
    SchemeTokenData
close

Description

The cardholder's name on the card
close

Description

The Token Cryptogram is a dynamic one-time use value that is used to verify the authenticity of the transaction and the integrity of the data used in the generation of the Token Cryptogram. Visa calls this the Token Authentication Verification Value (TAVV) cryptogram.
close

Description

The Electronic Commerce Indicator you got with the Token Cryptogram
close

Description

The network token. Note: This is called Payment Token in the EMVCo documentation
close

Description

The expiry date of the network token
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing data related to recurring
  • SDK Object type
    CardRecurrenceDetails
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.
close

Description

Minimum number of days between authorizations. If no value is provided we will set a default value of 30 days.
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.
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
  • 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.
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 using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically
close
Deprecated: Use threeDSecure.redirectionData.returnUrl instead.

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 protocol to use, e.g. http:// or https://. 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.
close
Deprecated: Use threeDSecure.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.
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.
close

Description

Object containing specific data regarding 3-D Secure
  • SDK Object type
    ThreeDSecure
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
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
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.

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
.
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
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.
close

Description

Object containing 3D secure details.
  • SDK Object type
    ExternalCardholderAuthenticationData
close

Description

Identifier of the authenticated transaction at the ACS/Issuer.
close

Description

Exemption code from Carte Bancaire (130) (unknown possible values so far -free format).
close

Description

The CAVV (cardholder authentication verification value) or AAV (accountholder authentication value) provides an authentication validation value.
close

Description

The algorithm, from your 3D Secure provider, used to generate the authentication CAVV.
close

Description

The 3-D Secure Directory Server transaction ID that is used for the 3D Authentication
close

Description

Electronic Commerce Indicator provides authentication validation results returned after AUTHENTICATIONVALIDATION
  • 0 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • 1 = Authentication attempted (MasterCard)
  • 2 = Successful authentication (MasterCard)
  • 5 = Successful authentication (Visa, Diners Club, Amex)
  • 6 = Authentication attempted (Visa, Diners Club, Amex)
  • 7 = No authentication, Internet (no liability shift, not a 3D Secure transaction)
  • (empty) = Not checked or not enrolled
close

Description

Global score calculated by the Carte Bancaire (130) Scoring platform. Possible values from 0 to 99.
close

Description

The 3-D Secure version used for the authentication. Possible values:
  • v1
  • v2
  • 1.0.2
  • 2.1.0
  • 2.2.0
close
Deprecated: No replacement

Description

The 3-D Secure Server transaction ID that is used for the 3-D Secure version 2 Authentication.
close

Description

The 3D Secure authentication result from your 3D Secure provider.
close

Description

The transaction ID that is used for the 3D Authentication
close

Description

Object containing data regarding the customer authentication that occurred prior to the current transaction
  • SDK Object type
    ThreeDSecureData
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)
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
close

Description

Timestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
close

Description

Object containing browser specific redirection related data
  • SDK Object type
    RedirectionData
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 protocol to use, e.g. http:// or https://. 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.
close

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.
close

Description

Object containing 3-D Secure in-app SDK data
  • SDK Object type
    SdkDataInput
close

Description

Object containing rendering options of the device.
  • SDK Object type
    DeviceRenderOptions
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
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)
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)
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
close

Description

JWE Object containing data encrypted by the 3-D Secure SDK
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.
close

Description

Indicates maximum amount of time (in minutes) for all exchanges. Minimum amount of minutes is 5.
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.
close

Description

Universally unique transaction identifier assigned by the 3-D Secure SDK to identify a single transaction.
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.
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
close

Description

ID of the token that holds previously stored card data. If both the token and card are provided, then the card takes precedence over the token.
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.
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.
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.
close

Description

Indicates which party initiated the unscheduled recurring transaction. Allowed values:
  • merchantInitiated - Merchant Initiated Transaction.
  • cardholderInitiated - Cardholder Initiated Transaction.

Note: this property is not allowed if isRecurring is true.
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

Note: this property is not allowed if isRecurring is true.
close

Description

Object containing the specific input details for cash payments
  • SDK Object type
    CashPaymentMethodSpecificInput
  • 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.

close
Deprecated: No replacement

Description

Object that holds the specific data for Boleto Bancario in Brazil (payment product 1503)
  • SDK Object type
    CashPaymentProduct1503SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Object that holds the specific data for Konbini in Japan (payment product 1504)
  • SDK Object type
    CashPaymentProduct1504SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Object that holds the specific data for e-Pay (payment product 1521).
  • SDK Object type
    CashPaymentProduct1521SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Object that holds the specific data for Tesco - Paysbuy Cash (payment product 1522).
  • SDK Object type
    CashPaymentProduct1522SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Object that holds the specific data for ATM Transfers Indonesia(payment product 1523).
  • SDK Object type
    CashPaymentProduct1523SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Object that holds the specific data for DragonPay (payment product 1524).
  • SDK Object type
    CashPaymentProduct1524SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Object that holds the specific data for 7-11 MOLPay Cash (payment product 1526).
  • SDK Object type
    CashPaymentProduct1526SpecificInput
  • 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.

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 protocol to use, e.g. http:// or https://. 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.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the specific input details for direct debit payments
  • SDK Object type
    NonSepaDirectDebitPaymentMethodSpecificInput
  • 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.

close

Description

Direct Debit payment collection date
Format: YYYYMMDD
close

Description

Descriptor intended to identify the transaction on the customer's bank statement
close

Description

Indicates if this transaction is of a one-off or a recurring type
  • true - This is recurring
  • false - This is one-off
close

Description

Object containing UK Direct Debit specific details
  • SDK Object type
    NonSepaDirectDebitPaymentProduct705SpecificInput
  • 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.

close

Description

Core reference number for the direct debit instruction in UK
close

Description

Object containing account holder name and bank account information
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

  • first-payment - First payment direct debit
  • nth-payment - Direct Debit (n-th payment)
  • re-presented - Re-presented direct debit (after failed attempt)
  • final-payment - Final payment direct debit
  • new-or-reinstated - (zero N) New or reinstated direct debit instruction
  • cancellation - (zero C) Cancellation of direct debit instruction
  • conversion-of-paper-DDI-to-electronic-DDI - (zero S) Conversion of paper DDI to electronic DDI (only used once, when migrating from traditional direct debit to AUDDIS
close

Description

Object containing ACH specific details
  • SDK Object type
    NonSepaDirectDebitPaymentProduct730SpecificInput
  • 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.

close

Description

Object containing account holder name and bank account information
  • SDK Object type
    BankAccountBban
close

Description

Name of the account holder
close

Description

Bank account number
close

Description

Bank code
close

Description

Name of the bank
close

Description

Branch code
close

Description

Bank check digit
close

Description

ISO 3166-1 alpha-2 country code of the country where the bank account is held For UK payouts this value is automatically set to GB as only payouts to UK accounts are supported.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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 transaction of a series of recurring transactions
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.
close

Description

ID of the stored token that contains the bank account details to be debited
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.
close

Description

Object containing the specific input details for e-invoice payments.
  • SDK Object type
    EInvoicePaymentMethodSpecificInput
  • 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.

close

Description

Indicates that the customer has read and accepted the terms and conditions of the product before proceeding with the payment. This must be done before the payment can continue. An URL to the terms and conditions can be retrieved with Get payment product.
close

Description

Object that holds the specific data for AfterPay Installments (payment product 9000).
  • SDK Object type
    EInvoicePaymentProduct9000SpecificInput
close

Description

Object containing the bank account details of the customer.
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
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.
close

Description

The ID of the installment plan selected by the customer. Installment plans can be retrieved with Get payment product.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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
close

Description

Object containing the specific input details for invoice payments
  • SDK Object type
    InvoicePaymentMethodSpecificInput
  • 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.

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.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing the specific input details for mobile payments.

Mobile payments produce the required payment data in encrypted form.

  • For Apple Pay, the encrypted payment data is the PKPayment.token.paymentData object passed as a string (with all quotation marks escaped).
  • For Google Pay, the encrypted payment data can be found in property paymentMethodData.tokenizationData.token of the PaymentData.toJson() result.
  • SDK Object type
    MobilePaymentMethodSpecificInput
  • 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.

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.
close

Description

Reference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.
close

Description

The payment data if you do the decryption of the encrypted payment data yourself.
  • SDK Object type
    DecryptedPaymentData
  • 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.

close
Deprecated: Use paymentMethod instead

Description

The type of payment credential which the customer used.
  • For Google Pay, maps to the paymentMethodDetails.authMethod property in the encrypted payment data.
.
close

Description

Card holder's name on the card.
  • For Apple Pay, maps to the cardholderName property in the encrypted payment data.
  • For Google Pay this is not available in the encrypted payment data, and can be omitted.
close

Description

The 3D secure online payment cryptogram.
  • For Apple Pay, maps to the paymentData.onlinePaymentCryptogram property in the encrypted payment data.
  • For Google Pay, maps to the paymentMethodDetails.cryptogram property in the encrypted payment data.
Not allowed for Google Pay if the authMethod in the response of Google is PAN_ONLY.
close

Description

The device specific PAN.
  • For Apple Pay, maps to the applicationPrimaryAccountNumber property in the encrypted payment data.
  • For Google Pay, maps to the paymentMethodDetails.dpan property in the encrypted payment data.
Not allowed for Google Pay if the authMethod in the response of Google is PAN_ONLY.
close

Description

The eci is Electronic Commerce Indicator.
  • For Apple Pay, maps to the paymentData.eciIndicator property in the encrypted payment data.
  • For Google Pay, maps to the paymentMethodDetails.eciIndicator property in the encrypted payment data.
close

Description

Expiry date of the card
Format: MMYY.
  • For Apple Pay, maps to the applicationExpirationDate property in the encrypted payment data. This property is formatted as YYMMDD, so this needs to be converted to get a correctly formatted expiry date.
  • For Google Pay, maps to the paymentMethodDetails.expirationMonth and paymentMethodDetails.expirationYear properties in the encrypted payment data. These need to be combined to get a correctly formatted expiry date.
close

Description

The non-device specific complete credit/debit card number (also know as the PAN).
  • For Apple Pay this is not available in the encrypted payment data, and must be omitted.
  • For Google Pay, maps to the paymentMethodDetails.pan property in the encrypted payment data.
Not allowed for Google Pay if the authMethod in the response of Google is CRYPTOGRAM_3DS.
close

Description

  • In case Google provides in the response as authMethod: CRYPTOGRAM_3DS send in as value of this property TOKENIZED_CARD.
  • In case Google provides in the response as authMethod: PAN_ONLY send in as value of this property CARD.
For Apple Pay this is not available in the encrypted payment data, and must be omitted.
close

Description

The payment data if we will do the decryption of the encrypted payment data.

Typically you'd use encryptedCustomerInput in the root of the create payment request to provide the encrypted payment data instead.

  • For Apple Pay, the encrypted payment data is the PKPayment.token.paymentData object passed as a string (with all quotation marks escaped).
  • For Google Pay, the encrypted payment data can be found in property paymentMethodData.tokenizationData.token of the PaymentData.toJson() result.
  • 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.

close

Description

Object containing information specific to Google Pay
  • SDK Object type
    MobilePaymentProduct320SpecificInput
close

Description

The card holder's name on the card.
The encrypted payment data can be found in property paymentMethodData.tokenizationData.info.billingAddress.name of the PaymentData.toJson() result.
close

Description

Object containing specific data regarding 3-D Secure
  • SDK Object type
    GPayThreeDSecure
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
.
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
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.
close

Description

Object containing browser specific redirection related data
  • SDK Object type
    RedirectionData
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 protocol to use, e.g. http:// or https://. 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.
close

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.
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.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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
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.
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
    RedirectPaymentMethodSpecificInput
  • 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.

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
close

Description

  • true
  • false
close

Description

Object containing specific input required for UPI (Payment product ID 4101)
  • SDK Object type
    RedirectPaymentProduct4101SpecificInput
  • 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.

close

Description

The merchant name as shown to the customer in some payment applications.
close

Description

The value of this property must be 'vpa', 'desktopQRCode', or 'urlIntent'.
close

Description

The Virtual Payment Address (VPA) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
close

Description

Object containing specific input required for Dutch iDeal payments (Payment product ID 809)
  • SDK Object type
    RedirectPaymentProduct809SpecificInput
  • 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.

close
Deprecated: Use redirectPaymentMethodSpecificInput.expirationPeriod instead

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.
close

Description

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.
close

Description

Object containing specific input required for German giropay payments (Payment product ID 816)
  • SDK Object type
    RedirectPaymentProduct816SpecificInput
  • 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.

close

Description

Object containing the bank account details of the customer
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
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.
close

Description

Object containing specific input required for PayPal payments (Payment product ID 840)
  • SDK Object type
    RedirectPaymentProduct840SpecificInput
  • 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.

close

Description

For payments processed by the Worldline 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
close
Deprecated: use order.references.descriptor instead.

Description

A free text string that you can send to PayPal. With a special agreement between PayPal and you, PayPal uses the data in that property, for custom services they offer to you.
close

Description

Deprecated: If your PayPal payments are processed by Worldline's Ogone Payment Platform, please use the property addressSelectionAtPayPal instead.

Indicates whether to use PayPal Express Checkout for payments processed by Worldline's GlobalCollect Payment Platform.
  • true = PayPal Express Checkout
  • false = Regular PayPal payment
For payments processed by Worldline's Ogone Payment Platform, please see the addressSelectionAtPayPal property for more information.
close

Description

Object containing specific input required for AliPay payments (Payment product ID 861)
  • SDK Object type
    RedirectPaymentProduct861SpecificInput
  • 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.

close

Description

This indicates that a customer is on a mobile device and it is used to distinguish whether a customer should be redirected to AliPay Desktop or Mobile. Alternatively, if you cannot determine whether a customer is on a mobile device or not, a customer can be redirected to AliPay Mobile if the property CreatePaymentRequest.order.customer.device.userAgent is supplied.
close

Description

Object containing specific input required for We Chat Pay payments (Payment product ID 863)
  • SDK Object type
    RedirectPaymentProduct863SpecificInput
  • 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.

close

Description

The type of integration with WeChat. Possible values:
  • desktopQRCode - used on desktops, the customer opens the WeChat app by scanning a QR code.
  • urlIntent - used in mobile apps or on mobile web pages, the customer opens the WeChat app using a URL intent.
  • nativeInApp - used in mobile apps that use the WeChat Pay SDK.
  • javaScriptAPI - used for WeChat official accounts. Requires the QQ browser to function.
  • miniProgram - used for Mini Programs.
close

Description

An openId of a customer.
close

Description

Object containing specific input required for China UnionPay payments (Payment product ID 869)
  • SDK Object type
    RedirectPaymentProduct869SpecificInput
  • 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.

close

Description

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.
close

Description

The name as described on the Resident Identity Card of the People's Republic of China.
close

Description

The identification number as described on the Resident Identity Card of the People's Republic of China.
close

Description

Object containing specific input required for Indian Net Banking payments (Payment product ID 882)
  • SDK Object type
    RedirectPaymentProduct882SpecificInput
  • 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.

close

Description

ID of the issuing bank of the customer. A list of available issuerIDs can be obtained by using the retrieve payment product directory API.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
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: 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.
close

Description

Object containing browser specific redirection related data
  • SDK Object type
    RedirectionData
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 protocol to use, e.g. http:// or https://. 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.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. All redirection using a POST method will load a page in the browser of the consumer that performs the actual redirection. This page contains a message to the consumer explaining what is happening. 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.
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.
close
Deprecated: Use redirectionData.returnUrl instead

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 protocol to use, e.g. http:// or https://. 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.
close

Description

ID of the token
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.
close

Description

Object containing the specific input details for SEPA direct debit payments
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificInput
  • 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.

close

Description

Changed date for direct debit collection. Only relevant for legacy SEPA Direct Debit.
Format: YYYYMMDD
close

Description

Description of the transaction that will appear on the customer bank statement to aid the customer in recognizing the transaction. Only relevant for legacy SEPA Direct Debit.
close

Description

Indicates if this transaction is of a one-off or a recurring type. Only relevant for legacy SEPA Direct Debit.
  • true - This is recurring
  • false - This is one-off
close

Description

Object containing information specific to SEPA Direct Debit
  • SDK Object type
    SepaDirectDebitPaymentProduct771SpecificInput
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.

close

Description

Object containing information to create a SEPA Direct Debit mandate.
  • SDK Object type
    CreateMandateWithReturnUrl
  • 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.

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.
close

Description

Customer object containing customer specific inputs
  • SDK Object type
    MandateCustomer
close

Description

Object containing IBAN information
  • SDK Object type
    BankAccountIban
close

Description

Name in which the account is held.
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.
close

Description

Name of company, as a customer
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    MandateContactDetails
close

Description

Email address of the customer
close

Description

Object containing billing address details
  • SDK Object type
    MandateAddress
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number
close

Description

Streetname
close

Description

Zip code
close

Description

Object containing personal information of the customer
  • SDK Object type
    MandatePersonalInformation
close

Description

Object containing the name details of the customer
  • SDK Object type
    MandatePersonalName
close

Description

Given name(s) or first name(s) of the customer
close

Description

Surname(s) or last name(s) of the customer
close

Description

Object containing the title of the customer (Mr, Miss or Mrs)
close

Description

The unique identifier of a customer
close

Description

The language code of the customer, one of de, en, es, fr, it, nl, si, sk, sv.
close

Description

Specifies whether the mandate is for one-off or recurring payments. Possible values are:
  • UNIQUE
  • RECURRING
close

Description

Return URL to use if the mandate signing requires redirection.
close

Description

Specifies whether the mandate is unsigned or singed by SMS. Possible values are:
  • UNSIGNED
  • SMS
close

Description

The unique identifier of the mandate
close
Deprecated: Use existingUniqueMandateReference or mandate.uniqueMandateReference instead

Description

A mandate ID to create a mandate under if the information to create a mandate has been supplied. Otherwise refers to the mandate to retrieve and use in the payment.
close

Description

Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Only relevant for legacy SEPA Direct Debit.
  • 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 transaction of a series of recurring transactions
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.
close

Description

ID of the token that holds previously stored SEPA Direct Debit account and mandate data. Only relevant for legacy SEPA Direct Debit.
close

Description

Indicates if this transaction should be tokenized. Only relevant for legacy SEPA Direct Debit.
  • 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.
close

Description

Data that was encrypted client side containing all customer entered data elements like card data.
Note: Because this data can only be submitted once to our system and contains encrypted card data you should not store it. As the data was captured within the context of a client session you also need to submit it to us before the session has expired.
close

Description

Object containing additional data that will be used to assess the risk of fraud
  • SDK Object type
    FraudFields
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.
close

Description

Additional black list input
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
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
close
Deprecated

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
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
close
Deprecated

Description

Full name of the state or province
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
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
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.
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
close
Deprecated: No replacement

Description

Indicates that the device fingerprint has been used while processing the order.
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
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
close

Description

Gift message
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
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
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
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.
close
Deprecated: Use order.shipping.comments instead

Description

Comments included during shipping
close
Deprecated: Use order.shipping.trackingNumber instead

Description

Shipment tracking number
close
Deprecated: No replacement

Description

Details on how the order is shipped to the customer
  • SDK Object type
    FraudFieldsShippingDetails
close
Deprecated: No replacement

Description

Details regarding the shipping method
close
Deprecated: No replacement

Description

Shipping method speed indicator
close
Deprecated: No replacement

Description

Shipping method type indicator
close

Description

Array of up to 16 userData properties, each with a max length of 256 characters, that can be used for fraudscreening
close
Deprecated: Use merchant.websiteUrl instead

Description

The website from which the purchase was made
close

Description

Object containing information on you, the merchant
  • SDK Object type
    Merchant
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.
close

Description

URL to find contact or support details to contact in case of questions.
close

Description

Object containing seller details
  • SDK Object type
    Seller
close

Description

Object containing the seller address details
  • SDK Object type
    Address
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
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
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
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
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.
close

Description

Description of the seller
close

Description

Seller ID assigned by the Merchant Aggregator
close

Description

The sellers geocode
close

Description

The sellers identifier
close

Description

Invoice number of the payment
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).
close

Description

Merchant category code
close

Description

Name of the seller
close

Description

Main Phone Number
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
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.
close

Description

Order object containing order related data
Please note that this object is required to be able to submit the amount.
  • SDK Object type
    Order
close

Description

Object containing additional input on the order
  • SDK Object type
    AdditionalOrderInput
close

Description

Object containing specific data regarding the recipient of an account funding transaction
  • SDK Object type
    AccountFundingRecipient
close

Description

Should be populated with the value of the corresponding accountNumberType of the recipient.
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.
close

Description

Object containing the address details of the recipient of an account funding transaction.
  • SDK Object type
    Address
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
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
close

Description

ISO 3166-2 alpha-3 state code
close

Description

Streetname
close

Description

Zip Code
close

Description

The date of birth of the recipient
Format: YYYYMMDD
close

Description

Object containing the name details of the recipient of an account funding transaction.
  • SDK Object type
    AfrName
close

Description

Given name(s) or first name(s) of the recipient of an account funding transaction.
close

Description

Surname(s) or last name(s) of the customer
close

Description

Either partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
close

Description

Object that holds airline specific data
  • SDK Object type
    AirlineData
close

Description

Numeric code identifying the agent
close

Description

Airline numeric code
close

Description

Date of the Flight
Format: YYYYMMDD
close

Description

Object that holds the data on the individual legs of the ticket
close
  • SDK Object type
    AirlineFlightLeg
close

Description

Reservation Booking Designator
close

Description

Arrival airport/city code
close

Description

The arrival time in the local time zone
Format: HH:MM
close

Description

IATA carrier code
close

Description

Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
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
close

Description

Date of the leg
Format: YYYYMMDD
close

Description

The departure time in the local time at the departure airport
Format: HH:MM
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
close

Description

New ticket number that is issued when a ticket is exchanged
close

Description

Fare of this leg
close

Description

Fare Basis/Ticket Designator
close

Description

Fee for this leg of the trip
close

Description

The flight number assigned by the airline carrier with no leading spaces
Should be a numeric string
close

Description

Sequence number of the flight leg
close

Description

Origin airport/city code
close

Description

PassengerClass if this leg
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
close

Description

Possible values are:
  • permitted = Stopover permitted
  • non-permitted = Stopover not permitted
close

Description

Taxes for this leg of the trip
close

Description

Airline tracing number
close

Description

  • true = The ticket is an E-Ticket
  • false = the ticket is not an E-Ticket
close
Deprecated: Use order.customer.accountType instead

Description

  • true = a registered known customer
  • false = unknown customer
close

Description

  • true - Restricted, the ticket is non-refundable
  • false - No restrictions, the ticket is (partially) refundable
close

Description

  • true - The payer is the ticket holder
  • false - The payer is not the ticket holder
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
close

Description

Your ID of the customer in the context of the airline data
close

Description

Name of the airline
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.
close

Description

Name of passenger
close

Description

Object that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
close
  • SDK Object type
    AirlinePassenger
close

Description

First name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Surname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Surname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Title of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
close

Description

Place of issue
For sales in the US the last two characters (pos 14-15) must be the US state code.
close

Description

Passenger name record
close

Description

IATA point of sale name
close

Description

city code of the point of sale
close

Description

Possible values:
  • e-ticket
  • city-ticket-office
  • airport-ticket-office
  • ticket-by-mail
  • ticket-on-departure
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
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
close

Description

Total fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
close

Description

Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
close

Description

Name of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
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
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
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object containing the total amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
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.
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
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.
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.
close
Deprecated: Use order.shoppingCart.amountBreakdown instead

Description

Object that holds Level3 summary data
  • SDK Object type
    Level3SummaryData
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
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
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
close
Deprecated: No replacement

Description

Object containing specific data regarding the recipient of a loan in the UK
  • SDK Object type
    LoanRecipient
close
Deprecated: No replacement

Description

Should be filled with the last 10 digits of the bank account number of the recipient of the loan.
close
Deprecated: No replacement

Description

The date of birth of the customer of the recipient of the loan.
Format: YYYYMMDD
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.
close
Deprecated: No replacement

Description

Surname of the recipient of the loan.
close
Deprecated: No replacement

Description

Zip code of the recipient of the loan
close

Description

Object that holds lodging specific data
  • SDK Object type
    LodgingData
close

Description

Object that holds lodging related charges
close
  • SDK Object type
    LodgingCharge
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.
close

Description

Currency for Charge amount. The code should be in 3 letter ISO format.
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
close

Description

The date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD
close

Description

The date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD
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.
close

Description

Indicates whether the room reservation is confirmed.
  • true - The room reservation is confirmed
  • false - The room reservation is not confirmed
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
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
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
close

Description

The total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
close

Description

The number of nights for the lodging stay
close

Description

The number of rooms rented for the lodging stay
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.
close

Description

The international customer service phone number of the facility
close

Description

The local phone number of the facility in an international phone number format
close

Description

Name of the person or business entity charged for the reservation and/or lodging stay
close

Description

Object that holds lodging related room data
close
  • SDK Object type
    LodgingRoom
close

Description

Daily room rate exclusive of any taxes and fees
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Daily room rate. The code should be in 3 letter ISO format
close

Description

Daily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode.
close

Description

Currency for Daily room tax. The code should be in 3 letter ISO format
close

Description

Number of nights charged at the rate in the dailyRoomRate property
close

Description

Location of the room within the facility, e.g. Park or Garden etc.
close

Description

Room number
close

Description

Size of bed, e.g., king, queen, double.
close

Description

Describes the type of room, e.g., standard, deluxe, suite.
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.
close

Description

Date and time of order
Format: YYYYMMDDHH24MISS
close

Description

Object that holds the purchase and usage type indicators
  • SDK Object type
    OrderTypeInformation
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.
close

Description

Possible values are:
  • physical
  • digital
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
close

Description

Possible values are:
  • private
  • commercial
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close

Description

Object containing the details of the customer
  • SDK Object type
    Customer
close

Description

Object containing data related to the account the customer has with you
  • SDK Object type
    CustomerAccount
close

Description

Object containing data on the authentication used by the customer to access their account
  • SDK Object type
    CustomerAccountAuthentication
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
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
close

Description

Timestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
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.
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.

close

Description

The date (YYYYMMDD) on which the customer created their account with you
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

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
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
close

Description

The last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
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

close

Description

Object containing information on the payment account data on file (tokens)
  • SDK Object type
    PaymentAccountOnFile
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.

close

Description

Number of attempts made to add new card to the customer account in the last 24 hours
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
close

Description

Object containing data on the purchase history of the customer with you
  • SDK Object type
    CustomerPaymentActivity
close

Description

Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
close

Description

Number of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
close

Description

Number of successful purchases made by this customer with you in the last 6 months
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
close

Description

Object containing billing address details
  • SDK Object type
    Address
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
close

Description

City
Note: For payments with product 1503 the maximum length is not 40 but 20.
close

Description

ISO 3166-1 alpha-2 country code
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
close

Description

Full name of the state or province
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