Sign in

v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
tokens

aid_customers_cid_tokens_post

Create a new customer token scopes:

  • admin:customers
  • write:customers
  • user:customers
post/accounts/{aid}/customers/users/{customer_id}/tokens

Path parameters

aidstring ^[PT]{1}\d{8}$ required

An id that uniquely identifies the account.

customer_idstring required

The customer id you have defined for the customer. (must not have trailing or leading spaces)

Query parameters

delete_token_eventsboolean

delete all token events recorded on token type/value before creating new customer token

Request body

token_idstring

The token id you have defined for the token. (must not have trailing or leading spaces)

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
typestring required

identifies how or who is resposible for the token value

valuestring required
metadataobject

Additional metadata about the token or the entity the token was created from

Example request

{
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "type": "sha1:email",
  "value": "a1b79ef1a62d94ffa86b3f3d846df0ee3993af92",
  "metadata": {
    "exp_month": 10,
    "exp_year": 20,
    "mask_pan": "**** **** **** 3477"
  }
}

Response

Customer token added

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
token_idstring

The token id you have defined for the token. (must not have trailing or leading spaces)

typestring required

identifies how or who is resposible for the token value

valuestring required
metadataobject

Additional metadata about the token or the entity the token was created from

Example response

{
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "type": "sha1:email",
  "value": "a1b79ef1a62d94ffa86b3f3d846df0ee3993af92",
  "metadata": {
    "exp_month": 10,
    "exp_year": 20,
    "mask_pan": "**** **** **** 3477"
  }
}