Server API version 1.0
Node.js

icon-search-large

Create hosted checkout

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

Hosted Checkouts

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

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

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

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

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

Request

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

The hosted checkout allows the use of three distinct components:

  1. Presenting a (filtered) list of payment products that the consumer can choose from;
  2. Handling of the actual payment, potentially involving data capture, redirection and/or the displaying of payment instructions;
  3. 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
cardPaymentMethodSpecificInput object no read close
close

Description

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

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

Deprecated for Hosted Checkouts: This property is deprecated for the hosted checkout flow. Use hostedCheckoutSpecificInput.paymentProductFilters instead.
Payment product identifier
Please see payment products for a full overview of possible values.
close

Description

Object containing data related to recurring
  • SDK Object type
    CardRecurrenceDetails
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
Deprecated: Use recurring.recurringPaymentSequenceIndicator instead.

Description

  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions
Note: This property will default to first when isRecurring is set to true.
Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
close

Description

Deprecated: This flag is deprecated for the Ogone payment platform. Use CardPaymentMethodSpecificInput.authorizationMode instead. Value 'true' of this property is mapped to authorizationMode FINAL_AUTHORIZATION and value 'false' is mapped to authorizationMode SALE.
  • true = the payment requires approval before the funds will be captured
  • false = the payment does not require approval, and the funds will be captured automatically
If true, payments with status PENDING_APPROVAL can be captured with the Approve payment API and payments with the status PENDING_CAPTURE can be captured using the Capture payment API
close
Deprecated: Use threeDSecureBase.skipAuthentication instead.

Description

  • true = 3D Secure authentication will be skipped for this transaction. This setting should be used when isRecurring is set to true and recurringPaymentSequenceIndicator is set to recurring.
  • false = 3D Secure authentication will not be skipped for this transaction.
Note: This is only possible if your account in our system is setup for 3D Secure authentication and if your configuration in our system allows you to override it per transaction.
close

Description

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

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

ID of the token that holds previously stored card data
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

Description

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

Notes:
  • This property is not allowed if isRecurring is true.
  • When a customer has chosen to use a token on a hosted checkout this property is set to "cardholderInitiated".
close

Description

  • first = This transaction is the first of a series of unscheduled recurring transactions
  • subsequent = This transaction is a subsequent transaction in a series of unscheduled recurring transactions

Notes:
  • This property is not allowed if isRecurring is true.
  • On a hosted checkout this property is set to "first" if the customer asks to remember the payment details and to "subsequent" in all other cases.
fraudFields object no read close
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
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
close
Deprecated

Description

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

Description

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

Description

Object containing hosted checkout specific data
  • SDK Object type
    HostedCheckoutSpecificInput
close

Description

  • true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence.
  • false - Only payment products that support one-off payments will be shown.
The default value for this property is false.
close

Description

Locale to use to present the MyCheckout payment pages to the customer. Please make sure that a language pack is configured for the locale you are submitting. If you submit a locale that is not setup on your account we will use the default language pack for your account. You can easily upload additional language packs and set the default language pack in the Configuration Center.
close

Description

Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the customer.
  • SDK Object type
    PaymentProductFiltersHostedCheckout
close

Description

Contains the payment product ids and payment product groups that should be excluded from the payment products available for the payment. Note that excluding a payment product will ensure exclusion, even if the payment product is also present in the restrictTo filter, and that excluding a payment product group will exclude all payment products that are a part of that group, even if one or more of them are present in the restrictTo filters.
  • SDK Object type
    PaymentProductFilter
close

Description

List containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called 'cards'.
close

Description

List containing all payment product ids that should either be restricted to in or excluded from the payment context.
close

Description

Contains the payment product ids and payment product groups that should be at most contained in the payment products available for completing the payment. Note that the list of payment products available for completing the payment will only contain payment products present in these filters, but not all payment products in these filters might be present in the list. Some of them might not be allowed in context or they might be present in the exclude filters.
  • SDK Object type
    PaymentProductFilter
