Skip to main content
POST
/
api
/
generic
/
tokens
curl --request POST \
  --url https://{cluster_id}.on-hellgate.cloud/api/generic/tokens \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "payload": {
    "iban": "DE89370400440532013000",
    "bic": "COBADEFFXXX",
    "account_holder_name": "John Doe"
  }
}
'
{
  "id": "8744c9ea-a02b-4ae6-875c-b64fc333e3ef",
  "created_at": "2023-10-01T12:34:56Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
payload
object
required

The payload is a key-value map, that can contain any information the user wants to store in the token.

  • Maximum 20 key-value pairs. * Maximum 20 characters per key. * Maximum 80 characters per value.
​
expiration_time
integer

The expiry time is used to specify after how many seconds a token should be automatically deleted after creation.

Required range: 1 <= x <= 2592000
​
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"
}
​
type_id
string<uuid>

The ID of a type to apply for this payload. If provided the payload will be validated against the schema of the type and the tokens can be filtered by the type ID as well.

Response

Success response

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
expires_at
string<data-time>
​
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"
}