Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-2428350487.0 KB
Payment Instrument Tokenization

Create a Network Token for a Card-on-File.

Create a Network Token for a Card-on-File.

Network tokens are automatically provisioned when creating a BR-DGE Card-on-File. However, in situation where this didn't happen (for example if network token support was not enabled at the time of Card-on-File creation or a temporary failure to provision network tokens), you can use this endpoint to manually trigger network token provisioning.

post/payment-instruments/{token}/network-token

Response

Network Token created.

idstring required

A unique identifier that represents the token associated with a card enrolled into the Card Network Service

tokenstring

The unique token for the enrolled PAN which can be used in authorization as per ISO/IEC 7812 format.

This will only be available once a cryptogram has been provisioned at least once.

expiryDatestring required

Expiration date of the token, noted in MM-YY format

issuer'MASTERCARD' | 'VISA' required

The issuing card network of the Network Token

status'ACTIVE' | 'DISABLED' | 'DELETED' required

The status of the Network Token.

  • ACTIVE: Can be used to provision Cryptograms for payments.

  • DISABLED: This can be due to card suspensions, fraud, or other temporary hold reasons and may be re-activated at a later date.

  • DELETED: The token is no longer valid and cannot be re-activated. This can be due to token expirations, lost card or other non-temporary reasons.

tokenUniqueReferencestring required

Unique identifier for the Network Token provided by the Card Network

paymentAccountReferencestring required

A non-financial reference assigned to each unique funding PAN (FPAN) that's used to link the payment account of that PAN to affiliated payment tokens. See our dedicated PAR guide for more info.

lastFourstring

Last four digits of the Network Token

cardBinstring

BIN of the associated associated Card

cardLastFourstring

Last four digits of the associated Card

cardExpiryDatestring

Expiration date of the associated Card, noted in MM-YY Format

cardIssuerstring

Name of the issuing bank

Example response

{
  "id": "WXdfRANqUrBalltlBKaaWHVGrFoWrIHsZAK",
  "token": "5186151969968300",
  "expiryDate": "08-26",
  "issuer": "MASTERCARD",
  "status": "ACTIVE",
  "tokenUniqueReference": "DM4MMC0000000001cd2826c715b7475bb089b7622366ebe4",
  "paymentAccountReference": "5001EUMYTT3AESCZGUEC77KPCLETI",
  "lastFour": "1234",
  "cardBin": "00123456",
  "cardLastFour": "1234",
  "cardExpiryDate": "08-26",
  "cardIssuer": "Bank of BR-DGE"
}