Create an online generic vault
Overview
This endpoint is used to create vaults that store any data that does not represent a credit card.
As this is an online vault endpoint, the request may contain the fields:
- (required) device: The device information associated with this vault. Device Fingerprinting
- (optional) hashedPin: Extra field to increase the level of security of the vault. FAQ
No auto-expiry mechanism will be applied to generic vaults even if they are not used for a year or longer.
For more information about online 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
Presence: required
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
Value: numeric, dots
Min length: 2
Presence: required
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
Min length: 1
Presence: required
Values: alphanumeric, dashes, spaces, underscores
Min length: 1
Max length: 64
Presence: required
Presence: required
Value: utf8
Presence: required
Values: utf8
Min length: 1
Max length: 64
Presence: required
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
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/generic/online |