Skip to main content

Read an offline credit card vault

Permanently deleted user
  • Updated

Overview

Allows you to read the contents of your offline credit card vault. This is a two step process to guard against network failure:
1. get-start
2. get-end

The first step (get-start) will retrieve the contents of your vault and give you the new vault (represented by encryptedData and payload in the response body for get-start). You must then acknowledge you received new vault using (get-end). It is only after it has been acknowledged that the Sanctum system recognises the vault content has been retrieved. If the retrieval of the content fails due to network issues, the retrieval request is ignored and you can restart the retrieval process by calling (get-start) again.


This two step process is identical to the vault update process.

Starting the data retrieval process:

Structure

Request

{
application {: The application details
externalRef: Your reference to this operation for audits. FAQ
vault {: Contains the details of the vault
}
 

Response

{
responseStatus {: Contains details about the response status
transactionToken {: Contains transaction token information to be used on acknowledging the response
vault {: Contains the details of the vault
}
 

Usage

This endpoint should be called to begin the data retrieval process for an offline credit card vault.

API used
POST /Sanctum/v1-2/vault/credit-card/offline/{vaultUuid}/get-start

 

Ending the data retrieval process:

Structure

Request
{
token: The transaction token from the get-start response
}
 
Response
{
responseStatus {: Contains details about the response status
}
 

Usage

This endpoint should be called to end the data retrieval process for an offline credit card vault.

API used
PUT /Sanctum/v1-2/vault/credit-card/offline/{{vaultUuid}}/get-end

 

Comments

0 comments

Please sign in to leave a comment.