On This Page

Provision a Network Token for a Card Number

This section describes how to provision a network token for a card number.

Network tokens that are provisioned by TMS are card-on-file (COF) tokens.

IMPORTANT

When provisioning a network token, you must include the "Accept:application/jose"
request header to receive the unmasked network token value for successful provisions in the API response.

When included, the response body contents will be encrypted using the organizations Token Management Message Level Encryption Key (MLE) in the Business Center. For more information, see Token Management Message-Level Encryption Keys.

You can use specific test card numbers to provision network tokens in the sandbox environment, see Test Card Numbers.

For information on network token provision failures, see Network Token Provision Failures.

Endpoint

Test:

POST https://nabgateway-api-test.nab.com.au/tms/v2/tokenized-cards

Production:

POST https://nabgateway-api.nab.com.au/tms/v2/tokenized-cards

Required Fields for Provisioning a Network Token for a Card Number

card.number
card.expirationMonth
card.expirationYear
source: Set to
ONFILE
.

REST Example: Provisioning a Network Token for a Card Number

Request

{
  "source": "ONFILE",
  "card": {
    "number": "X622943123116478",
    "expirationMonth": "12",
    "expirationYear": "2026"
  }
}

Response to a Successful Request

{
  "_links": {
    "self": {
      "href": "https://nabgateway-api-test.nab.com.au/tms/v2/tokenized-cards/518CA1611EF98697E063AF598E0ADFB9"
    },
    "instrumentIdentifier": {
      "href": "https://nabgateway-api-test.nab.com.au/tms/v1/instrumentidentifiers/7031530000033441624"
    }
  },
  "id": "518CA1611EF98697E063AF598E0ADFB9",
  "object": "tokenizedCard",
  "state": "ACTIVE",
  "enrollmentId": "15372f0f2bdf79725a1516de0288de01",
  "tokenReferenceId": "8d40eed53be76d63c665111dc1d46e01",
  "paymentAccountReference": "V0010013025104530884197510742",
  "number": "489537XXXXXX1624",
  "expirationMonth": "12",
  "expirationYear": "2034",
  "type": "visa",
  "card": {
    "suffix": "6478",
    "expirationMonth": "12",
    "expirationYear": "2026",
    "expirationPrinted": true,
    "securityCodePrinted": true
  },
  "metadata": {
    "cardArt": {
      "combinedAsset": {
        "id": "8f64614def1a41d39ea8acae4616bf6f",
        "_links": {
          "self": {
            "href": "/tms/v2/tokens/7031530000033441624/vts/assets/card-art-combined"
          }
        }
      },
      "brandLogoAsset": {
        "id": "00000000000000000000000000001071",
        "_links": {
          "self": {
            "href": "/tms/v2/tokens/7031530000033441624/vts/assets/brand-logo"
          }
        }
      },
      "foregroundColor": "1af0f0",
      "backgroundColor": "009614",
      "labelColor": "19550a"
    },
    "issuer": {
      "shortDescription": "shortDescription",
      "longDescription": "longDescription",
      "email": "[email protected]",
      "phoneNumber": "987654321",
      "url": "www.test.com",
      "capabilities": {
        "deviceBindingSupported": true,
        "cardholderVerificationSupported": true,
        "trustedBeneficiaryEnrollmentSupported": false,
        "delegatedAuthenticationSupported": true,
        "oboDeviceBindingSupported": false
      }
    },
    "services": {
      "scanAndPay": {
        "merchantPresentedQrEnabled": "N"
      }
    },
    "creator": "apiref_chase"
  },
  "source": "ONFILE"
}