Network Token Service Provider

Network Tokens extend our card-on-file (CoF) functionality, so when enabled a Card-on-File can asynchronously provision a Network Token which can then be used for payments outside of the BR-DGE platform. Please see our Vault documentation for our current network token functionality.

You can use BR-DGEs Network Token Service to:

• Create CoFs and have BR-DGE provision a Network Token (and optionally cryptogram):
  • Please see the POST /v1/payment-instruments endpoint for more information.
• Provision a Cryptogram for use outside of the BR-DGE platform:
  • Please see the POST /v1/payment-instruments/{token}/network-token-cryptogram endpoint for more information.
• Be kept informed of the status of your Network Tokens and whether they can be used:
  • Please see the GET /v1/payment-instruments request and Notifications section for more information.
• Delete existing CoFs and their respective network tokens:
  • Please see the DELETE /v1/payment-instruments/{token} endpoint for more information.

Usage

1. You will need to complete onboarding for the Network Token Service prior to using this feature. Get in contact with support to enable this.
2. Your customer registers a card.
   1. The card is registered immediately and will start a backend process to provision a network token.
      1. There is an option to immediately provision a network token in the API.
3. Network token Provisioning completes successfully.
   1. The CoF is updated with the network token details.
   2. A notification will be sent to you (if registered) with the changes.
4. Your customer wishes to make a payment.
   1. The customer makes a request.
   2. You receive the request and make a call to BR-DGE to receive a network token cryptogram, given the selected CoF from the customer.
   3. BR-DGE retrieves the network token cryptogram for the card, returning it to you.
   4. You use the generated cryptogram to make a payment.
5. If the customer wants to remove their card, you can delete their CoF, and the underlying network token will also be removed.

Network Provisioning Flow

The network provisioning flow is asynchronous (with option for synchronous provisioning), so there may be a period from when the card on file is created to when it is usable for retrieving cryptograms.

To assist with managing this, we have provided a status field to report on the stage of provisioning.

networkTokenProvisioningStatus can be one of the following states:

• UNPROVISIONED: A network token has not attempted to be provisioned, is not enabled or not valid for this payment instrument.
• PROVISIONING: Provisioning has been triggered but is not completed.
• FAILED: Provisioning has failed. The provisioning could not be completed.
• PROVISIONED: Provisioning was successful, and a network token is available for use.

Notifications

Through the lifecycle of the network token, we provide several notifications which can be subscribed to. These notifications will provide details of the lifecycle events of the token.

The events are:

• Network Token Status Change Event
  • This notification is triggered when a provisioned network token changes status between ACTIVE, DISABLED and DELETED
• Network Token Metadata Update Event
  • This notification is triggered when BR-DGE receives an update for the card metadata, like the card art.
  • After this notification is received we suggest you retrieve the information.
• Network Token Provisioning Failed Event
  • This notification is triggered when BR-DGE attempts to provision a network token but fails for some reason.

To enable notifications you can get in contact with support.