Skip to main content
GET
/
api
/
pci
/
tokens
/
{id}
Get token details
curl --request GET \
  --url https://{cluster_id}.on-hellgate.cloud/api/pci/tokens/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "8744c9ea-a02b-4ae6-875c-b64fc333e3ef",
  "card": {
    "cardholder_name": "John Doe",
    "expiry_month": 12,
    "expiry_year": 2025,
    "masked_account_number": "411111******1111",
    "scheme": "visa"
  },
  "created_at": "2023-10-01T12:00:00Z"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The ID of the token to read.

Response

Success response

​
id
string<uuid>
required
​
card
object
required
Example:
{
  "cardholder_name": "John Doe",
  "expiry_month": 12,
  "expiry_year": 2025,
  "masked_account_number": "411111******1111",
  "scheme": "visa"
}
​
created_at
string<date-time>
required
​
expires_at
string<date-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"
}