Hosted Fields Token

Supported Parameters:

Fields	Description	Type	Default	Required
expiration	Token expiration in minutes. The maximum allowed value is 30	Integer	30	No
terminal	The ID of your terminal on which the payment will be processed. Must be an active terminal using our Gateway	Integer	N/A	Yes
domain	The Website domain on which the token will be used. Please use full URL Name. E.g. https://my.website.com	String	N/A	Yes
saveCard	Whether you want to retrieve the tokenized card after the payment is made. Allowed values: `required`, `optional`, `disabled`	String	disabled	No
3ds	Enable or Disable 3DS checks.	boolean	false	No

`expiration` Parameter

Controls the expiration time of the token. Defaults to 15 minutes if not provided. The maximum allowed value is 30. If card saving (card tokenization) was allowed by the user during the payment process (or if you made it a requirement), you must retrieve the tokenized card while the Hosted Fields Token is still active.
For example if you issue an Hosted Fields Token with an expiration time of 10 minutes, then the payment and card token retrieval must occur within this time limit. Otherwise, you will need to issue a new Hosted Fields Token. If the payment is made within the time limit but the card token is not retrieved within the same period, it will be lost and will not be available to you

`terminal` Parameter

Specifies the terminal ID on which the payment will be processed. The terminal must be in Active status and must be an internal terminal, pointing to our gateway.

`domain` Parameter

Specifies the URL on which the Hosted Fields Token will be used and the payment form will be rendered. You need to specify the full URL. E.g: https://my.website.com. If your website is accessed with a port number, you need to provide it too. E.g: https://my.website.com:3000

`saveCard` Parameter

Specifies whether you want to save the tokenized card after the payment is made. Accepted values: required, optional, disabled.

`required`

The card will be tokenized and available for you to fetch after the payment is processed. A message will be rendered above the payment form submit button informing the user that their card will be saved. You are responsible for requesting the tokenized card after the payment.

`optional`

Card tokenization will be optional. The user will be presented with a checkbox to explicitly confirm that they want their card to be saved for future payments. If unchecked the card token will not be available for you.

`disabled`

This is the default value of the saveCard parameter. Card tokenization will not be performed and the card token will not be available to you.

`3ds` Parameter

Enables or disables the 3DS Verification when it is set as optional on the terminal. If the terminal you specified requires 3DS Verification, then the 3DS will be enabled by default and you wont be able to disable it in your hosted fields form. If 3DS verification is disabled on your terminal, then the 3DS will also be disabled. If you still request 3DS verification for the Hosted Fields Token when 3DS is disabled, an exception will be thrown.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "expiration": 15,
    "terminal": 3,
    "domain": "https://my.website.com",
    "saveCard": "required",
    "3ds": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Hosted Fields Token

application/json

Body

Example

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczpcL1wvZGFzaGJvYXJkLmludCIsInN1YiI6Ikhvc3RlZCBGaWVsZHMgQWNjZXNzVG9rZW4iLCJhdWQiOm51bGwsImV4cCI6MTc0MTcwMjY0MiwiaWF0IjoxNzQxNzAxNzQyLCJzYXZlQ2FyZCI6InJlcXVpcmVkIiwidGhyZWVkcyI6ZmFsc2UsImlmcmFtZVNyYyI6Imh0dHBzOlwvXC9kYXNoYm9hcmQuaW50XC9nYXRld2F5XC9ob3N0ZWQtZmllbGRzIiwiZG9tYWluIjoiaHR0cHM6XC9cL2xvY2FsaG9zd",
    "issued_at": 1741701742,
    "expiration": 15,
    "expires_at": "2025-03-11 14:17:22 UTC"
}

expiration Parameter#

terminal Parameter#

domain Parameter#

saveCard Parameter#

required#

optional#

disabled#

3ds Parameter#