Sign in

v1

latestOpenAPI 3.1.0Payrails GmbH2026-07-2614905.7 MB
Vault Records and Aliases

Get record and its fields by alias

Retrieve a record and all fields associated with the record by the alias of one of its fields.

get/token/records

Query parameters

aliasstring required

Alias of a Record Field.

includeVolatileInfoboolean

Boolean indicating if additional information regarding volatile fields should be included in the response.

includeDetokenizationsboolean

Boolean indicating if additional information regarding performed detokenization attempts should be returned.

Response

Record and its fields.

idstring uuid

Payrails unique identifier of the record.

typestring

Type of this record, e.g. card or networkToken.

fingerprintstring

The fingerprint of the record. Depending on type can be used to match with other records.

Example response

{
  "fields": [
    {
      "maximumExpirationDate": "2024-12-31T23:59:59Z",
      "detokenizations": [
        {
          "lastAttemptedAt": "2024-01-01T12:00:00Z",
          "count": 1,
          "type": "detokenization"
        }
      ]
    }
  ]
}