close

Description

List containing all payment product groups that should either be restricted to in or excluded from the payment context. Currently, there is only one group, called 'cards'.
close

Description

List containing all payment product ids that should either be restricted to in or excluded from the payment context.
close

Description

  • true - The customer may only complete the payment using one of the provided accounts on file.
  • false -The customer can complete the payment using any way they like, as long as it is allowed in the payment context. Default.
Note that the request must contain at least one valid account on file with an allowed payment product (not excluded and allowed in context) if this property is set to true, else the request will fail.
close

Description

This flag affects the status of a Hosted Checkout when a customer presses the cancel button and is returned to you as a result.
If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS.
The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change.
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

  • true - MyCheckout will show a result page to the customer when applicable. Default.
  • false - MyCheckout will redirect the customer back to the provided returnUrl when this is possible.
The default value for this property is true.
close

Description

String containing comma separated tokens (no spaces) associated with the customer of this hosted checkout. Valid tokens will be used to present the customer the option to re-use previously used payment details. This means the customer for instance does not have to re-enter their card details again, which a big plus when the customer is using their mobile phone to complete the checkout.
close

Description

By default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off, 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.
close

Description

Using the Configuration Center it is possible to create multiple variations of your MyCheckout payment pages. By specifying a specific variant you can force the use of another variant then the default. This allows you to test out the effect of certain changes to your MyCheckout payment pages in a controlled manner. Please note that you need to specify the ID of the variant.
close

Description

Additional address information
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
close

Description

Full name of the state or province
close

Description

Streetname
close

Description

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

Description

Order object containing order related data
  • SDK Object type
    Order
close

Description

Object containing additional input on the order
  • SDK Object type
    AdditionalOrderInput
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

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

Name of passenger
close

Description

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

Description

First name of the passenger (this property is used for fraud screening)
close

Description

Surname of the passenger (this property is used for fraud screening)
close

Description

Surname prefix of the passenger (this property is used for fraud screening)
close

Description

Title of the passenger (this property is used for fraud screening)
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 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
close

Description

Amount in cents and always having 2 decimals
close

Description

Three-letter ISO currency code representing the currency for the amount
close
  • SDK Object type
    LodgingCharge
close
  • SDK Object type
    LodgingRoom
close

Description

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

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

Authentication used by the customer on your website
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
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

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

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

Description

Full name of the state or province
close

Description

Streetname
close

Description

Zip code
Note: For payments with product 1503 the maximum length is not 10 but 8.
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
close

Description

Name of company, as a customer
close

Description

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

Description

Email address of the customer
close

Description

International version of the mobile phone number of the customer including the leading + (i.e. +16127779311).
close

Description

Phone number of the customer
close

Description

International version of the work phone number of the customer including the leading + (i.e. +31235671500)
close

Description

Object containing information on the device and browser of the customer
  • SDK Object type
    CustomerDevice
close

Description

The accept-header of the customer client from the HTTP Headers.
close

Description

Object containing information regarding the browser of the customer
  • SDK Object type
    BrowserData
close

Description

ColorDepth in bits. Value is returned from the screen.colorDepth property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

The innerHeight of the frame in case you are capturing your payments in a frame. We will use this to validate if the height provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
close

Description

The innerWidth of the frame in case you are capturing your payments in a frame. We will use this to validate if the width provided in the cardPaymentMethodSpecifInput.threeDSecure.challengeCanvasSize will actually fit in the iFrame you use.
close

Description

true =Java is enabled in the browser

false = Java is not enabled in the browser

Value is returned from the navigator.javaEnabled property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

true = JavaScript is enabled in the browser

false = JavaScript is not enabled in the browser

Note: Required in future 3-D Secure version 2.2.

close

Description

Height of the screen in pixels. Value is returned from the screen.height property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

Width of the screen in pixels. Value is returned from the screen.width property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

