checkoutSession

terminals

List of terminals available for the user. Based on these terminals, available payment methods will be grouped. Note that this replaces the single terminal parameter from createPaymentRequest.

shop_orderid

This is the internal ID of the order in your webshop. In most integrations, you can use the same order ID for up to four orders. The shop_orderid value is posted back to you, so you know the order to which the payment refers.

[a-zA-Z0-9-]{1,100}

amount

This is the payment amount. If you are setting up a subscription, it is the default amount for each capture. For unscheduled agreement you can use 0 if you are only setting up the subscription without charging the customer.
You must use a dot as the decimal separator, and the amount can have maximum 2 decimals.

float

session_id

Optional identifier for a session to be created. If not provided, the identifier will be generated automatically. Must be unique.

String{0,50}

language

The language in which the payment form is displayed. For more information about supported language codes, see Supported languages. If the language parameter is not set, the language is derived from the browser's Accept-Language HTTP header field. If none of the browser languages are supported, the default is English, en. If the language you set is not supported, an error is returned.

[a-z]{2}

transaction_info

This is a one-dimensional associative array, where you can put any value that you would like to associate with the payment.

Array

Maximum 50 entries of maximum 255 characters each.

type

This is the authorization type. For more information, see Payment request types:

• payment (default)
• paymentAndCapture
• verifyCard
• subscription
• subscriptionAndCharge
• subscriptionAndReserve

string

ccToken

This is the credit card token value. By using a credit card token from a previous payment, your customer won't have to enter credit card details again. To enable this, select the Enable credit card token check box under Home > Terminal Settings in the Merchant Interface.

string

sale_reconciliation_identifier

This is the sales reconciliation identifier, used in the reconciliation CSV files you can download from the Merchant Information Interface, or by using the getCustomReport method. For more information, see getCustomReport.This parameter can only be used when the type parameter is set to paymentAndCapture.

String{0,100}

sale_invoice_number

This is the invoice number for the capture.

string

fraud_service

Setting the fraud_service parameter lets you select a different fraud detection service on the payment level. Some of the existing fraud detection services cannot be changed at the payment level directly because they need additional configuration on the terminal (e.g. marketpay).

string

The customer's e-user name or user id. This uniquely identifies the user in your system.

The customer's email address. It is required for 3DS to provide a valid email address, which then increases the chances for a frictionless flow, and therefore conversion. If provided will auto-fill the Email input for credit card forms. Please ensure you populate this field to improve the user experience.

The customer's telephone number, without spaces. This must include the country code. You can prefix the code with + (e.g. +446721846), or 00 (e.g. 00446721846), or omit the prefix (e.g. 446721846).

The birth date of the customer

Mandatory if your MCC code is 6012.

Certain invoice payment providers require gender to be sent. Use this field to comply with that requirement.

If this parameter is required by the provider, but not set in the method call, the customer is asked for this information on the payment page (callback_form).

The last name for the customer's billing address.

Mandatory if your MCC code is 6012.

The first name for the customer's billing address.

The street address of the customer's billing address.

The city of the customer's billing address.

Mandatory for fraud detection.

The region of the customer's billing address.

Mandatory for fraud detection.

The postal code of the customer's billing address.

Mandatory if your MCC code is 6012.

Mandatory for fraud detection.

The country of the customer's billing address as a 2 character ISO-3166 country code. Northern Ireland is an exception; see here.

Mandatory for fraud detection.

The first name for the customer's shipping address.

The last name for the customer's shipping address.

The city of the customer's shipping address.

The region of the customer's shipping address.

The postal code of the customer's shipping address.

description

Description of an item.

String (255)

itemId

The item identification.

String (100)

quantity

The quantity of the item. The value must be greater than zero.

Decimal

unitPrice

The unit price, excluding sales tax. The value must be greater than zero.

unitPrice supports up to three decimals, however for most acquirers and currencies two decimals are recommended.

Decimal

taxPercent

This is the tax percentage of the unit price.

Decimal

taxAmount

This is the total tax on an order line, before any discounts are applied. It is recommended to use taxAmount if possible. If you provide both taxPercent and taxAmount, the amount takes precedence.

Decimal

unitCode

The relevant measurement unit for the order line. For example, kg.

String (50)

discount

The order line's discount in percent. Must be a non-negative decimal number if provided. Will be used to calculate final amount for order line after applying taxes.

Decimal

The goods type of the order line - shipment, handling, item, digital, discount, gift_card, physical, sales_tax, subscription_model.