Create an online credit card vault – Support Center

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

expiryMonth: The expiry month of the card

expiryYear: The expiry year of the card

name: The cardholder's name

number: The card number (Must pass Luhn algorithm FAQ)

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.

metadata {: Add metadata tags to the vault. FAQ

Structure

RequestResponse

{

application {: The application details

device {: Contains the end-user's device metrics. Device Fingerprinting

username: The username that this vault is associated with. FAQ

externalRef: Your reference to this operation for audits. FAQ

vault {: The vault to create

metadata {: Add metadata tags to the vault. FAQ

}

Usage

API used
POST /sanctum/v1-2/vault/credit-card/online

Sequence diagram for creating an online credit card vault