API Reference

Server API version 1.0
Java

Results for

icon-search-large No search results yet
Enter your search query above

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 field of hostedCheckoutSpecificInput.

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

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

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

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

PayloadCreateHostedCheckoutRequest

Property Type Required Details
bankTransferPaymentMethodSpecificInput object no read close
close

Description

Object containing the specific input details for bank transfer payments
  • SDK Object type
    BankTransferPaymentMethodSpecificInputBase
additionalReference string (20) no read close
close

Description

Your additional reference identifier for this transaction. Data supplied in this field will also be returned in our report files, allowing you to reconcile the incoming funds.
paymentProductId integer (5) no read close
close

Description

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

Description

Object containing the specific input details for card payments
  • SDK Object type
    CardPaymentMethodSpecificInputBase
authorizationMode enum no read close
close

Description

Determines the type of the authorization that will be used. Allowed values:
  • FINAL_AUTHORIZATION - The payment creation results in an authorization that is ready for capture. Final authorizations can't be reversed and need to be captured for the full amount within 7 days.
  • PRE_AUTHORIZATION - The payment creation results in a pre-authorization that is ready for capture. Pre-authortizations can be reversed and can be captured within 30 days. The capture amount can be lower than the authorized amount.
  • SALE - The payment creation results in an authorization that is already captured at the moment of approval.
Only used with some acquirers, ingnored for acquirers that don't support this. In case the acquirer doesn't allow this to be specified the authorizationMode is 'unspecified', which behaves similar to a final authorization.
customerReference string no read close
close

Description

