Create an offline credit card vault
Overview
This endpoint is used to create vaults that store data representing a credit card.
A creditCard object is expected in the request with the follow fields:
Values: [1-12]
Presence: required
Values: 4-digit integer e.g. 2018
Presence: required
Max length: 30
Presence: required
An offline vault can be created as a PERPETUAL, TIME_EXPIRY or LIMITED vault:
Vault Type | Description | How to create |
---|---|---|
PERPETUAL | This is the default vault type. This allows you to read and update the vault as many times as required without restrictions | Don't specify the maxUsage or expiryDate field in the vault object |
TIME_EXPIRY | Allows you to read or update a vault as many times as required up until the ISO 8601 specified expiry date | Specify the expiryDate field in the vault object |
LIMITED | Allows you to read the vault maxUsage amount of times. Updates do not count as a vault usage | Specify the maxUsage field in the vault object |
Details on the valid time expiry and limited fields:
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
If none of these parameters are set then the vault will exist until it has automatically expired after a 1 year
period of non-use.
For more information about offline vaults see
here.
Additionally the user may create metadata tags for their vault.
This JSON Object contains key/value pairs, with each pair representing a metadata tag.
Type: JSON ObjectFormat: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Structure
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: alphanumeric, dashes, spaces, underscores
Min length: 1
Max length: 64
Presence: required
Presence: required
Presence: required
Values: [1-12]
Presence: required
Values: 4-digit integer e.g. 2018
Presence: required
Max length: 30
Presence: required
Format: ISO 8601 time-date
Example: "2018-09-27T06:55:23.045Z"
Presence: optional
This JSON Object contains key/value pairs, with each pair representing a metadata tag.
Type: JSON ObjectFormat: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Values: utf8
Min length: 1
Max length: 64
Presence: required
Presence: required
Values: alphanumeric, dashes
Presence: optional
Presence: optional
Presence: optional
Presence: optional
Values: ERROR, SUCCESS
Presence: required
Presence: required
Presence: required
Presence: required
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Usage
API used |
POST /sanctum/v1-2/vault/credit-card/offline |