Sign in

v1

latestOpenAPI 3.1.02026-07-242325051.4 MB
Tokens

Token:Browse

Get all vault tokens for the authenticated merchant

get/tokenization/tokens

Query parameters

eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

A unique identifier for a tokenized record.

{
  "eq": "VY-1234-1234-1234",
  "neq": "VY-1234-1234-1234"
}
eqstring date

Get results that equal the given value

neqstring date

Get results that do not equal the given value

gtstring date

Get results that are greater than the given value

gtestring date

Get results that are greater than or equal to the given value

ltstring date

Get results that are less than the given value

ltestring date

Get results that are less than or equal to the given value

The date at which this entity was created presented in the correct ISO-8601 (a.k.a. ATOM) notation.

{
  "eq": "1999-02-15",
  "neq": "1999-02-15",
  "gt": "1999-02-15",
  "gte": "1999-02-15",
  "lt": "1999-02-15",
  "lte": "1999-02-15"
}
eqstring date

Get results that equal the given value

neqstring date

Get results that do not equal the given value

gtstring date

Get results that are greater than the given value

gtestring date

Get results that are greater than or equal to the given value

ltstring date

Get results that are less than the given value

ltestring date

Get results that are less than or equal to the given value

The date at which the token was last used.

{
  "eq": "1999-02-15",
  "neq": "1999-02-15",
  "gt": "1999-02-15",
  "gte": "1999-02-15",
  "lt": "1999-02-15",
  "lte": "1999-02-15"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

likestring

Get results that are similar to the given value

nlikestring

Get results that are not similar to the given value

The name of the customer that started the transaction.

{
  "eq": "John Doe",
  "neq": "John Doe",
  "like": "John Doe",
  "nlike": "John Doe"
}
eqstring

Get results that equal the given value

neqstring

Get results that do not equal the given value

The code of the merchant for which the transaction was started.

{
  "eq": "M-####-####",
  "neq": "M-####-####"
}

Response

Ok.

totalinteger
countinteger
pagesinteger

Example response

{
  "total": 5,
  "count": 5,
  "pages": 1,
  "tokens": [
    {
      "code": "VY-1234-1234-1234",
      "token": "97f32429bb6828b98023e38d6498d76a9386d",
      "numberOfTransactions": 12,
      "payer": {
        "consumerName": "John Doe",
        "maskedPAN": "54594*****95969",
        "customerKey": "abdcdk9394952dkf"
      },
      "expiryDate": "2029-09-05",
      "paymentMethod": {
        "id": 10,
        "name": "Visa Mastercard"
      },
      "merchant": {
        "code": "M-1234-1234",
        "name": "Great Cookies Inc.",
        "status": "ACTIVE"
      },
      "lastUsedAt": "2023-11-22T00:00:00+00:00",
      "createdAt": "2023-11-22T00:00:00+00:00",
      "createdBy": "AT-1234-1234"
    }
  ],
  "_links": [
    {
      "href": "/tokenization",
      "rel": "self",
      "type": "GET"
    }
  ]
}