Skip to main content
POST
/
api
/
network
/
tokens
/
{id}
/
cryptograms
curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/network/tokens/{id}/cryptograms \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "ecom",
  "amount": 1000,
  "currency_code": "EUR",
  "reference": "order_1234567890"
}
'
{
  "type": "tavv",
  "cryptogram": "Af9KZ3vVQkFxM3BZkJYFZkYBAgAEAAAB",
  "eci": "05",
  "expiry_month": 10,
  "expiry_year": 2030,
  "number": "4122234533471157"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The ID of the token for which to request a cryptogram.

Body

application/json
​
amount
integer
required

The amount given in minor units (e.g. use 700 for 7€). Some currencies do not support minor units (e.g. Japanese Yen). In this case send in the full value, i.e. 100 for 100 JPY.

​
currency_code
string
required

The three letter ISO-4217 currency code.

​
reference
string
required
​
type
string
​
mode
enum<string>

Controls whether the cryptogram is returned in the response or kept inside Guardian.

  • inline returns the full cryptogram payload. Only allowed when the instance compliance level is SAQ-D or RoC.
  • reference returns a short-lived, single-use cryptogram_reference instead. Forward it with Forward cryptogram.

When omitted, the mode defaults to inline on SAQ-D / RoC and is forced to reference on SAQ-A / SAQ-A EP.

Available options:
inline,
reference
​
metadata
object

Metadata consisting of key-value entries.

  • Maximum 20 key-value pairs.
  • Maximum 20 characters per key.
  • Maximum 80 characters per value.
Example:
{
  "my_key_one": "my_value_one",
  "my_key_two": "my_value_two"
}

Response

Success response with the requested cryptogram.

​
cryptogram
string
required

The token authentication verification value (TAVV) for the network token.

​
eci
string
required

The Electronic Commerce Indicator (ECI) from the issuer.

​
expiry_month
integer
required
​
expiry_year
integer
required
​
number
string
required
​
type
string
​
metadata
object

Metadata consisting of key-value entries.

  • Maximum 20 key-value pairs.
  • Maximum 20 characters per key.
  • Maximum 80 characters per value.
Example:
{
  "my_key_one": "my_value_one",
  "my_key_two": "my_value_two"
}