Note: This data can only be collected if JavaScript is enabled in the browser. This means that 3-D Secure version 2.1 requires the use of JavaScript to enabled. In the upcoming version 2.2 of the specification this is no longer a requirement. As we currently support version 2.1 it means that this property is required when cardPaymentMethodSpecifInput.threeDSecure.authenticationFlow is set to "browser".

close

Description

Locale of the client device/browser. Returned in the browser from the navigator.language property.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

close

Description

Offset in minutes of timezone of the client versus the UTC. Value is returned by the JavaScript getTimezoneOffset() Method.

If you use the latest version of our JavaScript Client SDK, we will collect this data and include it in the encryptedCustomerInput property. We will then automatically populate this data if available.

close

Description

User-Agent of the client device/browser from the HTTP Headers.

As a fall-back we will use the userAgent that might be included in the encryptedCustomerInput, but this is captured client side using JavaScript and might be different.

close

Description

Fiscal registration number of the customer or the tax registration number of the company for a business customer. Please find below specifics per country:
  • Brazil - Consumer (CPF) with a length of 11 digits
  • Brazil - Company (CNPJ) with a length of 14 digits
  • Denmark - Consumer (CPR-nummer or personnummer) with a length of 10 digits
  • Finland - Consumer (Finnish: henkilötunnus (abbreviated as HETU), Swedish: personbeteckning) with a length of 11 characters
  • Norway - Consumer (fødselsnummer) with a length of 11 digits
  • Sweden - Consumer (personnummer) with a length of 10 or 12 digits
close

Description

The locale that the customer should be addressed in (for 3rd parties). Note that some 3rd party providers only support the languageCode part of the locale, in those cases we will only use part of the locale provided.
close

Description

Your identifier for the customer. It is used in the fraud-screening process.
close

Description

Object containing personal information like name, date of birth and gender.
  • SDK Object type
    PersonalInformation
close

Description

The date of birth of the customer
Format: YYYYMMDD
close

Description

Object containing the name details of the customer
  • SDK Object type
    PersonalName
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

Middle name - In between first name and surname - of the customer
close

Description

Title of customer
close
Deprecated: Use order.shipping.address instead

Description

Object containing shipping address details
  • SDK Object type
    AddressPersonal
close
Deprecated

Description

Additional address information
close
Deprecated

Description

City
close
Deprecated

Description

ISO 3166-1 alpha-2 country code
close
Deprecated

Description

House number
close
Deprecated

Description

Object that holds the name elements
  • SDK Object type
    PersonalName
close
Deprecated

Description

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

Description

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

Description

Middle name - In between first name and surname - of the customer
close
Deprecated

Description

Title of customer
close
Deprecated

Description

Full name of the state or province
close
Deprecated

Description

Streetname
close
Deprecated

Description

Zip code
close
Deprecated
  • SDK Object type
    LineItem
close
Deprecated

Description

Object containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
  • SDK Object type
    AmountOfMoney
close
Deprecated

Description

Amount in cents and always having 2 decimals
close
Deprecated

Description

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

Description

Object containing the line items of the invoice or shopping cart
  • SDK Object type
    LineItemInvoiceData
close
Deprecated

Description

Shopping cart item description
close
Deprecated

Description

Line number for printed invoice or order of items in the cart
Should be a numeric string
close
Deprecated

Description

Page number for printed invoice
Should be a numeric string
close
Deprecated

Description

Quantity of the item
close
Deprecated

Description

Price per item
close
Deprecated

Description

Discount on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Total amount for the line item
close
Deprecated

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close
Deprecated

Description

The price of one unit of the product, the value should be zero or greater
close
Deprecated

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Tax on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close
Deprecated

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    OrderLineDetails
close
Deprecated

Description

Discount on the line item, with the last two digits implied as decimal places
close
Deprecated

Description

Total amount for the line item
close
Deprecated

Description

