Sign in

v1

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

Get record and aliases for a given instrumentId.

Get record, aliases, and all associated fields for a given instrumentId.

get/token/instruments/{instrumentId}/records

Path parameters

instrumentIdstring uuid required

Identifier of the resource in Payrails.

Query parameters

includeVolatileInfoboolean

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

Response

Successful retrieval of records and aliases by instrumentId.

instrumentIdstring uuid

Example response

{
  "instrumentId": "882da741-c493-491c-9d11-993e4d709f4a",
  "records": [
    {
      "id": "a5e219cd-1707-4dd7-b963-115c382c57e4",
      "type": "card",
      "fingerprint": "581a61af-d92d-4b7e-bfe4-303bd500d06e",
      "fields": [
        {
          "recordId": "a5e219cd-1707-4dd7-b963-115c382c57e4",
          "recordType": "card",
          "alias": "0cdedf0b-6ea7-4d7f-9942-0a4ddda0f7fd",
          "fieldType": "cardNumber",
          "displayableValue": "411111**1111",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "a5e219cd-1707-4dd7-b963-115c382c57e4",
          "recordType": "card",
          "alias": "651e66f1-7c09-4ba2-baef-d29050e6362e",
          "fieldType": "expiryMonth",
          "displayableValue": "01",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "a5e219cd-1707-4dd7-b963-115c382c57e4",
          "recordType": "card",
          "alias": "5c862e69-22b3-4eaf-92fa-5068813c863f",
          "fieldType": "expiryYear",
          "displayableValue": "25",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "a5e219cd-1707-4dd7-b963-115c382c57e4",
          "recordType": "card",
          "alias": "52661250-8140-4d92-8b44-bc9a6f17fd48",
          "fieldType": "holderName",
          "displayableValue": "Foo",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "a5e219cd-1707-4dd7-b963-115c382c57e4",
          "recordType": "card",
          "alias": "db821554-6f4c-4cd8-87d0-f22dd3cdcc40",
          "fieldType": "securityCode",
          "displayableValue": null,
          "allowedDetokenizationCount": 1,
          "allowedSdkRevealCount": 0
        }
      ]
    },
    {
      "id": "f1dd67f4-771d-465f-bb2e-bed7e7e8bf39",
      "type": "networkToken",
      "fingerprint": "581a61af-d92d-4b7e-bfe4-303bd500d06e",
      "fields": [
        {
          "recordId": "f1dd67f4-771d-465f-bb2e-bed7e7e8bf39",
          "recordType": "networkToken",
          "alias": "88774a64-9bc7-4641-b4b9-4800896a5303",
          "fieldType": "cryptogram",
          "displayableValue": null,
          "allowedDetokenizationCount": 1,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "f1dd67f4-771d-465f-bb2e-bed7e7e8bf39",
          "recordType": "networkToken",
          "alias": "ebd69b8d-1e9e-46fc-a197-91d5993b2c89",
          "fieldType": "expiryMonth",
          "displayableValue": "01",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "f1dd67f4-771d-465f-bb2e-bed7e7e8bf39",
          "recordType": "networkToken",
          "alias": "9322f77c-b093-48e6-a628-bccab0a606dd",
          "fieldType": "expiryYear",
          "displayableValue": "35",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        },
        {
          "recordId": "f1dd67f4-771d-465f-bb2e-bed7e7e8bf39",
          "recordType": "networkToken",
          "alias": "8fad08c9-1c2b-4f45-9ddc-2d6d53f7033d",
          "fieldType": "networkToken",
          "displayableValue": "411111**1111",
          "allowedDetokenizationCount": null,
          "allowedSdkRevealCount": 0
        }
      ]
    }
  ]
}