Skip to main content

Quick Integration Guide

Introduction

In this section you will find a guide on how to successfully integrate Token Management Platform (TMP) into your services to support card tokenization and additional features.

image-1671195769949.png

Supported Approaches

There are two main approaches to Token Management Platform (TMP) integration the issue can follow, depending on the preferred card storage location:

  1. Cards stored in Verestro Data Core with the use of Lifecycle API
  2. Cards stored outside of Verestro (for example by issuer's processor)

Approach 1. Cards stored IN Verestro (Lifecycle API) 

To fully integrate with Token Management Platform (TMP) when storing card data in Verestro, the issuer will have to do the following integrations:

1. Lifecycle API integration (mandatory).
2. TMP API integration (optional).
3. Issuer API integration (optional).

Each integration and its purpose is described below:

Lifecycle API

image-1671196092492.png

Lifecycle API is the main way of populating DataCore database with the issuer cards. TMP will use DataCore database as a card source. The main idea, is that the issuer should keep cards in DataCore updated with the actual state. During the tokenization, TMP will check if card number is present, card is not blocked and expiry date matches. All changes to the card state will be also reflected to available tokens.

Please refer to Lifecycle API documentation.

Features available if Lifecycle API is integrated:

  • MDES/VTS tokenization.
  • MDES/VTS Automated Token Lifecycle Management.
TMP API

image-1671196386793.png

TMP API is exposed by Verestro Token Management Platform. This set of APIs is optional and is used by the Issuer to simplify Push Provisioning process.

Available API methods:

  • Sign Card (used for Apple Pay and Google Pay Push Provisioning)
  • Get tokens (used to display or hide "Add to xPay" button in the mobile app)
  • Activate tokens (used when issuer would like to implement InApp activation method)
Issuer API

image-1671450239468.png

Issuer API is a set of APIs exposed by the Issuer. Verestro Token Management Platform will call this API to send Token updates, User notifications or to verify the CVC (required for Apple Pay).

Features available if Issuer API is integrated:

  • Receiving of Token Updates, when the token is changed.
  • Receiving of User Notification, when a SMS notification needs to be sent to the user.
  • CVC Verification.

Approach 2. Cards stored OUTSIDE of Verestro

To fully integrate with Token Management Platform (TMP), when card data is stored outside of Verestro (for example by the issuer's processor), the issuer will have to do the following integrations:

1. TMP API integration (mandatory).
2. Issuer API integration (mandatory).

Each integration and its purpose is described below:

TMP API

image-1671196386793.png

TMP API is exposed by Verestro Token Management Platform. This set of APIs is optional and is used by the Issuer to simplify Push Provisioning process and to keep TMP updated on card lifecycle events.

Available API methods:

  • Card Events (used to notify TMP about card lifecycle events)
  • Sign Card (used for Apple Pay and Google Pay Push Provisioning)
  • Get tokens (used to display or hide "Add to xPay" button in the mobile app)
  • Activate tokens (used when issuer would like to implement InApp activation method)
Issuer API

image-1671450239468.png

Issuer API is a set of APIs exposed by the Issuer to Verestro TMP. Verestro Token Management Platform will call this API to verify the card data during predigitization; send Token updates and User notifications.

Features available if Issuer API is integrated:

  • Verifying card data, which is a mandatory step to complete the tokenization.
  • Receiving of Token Updates, when the token is changed.
  • Receiving of User Notification, when a SMS notification needs to be sent to the user.
Back to top