Skip to main content
GET
/
api
/
network
/
tokens
/
{id}
Get token details
curl --request GET \
  --url https://{cluster_id}.on-hellgate.cloud/api/network/tokens/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2023-10-01T12:00:00Z",
  "card": {
    "cardholder_name": "John Doe",
    "expiry_month": 12,
    "expiry_year": 2025,
    "masked_account_number": "411111******1111",
    "scheme": "visa"
  },
  "network_token": {
    "status": "active",
    "type": "vts"
  },
  "pci_token_id": "42510fee-ee8a-4377-a6e9-8aca381578ea"
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required

The ID of the token to retrieve.

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
​
network_token
object
required
​
pci_token_id
string<uuid>

The ID of the PCI token that represents the card

​
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"
}