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:
- creditCard: The credit card to store
-
The expiry month of the card
-
The expiry year of the card
-
The cardholder's name
-
The card number (Must pass Luhn algorithm FAQ)
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:
-
Determines the maximum amount of times the vault may be read. FAQ
-
Determines the period of time you may read/update this vault before it is deleted
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.
Add metadata tags to the vault. FAQ
Structure
Request
{
The application details
The username that this vault is associated with. FAQ
Your reference to this operation for audits. FAQ
Contains information about the vault to create
}
Response
{
Contains details about the response status
Contains the details of the created vault
}
Usage
| API used |
| POST /Sanctum/v1-2/vault/credit-card/offline |
Comments
0 comments
Please sign in to leave a comment.