The category of the product (i.e. home appliance). This property can be used for fraud screening.
close
Deprecated

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close
Deprecated

Description

The name of the product.
close
Deprecated

Description

The price of one unit of the product, the value should be zero or greater
close
Deprecated

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Tax on the line item, with the last two digits implied as decimal places
close
Deprecated

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close

Description

Object that holds all reference properties that are linked to this transaction
  • SDK Object type
    OrderReferences
close

Description

Descriptive text that is used towards to customer, either during an online checkout at a third party and/or on the statement of the customer. For card transactions this is usually referred to as a Soft Descriptor. The maximum allowed length varies per card acquirer:
  • AIB - 22 characters
  • American Express - 25 characters
  • Atos Origin BNP - 15 characters
  • Barclays - 25 characters
  • Catella - 22 characters
  • CBA - 20 characters
  • Elavon - 25 characters
  • First Data - 25 characters
  • INICIS (INIPAY) - 22-30 characters
  • JCB - 25 characters
  • Merchant Solutions - 22-25 characters
  • Payvision (EU & HK) - 25 characters
  • SEB Euroline - 22 characters
  • Sub1 Argentina - 15 characters
  • Wells Fargo - 25 characters
Note that we advise you to use 22 characters as the max length as beyond this our experience is that issuers will start to truncate. We currently also only allow per API call overrides for AIB and Barclays
For alternative payment products the maximum allowed length varies per payment product:
  • 402 e-Przelewy - 30 characters
  • 404 INICIS - 80 characters
  • 802 Nordea ePayment Finland - 234 characters
  • 809 iDeal - 32 characters
  • 836 SOFORT - 42 characters
  • 840 PayPal - 127 characters
  • 841 WebMoney - 175 characters
  • 849 Yandex - 64 characters
  • 861 Alipay - 256 characters
  • 863 WeChat Pay - 32 characters
  • 880 BOKU - 20 characters
  • 8580 Qiwi - 255 characters
  • 1504 Konbini - 80 characters
All other payment products don't support a descriptor.
close

Description

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

Description

Additional address information
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
close
Deprecated

Description

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

Object containing information regarding shipping / delivery
  • SDK Object type
    Shipping
close

Description

Object containing address information
  • SDK Object type
    AddressPersonal
close

Description

Additional address information
close

Description

City
close

Description

ISO 3166-1 alpha-2 country code
close

Description

House number
close

Description

Object that holds the name elements
  • SDK Object type
    PersonalName
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

Middle name - In between first name and surname - of the customer
close

Description

Title of customer
close

Description

Full name of the state or province
close

Description

Streetname
close

Description

Zip code
close

Description

Indicates shipping method chosen for the transaction. Possible values:
  • same-as-billing = the shipping address is the same as the billing address
  • another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
  • different-than-billing = shipping address is different from the billing address
  • ship-to-store = goods are shipped to a store (shipping address = store address)
  • digital-goods = electronic delivery of digital goods
  • travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
  • other = other means of delivery
close

Description

Email address linked to the shipping
close

Description

Date (YYYYMMDD) when the shipping details for this transaction were first used.
close

Description

Indicator if this shipping address is used for the first time to ship an order

true = the shipping details are used for the first time with this transaction

false = the shipping details have been used for other transactions in the past

close

Description

