Create hosted checkout
Hosted Checkouts
Using hostedCheckouts you can process transactions using MyCheckout, our easy to use hosted responsive payment pages. Your consumers will be able to complete the payment process using MyCheckout that is hosted by us. Using these pages to capture card details and process card transactions will greatly reduce not only your integration efforts, but it will also reduce your 'PCI exposure' to the lowest level (SAQ-A).
The layout and look and feel of the MyCheckout Pages can be managed through the Configuration Center. Here you will find the powerful, yet very intuitive MyCheckout editor that lets you create multiple variations of your hosted payment pages hosted by us. If you have created multiple versions you are able to direct your consumers to specific variants through this API. This allows you easily test out different variations or continue specific campaigns all the way through to the payment pages.
The MyCheckout pages automatically adapt based on screen width of your consumers device. Clients that do not support JavaScript to be run on the client will still be able to make payments (although they will lack all the client side validation and automatic formatting to assist them). Please note that both the responsive nature and the support for clients without JavaScript support might not apply to 3rd party payment pages that the consumer might be redirected to to complete the payment.
MyCheckout is also modular in its setup, allowing you to specify exactly what you want us to do as part of your checkout flow. You decide if we should display the payment product selection and/or the confirmation page after a successful payment.
In case a payment product that requires the consumer to (manually) push the funds was selected, you will have the option to show these instructions again at a later moment. You could show them on your website in an area where the consumer can track the progress of their order. To avoid multiple payments you should however avoid showing them again for transactions that have already been paid.
Request
You can start a hostedCheckout flow by posting the relevant details to the endpoint. We will then return you all the details you need to redirect the consumer to us, retrieve the status and recognize the consumer when he/she returns to your website.
The hosted checkout allows the use of three distinct components:
- Presenting a (filtered) list of payment products that the consumer can choose from;
- Handling of the actual payment, potentially involving data capture, redirection and/or the displaying of payment instructions;
- Presenting a confirmation/failure page after the payment.
Step 1 and 3 from the above list are optional. When no or partial filtering is provided, the first page the consumer will see is a payment product selection page. However, the hosted checkout will start as if a payment product had been selected if that specific payment product is the only entry in the request's restriction filters.
By providing payment product ids and groups in the hostedCheckoutSpecificInput's paymentProductFilters object, you can reduce the list of available payment products by either excluding or restricting to certain products. Note that at least one viable payment product must be left after filtering and that exclusion is leading, meaning that restricting and excluding the same product will lead to exclusion.
By setting the tokensOnly boolean to true, as part of the paymentProductFilters object, the consumer may only complete the payment using one of the accounts on file provided in the tokens property of hostedCheckoutSpecificInput.
By setting the showResultPage boolean to false, as part of the hostedCheckoutSpecificInput, the system will skip the confirmation/failure page after the consumer has completed the payment. This setting is true by default and the results page will be presented to the user.
In case the payment product selection page needs to be skipped the hostedCheckout call needs to contain one of the following objects in which all payment products have been categorized. These will also be used if the consumer selects a related payment product.
- Bank transfer payments - bankTransferPaymentMethodSpecificInput
All payment products where consumers are asked to push their payment to a specific bank account. We will display payment instructions to the consumer. - Card payments - cardPaymentMethodSpecificInput
All credit and debit card products fall into this category if they allow for direct submission of card data without a redirect to a third party to capture the card details. - Cash payments - cashPaymentMethodSpecificInput
All payment products that allow the consumer to pay with cash at a physical location. The consumer is presented with instructions on how to make these kind of payments. In some cases we presents these instruction, while in other cases the instructions will be displayed by a 3rd party after a redirect. - Redirect payments - redirectPaymentMethodSpecificInput
All payment products that involve a redirect to a 3rd party to complete the payment directly online, like iDeal and PayPal.
A generic transaction can be submitted using the order and the fraudFields objects.
PayloadCreateHostedCheckoutRequest
Properties
|
|||
Property | Type | Required | Details |
---|---|---|---|
object | no | read close | |
close
DescriptionObject containing the specific input details for bank transfer payments
|
|||
additionalReference | string (20) | no | read close |
close
DescriptionYour additional reference identifier for this transaction. Data supplied in this property will also be returned in our report files, allowing you to reconcile the incoming funds.
|
|||
paymentProductId | integer (5) | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionObject containing the specific input details for card payments
|
|||
acquirerPromotionCode | string (32) | no | read close |
close
DescriptionIn case you have been provided with a promotion code by an acquirer, you can use this property to flag the transaction as being part of a specific card payment product promotion.
|
|||
authorizationMode | enum | no | read close |
close
DescriptionDetermines the type of the authorization that will be used. Allowed values:
|
|||
customerReference | string (17) | no | read close |
close
DescriptionReference of the customer for the payment (purchase order #, etc.) Only used with some acquirers.
|
|||
initialSchemeTransactionId | string (100) | no | read close |
close
DescriptionThe unique scheme transactionId of the initial transaction that was performed with SCA. In case this is unknown a scheme transactionId of an earlier transaction part of the same sequence can be used as a fall-back. Strongly advised to be submitted for any MerchantInitiated or recurring transaction (a subsequent one).
|
|||
paymentProductId | integer (5) | no | read close |
close
DescriptionDeprecated for Hosted Checkouts: This property is deprecated for the hosted checkout flow. Use hostedCheckoutSpecificInput.paymentProductFilters instead. Payment product identifierPlease see payment products for a full overview of possible values. |
|||
object | no | read close | |
endDate | string (8) | depends | read close |
close
DescriptionDate 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.
|
|||
minFrequency | integer (4) | depends | read close |
close
DescriptionMinimum number of days between authorizations. If no value is provided we will set a default value of 30 days.
|
|||
recurringPaymentSequenceIndicator | string | depends | read close |
close
Description
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. |
|||
recurringPaymentSequenceIndicator | string | no | read close |
close
Deprecated:
Use recurring.recurringPaymentSequenceIndicator instead.
Description
Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response. |
|||
requiresApproval | boolean | no | read close |
close
DescriptionDeprecated 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.
|
|||
skipAuthentication | boolean | no | read close |
close
Deprecated:
Use threeDSecureBase.skipAuthentication instead.
Description
|
|||
skipFraudService | boolean | no | read close |
close
Description
|
|||
object | no | read close | |
close
DescriptionObject containing specific data regarding 3-D Secure
|
|||
object | no | read close | |
close
DescriptionAllows 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.
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
authenticationFlow | string | no | read close |
close
DescriptionIndicates whether a transaction is performed in-app using an EMVco certified mobile SDK or inside a browser. Allowed values:
Note: We will add support for the in-app flow in a future release. |
|||
challengeCanvasSize | string | depends | read close |
close
DescriptionDimensions 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:
|
|||
challengeIndicator | string | no | read close |
close
DescriptionAllows you to indicate if you want the customer to be challenged for extra security on this transaction.
Possible values:
|
|||
exemptionRequest | string | no | read close |
close
DescriptionType of strong customer authentication (SCA) exemption requested for this transaction. Possible values:
|
|||
object | no | read close | |
close
DescriptionObject containing data regarding the customer authentication that occurred prior to the current transaction
|
|||
acsTransactionId | string (36) | no | read close |
close
DescriptionThe ACS Transaction ID for a prior 3-D Secure authenticated transaction (for example, the first recurring transaction that was authenticated with the customer)
|
|||
method | string | no | read close |
close
DescriptionMethod of authentication used for this transaction.
Possible values:
|
|||
utcTimestamp | string (12) | no | read close |
close
DescriptionTimestamp in UTC (YYYYMMDDHHmm) of the 3-D Secure authentication of this transaction
|
|||
object | no | read close | |
object | no | read close | |
close
DescriptionObject containing rendering options of the device.
|
|||
sdkInterface | string | no | read close |
close
DescriptionLists all of the SDK Interface types that the device supports for displaying specific challenge user interfaces within the SDK.
|
|||
sdkUiType | string | no | read close |
close
Deprecated:
Please use cardPaymentMethodSpecificInput.threeDSecure.sdkData.deviceRenderOptions.sdkUiTypes
DescriptionLists all UI types that the device supports for displaying specific challenge user interfaces within the SDK.
|
|||
sdkUiTypes | array | no | read close |
close
DescriptionLists all UI types that the device supports for displaying specific challenge user interfaces within the SDK.
|
|||
sdkAppId | string (36) | no | read close |
close
DescriptionUniversally unique ID created upon all installations and updates of your app on a c Device. This will be newly generated and stored by the 3DS SDK for each installation or update
|
|||
sdkEncryptedData | string (64000) | no | read close |
close
DescriptionJWE Object containing data encrypted by the 3-D Secure SDK
|
|||
sdkEphemeralPublicKey | string (256) | no | read close |
close
DescriptionPublic key component of the ephemeral key pair generated by the 3-D Secure SDK and used to establish session keys between the 3-D Secure SDK and ACS.
|
|||
sdkMaxTimeout | string (2) | no | read close |
close
DescriptionIndicates maximum amount of time (in minutes) for all exchanges. Minimum amount of minutes is 5.
|
|||
sdkReferenceNumber | string (32) | no | read close |
close
DescriptionIdentifies the vendor and version for the 3-D Secure SDK that is integrated in your app, assigned by EMVCo when the 3-D Secure SDK is approved.
|
|||
sdkTransactionId | string (36) | no | read close |
close
DescriptionUniversally unique transaction identifier assigned by the 3-D Secure SDK to identify a single transaction.
|
|||
skipAuthentication | boolean | no | read close |
close
Description
|
|||
transactionRiskLevel | string | no | read close |
close
DescriptionIn 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:
|
|||
token | string (40) | no | read close |
close
DescriptionID of the token that holds previously stored card data
|
|||
tokenize | boolean | no | read close |
close
DescriptionIndicates if this transaction should be tokenized
|
|||
transactionChannel | enum | no | read close |
close
DescriptionIndicates the channel via which the payment is created. Allowed values:
|
|||
unscheduledCardOnFileIndicator | string | no | read close |
close
Deprecated:
Use unscheduledCardOnFileSequenceIndicator instead.
Description
Note: this property is not allowed if isRecurring is true. |
|||
unscheduledCardOnFileRequestor | string | depends | read close |
close
DescriptionIndicates which party initiated the unscheduled recurring transaction. Allowed values:
Notes:
|
|||
unscheduledCardOnFileSequenceIndicator | string | no | read close |
close
Description
Notes:
|
|||
object | no | read close | |
close
DescriptionObject containing the specific input details for cash payments
|
|||
paymentProductId | integer (5) | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
object | no | read close | |
close
DescriptionObject containing the specific input details for eInvoice payments
|
|||
paymentProductId | integer (5) | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
requiresApproval | boolean | no | read close |
close
Description
|
|||
object | no depends no no yes | read close | |
close
DescriptionObject containing additional data that will be used to assess the risk of fraud
|
|||
addressesAreIdentical | boolean | no | read close |
close
Deprecated:
For risk assessments there is no replacement. For other calls, please use order.shipping.addressIndicator to indicate that the billing and shipping address are identical.
DescriptionIndicates that invoice and shipping addresses are equal.
|
|||
blackListData | string (50) | no | read close |
close
DescriptionAdditional black list input
|
|||
object | no | read close | |
close
Deprecated:
This should be the same as order.customer.billingAddress
DescriptionThe address that belongs to the owner of the card
|
|||
additionalInfo | string (50) | no | read close |
close
Deprecated
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
Deprecated
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
customerIpAddress | string (45) | no depends no depends yes | read close |
close
DescriptionThe 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.
|
|||
defaultFormFill | string | no | read close |
close
Deprecated:
Use order.customer.device.defaultFormFill instead
DescriptionDegree of default form fill, with the following possible values:
|
|||
deviceFingerprintActivated | boolean | no | read close |
close
Deprecated:
No replacement
DescriptionIndicates that the device fingerprint has been used while processing the order.
|
|||
deviceFingerprintTransactionId | string | no | read close |
close
Deprecated:
Use order.customer.device.deviceFingerprintTransactionId instead
DescriptionOne must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
|
|||
giftCardType | string | no | read close |
close
DescriptionOne of the following gift card types:
|
|||
giftMessage | string (160) | no | read close |
close
DescriptionGift message
|
|||
hasForgottenPwd | boolean | no | read close |
close
Deprecated:
Use order.customer.account.hasForgottenPassword instead
DescriptionSpecifies if the customer (initially) had forgotten their password
|
|||
hasPassword | boolean | no | read close |
close
Deprecated:
Use order.customer.account.hasPassword instead
DescriptionSpecifies if the customer entered a password to gain access to an account registered with the you
|
|||
isPreviousCustomer | boolean | no | read close |
close
Deprecated:
Use order.customer.isPreviousCustomer instead
DescriptionSpecifies if the customer has a history of online shopping with the merchant
|
|||
orderTimezone | string (2) | no depends no no yes | read close |
close
DescriptionTimezone in which the order was placed. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
shipComments | string (160) | no | read close |
close
Deprecated:
Use order.shipping.comments instead
DescriptionComments included during shipping
|
|||
shipmentTrackingNumber | string (19) | no | read close |
close
Deprecated:
Use order.shipping.trackingNumber instead
DescriptionShipment tracking number
|
|||
object | no | read close | |
close
Deprecated:
No replacement
DescriptionDetails on how the order is shipped to the customer
|
|||
methodDetails | string (50) | no | read close |
close
Deprecated:
No replacement
DescriptionDetails regarding the shipping method
|
|||
methodSpeed | integer | no | read close |
close
Deprecated:
No replacement
DescriptionShipping method speed indicator
|
|||
methodType | integer | no | read close |
close
Deprecated:
No replacement
DescriptionShipping method type indicator
|
|||
userData | array | no | read close |
close
DescriptionArray of up to 16 userData properties, each with a max length of 256 characters, that can be used for fraudscreening
|
|||
website | string (60) | no | read close |
close
Deprecated:
Use merchant.websiteUrl instead
DescriptionThe website from which the purchase was made
|
|||
object | no | read close | |
close
DescriptionObject containing hosted checkout specific data
|
|||
isRecurring | boolean | no | read close |
close
Description
|
|||
locale | string (6) | no | read close |
close
DescriptionLocale to use to present the MyCheckout payment pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
|
|||
object | no | read close | |
close
DescriptionContains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
|
|||
object | no | read close | |
close
DescriptionContains the payment product ids and payment product groups that should be excluded from the payment products available for the payment. Note that excluding a payment product will ensure exclusion, even if the payment product is also present in the restrictTo filter, and that excluding a payment product group will exclude all payment products that are a part of that group, even if one or more of them are present in the restrictTo filters.
|
|||
groups | array | no | read close |
close
DescriptionList containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called 'cards'.
|
|||
products | array | no | read close |
close
DescriptionList containing all payment product ids that should either be restricted to in or excluded from the payment context.
|
|||
object | no | read close | |
close
DescriptionContains the payment product ids and payment product groups that should be at most contained in the payment products available for completing the payment. Note that the list of payment products available for completing the payment will only contain payment products present in these filters, but not all payment products in these filters might be present in the list. Some of them might not be allowed in context or they might be present in the exclude filters.
|
|||
groups | array | no | read close |
close
DescriptionList containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called 'cards'.
|
|||
products | array | no | read close |
close
DescriptionList containing all payment product ids that should either be restricted to in or excluded from the payment context.
|
|||
tokensOnly | boolean | no | read close |
close
Description
|
|||
object | no | read close | |
close
DescriptionThe object containing reference data for the text that can be displayed on MyCheckout hosted payment page with subscription information.
Note: The data in this object is only meant for displaying recurring payments-related data on your checkout page. You still need to submit all the recurring payment-related data in the corresponding payment product-specific input. (example: cardPaymentMethodSpecificInput.recurring and cardPaymentMethodSpecificInput.isRecurring)
|
|||
object | yes | read close | |
close
DescriptionThe object containing the frequency and interval between recurring payments.
|
|||
interval | enum | yes | read close |
close
DescriptionThe interval between recurring payments specified as days, weeks, quarters, or years.
|
|||
intervalFrequency | integer (4) | yes | read close |
close
DescriptionThe number of days, weeks, months, quarters, or years between recurring payments.
|
|||
object | no | read close | |
close
DescriptionThe object containing data of the trial period: no-cost or discounted time-constrained trial subscription period.
|
|||
object | yes | read close | |
close
DescriptionThe object containing the amount and ISO currency code attributes of money to be paid after the trial period ends.
Note: The property order.amountOfMoney should be populated with the amount to be paid during or for the trial period (no-cost or discounted time-constrained trial subscription period).
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
endDate | string (8) | depends | read close |
close
DescriptionThe date that the trial period ends in YYYYMMDD format.
|
|||
isRecurring | boolean | no | read close |
close
DescriptionThe property specifying if there will be recurring charges throughout the trial period (when the trial period involves a temporary discounted rate).
True = there will be recurring charges during the trial period False = there will not be recurring charges during the trial period |
|||
object | depends | read close | |
close
DescriptionThe object containing information on the trial period duration and the interval between payments during that period.
|
|||
duration | integer (4) | yes | read close |
close
DescriptionThe number of days, weeks, months, or years before the trial period ends.
|
|||
interval | enum | yes | read close |
close
DescriptionThe interval for the trial period to finish specified as days, weeks, months, quarters, or years.
|
|||
object | no | read close | |
close
DescriptionThe object containing the frequency and interval between recurring payments.
Note: This object should only be populated if the frequency of recurring payments between the trial and regular periods is different. If you do not populated this object, then the same interval frequency and interval of recurringPaymentsData.recurringInterval will be used
|
|||
interval | enum | yes | read close |
close
DescriptionThe interval between recurring payments specified as days, weeks, quarters, or years.
|
|||
intervalFrequency | integer (4) | yes | read close |
close
DescriptionThe number of days, weeks, months, quarters, or years between recurring payments.
|
|||
returnCancelState | boolean | no | read close |
close
DescriptionThis flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result.
If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS. The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change. |
|||
returnUrl | string (512) | no | read close |
close
DescriptionThe 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. |
|||
showResultPage | boolean | no | read close |
close
Description
|
|||
tokens | string | no | read close |
close
DescriptionString containing comma separated tokens (no spaces) associated with the customer of this hosted checkout. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the checkout.
|
|||
validateShoppingCart | boolean | no | read close |
close
DescriptionBy default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off for a hosted checkout on the Ogone Payment Platform, in which case the rendering of the shopping cart will be skipped if any required information is missing. Use this when you want fraud-checks to be performed on the shopping cart, but do not want to suply all data needed for displaying it in the hosted checkout. The default value for this property is true.
|
|||
variant | string | no | read close |
close
DescriptionUsing the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID of the variant.
|
|||
object | no depends no no yes | read close | |
configurationId | string | no | read close |
close
DescriptionIn case your account has been setup with multiple configurations you can use this property to identify the one you would like to use for the transaction. Note that you can only submit preconfigured values in combination with the Worldline Online Payments Acceptance platform. In case no value is supplied a default value of 0 will be submitted to the Worldline Online Payments Acceptance platform. The Worldline Online Payments Acceptance platform internally refers to this as a PosId.
|
|||
contactWebsiteUrl | string (2048) | no | read close |
close
DescriptionURL to find contact or support details to contact in case of questions.
|
|||
object | no | read close | |
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
channelCode | string (3) | no | read close |
close
DescriptionThis property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
|
|||
description | string (32) | no | read close |
close
DescriptionDescription of the seller
|
|||
externalReferenceId | string (15) | no | read close |
close
DescriptionSeller ID assigned by the Merchant Aggregator
|
|||
geocode | string (5) | no | read close |
close
DescriptionThe sellers geocode
|
|||
id | string (40) | no depends no yes no | read close |
close
DescriptionThe sellers identifier
|
|||
invoiceNumber | string (12) | no | read close |
close
DescriptionInvoice number of the payment
|
|||
isForeignRetailer | boolean | no | read close |
close
DescriptionIndicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
|
|||
mcc | string (5) | no | read close |
close
DescriptionMerchant category code
|
|||
name | string (128) | no depends no yes no | read close |
close
DescriptionName of the seller
|
|||
phoneNumber | string (32) | no | read close |
close
DescriptionMain Phone Number
|
|||
type | string | no depends no yes no | read close |
close
DescriptionSeller type. Possible values:
|
|||
websiteUrl | string (60) | no depends no no yes | read close |
close
DescriptionThe website from which the purchase was made. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
object | depends | read close | |
close
DescriptionObject containing reference data for Google Pay (paymentProductId 320) and Apple Pay (paymentProductID 302).
|
|||
authorizationMode | enum | no | read close |
close
DescriptionDetermines the type of the authorization that will be used. Allowed values:
|
|||
customerReference | string (17) | no | read close |
close
DescriptionReference of the customer for the payment (purchase order #, etc.). Only used with some acquirers.
|
|||
object | no | read close | |
close
DescriptionObject containing information specific to Apple Pay
|
|||
businessName | string (64) | no | read close |
close
DescriptionUsed as an input for the Apple Pay payment button. Your default business name is configured in the Configuration Center. In case you want to use another business name than the one configured in the Configuration Center, provide your company name in a human readable form.
|
|||
object | depends | read close | |
close
DescriptionObject containing information specific to Google Pay (paymentProductId 320)
|
|||
merchantName | string | depends | read close |
close
DescriptionUsed as an input for the Google Pay payment sheet. Provide your company name in a human readable form.
|
|||
merchantOrigin | string | depends | read close |
object | no depends yes depends no | read close | |
close
DescriptionObject containing specific data regarding 3-D Secure
|
|||
challengeCanvasSize | string | depends | read close |
close
DescriptionDimensions 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:
|
|||
challengeIndicator | string | no | read close |
close
DescriptionAllows you to indicate if you want the customer to be challenged for extra security on this transaction.
Possible values:
|
|||
exemptionRequest | string | no | read close |
close
DescriptionType of strong customer authentication (SCA) exemption requested for this transaction. Possible values:
|
|||
object | no depends yes depends no | read close | |
close
Deprecated:
No replacement
DescriptionObject containing browser specific redirection related data
|
|||
returnUrl | string (512) | depends | read close |
close
Deprecated:
No replacement
DescriptionThe 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. |
|||
variant | string | no | read close |
close
Deprecated:
No replacement
DescriptionUsing 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:
Note: In case you have defined a Dynamic 3D Secure rule that takes the variant into account this will only work if you explicitly specify the ID using this property. |
|||
skipAuthentication | boolean | no | read close |
close
Description
|
|||
paymentProductId | integer (5) | no | read close |
close
DescriptionPayment product identifier
Please see payment products for a full overview of possible values. |
|||
requiresApproval | boolean | no | read close |
close
Description
|
|||
skipFraudService | boolean | no | read close |
close
Description
|
|||
object | yes | read close | |
object | no depends no depends yes | read close | |
close
DescriptionObject containing additional input on the order
|
|||
object | depends | read close | |
close
DescriptionObject containing specific data regarding the recipient of an account funding transaction
|
|||
accountNumber | string (50) | depends | read close |
close
DescriptionShould be populated with the value of the corresponding accountNumberType of the recipient.
|
|||
accountNumberType | string | depends | read close |
close
DescriptionDefines the account number type of the recipient. Possible values are:
|
|||
object | no | read close | |
close
DescriptionObject containing the address details of the recipient of an account funding transaction.
|
|||
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
dateOfBirth | string (8) | depends | read close |
close
DescriptionThe date of birth of the recipient
Format: YYYYMMDD |
|||
object | depends | read close | |
close
DescriptionObject containing the name details of the recipient of an account funding transaction.
|
|||
firstName | string (15) | yes | read close |
close
DescriptionGiven name(s) or first name(s) of the recipient of an account funding transaction.
|
|||
surname | string (70) | yes | read close |
close
DescriptionSurname(s) or last name(s) of the customer
|
|||
partialPan | string (10) | depends | read close |
close
DescriptionEither partialPan or accountnumber is required for merchants that use Merchant Category Code (MCC) 6012 for transactions involving UK costumers.
|
|||
object | no depends no depends depends | read close | |
agentNumericCode | string (8) | no | read close |
close
DescriptionNumeric code identifying the agent
|
|||
code | string (3) | no | read close |
close
DescriptionAirline numeric code
|
|||
flightDate | string (8) | no depends no no depends | read close |
close
DescriptionDate of the Flight
Format: YYYYMMDD |
|||
array of object | no depends no no depends | read close | |
close
DescriptionObject that holds the data on the individual legs of the ticket
|
|||
object | no | read close | |
airlineClass | string | no | read close |
close
DescriptionReservation Booking Designator
|
|||
arrivalAirport | string (3) | no depends no no depends | read close |
close
DescriptionArrival airport/city code
|
|||
arrivalTime | string | no | read close |
close
DescriptionThe arrival time in the local time zone
Format: HH:MM |
|||
carrierCode | string (2) | no | read close |
close
DescriptionIATA carrier code
|
|||
conjunctionTicket | string (14) | no | read close |
close
DescriptionIdentifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
|
|||
couponNumber | string (1) | no | read close |
close
DescriptionThe coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
|
|||
date | string (8) | no depends no no depends | read close |
close
DescriptionDate of the leg
Format: YYYYMMDD |
|||
departureTime | string (6) | depends | read close |
close
DescriptionThe departure time in the local time at the departure airport
Format: HH:MM |
|||
endorsementOrRestriction | string (20) | no | read close |
close
DescriptionAn endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
|
|||
exchangeTicket | string (15) | no | read close |
close
DescriptionNew ticket number that is issued when a ticket is exchanged
|
|||
fare | string (12) | no | read close |
close
DescriptionFare of this leg
|
|||
fareBasis | string (15) | no | read close |
close
DescriptionFare Basis/Ticket Designator
|
|||
fee | integer | no | read close |
close
DescriptionFee for this leg of the trip
|
|||
flightNumber | string (4) | depends | read close |
close
DescriptionThe flight number assigned by the airline carrier with no leading spaces
Should be a numeric string |
|||
number | integer (5) | no | read close |
close
DescriptionSequence number of the flight leg
|
|||
originAirport | string (3) | no depends no no depends | read close |
close
DescriptionOrigin airport/city code
|
|||
passengerClass | string | no | read close |
close
DescriptionPassengerClass if this leg
|
|||
serviceClass | enum | no | read close |
close
Deprecated:
Use passengerClass instead
DescriptionServiceClass of this leg (this property is used for fraud screening on the Ogone Payment Platform).
Possible values are:
|
|||
stopoverCode | string | depends | read close |
close
DescriptionPossible values are:
|
|||
taxes | integer | no | read close |
close
DescriptionTaxes for this leg of the trip
|
|||
invoiceNumber | string (6) | no | read close |
close
DescriptionAirline tracing number
|
|||
isETicket | boolean | no | read close |
close
Description
|
|||
isRegisteredCustomer | boolean | no | read close |
close
Deprecated:
Use order.customer.accountType instead
Description
|
|||
isRestrictedTicket | boolean | no | read close |
close
Description
|
|||
isThirdParty | boolean | no | read close |
close
Description
|
|||
issueDate | string (8) | no | read close |
close
DescriptionThis is the date of issue recorded in the airline system
In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
Format: YYYYMMDD |
|||
merchantCustomerId | string (16) | no | read close |
close
DescriptionYour ID of the customer in the context of the airline data
|
|||
name | string (20) | no | read close |
close
DescriptionName of the airline
|
|||
numberInParty | integer | no | read close |
close
DescriptionTotal number of passengers in the party. If the the property numberInParty is not present, then the number of passengers will be used on the WL Online Payment Acceptance Platform.
|
|||
passengerName | string (49) | no depends no no depends | read close |
close
DescriptionName of passenger
|
|||
array of object | no | read close | |
close
DescriptionObject that holds the data on the individual passengers (this object is used for fraud screening on the Ogone Payment Platform)
|
|||
object | no | read close | |
firstName | string (15) | no | read close |
close
DescriptionFirst name of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
surname | string (70) | no | read close |
close
DescriptionSurname of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionSurname prefix of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
title | string (35) | no | read close |
close
DescriptionTitle of the passenger (this property is used for fraud screening on the Ogone Payment Platform)
|
|||
placeOfIssue | string (15) | no | read close |
close
DescriptionPlace of issue
For sales in the US the last two characters (pos 14-15) must be the US state code. |
|||
pnr | string (127) | no depends no no depends | read close |
close
DescriptionPassenger name record
|
|||
pointOfSale | string (25) | no | read close |
close
DescriptionIATA point of sale name
|
|||
posCityCode | string (10) | no | read close |
close
Descriptioncity code of the point of sale
|
|||
ticketDeliveryMethod | string | no | read close |
close
DescriptionPossible values:
|
|||
ticketNumber | string (13) | no | read close |
close
DescriptionThe ticket or document number. On the Ogone Payment Platform and the GlobalCollect Payment Platform it contains:
|
|||
totalFare | integer | no | read close |
close
DescriptionTotal fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
|
|||
totalFee | integer | no | read close |
close
DescriptionTotal fee for all legs on the ticket. If multiple tickets are purchased, this is the total fee for all tickets
|
|||
totalTaxes | integer | no | read close |
close
DescriptionTotal taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
|
|||
travelAgencyName | string (25) | no | read close |
close
DescriptionName of the travel agency issuing the ticket. For direct airline integration, leave this property blank on the Ogone Payment Platform.
|
|||
object | no | read close | |
close
DescriptionObject 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.
|
|||
object | no | read close | |
close
DescriptionThe 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.
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no | read close | |
close
DescriptionObject containing the total amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
frequencyOfInstallments | string | no | read close |
close
DescriptionThe frequency in which the installments will be collected from the customer.
The possible values are:
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), only the value monthly is valid. |
|||
installmentPlanCode | integer | no | read close |
close
DescriptionThe code for the installment plan. The possible values are:
|
|||
interestRate | string | no | read close |
close
DescriptionThe interest rate paid for installments expressed in percentage. So for example 5.75 means 5.75%
For the payment product IDs BC Card (paymentProductId 8590), Hana Card (paymentProductId 8591), Hyundai Card (paymentProductId 8592), KB Card (paymentProductId 8593), Lotte Card (paymentProductId 8594), NH Card (paymentProductId 8595), Samsung Card (paymentProductId 8596) and Shinhan Card (paymentProductId 8597), this property is not used as the value is decided by the issuer. |
|||
numberOfInstallments | integer (5) | no depends no yes no | read close |
close
DescriptionThe 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. |
|||
object | no | read close | |
close
Deprecated:
Use order.shoppingCart.amountBreakdown instead
DescriptionObject that holds Level3 summary data
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type DISCOUNT instead
DescriptionDiscount on the entire transaction, with the last 2 digits are implied decimal places
|
|||
dutyAmount | integer (12) | no | read close |
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type DUTY instead
DescriptionDuty on the entire transaction, with the last 2 digits are implied decimal places
|
|||
shippingAmount | integer (12) | no | read close |
close
Deprecated:
Use order.shoppingCart.amountBreakdown with type SHIPPING instead
DescriptionShippingcost on the entire transaction, with the last 2 digits are implied decimal places
|
|||
object | depends | read close | |
close
Deprecated:
No replacement
DescriptionObject containing specific data regarding the recipient of a loan in the UK
|
|||
accountNumber | string (10) | depends | read close |
close
Deprecated:
No replacement
DescriptionShould be filled with the last 10 digits of the bank account number of the recipient of the loan.
|
|||
dateOfBirth | string (8) | depends | read close |
close
Deprecated:
No replacement
DescriptionThe date of birth of the customer of the recipient of the loan.
Format: YYYYMMDD |
|||
partialPan | string (10) | depends | read close |
close
Deprecated:
No replacement
DescriptionShould be filled with the first 6 and last 4 digits of the PAN number of the recipient of the loan.
|
|||
surname | string (12) | depends | read close |
close
Deprecated:
No replacement
DescriptionSurname of the recipient of the loan.
|
|||
zip | string (10) | depends | read close |
close
Deprecated:
No replacement
DescriptionZip code of the recipient of the loan
|
|||
object | no | read close | |
array of object | no | read close | |
close
DescriptionObject that holds lodging related charges
|
|||
object | no | read close | |
chargeAmount | integer (12) | no | read close |
close
DescriptionAmount of additional charges associated with the stay of the guest.
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
chargeAmountCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Charge amount. The code should be in 3 letter ISO format.
|
|||
chargeType | string | no | read close |
close
DescriptionType of additional charges associated with the stay of the guest.
Allowed values:
|
|||
checkInDate | string (8) | no | read close |
close
DescriptionThe date the guest checks into (or plans to check in to) the facility.
Format: YYYYMMDD |
|||
checkOutDate | string (8) | no | read close |
close
DescriptionThe date the guest checks out of (or plans to check out of) the facility.
Format: YYYYMMDD |
|||
folioNumber | string (25) | no | read close |
close
DescriptionThe Lodging Folio Number assigned to the itemized statement of charges and credits associated with this lodging stay, which can be any combination of characters and numerals defined by the Merchant or authorized Third Party Processor.
|
|||
isConfirmedReservation | boolean | no | read close |
close
DescriptionIndicates whether the room reservation is confirmed.
|
|||
isFacilityFireSafetyConform | boolean | no | read close |
close
DescriptionDefines whether or not the facility conforms to the requirements of the Hotel and Motel Fire Safety Act of 1990, or similar legislation.
|
|||
isNoShow | boolean | no | read close |
close
DescriptionIndicate if this the customer is a no show case. In such case, the lodging property can charge a no show fee.
|
|||
isPreferenceSmokingRoom | boolean | no | read close |
close
DescriptionIndicated the preference of the customer for a smoking or non-smoking room.
|
|||
numberOfAdults | integer (3) | no | read close |
close
DescriptionThe total number of adult guests staying (or planning to stay) at the facility (i.e., all booked rooms)
|
|||
numberOfNights | integer (4) | no | read close |
close
DescriptionThe number of nights for the lodging stay
|
|||
numberOfRooms | integer (4) | no | read close |
close
DescriptionThe number of rooms rented for the lodging stay
|
|||
programCode | string | no | read close |
close
DescriptionCode that corresponds to the category of lodging charges detailed in this message.
Allowed values:
|
|||
propertyCustomerServicePhoneNumber | string (20) | no | read close |
close
DescriptionThe international customer service phone number of the facility
|
|||
propertyPhoneNumber | string (20) | no | read close |
close
DescriptionThe local phone number of the facility in an international phone number format
|
|||
renterName | string (26) | no | read close |
close
DescriptionName of the person or business entity charged for the reservation and/or lodging stay
|
|||
array of object | no | read close | |
close
DescriptionObject that holds lodging related room data
|
|||
object | no | read close | |
dailyRoomRate | string (12) | no | read close |
close
DescriptionDaily room rate exclusive of any taxes and fees
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
dailyRoomRateCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Daily room rate. The code should be in 3 letter ISO format
|
|||
dailyRoomTaxAmount | string (12) | no | read close |
close
DescriptionDaily room tax
Note: The currencyCode is presumed to be identical to the order.amountOfMoney.currencyCode. |
|||
dailyRoomTaxAmountCurrencyCode | string (3) | no | read close |
close
DescriptionCurrency for Daily room tax. The code should be in 3 letter ISO format
|
|||
numberOfNightsAtRoomRate | integer (4) | no | read close |
close
DescriptionNumber of nights charged at the rate in the dailyRoomRate property
|
|||
roomLocation | string (10) | no | read close |
close
DescriptionLocation of the room within the facility, e.g. Park or Garden etc.
|
|||
roomNumber | string (6) | no | read close |
close
DescriptionRoom number
|
|||
typeOfBed | string (12) | no | read close |
close
DescriptionSize of bed, e.g., king, queen, double.
|
|||
typeOfRoom | string (12) | no | read close |
close
DescriptionDescribes the type of room, e.g., standard, deluxe, suite.
|
|||
numberOfInstallments | integer (5) | no | read close |
close
Deprecated:
Use installments.numberOfInstallments instead.
DescriptionThe number of installments in which this transaction will be paid, which can be used for card payments. Only used with some acquirers. In case you send in the details of this object, only the combination of card products and acquirers that do support installments will be shown on the MyCheckout hosted payment pages.
|
|||
orderDate | string (14) | no | read close |
close
DescriptionDate and time of order
Format: YYYYMMDDHH24MISS |
|||
object | no | read close | |
close
DescriptionObject that holds the purchase and usage type indicators
|
|||
fundingType | string | depends | read close |
close
DescriptionIdentifies the funding type being authenticated. Possible values are:
|
|||
paymentCode | string | no | read close |
close
DescriptionPayment code to support account funding transactions. Possible values are:
|
|||
purchaseType | string | no | read close |
close
DescriptionPossible values are:
|
|||
transactionType | string | depends | read close |
close
DescriptionIdentifies the type of transaction being authenticated.
Possible values are:
|
|||
usageType | string | no | read close |
close
DescriptionPossible values are:
|
|||
object | yes | read close | |
close
DescriptionObject containing amount and ISO currency code attributes
|
|||
amount | integer (12) | yes | read close |
close
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | depends | read close | |
object | no | read close | |
close
DescriptionObject containing data related to the account the customer has with you
|
|||
object | no | read close | |
close
DescriptionObject containing data on the authentication used by the customer to access their account
|
|||
data | string (20000) | no | read close |
close
DescriptionData 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:
|
|||
method | string | depends | read close |
close
DescriptionAuthentication used by the customer on your website or app
Possible values :
|
|||
utcTimestamp | string (12) | no | read close |
close
DescriptionTimestamp (YYYYMMDDHHmm) of the authentication of the customer to their account with you
|
|||
changeDate | string (8) | no | read close |
close
DescriptionThe last date (YYYYMMDD) on which the customer made changes to their account with you. These are changes to billing & shipping address details, new payment account (tokens), or new users(s) added.
|
|||
changedDuringCheckout | boolean | no | read close |
close
Descriptiontrue = the customer made changes to their account during this checkout
false = the customer didn't change anything to their account during this checkout/n The changes ment here are changes to billing & shipping address details, new payment account (tokens), or new users(s) added. |
|||
createDate | string (8) | no | read close |
close
DescriptionThe date (YYYYMMDD) on which the customer created their account with you
|
|||
hadSuspiciousActivity | boolean | no | read close |
close
DescriptionSpecifies if you have experienced suspicious activity on the account of the customer
true = you have experienced suspicious activity (including previous fraud) on the customer account used for this transaction false = you have experienced no suspicious activity (including previous fraud) on the customer account used for this transaction |
|||
hasForgottenPassword | boolean | no | read close |
close
DescriptionSpecifies if the customer (initially) had forgotten their password
|
|||
hasPassword | boolean | no | read close |
close
DescriptionSpecifies if the customer entered a password to gain access to an account registered with the you
|
|||
passwordChangeDate | string (8) | no | read close |
close
DescriptionThe last date (YYYYMMDD) on which the customer changed their password for the account used in this transaction
|
|||
passwordChangedDuringCheckout | boolean | no | read close |
close
DescriptionIndicates 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 |
|||
object | no | read close | |
close
DescriptionObject containing information on the payment account data on file (tokens)
|
|||
createDate | string (8) | no | read close |
close
DescriptionThe date (YYYYMMDD) when the payment account on file was first created.
In case a token is used for the transaction we will use the creation date of the token in our system in case you leave this property empty. |
|||
numberOfCardOnFileCreationAttemptsLast24Hours | integer (3) | no | read close |
close
DescriptionNumber of attempts made to add new card to the customer account in the last 24 hours
|
|||
paymentAccountOnFileType | string | depends | read close |
close
DescriptionIndicates the type of account. For example, for a multi-account card product.
|
|||
object | no | read close | |
close
DescriptionObject containing data on the purchase history of the customer with you
|
|||
numberOfPaymentAttemptsLast24Hours | integer (3) | no | read close |
close
DescriptionNumber of payment attempts (so including unsuccessful ones) made by this customer with you in the last 24 hours
|
|||
numberOfPaymentAttemptsLastYear | integer (3) | no | read close |
close
DescriptionNumber of payment attempts (so including unsuccessful ones) made by this customer with you in the last 12 months
|
|||
numberOfPurchasesLast6Months | integer (4) | no | read close |
close
DescriptionNumber of successful purchases made by this customer with you in the last 6 months
|
|||
accountType | string | no | read close |
close
DescriptionType of the customer account that is used to place this order. Can have one of the following values:
|
|||
object | depends | read close | |
additionalInfo | string (50) | no | read close |
close
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | depends | read close |
close
DescriptionHouse number. The houseNumber is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
state | string (35) | no depends no no depends | read close |
close
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | depends depends no depends depends | read close |
close
DescriptionStreetname
|
|||
zip | string | depends depends no depends depends | read close |
close
DescriptionZip code
Note: For payments with product 1503 the maximum length is not 10 but 8. |
|||
object | depends depends no no depends | read close | |
dateOfIncorporation | string (8) | no depends no no depends | read close |
close
DescriptionThe date of incorporation is the specific date when the company was registered with the relevant authority.
Format: YYYYMMDD |
|||
name | string (40) | depends depends no no no | read close |
close
DescriptionName of company, as a customer
|
|||
vatNumber | string (17) | depends | read close |
close
DescriptionLocal VAT number of the company
|
|||
object | depends depends no depends yes | read close | |
close
DescriptionObject containing contact details like email address and phone number
|
|||
emailAddress | string (70) | depends depends no depends depends | read close |
close
DescriptionEmail address of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
emailMessageType | string | no | read close |
close
DescriptionPreference for the type of email message markup
|
|||
faxNumber | string (20) | no | read close |
close
DescriptionFax number of the customer
|
|||
mobilePhoneNumber | string (20) | depends depends no depends depends | read close |
close
DescriptionInternational version of the mobile phone number of the customer including the leading + (i.e. +16127779311).
|
|||
phoneNumber | string (20) | depends depends no depends depends | read close |
close
DescriptionPhone number of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
workPhoneNumber | string (20) | no depends no depends no | read close |
close
DescriptionInternational version of the work phone number of the customer including the leading + (i.e. +31235671500)
|
|||
object | depends depends no no depends | read close | |
close
DescriptionObject containing information on the device and browser of the customer
|
|||
acceptHeader | string (2048) | depends | read close |
close
DescriptionThe accept-header of the customer client from the HTTP Headers.
|
|||
object | depends depends no no no | read close | |
close
DescriptionObject containing information regarding the browser of the customer
|
|||
colorDepth | integer (2) | depends | read close |
close
DescriptionColorDepth in bits. Value is returned from the screen.colorDepth property.
If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". |
|||
innerHeight | string (6) | no | read close |
close
DescriptionThe innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
|
|||
innerWidth | string (6) | no | read close |
close
DescriptionThe innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
|
|||
javaEnabled | boolean | depends | read close |
close
Descriptiontrue =Java is enabled in the browser
false = Java is not enabled in the browser Value is returned from the navigator.javaEnabled property. If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". |
|||
javaScriptEnabled | boolean | depends | read close |
close
Descriptiontrue = JavaScript is enabled in the browser
false = JavaScript is not enabled in the browser Note: Required in future 3-D Secure version 2.2. |
|||
screenHeight | string (6) | depends | read close |
close
DescriptionHeight of the screen in pixels. Value is returned from the screen.height property.
If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". |
|||
screenWidth | string (6) | depends | read close |
close
DescriptionWidth of the screen in pixels. Value is returned from the screen.width property.
If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser". |
|||
defaultFormFill | string | no | read close |
close
DescriptionDegree of default form fill, with the following possible values:
|
|||
deviceFingerprintTransactionId | string | no | read close |
close
DescriptionOne must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
|
|||
ipAddress | string (45) | depends depends depends depends depends | read close |
close
DescriptionThe IP address of the customer client from the HTTP Headers.
|
|||
locale | string (8) | depends depends depends depends no | read close |
close
DescriptionLocale of the client device/browser. Returned in the browser from the navigator.language property.
If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. |
|||
timezoneOffsetUtcMinutes | string (6) | depends depends depends depends no | read close |
close
DescriptionOffset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method.
If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available. |
|||
userAgent | string (2048) | depends depends depends depends depends | read close |
close
DescriptionUser-Agent of the client device/browser from the HTTP Headers.
As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different. |
|||
fiscalNumber | string (14) | depends | read close |
close
DescriptionThe fiscal registration number of the customer or the tax registration number of the company in case of a business customer. Please find below specifics per country:
|
|||
isCompany | boolean | no | read close |
close
DescriptionIndicates if the payer is a company or an individual
|
|||
isPreviousCustomer | boolean | no | read close |
close
DescriptionSpecifies if the customer has a history of online shopping with the merchant
|
|||
locale | string (6) | depends | read close |
close
DescriptionThe locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided.
|
|||
merchantCustomerId | string (15) | depends | read close |
close
DescriptionYour identifier for the customer. It can be used as a search criteria in the GlobalCollect Payment Console and is also included in the GlobalCollect report files. It is used in the fraud-screening process for payments on the Ogone Payment Platform.
|
|||
object | depends depends no depends depends | read close | |
close
DescriptionObject containing personal information like name, date of birth and gender.
|
|||
dateOfBirth | string (8) | no depends no depends depends | read close |
close
DescriptionThe date of birth of the customer
Format: YYYYMMDD |
|||
gender | string | no | read close |
close
DescriptionThe gender of the customer, possible values are:
|
|||
object | depends | read close | |
close
DescriptionObject containing identification documents information
|
|||
idIssuingCountryCode | string (2) | yes | read close |
close
DescriptionISO 3166-1 alpha-2 country code of the country that issued the identification document
|
|||
idType | string | yes | read close |
close
DescriptionIndicates the type of identification
|
|||
idValue | string (70) | yes | read close |
close
DescriptionThe value of the identification
|
|||
object | depends depends no depends depends | read close | |
firstName | string (15) | depends depends no depends depends | read close |
close
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
close
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surnamePrefix | string (15) | no | read close |
close
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
title | string (35) | depends | read close |
close
DescriptionTitle of customer
|
|||
object | no | read close | |
close
Deprecated:
Use order.shipping.address instead
DescriptionObject containing shipping address details
|
|||
additionalInfo | string (50) | no | read close |
close
Deprecated
DescriptionAdditional address information
|
|||
city | string | no depends no no depends | read close |
close
Deprecated
DescriptionCity
|
|||
countryCode | string (2) | no depends no no depends | read close |
close
Deprecated
DescriptionISO 3166-1 alpha-2 country code
|
|||
houseNumber | string (15) | no | read close |
close
Deprecated
DescriptionHouse number
|
|||
object | no depends no no depends | read close | |
firstName | string (15) | depends depends no depends depends | read close |
close
Deprecated
DescriptionGiven name(s) or first name(s) of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surname | string (70) | depends depends depends depends depends | read close |
close
Deprecated
DescriptionSurname(s) or last name(s) of the customer. The surname is truncated after 25 characters, with the limit being applied after surnamePrefix is prepended, for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
surnamePrefix | string (15) | no | read close |
close
Deprecated
DescriptionMiddle name - In between first name and surname - of the customer. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
title | string (35) | depends | read close |
close
Deprecated
DescriptionTitle of customer
|
|||
state | string (35) | no depends no no depends | read close |
close
Deprecated
DescriptionFull name of the state or province
|
|||
stateCode | string | depends | read close |
close
Deprecated
DescriptionISO 3166-2 alpha-3 state code
Notes:
|
|||
street | string (50) | no depends no depends depends | read close |
close
Deprecated
DescriptionStreetname
|
|||
zip | string | no depends no depends depends | read close |
close
Deprecated
DescriptionZip code
|
|||
vatNumber | string (17) | no | read close |
close
Deprecated:
Use companyInformation.vatNumber instead
DescriptionLocal VAT number of the company
|
|||
array of object | no | read close | |
close
Deprecated:
Use shoppingCart.items instead
DescriptionShopping cart data
|
|||
object | no | read close | |
object | no depends depends depends yes | read close | |
close
Deprecated
DescriptionObject containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
|
|||
amount | integer (12) | yes | read close |
close
Deprecated
DescriptionAmount in cents and always having 2 decimals
|
|||
currencyCode | string (3) | yes | read close |
close
Deprecated
DescriptionThree-letter ISO currency code representing the currency for the amount
|
|||
object | no depends depends depends yes | read close | |
close
Deprecated
DescriptionObject containing the line items of the invoice or shopping cart. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
description | string (116) | depends | read close |
close
Deprecated
DescriptionShopping cart item description
|
|||
merchantLinenumber | string (5) | no | read close |
close
Deprecated
DescriptionLine number for printed invoice or order of items in the cart
Should be a numeric string |
|||
merchantPagenumber | string (3) | no | read close |
close
Deprecated
DescriptionPage number for printed invoice
Should be a numeric string |
|||
nrOfItems | string (4) | depends | read close |
close
Deprecated
DescriptionQuantity of the item
|
|||
pricePerItem | integer (12) | depends | read close |
close
Deprecated
DescriptionPrice per item
|
|||
object | no | read close | |
close
Deprecated:
Use orderLineDetails instead
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated
DescriptionDiscount on the line item, with the last two digits are implied decimal places
|
|||
lineAmountTotal | integer (12) | no | read close |
close
Deprecated
DescriptionTotal amount for the line item
|
|||
productCode | string (12) | no | read close |
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
productPrice | integer (12) | no | read close |
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
productType | string (12) | no | read close |
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
quantity | integer (4) | no | read close |
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
taxAmount | integer (12) | no | read close |
close
Deprecated
DescriptionTax on the line item, with the last two digits are implied decimal places
|
|||
unit | string (12) | no | read close |
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
object | no depends no depends yes | read close | |
close
Deprecated
DescriptionObject containing additional information that when supplied can have a beneficial effect on the discountrates
|
|||
discountAmount | integer (12) | no | read close |
close
Deprecated
DescriptionDiscount on the line item, with the last two digits implied as decimal places
|
|||
googleProductCategoryId | integer (10) | no | read close |
close
Deprecated
DescriptionThe Google product category ID for the item.
|
|||
lineAmountTotal | integer (12) | depends | read close |
close
Deprecated
DescriptionTotal amount for the line item
|
|||
naicsCommodityCode | string (6) | no | read close |
close
Deprecated
DescriptionThe UNSPC commodity code of the item.
|
|||
productCategory | string (50) | no | read close |
close
Deprecated
DescriptionThe category of the product (i.e. home appliance). This property can be used for fraud screening on the Ogone Platform.
|
|||
productCode | string (12) | yes depends depends depends yes | read close |
close
Deprecated
DescriptionProduct or UPC Code, left justified
Note: Must not be all spaces or all zeros |
|||
productName | string (120) | no depends no depends yes | read close |
close
Deprecated
DescriptionThe name of the product. The '+' character is not allowed in this property for transactions that are processed by TechProcess Payment Platform.
|
|||
productPrice | integer (12) | yes depends depends depends depends | read close |
close
Deprecated
DescriptionThe price of one unit of the product, the value should be zero or greater
|
|||
productSku | string (12) | no | read close |
close
Deprecated
DescriptionProduct SKU number
|
|||
productType | string (12) | depends | read close |
close
Deprecated
DescriptionCode used to classify items that are purchased
Note: Must not be all spaces or all zeros |
|||
quantity | integer (4) | yes depends depends depends depends | read close |
close
Deprecated
DescriptionQuantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros |
|||
taxAmount | integer (12) | no | read close |
close
Deprecated
DescriptionTax on the line item, with the last two digits implied as decimal places
|
|||
unit | string (12) | no | read close |
close
Deprecated
DescriptionIndicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
|
|||
object | depends | read close | |
close
DescriptionObject that holds all reference properties that are linked to this transaction
|
|||
descriptor | string (256) | no | read close |
close
DescriptionDescriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
For alternative payment products the maximum allowed length varies per payment product:
|
|||
object | no | read close | |
additionalData | string (500) | no | read close |
close
DescriptionAdditional data for printed invoices
|
|||
invoiceDate | string (14) | no | read close |
close
DescriptionDate and time on invoice
Format: YYYYMMDDHH24MISS |
|||
invoiceNumber | string (20) | no | read close |
close
DescriptionYour invoice number (on printed invoice) that is also returned in our report files
|
|||
textQualifiers | array | no | read close |
close
DescriptionArray of 3 text qualifiers, each with a max length of 10 characters
|
|||
merchantOrderId | integer (10) | no | read close |
close
DescriptionYour order identifier
Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system. |
|||
merchantReference | string | no depends no depends yes | read close |
close
DescriptionNote that the maximum length of this field for transactions processed on the GlobalCollect platform is 30. Note that the maximum length of this field for transactions processed on the WL Online Payment Acceptance Platform platform is 50. Your unique reference of the transaction that is also returned in our report files. This is almost always used for your reconciliation of our report files. |
|||
providerId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation for Gateway merchants
|
|||
providerMerchantId | string | no | read close |
close
DescriptionProvides an additional means of reconciliation, this is the MerchantId used at the provider
|
|||
object | no | read close | |
close
Deprecated:
Use merchant.seller instead
DescriptionObject containing seller details
|
|||
object | no | read close | |
additionalInfo | string (50) | no | read close |
close
Deprecated
DescriptionAdditional address information. The additionalInfo is truncated after 10 characters for payments, refunds or payouts that are processed by the WL Online Payment Acceptance platform
|
|||
city | string | depends depends no depends depends | read close |
close
Deprecated
DescriptionCity
Note: For payments with product 1503 the maximum length is not 40 but 20. |
|||
countryCode | string (2) | no depends no yes yes | read clo |