PApayrails
Vault Records and Aliases

Get field details by alias

Get field details for the given alias.

get/token/records/fields/{alias}

Request

Path parameters

aliasstring required

Alias of the record's field in Payrails Vault.

Query parameters

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

Details about field.

aliasstring

Merchant-facing unique alias for the field. Used as an identifier.

recordIdstring

Identifier of the record to which the alias belongs.

recordTypestring

Record type to which this field belongs, e.g. card and networkToken.

fieldTypestring

Field type of the alias, e.g. cardNumber, expiryMonth, expiryYear, securityCode, holderName, networkToken, cryptogram.

displayableValuestring nullable

Displayable value for the field.

allowedDetokenizationCountinteger nullable

It will be restricted if used on a proxy and reaches the limit mentioned in this field.

allowedSdkRevealCountinteger nullable

It will be restricted if used on a SDK reveal and reaches the limit mentioned in this field.

hasValueboolean nullable

Indicates whether the volatile field has a value associated with it. If false or not present, the field has been deleted or was never set.

maximumExpirationDatestring date-time nullable

The maximum expiration date for the volatile field value. After this date, the field value will be deleted. Please note that depending on usage of volatile field, value can be deleted even earlier, for example if allowed detokenization or reveal counts are exceeded, or when you explicitly call delete operation on the field.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.