Tokenize records

Store card or network token data in the Payrails Vault and receive aliases for it.

The response returns one entry per requested record, in the order of the request, in the same
representation the record retrieval endpoints return. A record that fails validation carries an error
and does not fail the rest of the request.

A request holds at most 50 records. One carrying more is rejected with 413 and no record is stored.

Repeating a request stores new records and returns new aliases. The endpoint provides no idempotency.

This endpoint is served on the Payrails Vault host and accepts a Vault access token. It is available by
request and requires an approval by Payrails.

Body Params

Records to tokenize.

records
array of objects
required
length between 1 and 50

Records to tokenize. A request holds at least 1 and at most 50 records; a request carrying more is rejected with 413 before any record is stored.

records*
string
enum
required

Type of the record to create.

Allowed:
fields
object
required

Values to tokenize, keyed by field type. Allowed keys depend on the record type:

  • card: cardNumber, expiryMonth, expiryYear, holderName, securityCode.
  • networkToken: networkToken, expiryMonth, expiryYear, cryptogram.

securityCode and cryptogram are stored as volatile fields and expire according to your vault
configuration. Their retention cannot be set per request.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Choose an example:
application/json