Get field details by alias list
Get field details for multiple provided aliases. The order in which aliases returned may not match the order in which you passed the aliases in request. Not found fields will be ignored: if you request fields by aliases a, b, c and there is no field with alias b, then only fields a and c are returned.
Authorizations
You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>.
These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.
Query Parameters
Comma-separated aliases of fields in Payrails Vault. There should be at least one alias provided and in one call you can provide up to 10 aliases.
Boolean indicating if additional information regarding volatile fields should be included in the response.
Boolean indicating if additional information regarding performed detokenization attempts should be returned.
Response
Array of Field objects.
Merchant-facing unique alias for the field. Used as an identifier.
Identifier of the record to which the alias belongs.
Record type to which this field belongs, e.g. card and networkToken.
Field type of the alias, e.g. cardNumber, expiryMonth,
expiryYear, securityCode, holderName, networkToken, cryptogram.
Displayable value for the field.
It will be restricted if used on a proxy and reaches the limit mentioned in this field.
0
It will be restricted if used on a SDK reveal and reaches the limit mentioned in this field.
0
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.
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.
"2024-12-31T23:59:59Z"
List of detokenization attempts performed on this field. This field is returned only when requested via includeDetokenizations query parameter.