Reference of the consumer for the payment (purchase order #, etc.) Only used with some acquirers.
paymentProductId integer (5) no read close
close

Description

Deprecated for Hosted Checkouts: This field 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.
recurringPaymentSequenceIndicator string no read close
close

Description

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

Description

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

Description

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

Description

  • true = Fraud scoring will be skipped for this transaction
  • false = Fraud scoring will not be skipped for this transaction
Note: This is only possible if your account in our system is setup for Fraud scoring and if your configuration in our system allows you to override it per transaction.
token string (40) no read close
close

Description

ID of the token that holds previously stored card data
tokenize boolean no read close
close

Description

Indicates if this transaction should be tokenized
  • true - Tokenize the transaction. Note that a payment on the GlobalCollect platform that results in a status REDIRECTED cannot be tokenized in this way. In this case, use the 'Create a token from payment' functionality after your customer succesfully completes the redirection.
  • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
transactionChannel enum depends read close
close

Description

Indicates the channel via which the payment is created. Allowed values:
  • ECOMMERCE - The transaction is a regular E-Commerce transaction.
  • MOTO - The transaction is a Mail Order/Telephone Order.

Depends on:

Defaults to ECOMMERCE. This field is ignored for GlobalCollect merchants.
unscheduledCardOnFileIndicator string no read close
close

Description

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

Note: this field is not allowed if isRecurring is true.
unscheduledCardOnFileRequestor string depends read close
close

Description

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

Note: this field is not allowed if isRecurring is true.

Depends on:

Required if unscheduledCardOnFileIndicator is 'subsequent'. Otherwise it must not be 'merchantInitiated'.
cashPaymentMethodSpecificInput object no read close
close

Description

Object containing the specific input details for cash payments
  • SDK Object type
    CashPaymentMethodSpecificInputBase
paymentProductId integer (5) no read close
close

Description

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

Description

Object containing the specific input details for eInvoice payments
  • SDK Object type
    EInvoicePaymentMethodSpecificInputBase
paymentProductId integer (5) no read close
close

Description

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

Description

  • true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically
fraudFields object depends read close
close

Description

Object containing additional data that will be used to assess the risk of fraud

Depends on:

This object is required for hosted checkouts with products 9000 and 9001.
  • SDK Object type
    FraudFields
addressesAreIdentical boolean no read close
close

Description

Indicates that invoice and shipping addresses are equal.
blackListData string (50) no read close
close

Description

Additional black list input
cardOwnerAddress object no read close
close

Description

The address that belongs to the owner of the card
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

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

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

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

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
customerIpAddress string (32) depends read close
close

Description

The IP Address of the consumer that is making the payment

Depends on:

This field is required for payments with products 863, 9000 and 9001, and hosted checkouts with products 9000 and 9001.
defaultFormFill string no read close
close

Description

Degree of default form fill, with the following possible values:
  • automatically - All fields filled automatically
  • automatically-but-modified - All fields filled automatically, but some fields were modified manually
  • manually - All fields were entered manually
deviceFingerprintActivated boolean no read close
close

Description

Indicates that the device fingerprint has been used while processing the order.
deviceFingerprintTransactionId string no read close
close

Description

One must set the deviceFingerprintTransactionId received by the response of the endpoint /{merchant}/products/{paymentProductId}/deviceFingerprint
giftCardType string no read close
close

Description

One of the following gift card types:
  • celebrate-fall - Celebrate Fall
  • grandparents-day - Grandparent's Day
  • independence-day - Independence Day
  • anniversary - Anniversary
  • birthday - Birthday
  • congratulations - Congratulations
  • april-fools-day - April Fool's Day
  • easter - Easter
  • fathers-day - Father's Day
  • graduation - Graduation
  • holiday - Holiday
  • seasons-greetings - Season's Greetings
  • passover - Passover
  • kwanzaa - Kwanzaa
  • halloween - Halloween
  • mothers-day - Mother's Day
  • new-years-day - New Year's Day
  • bosses-day - Bosses' Day
  • st-patricks-day - St. Patrick's Day
  • sweetest-day - Sweetest Day
  • christmas - Christmas
  • baby-shower - Baby Shower
  • thanksgiving - Thanksgiving
  • other - Other
  • valentines-day - Valentine's Day
  • wedding - Wedding
  • secretarys-day - Secretary's Day
  • chinese-new-year - Chinese New Year
  • hanukkah - Hanukkah
giftMessage string (160) no read close
close

Description

Gift message
hasForgottenPwd boolean no read close
close

Description

Specifies if the consumer (initially) had forgotten their password
  • true - The consumer has forgotten their password
  • false - The consumer has not forgotten their password
hasPassword boolean no read close
close

Description

Specifies if the consumer entered a password to gain access to an account registered with the you
  • true - The consumer has used a password to gain access
  • false - The consumer has not used a password to gain access
isPreviousCustomer boolean no read close
close

Description

Specifies if the consumer has a history of online shopping with the merchant
  • true - The consumer is a known returning consumer
  • false - The consumer is new/unknown consumer
orderTimezone string (2) no read close
close

Description

Timezone in which the order was placed
shipComments string (160) no read close
close

Description

Comments included during shipping
shipmentTrackingNumber string (19) no read close
close

Description

Shipment tracking number
shippingDetails object no read close
close

Description

Details on how the order is shipped to the customer
  • SDK Object type
    FraudFieldsShippingDetails
methodDetails string (50) no read close
close

Description

Details regarding the shipping method
methodSpeed integer no read close
close

Description

Shipping method speed indicator
methodType integer no read close
close

Description

Shipping method type indicator
userData array no read close
close

Description

Array of up to 16 userData fields, each with a max length of 256 characters, that can be used for fraudscreening
website string (60) no read close
close

Description

The website from which the purchase was made
hostedCheckoutSpecificInput object no read close
close

Description

Object containing hosted checkout specific data
  • SDK Object type
    HostedCheckoutSpecificInput
isRecurring boolean no read close
close

Description

  • true - Only payment products that support recurring payments will be shown. Any transactions created will also be tagged as being a first of a recurring sequence.
  • false - Only payment products that support one-off payments will be shown.
The default value for this field is false.
locale string (6) no read close
close

Description

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

Description

Contains the payment product ids and payment product groups that will be used for manipulating the payment products available for the payment to the consumer.
  • SDK Object type
    PaymentProductFiltersHostedCheckout
exclude object no read close
close

Description

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

Description

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

Description

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

Description

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

Description

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

Description

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

Description

  • true - The consumer may only complete the payment using one of the provided accounts on file.
  • false -The consumer 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 field is set to true, else the request will fail.
returnCancelState boolean no read close
close

Description

This flag affects the status of a Hosted Checkout when a consumer presses the cancel button and is returned to you as a result.
If set to true, then the status will be CANCELLED_BY_CONSUMER. If set to false, then the status will be IN_PROGRESS.
The default value is false. This flag was added to introduce the additional CANCELLED_BY_CONSUMER state as a non-breaking change.
returnUrl string (512) no read close
close

Description

The URL that the consumer 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 consumer 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

  • true - MyCheckout will show a result page to the consumer when applicable. Default.
  • false - MyCheckout will redirect the consumer back to the provided returnUrl when this is possible.
The default value for this field is true.
tokens string no read close
close

Description

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

Description

By default, validation is done for all the information required to display the shopping cart. Set this value to false if you would like to turn that feature off for the Ogone Payment Platform, in which case the rendering of the shopping cart will be skipped if any required information is missing. By default the value is true.
Note: This field is only supported by the Ogone Payment Platform.
variant string no read close
close

Description

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

Description

Order object containing order related data
  • SDK Object type
    Order
additionalInput object depends read close
close

Description

Object containing additional input on the order

Depends on:

Required for payments done with payment product 120 - UATP. Required for hosted checkouts where payment product 120 - UATP is allowed.
  • SDK Object type
    AdditionalOrderInput
airlineData object depends read close
close

Description

Object that holds airline specific data

Depends on:

Required for payments done with payment product 120 - UATP. Required for hosted checkouts where payment product 120 - UATP is allowed.
  • SDK Object type
    AirlineData
agentNumericCode string (8) no read close
close

Description

Numeric code identifying the agent
code string (3) yes read close
close

Description

Airline numeric code
flightDate string (8) no read close
close

Description

Date of the Flight
Format: YYYYMMDD
flightLegs array of object no read close
close

Description

Object that holds the data on the individual legs of the ticket
items object no read close
close
  • SDK Object type
    AirlineFlightLeg
airlineClass string (2) yes read close
close

Description

Reservation Booking Designator
arrivalAirport string (3) yes read close
close

Description

Arrival airport/city code
arrivalTime string (5) no read close
close

Description

The arrival time in the local time zone
Format: HH:MM
carrierCode string (2) yes read close
close

Description

IATA carrier code
conjunctionTicket string (14) no read close
close

Description

Identifying number of a ticket issued to a passenger in conjunction with this ticket and that constitutes a single contract of carriage
couponNumber string (1) no read close
close

Description

The coupon number associated with this leg of the trip. A ticket can contain several legs of travel, and each leg of travel requires a separate coupon
date string (8) yes read close
close

Description

Date of the leg
Format: YYYYMMDD
departureTime string (6) depends read close
close

Description

The departure time in the local time at the departure airport
Format: HH:MM

Depends on:

Required for PayPal (840) when Airline data is submitted
endorsementOrRestriction string (20) no read close
close

Description

An endorsement can be an agency-added notation or a mandatory government required notation, such as value-added tax. A restriction is a limitation based on the type of fare, such as a ticket with a 3-day minimum stay
exchangeTicket string (15) no read close
close

Description

New ticket number that is issued when a ticket is exchanged
fare string (12) no read close
close

Description

Fare of this leg
fareBasis string (15) no read close
close

Description

Fare Basis/Ticket Designator
fee integer no read close
close

Description

Fee for this leg of the trip
flightNumber string (4) depends read close
close

Description

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

Depends on:

Required for PayPal (840) when Airline data is submitted
number integer (5) yes read close
close

Description

Sequence number of the flight leg
originAirport string (3) yes read close
close

Description

Origin airport/city code
passengerClass string no read close
close

Description

PassengerClass if this leg
serviceClass enum no read close
close
Deprecated: Use passengerClass instead

Description

ServiceClass of this leg (this field is used for fraud screening on the Ogone Payment Platform).

Possible values are:

  • economy
  • premium-economy
  • business
  • first
stopoverCode string depends read close
close

Description

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

Depends on:

Required for PayPal (840) when Airline data is submitted
taxes integer no read close
close

Description

Taxes for this leg of the trip
invoiceNumber string (6) no read close
close

Description

Airline tracing number
isETicket boolean no read close
close

Description

  • true = The ticket is an E-Ticket
  • false = the ticket is not an E-Ticket
isRegisteredCustomer boolean no read close
close

Description

  • true = a registered known consumer
  • false = unknown consumer
isRestrictedTicket boolean no read close
close

Description

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

Description

  • true - The payer is the ticket holder
  • false - The payer is not the ticket holder
issueDate string (8) no read close
close

Description

This is the date of issue recorded in the airline system In a case of multiple issuances of the same ticket to a cardholder, you should use the last ticket date.
Format: YYYYMMDD
merchantCustomerId string (16) no read close
close

Description

Your ID of the consumer in the context of the airline data
name string (20) yes read close
close

Description

Name of the airline
passengerName string (49) no read close
close

Description

Name of passenger
passengers array of object no read close
close

Description

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

Description

First name of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
surname string (70) no read close
close

Description

Surname of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
surnamePrefix string (15) no read close
close

Description

Surname prefix of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
title string (35) no read close
close

Description

Title of the passenger (this field is used for fraud screening on the Ogone Payment Platform)
placeOfIssue string (15) no read close
close

Description

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

Description

Passenger name record
pointOfSale string (25) no read close
close

Description

IATA point of sale name
posCityCode string (10) no read close
close

Description

city code of the point of sale
ticketDeliveryMethod string no read close
close

Description

Possible values:
  • e-ticket
  • city-ticket-office
  • airport-ticket-office
  • ticket-by-mail
  • ticket-on-departure
ticketNumber string (13) no read close
close

Description

The ticket or document number contains:
  • Airline code: 3-digit airline code number
  • Form code: A maximum of 3 digits indicating the type of document, the source of issue and the number of coupons it contains
  • Serial number: A maximum of 8 digits allocated on a sequential basis, provided that the total number of digits allocated to the form code and serial number shall not exceed ten
  • TICKETNUMBER can be replaced with PNR if the ticket number is unavailable
totalFare integer no read close
close

Description

Total fare for all legs on the ticket, excluding taxes and fees. If multiple tickets are purchased, this is the total fare for all tickets
totalFee integer no read close
close

Description

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

Description

Total taxes for all legs on the ticket. If multiple tickets are purchased, this is the total taxes for all tickets
travelAgencyName string (25) no read close
close

Description

Name of the travel agency issuing the ticket. For direct airline integration, leave this field blank
level3SummaryData object no read close
close
Deprecated: Use Order.shoppingCart instead

Description

Object that holds Level3 summary data
  • SDK Object type
    Level3SummaryData
discountAmount integer (12) no read close
close
Deprecated: Use ShoppingCart.amountbreakdown with type DISCOUNT instead

Description

Discount on the entire transaction, with the last 2 digits are implied decimal places
dutyAmount integer (12) no read close
close
Deprecated: Use ShoppingCart.amountbreakdown with type DUTY instead

Description

Duty on the entire transaction, with the last 2 digits are implied decimal places
shippingAmount integer (12) no read close
close
Deprecated: Use ShoppingCart.amountbreakdown with type SHIPPING instead

Description

Shippingcost on the entire transaction, with the last 2 digits are implied decimal places
numberOfInstallments integer (5) no read close
close

Description

The number of installments
orderDate string (14) no read close
close

Description

Date and time of order
Format: YYYYMMDDHH24MISS
typeInformation object no read close
close

Description

Object that holds the purchase and usage type indicators
  • SDK Object type
    OrderTypeInformation
purchaseType string no read close
close

Description

Possible values are:
  • physical
  • digital
usageType string no read close
close

Description

Possible values are:
  • private
  • commercial
amountOfMoney object yes read close
close

Description

Object containing amount and ISO currency code attributes
  • SDK Object type
    AmountOfMoney
amount integer (12) yes read close
close

Description

Amount in cents and always having 2 decimals
currencyCode string (3) yes read close
close

Description

Three-letter ISO currency code representing the currency for the amount
customer object depends read close
close

Description

Object containing the details of the consumer

Depends on:

Please note that this object is required, except when a token has been included in the request that includes at least the countryCode in the billingAddress.
  • SDK Object type
    Customer
billingAddress object depends read close
close

Description

Object containing billing address details

Depends on:

Please note that this object is required, except when a token has been included in the request that includes at least the countryCode.
For Direct Debit UK (705) the city, street and zip fields are also required, except when a token has been included in the request that includes these fields.
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

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

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

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

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
companyInformation object no read close
close

Description

Object containing company information
  • SDK Object type
    CompanyInformation
name string (40) no read close
close

Description

Name of company, as a consumer
contactDetails object depends read close
close

Description

Object containing contact details like email address and phone number

Depends on:

Required for payments with product 806, 9000 or 9001.
  • SDK Object type
    ContactDetails
emailAddress string (70) depends read close
close

Description

Email address of the consumer

Depends on:

Required for payments with product 806, 9000 or 9001.
emailMessageType string no read close
close

Description

Preference for the type of email message markup
  • plain-text
  • html
faxNumber string (20) no read close
close

Description

Fax number of the consumer
phoneNumber string (20) depends read close
close

Description

Phone number of the consumer

Depends on:

Required for payments with product 9000 or 9001.
fiscalNumber string (14) depends read close
close

Description

Fiscal registration number of the consumer (CPF) with a length of 11 or the tax registration number of the company for a business consumer (CNPJ) with a length of 14.

Depends on:

Required for payments done with payment products:
  • 51 - Deposito Identificado
  • 1503 - Boleto Bancario
  • 840 - PayPal, but only for transactions done in Brazil
  • 9000 - AfterPay Installments and 9001 - AfterPay Invoice, but only for transactions done in Denmark, Finland, Norway and Sweden
locale string (6) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
merchantCustomerId string (15) depends read close
close

Description

Your identifier for the consumer that can be used as a search criteria in the Global Collect Payment Console and is also included in the Global Collect report files. For Ingenco's Ogone Payment Platform this field is used in the fraud-screening process.

Depends on:

Required for payments done with payment product 806 (Trustly) and 830 (PaysafeCard).
Required for hosted checkouts where payment products 806 (Trustly) and 830 (PaysafeCard) are allowed.
Required for card payments and hosted checkouts with the unscheduledCardOnFileIndicator or unscheduledCardOnFileRequestor property set.
personalInformation object depends read close
close

Description

Object containing personal information like name, date of birth and gender.

Depends on:

Required for payments with product 806, 9000 or 9001.
  • SDK Object type
    PersonalInformation
dateOfBirth string (8) depends read close
close

Description

The date of birth of the consumer
Format: YYYYMMDD

Depends on:

Required for payments with product 9000 or 9001 in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
gender string no read close
close

Description

The gender of the consumer, possible values are:
  • male
  • female
  • unknown or empty
name object depends read close
close

Description

Object containing the name details of the consumer

Depends on:

Required for payments with product 806, 9000 or 9001.
  • SDK Object type
    PersonalName
firstName string (15) depends read close
close

Description

Given name(s) or first name(s) of the consumer

Depends on:

Required for payments with product 806, 9000 or 9001.
surname string (70) depends read close
close

Description

Surname(s) or last name(s) of the consumer

Depends on:

Required for the creation of a Payout.
Required for payments with product 806, 9000 or 9001.
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
title string (35) depends read close
close

Description

Title of consumer

Depends on:

Required for payments with product 9000 or 9001 in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
shippingAddress object no read close
close

Description

Object containing shipping address details
  • SDK Object type
    AddressPersonal
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

City

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Please note that this field is required, except when a token has been included in the request that includes this value.
houseNumber string (15) no read close
close

Description

House number
name object no read close
close

Description

Object that holds the name elements
  • SDK Object type
    PersonalName
firstName string (15) depends read close
close

Description

Given name(s) or first name(s) of the consumer

Depends on:

Required for payments with product 806, 9000 or 9001.
surname string (70) depends read close
close

Description

Surname(s) or last name(s) of the consumer

Depends on:

Required for the creation of a Payout.
Required for payments with product 806, 9000 or 9001.
surnamePrefix string (15) no read close
close

Description

Middle name - In between first name and surname - of the consumer
title string (35) depends read close
close

Description

Title of consumer

Depends on:

Required for payments with product 9000 or 9001 in Austria (AT), Belgium (BE), Germany (DE), the Netherlands (NL) and Switzerland (CH).
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
zip string (10) depends read close
close

Description

Zip code

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
vatNumber string (17) no read close
close

Description

Local VAT number of the consumer
items array of object no read close
close
Deprecated: Use ShoppingCart.items instead

Description

Shopping cart data
items object no read close
close
  • SDK Object type
    LineItem
amountOfMoney object depends read close
close

Description

Object containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item

Depends on:

Required in hosted checkout if hostedCheckoutSpecificInput.validateShoppingCart is true or not provided.
Note: hostedCheckoutSpecificInput.validateShoppingCart is only supported by the Ogone Payment Platform.
  • SDK Object type
    AmountOfMoney
amount integer (12) yes read close
close

Description

Amount in cents and always having 2 decimals
currencyCode string (3) yes read close
close

Description

Three-letter ISO currency code representing the currency for the amount
invoiceData object depends read close
close

Description

Object containing the line items of the invoice or shopping cart

Depends on:

Required in hosted checkout if hostedCheckoutSpecificInput.validateShoppingCart is true or not provided.
Note: hostedCheckoutSpecificInput.validateShoppingCart is only supported by the Ogone Payment Platform.
  • SDK Object type
    LineItemInvoiceData
description string (116) depends read close
close

Description

Shopping cart item description

Depends on:

When you want your shopping cart to be displayed on our hostedCheckout pages this field is required for the cart to display correctly.
merchantLinenumber string (5) no read close
close

Description

Line number for printed invoice or order of items in the cart
Should be a numeric string
merchantPagenumber string (3) no read close
close

Description

Page number for printed invoice
Should be a numeric string
nrOfItems string (4) depends read close
close

Description

Quantity of the item

Depends on:

When you want your shopping cart to be displayed on our hostedCheckout pages this field is required for the cart to display correctly.
pricePerItem integer (12) depends read close
close

Description

Price per item

Depends on:

When you want your shopping cart to be displayed on our hostedCheckout pages this field is required for the cart to display correctly.
level3InterchangeInformation object no read close
close
Deprecated: Use orderLineDetails instead

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    LineItemLevel3InterchangeInformation
discountAmount integer (12) no read close
close

Description

Discount on the line item, with the last two digits are implied decimal places
lineAmountTotal integer (12) no read close
close

Description

Total amount for the line item
productCode string (12) no read close
close

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
productPrice integer (12) no read close
close

Description

The price of one unit of the product, the value should be zero or greater
productType string (12) no read close
close

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
quantity integer (4) no read close
close

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
taxAmount integer (12) no read close
close

Description

Tax on the line item, with the last two digits are implied decimal places
unit string (12) no read close
close

Description

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

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates

Depends on:

This object is required for payments and hosted checkouts with products 9000 and 9001.
  • SDK Object type
    OrderLineDetails
discountAmount integer (12) no read close
close

Description

Discount on the line item, with the last two digits implied as decimal places
googleProductCategoryId integer (10) no read close
close

Description

The Google product category ID for the item.
lineAmountTotal integer (12) no read close
close

Description

Total amount for the line item
productCategory string (50) no read close
close

Description

This field indicates the category of the product (i.e. home appliance), used for fraud screening on the Ogone Payment Platform.
productCode string (12) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
productName string (120) depends read close
close

Description

The name of the product.

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
productPrice integer (12) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
productType string (12) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
quantity integer (4) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
taxAmount integer (12) no read close
close

Description

Tax on the line item, with the last two digits implied as decimal places
unit string (12) no read close
close

Description

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

Description

Object that holds all reference fields that are linked to this transaction

Depends on:

This object is required for payments and hosted checkouts with products 9000 and 9001.
  • SDK Object type
    OrderReferences
descriptor string (256) no read close
close

Description

Descriptive text that is used towards to consumer, either during an online checkout at a third party and/or on the statement of the consumer. 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
  • 819 Aktia - 210 characters
  • 836 SOFORT - 42 characters
  • 840 PayPal - 127 characters
  • 841 WebMoney - 175 characters
  • 849 Yandex - 64 characters
  • 861 Alipay - 256 characters
  • 863 WeChat Pay - 32 characters
  • 880 BOKU - 20 characters
  • 8580 Qiwi - 255 characters
  • 1504 Konbini - 80 characters
All other payment products don't support a descriptor.
invoiceData object no read close
close

Description

Object containing additional invoice data
  • SDK Object type
    OrderInvoiceData
additionalData string (500) no read close
close

Description

Additional data for printed invoices
invoiceDate string (14) no read close
close

Description

Date and time on invoice
Format: YYYYMMDDHH24MISS
invoiceNumber string (20) no read close
close

Description

Your invoice number (on printed invoice) that is also returned in our report files
textQualifiers array no read close
close

Description

Array of 3 text qualifiers, each with a max length of 10 characters
merchantOrderId integer (10) no read close
close

Description

Your order identifier
Note: This does not need to have a unique value for each transaction. This allows your to link multiple transactions to the same logical order in your system.
merchantReference string (30) depends read close
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.

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
seller object no read close
close

Description

Object containing seller details
  • SDK Object type
    Seller
address object no read close
close

Description

Object containing the seller address details
  • SDK Object type
    Address
additionalInfo string (50) no read close
close

Description

Additional address information
city string (40) depends read close
close

Description

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

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required, except when a token has been included in the request that includes this value.
Required when address is included in Seller.
houseNumber string (15) depends read close
close

Description

House number

Depends on:

Required when address is included in Seller.
state string (35) no read close
close

Description

Full name of the state or province
stateCode string (9) no read close
close

Description

State code
Note: For payments with product 1503 the maximum length is not 9 but 2.
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Invoice payments (201)
Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for the creation of a Payout.
Required for payments with product 9000 or 9001.
Required when address is included in Seller.
zip string (10) depends read close
close

Description

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

Depends on:

Required for Direct Debit UK (705), except when a token has been included in the request that includes this value.
Required for payments with product 9000 or 9001.
channelCode string (3) no read close
close

Description

Channel code, refer to
description string (32) no read close
close

Description

Description of the seller
geocode string (5) no read close
close

Description

The sellers geocode
id string (40) yes read close
close

Description

The sellers identifier
invoiceNumber string (12) no read close
close

Description

Invoice number of the payment
mcc string (5) no read close
close

Description

Merchant category code
name string (128) yes read close
close

Description

Name of the seller
type string yes read close
close

Description

Seller type. Possible values:
  • passport
  • dni
  • arg-identity-card
  • civic-notebook
  • enrollment-book
  • cuil
  • cuit
  • general-register
  • election-title
  • cpf
  • cnpj
  • ssn
  • citizen-ship
  • col-identity-card
  • alien-registration
shoppingCart object depends read close
close

Description

Shopping cart data, including items and specific amounts.

Depends on:

This object is required for payments and hosted checkouts with products 9000 and 9001.
  • SDK Object type
    ShoppingCart
amountBreakdown array of object no read close
close

Description

Determines the type of the amount.
items object no read close
close
  • SDK Object type
    AmountBreakdown
amount integer yes read close
close

Description

Amount in cents and always having 2 decimals
type enum yes read close
close

Description

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

Description

Shopping cart data

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
items object no read close
close
  • SDK Object type
    LineItem
amountOfMoney object depends read close
close

Description

Object containing amount and ISO currency code attributes
Note: make sure you submit the amount and currency code for each line item

Depends on:

Required in hosted checkout if hostedCheckoutSpecificInput.validateShoppingCart is true or not provided.
Note: hostedCheckoutSpecificInput.validateShoppingCart is only supported by the Ogone Payment Platform.
  • SDK Object type
    AmountOfMoney
amount integer (12) yes read close
close

Description

Amount in cents and always having 2 decimals
currencyCode string (3) yes read close
close

Description

Three-letter ISO currency code representing the currency for the amount
invoiceData object depends read close
close

Description

Object containing the line items of the invoice or shopping cart

Depends on:

Required in hosted checkout if hostedCheckoutSpecificInput.validateShoppingCart is true or not provided.
Note: hostedCheckoutSpecificInput.validateShoppingCart is only supported by the Ogone Payment Platform.
  • SDK Object type
    LineItemInvoiceData
description string (116) depends read close
close

Description

Shopping cart item description

Depends on:

When you want your shopping cart to be displayed on our hostedCheckout pages this field is required for the cart to display correctly.
merchantLinenumber string (5) no read close
close

Description

Line number for printed invoice or order of items in the cart
Should be a numeric string
merchantPagenumber string (3) no read close
close

Description

Page number for printed invoice
Should be a numeric string
nrOfItems string (4) depends read close
close

Description

Quantity of the item

Depends on:

When you want your shopping cart to be displayed on our hostedCheckout pages this field is required for the cart to display correctly.
pricePerItem integer (12) depends read close
close

Description

Price per item

Depends on:

When you want your shopping cart to be displayed on our hostedCheckout pages this field is required for the cart to display correctly.
level3InterchangeInformation object no read close
close
Deprecated: Use orderLineDetails instead

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates
  • SDK Object type
    LineItemLevel3InterchangeInformation
discountAmount integer (12) no read close
close

Description

Discount on the line item, with the last two digits are implied decimal places
lineAmountTotal integer (12) no read close
close

Description

Total amount for the line item
productCode string (12) no read close
close

Description

Product or UPC Code, left justified
Note: Must not be all spaces or all zeros
productPrice integer (12) no read close
close

Description

The price of one unit of the product, the value should be zero or greater
productType string (12) no read close
close

Description

Code used to classify items that are purchased
Note: Must not be all spaces or all zeros
quantity integer (4) no read close
close

Description

Quantity of the units being purchased, should be greater than zero
Note: Must not be all spaces or all zeros
taxAmount integer (12) no read close
close

Description

Tax on the line item, with the last two digits are implied decimal places
unit string (12) no read close
close

Description

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

Description

Object containing additional information that when supplied can have a beneficial effect on the discountrates

Depends on:

This object is required for payments and hosted checkouts with products 9000 and 9001.
  • SDK Object type
    OrderLineDetails
discountAmount integer (12) no read close
close

Description

Discount on the line item, with the last two digits implied as decimal places
googleProductCategoryId integer (10) no read close
close

Description

The Google product category ID for the item.
lineAmountTotal integer (12) no read close
close

Description

Total amount for the line item
productCategory string (50) no read close
close

Description

This field indicates the category of the product (i.e. home appliance), used for fraud screening on the Ogone Payment Platform.
productCode string (12) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
productName string (120) depends read close
close

Description

The name of the product.

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
productPrice integer (12) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
productType string (12) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
quantity integer (4) depends read close
close

Description

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

Depends on:

This field is required for payments and hosted checkouts with products 9000 and 9001.
taxAmount integer (12) no read close
close

Description

Tax on the line item, with the last two digits implied as decimal places
unit string (12) no read close
close

Description

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

Description

Object containing the specific input details for payments that involve redirects to 3rd parties to complete, like iDeal and PayPal
  • SDK Object type
    RedirectPaymentMethodSpecificInputBase
expirationPeriod integer no read close
close

Description

This sets the maximum amount of minutes a consumer has to complete the payment at the bank. After this period has expired it is impossible for the consumer 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 consumer has to complete the payment. Please note that it is normal for a consumer 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
paymentProductId integer (5) no read close
close

Description

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

Description

  • first = This transaction is the first of a series of recurring transactions
  • recurring = This transaction is a subsequent transaction in a series of recurring transactions
Note: Will default to first when isRecurring is set to true, with the following exception that it is set to recurring when the consumer is making the payment using a PayPal token.
Note: For any first of a recurring the system will automatically create a token as you will need to use a token for any subsequent recurring transactions. In case a token already exists this is indicated in the response with a value of False for the isNewToken property in the response.
requiresApproval boolean no read close
close

Description

  • true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
  • false = the payment does not require approval, and the funds will be captured automatically
token string (40) no read close
close

Description

ID of the token
tokenize boolean no read close
close

Description

Indicates if this transaction should be tokenized
  • true - Tokenize the transaction. Note that a payment on the GlobalCollect platform that results in a status REDIRECTED cannot be tokenized in this way. In this case, use the 'Create a token from payment' functionality after your customer succesfully completes the redirection.
  • false - Do not tokenize the transaction, unless it would be tokenized by other means such as auto-tokenization of recurring payments.
sepaDirectDebitPaymentMethodSpecificInput object depends read close
close

Description

Object containing the specific input details for SEPA direct debit payments

Depends on:

Required for hosted checkouts with product 771.
  • SDK Object type
    SepaDirectDebitPaymentMethodSpecificInputBase
paymentProduct771SpecificInput object depends read close
close

Description

Object containing information specific to SEPA Direct Debit

Depends on:

Required for hosted checkouts with product 771.
  • SDK Object type
    SepaDirectDebitPaymentProduct771SpecificInputBase
mandate object no read close
close

Description

Object containing information to create a SEPA Direct Debit mandate. Required for creating HostedCheckouts with SEPA Direct Debit supported.
  • SDK Object type
    CreateMandateBase
alias string no read close
close

Description

An alias for the mandate. This can be used to visually represent the mandate.
Do not include any unobfuscated sensitive data in the alias.
Default value if not provided is the obfuscated IBAN of the customer.
customer object depends read close
close

Description

Customer object containing customer specific inputs

Depends on:

Required for Create mandate and Create payment calls
  • SDK Object type
    MandateCustomer
bankAccountIban object depends read close
close

Description

Object containing IBAN information

Depends on:

Required for Create mandate and Create payment calls
  • SDK Object type
    BankAccountIban
accountHolderName string (30) depends read close
close

Description

Name in which the account is held.

Depends on:

Required for the creation of a Payout
Required for Create and Update token calls.
iban string (50) depends read close
close

Description

The IBAN is the International Bank Account Number. It is an internationally agreed format for the BBAN and includes the ISO country code and two check digits.

Depends on:

Required for the creation of a Payout
Required for Create and Update token.
Required for payments with product 9000 in Austria (AT) and Germany (DE).
Required for Create mandate and Create payment with mandate calls
companyName string (40) no read close
close

Description

Name of company, as a consumer
contactDetails object no read close
close

Description

Object containing contact details like email address and phone number
  • SDK Object type
    MandateContactDetails
emailAddress string (70) no read close
close

Description

Email address of the consumer
mandateAddress object depends read close
close

Description

Object containing billing address details

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
  • SDK Object type
    MandateAddress
city string (40) depends read close
close

Description

City

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
countryCode string (2) depends read close
close

Description

ISO 3166-1 alpha-2 country code

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
houseNumber string (15) no read close
close

Description

House number
street string (50) depends read close
close

Description

Streetname

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
zip string (10) depends read close
close

Description

Zip code

Depends on:

Required for Create mandate and Create payment calls.
Required for Create hostedCheckout calls where the IBAN is also provided.
personalInformation object depends read close
close

Description

Object containing personal information of the consumer

Depends on:

Required for Create mandate and Create payment calls
  • SDK Object type
    MandatePersonalInformation
name object depends read close
close

Description

Object containing the name details of the consumer

Depends on:

Required for create mandate and Create payment calls
  • SDK Object type
    MandatePersonalName
firstName string (15) depends read close
close

Description

Given name(s) or first name(s) of the consumer

Depends on:

Required for create mandate and Create payment calls
surname string (70) depends read close
close

Description

Surname(s) or last name(s) of the consumer

Depends on:

Required for create mandate and Create payment calls
title enum depends read close
close

Description

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

Depends on:

Required for create mandate and Create payment calls
customerReference string (35) yes read close
close

Description

The unique identifier of a customer
language string no read close
close

Description

The language of the customer.
recurrenceType enum yes read close
close

Description

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

Description

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

Description

The unique identifier of the mandate
mandateReference string (35) no read close
close
Deprecated: Use mandate.uniqueMandateReference instead

Description

A mandate ID to create a mandate under.
paymentProductId integer (5) no read close
close

Description

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

Request example

SDK: Java

This scenario you will probably use the most

  • HostedCheckoutSpecificInput hostedCheckoutSpecificInput = new HostedCheckoutSpecificInput();
    hostedCheckoutSpecificInput.setLocale("en_GB");
    hostedCheckoutSpecificInput.setVariant("testVariant");
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(2345L);
    amountOfMoney.setCurrencyCode("USD");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    Customer customer = new Customer();
    customer.setBillingAddress(billingAddress);
    customer.setMerchantCustomerId("1234");
    
    Order order = new Order();
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    CreateHostedCheckoutRequest body = new CreateHostedCheckoutRequest();
    body.setHostedCheckoutSpecificInput(hostedCheckoutSpecificInput);
    body.setOrder(order);
    
    CreateHostedCheckoutResponse response = client.merchant("merchantId").hostedcheckouts().create(body);
    
  • HostedCheckoutSpecificInput hostedCheckoutSpecificInput = new HostedCheckoutSpecificInput();
    hostedCheckoutSpecificInput.setLocale("en_GB");
    hostedCheckoutSpecificInput.setVariant("100");
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(2345L);
    amountOfMoney.setCurrencyCode("USD");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    Customer customer = new Customer();
    customer.setBillingAddress(billingAddress);
    customer.setMerchantCustomerId("YOURCUSTOMERID");
    
    Order order = new Order();
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    CreateHostedCheckoutRequest body = new CreateHostedCheckoutRequest();
    body.setHostedCheckoutSpecificInput(hostedCheckoutSpecificInput);
    body.setOrder(order);
    
    CreateHostedCheckoutResponse response = client.merchant("merchantId").hostedcheckouts().create(body);
    
  • HostedCheckoutSpecificInput hostedCheckoutSpecificInput = new HostedCheckoutSpecificInput();
    hostedCheckoutSpecificInput.setLocale("en_GB");
    hostedCheckoutSpecificInput.setVariant("100");
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(100L);
    amountOfMoney.setCurrencyCode("USD");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    Customer customer = new Customer();
    customer.setBillingAddress(billingAddress);
    customer.setMerchantCustomerId("YOURCUSTOMERID");
    
    Order order = new Order();
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    CreateHostedCheckoutRequest body = new CreateHostedCheckoutRequest();
    body.setHostedCheckoutSpecificInput(hostedCheckoutSpecificInput);
    body.setOrder(order);
    
    CreateHostedCheckoutResponse response = client.merchant("merchantId").hostedcheckouts().create(body);
    
  • HostedCheckoutSpecificInput hostedCheckoutSpecificInput = new HostedCheckoutSpecificInput();
    hostedCheckoutSpecificInput.setLocale("en_GB");
    hostedCheckoutSpecificInput.setReturnUrl("http://www.google.com");
    hostedCheckoutSpecificInput.setVariant("100");
    
    AmountOfMoney amountOfMoney = new AmountOfMoney();
    amountOfMoney.setAmount(2345L);
    amountOfMoney.setCurrencyCode("USD");
    
    Address billingAddress = new Address();
    billingAddress.setCountryCode("US");
    
    Customer customer = new Customer();
    customer.setBillingAddress(billingAddress);
    customer.setMerchantCustomerId("YOURCUSTOMERID");
    
    Order order = new Order();
    order.setAmountOfMoney(amountOfMoney);
    order.setCustomer(customer);
    
    CreateHostedCheckoutRequest body = new CreateHostedCheckoutRequest();
    body.setHostedCheckoutSpecificInput(hostedCheckoutSpecificInput);
    body.setOrder(order);
    
    CreateHostedCheckoutResponse response = client.merchant("merchantId").hostedcheckouts().create(body);
    

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

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

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

Property Type Required Details
RETURNMAC string no read close
close

Description

When the consumer is returned to your site we will append this field and value to the query-string. You should store this data, so you can identify the returning consumer.
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

This field will contain the merchantReference you provided in case you included one in the Create hostedCheckout API call. In case you didn't provide one the system will generate one for you (for the Ogone payment platform only) to allow you to link any created payment to this hostedCheckout. To relate a payment done by the consumer in a hostedCheckout session you can use the following fields:
  • paymentOutput.references.merchantReference (for the GlobalCollect payment engine this is only possible when you supply a merchantReference during the creation of the hostedCheckout)
  • hostedCheckoutSpecificOutput.hostedCheckoutId (only returned when using the GlobalCollect payment engine)
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 consumer 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: Java

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

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
items object no read close
close
  • SDK Object type
    APIError
category string no read close
close

Description

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

Description

Error code
httpStatusCode integer no read close
close

Description

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

Description

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

Description

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

Description

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

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Java

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