Indicates the merchandise delivery timeframe. Possible values:
  • electronic = For electronic delivery (services or digital goods
  • same-day = For same day deliveries
  • overnight = For overnight deliveries
  • 2-day-or-more = For two day or more delivery time
close

Description

Shopping cart data, including items and specific amounts.
  • SDK Object type
    ShoppingCart
close

Description

Determines the type of the amount.
close
  • SDK Object type
    AmountBreakdown
close

Description

Amount in cents and always having 2 decimals
close

Description

Type of the amount. Each type is only allowed to be provided once. Allowed values:
  • AIRPORT_TAX - The amount of tax paid for the airport, with the last 2 digits implied as decimal places.
  • CONSUMPTION_TAX - The amount of consumption tax paid by the customer, with the last 2 digits implied as decimal places.
  • DISCOUNT - Discount on the entire transaction, with the last 2 digits implied as decimal places.
  • DUTY - Duty on the entire transaction, with the last 2 digits implied as decimal places.
  • HANDLING - Handling cost on the entire transaction, with the last 2 digits implied as decimal places.
  • SHIPPING - Shipping cost on the entire transaction, with the last 2 digits implied as decimal places.
  • TAX - Total tax paid on the entire transaction, with the last 2 digits implied as decimal places.
  • VAT - Total amount of VAT paid on the transaction, with the last 2 digits implied as decimal places.
  • BASE_AMOUNT - Order amount excluding all taxes, discount & shipping costs, with the last 2 digits implied as decimal places.
close

Description

Object containing information on purchased gift card(s)
  • SDK Object type
    GiftCardPurchase
close

Description

Object containing information on an amount of money
  • 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

Number of gift cards that are purchased through this transaction
close

Description

Shopping cart data
close
  • SDK Object type
    LineItem
close

Description

Object containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item
  • 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 line items of the invoice or shopping cart
  • SDK Object type
    LineItemInvoiceData
close

Description

Shopping cart item description
close

Description

Line number for printed invoice or order of items in the cart
Should be a numeric string
close

Description

Page number for printed invoice
Should be a numeric string
close

Description

Quantity of the item
close

Description

Price per item
close
Deprecated

Description

Discount on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Total amount for the line item
close
Deprecated

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close
Deprecated

Description

The price of one unit of the product, the value should be zero or greater
close
Deprecated

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close
Deprecated

Description

Tax on the line item, with the last two digits are implied decimal places
close
Deprecated

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
close

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    OrderLineDetails
close

Description

Discount on the line item, with the last two digits implied as decimal places
close

Description

Total amount for the line item
close

Description

The category of the product (i.e. home appliance). This property can be used for fraud screening.
close

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
close

Description

The name of the product.
close

Description

The price of one unit of the product, the value should be zero or greater
close

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
close

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
close

Description

Tax on the line item, with the last two digits implied as decimal places
close

Description

Indicates the line item unit of measure; for example: each, kit, pair, gallon, month, etc.
redirectPaymentMethodSpecificInput object no read close
close

Description

Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
  • SDK Object type
    RedirectPaymentMethodSpecificInputBase
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

Object containing specific input required for PayPal payments (Payment product ID 840)
  • SDK Object type
    RedirectPaymentProduct840SpecificInputBase
close

Description

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

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: Will default to first when isRecurring is set to true, with the following exception that it is set to recurring when the customer is making the payment using a PayPal token.
Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
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
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

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
    CreateMandateBase
  • Property is part of a group
    Learn more

    Properties that make up a group are mutually exclusive, which means you can only include one of each group in any given call.

    If there are multiple groups at one level in the object hierarchy we use numbers to distinguish groups from one another.

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

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

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

Description

The unique identifier of the mandate. If you do not provide one, we will generate one for you.
close

Description

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

Request example

SDK: Node.js

This scenario you will probably use the most

  • var body = {
        "order" : {
            "amountOfMoney" : {
                "currencyCode" : "USD",
                "amount" : 2345
            },
            "customer" : {
                "merchantCustomerId" : "1234",
                "billingAddress" : {
                    "countryCode" : "US"
                }
            }
        },
        "hostedCheckoutSpecificInput" : {
            "variant" : "testVariant",
            "locale" : "en_GB"
        }
    };
    connectSdk.hostedcheckouts.create("merchantId", body, null, function (error, sdkResponse) {
      // if sdkResponse is not null, it has the following properties:
      // - status: the HTTP status code
      // - body: the response body
      // - isSuccess: true if the call was successful,
      //              or false if the Ingenico ePayments platform returned an error response
    });
    
  • var body = {
        "order" : {
            "amountOfMoney" : {
                "currencyCode" : "EUR",
                "amount" : 2345
            },
            "customer" : {
                "billingAddress" : {
                    "countryCode" : "NL"
                },
                "merchantCustomerId" : "YOURCUSTOMERID"
            }
        },
        "hostedCheckoutSpecificInput" : {
            "variant" : "100",
            "locale" : "nl_NL"
        }
    };
    connectSdk.hostedcheckouts.create("merchantId", body, null, function (error, sdkResponse) {
      // if sdkResponse is not null, it has the following properties:
      // - status: the HTTP status code
      // - body: the response body
      // - isSuccess: true if the call was successful,
      //              or false if the Ingenico ePayments platform returned an error response
    });
    
  • var body = {
        "order" : {
            "amountOfMoney" : {
                "currencyCode" : "USD",
                "amount" : 100
            },
            "customer" : {
                "billingAddress" : {
                    "countryCode" : "US"
                },
                "merchantCustomerId" : "YOURCUSTOMERID"
            }
        },
        "hostedCheckoutSpecificInput" : {
            "variant" : "100",
            "locale" : "en_US"
        }
    };
    connectSdk.hostedcheckouts.create("merchantId", body, null, function (error, sdkResponse) {
      // if sdkResponse is not null, it has the following properties:
      // - status: the HTTP status code
      // - body: the response body
      // - isSuccess: true if the call was successful,
      //              or false if the Ingenico ePayments platform returned an error response
    });
    
  • var body = {
        "order" : {
            "amountOfMoney" : {
                "currencyCode" : "USD",
                "amount" : 2345
            },
            "customer" : {
                "billingAddress" : {
                    "countryCode" : "US"
                },
                "merchantCustomerId" : "YOURCUSTOMERID"
            }
        },
        "hostedCheckoutSpecificInput" : {
            "variant" : "100",
            "locale" : "en_GB",
            "returnUrl" : "http://www.google.com"
        }
    };
    connectSdk.hostedcheckouts.create("merchantId", body, null, function (error, sdkResponse) {
      // if sdkResponse is not null, it has the following properties:
      // - status: the HTTP status code
      // - body: the response body
      // - isSuccess: true if the call was successful,
      //              or false if the Ingenico ePayments platform returned an error response
    });
    

Responses

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

Response 201 - CreatedCreateHostedCheckoutResponse

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

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

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

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

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

Properties
Property Type Required Details
RETURNMAC string no read close
close

Description

When the customer is returned to your site we will append this property and value to the query-string. You should store this data, so you can identify the returning customer.
hostedCheckoutId string no read close
close

Description

This is the ID under which the data for this checkout can be retrieved.
invalidTokens array no read close
close

Description

Tokens that are submitted in the request are validated. In case any of the tokens can't be used anymore they are returned in this array. You should most likely remove those tokens from your system.
merchantReference string no read close
close

Description

If a payment is created during this hosted checkout, then it will use this merchantReference. This is the merchantReference you provided in the Create Hosted Checkout request, or if you did not provide one, a reference generated by Connect. This allows you to to link a webhook related to the created payment back to this hosted checkout using the webhook's paymentOutput.references.merchantReference..
partialRedirectUrl string no read close
close

Description

The partial URL as generated by our system. You will need to add the protocol and the relevant subdomain to this URL, before redirecting your customer to this URL. A special 'payment' subdomain will always work so you can always add 'https://payment.' at the beginning of this response value to view your MyCheckout hosted payment pages.

Response example

SDK: Node.js

This scenario you will probably use the most

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

Response 400 - Bad requestErrorResponse

Properties
Property Type Required Details
errorId string yes read close
close

Description

Unique reference, for debugging purposes, of this error response
errors array of object yes read close
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the E-Payment platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the E-Payment platform or between E-Payment and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.

Response example

SDK: Node.js

This scenario you will probably use the most

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