Create an online 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:
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
Type: integer
Values: [1-12]
Presence: required
Values: [1-12]
Presence: required
Type: integer
Values: 4-digit integer e.g. 2018
Presence: required
Values: 4-digit integer e.g. 2018
Presence: required
Type: string
Max length: 30
Presence: required
Max length: 30
Presence: required
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
For more information about online vaults see here.
Additionally the user may create metadata tags for their vault.
FAQ
Format: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
The key of the metadata tag.
The value of the metadata tag.
Add metadata tags to the 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
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Structure
{
The application's api key
The application's uuid
The expiry month of the card
The expiry year of the card
The cardholder's name
The card number (Must pass Luhn algorithm
Contains the credit card details to store
The name of the vault
Value to secure this vault. For more information about the hashedPin
The vault to create } The application details
Type: JSON Object
Presence: required
Presence: required
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Device Fingerprinting
Type of browser on the end-user's device
Version of the browser on the end-user's device
Operating System on the end-user's device
Fonts on the end-user's device
Contains the end-user's device metrics.
Type: JSON Object
Presence: required
Presence: required
Type: string
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
Type: string
Value: numeric, dots
Min length: 2
Presence: required
Value: numeric, dots
Min length: 2
Presence: required
Type: string
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
Value: alphanumeric, dash, underscore, space
Min length: 2
Presence: required
Type: Array of string
Min length: 1
Presence: required
Min length: 1
Presence: required
FAQ
The username that this vault is associated with.
Your reference to this operation for audits.
Type: string
Values: alphanumeric, dashes, spaces, underscores
Min length: 1
Max length: 64
Presence: required
Values: alphanumeric, dashes, spaces, underscores
Min length: 1
Max length: 64
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: integer
Values: [1-12]
Presence: required
Values: [1-12]
Presence: required
Type: integer
Values: 4-digit integer e.g. 2018
Presence: required
Values: 4-digit integer e.g. 2018
Presence: required
Type: string
Max length: 30
Presence: required
Max length: 30
Presence: required
Type: string
Values: utf8
Min length: 1
Max length: 64
Presence: required
Values: utf8
Min length: 1
Max length: 64
Presence: required
FAQ
Format: <key>: <value>
Presence: optional
Max Key/Value pairs: 50
The key of the metadata tag.
The value of the metadata tag.
Add metadata tags to the 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
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: required
Min length: 1
Max length: 32
Type: string
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
Values: utf8 (alphanumeric, dashes, underscores, spaces)
Presence: optional
Min length: 0
Max length: 255
{
The response status code
Contains reasons for the parent detailed error
The JSON property in the request responsible for the parent detailed error
Contains error details if any error(s) occurred
The response message
The response status
The vault's encryptedData
The vault's payload
Contains the credentials required for further use of the created vault
The uuid of the created vault
Contains the details of the created vault }
Contains details about the response status
Type: JSON Object
Presence: required
Presence: required
Type: optional
Values: alphanumeric, dashes
Presence: optional
Values: alphanumeric, dashes
Presence: optional
Type: Array of JSON Objects
Presence: optional
Presence: optional
Type: Array of string
Presence: optional
Presence: optional
Type: string
Presence: optional
Presence: optional
Type: string
Values: ERROR, SUCCESS
Presence: required
Values: ERROR, SUCCESS
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: JSON Object
Presence: required
Presence: required
Type: string
Presence: required
Presence: required
Type: string
Presence: required
Presence: required
Type: string
Values: hexadecimal, dashes
Length: 36
Presence: required
Values: hexadecimal, dashes
Length: 36
Presence: required
Usage
API used |
POST /sanctum/v1-2/vault/credit-card/online |