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.

Endpoint

Test:

POST https://api.smartpayfuse-test.barclaycard/tms/v1/instrumentidentifiers

Production:

POST https://api.smartpayfuse.barclaycard/tms/v1/instrumentidentifiers

Required Fields for Provisioning a Network Token for a Card Number

card.number
card.expirationMonth
card.expirationYear
type

REST Example: Provisioning a Network Token for a Card Number

Request

{
  "type": "enrollable card",
  "card": {
    "number": "X622943123116478",
    "expirationMonth": "12",
    "expirationYear": "2026"
  }
}

Response to a Successful Request

{
  "_links": {
    "self": {
      "href": "https://api.smartpayfuse-test.barclaycard/tms/v1/instrumentidentifiers/496F3A5C78FFDF96E063AF598E0ACAD9"
    },
    "paymentInstruments": {
      "href": "https://api.smartpayfuse-test.barclaycard/tms/v1/instrumentidentifiers/496F3A5C78FFDF96E063AF598E0ACAD9/paymentinstruments"
    },
    "tokenized-cards": {
      "href": "https://api.smartpayfuse-test.barclaycard/tms/v2/tokenized-cards/4BCD0B03B2FF365EE063AF598E0A2B0A"
    }
  },
  "id": "496F3A5C78FFDF96E063AF598E0ACAD9",
  "object": "instrumentIdentifier",
  "state": "ACTIVE",
  "tokenizedCard": {
    "id": "4BCD0B03B2FF365EE063AF598E0A2B0A",
    "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": "https://api.smartpayfuse-test.barclaycard/tms/v2/tokens/496F3A5C78FFDF96E063AF598E0ACAD9/vts/assets/card-art-combined"
            }
          }
        },
        "brandLogoAsset": {
          "id": "00000000000000000000000000001071",
          "_links": {
            "self": {
              "href": "https://api.smartpayfuse-test.barclaycard/tms/v2/tokens/496F3A5C78FFDF96E063AF598E0ACAD9/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": false,
          "oboDeviceBindingSupported": false
        }
      },
      "services": {
        "scanAndPay": {
          "merchantPresentedQrEnabled": "N"
        }
      },
      "creator": "apiref_chase"
    },
    "source": "ONFILE"
  },
  "card": {
    "number": "462294XXXXXX6478"
  },
  "issuer": {
    "paymentAccountReference": "V0010013025104530884197510742"
  },
  "metadata": {
    "creator": "apiref_chase"
  }
}


{
    "_links": {
        "self": {
            "href": "https://api.smartpayfuse-test.barclaycard/tms/v1/instrumentidentifiers/7030000000014911515"
        },
        "paymentInstruments": {
            "href": "https://api.smartpayfuse-test.barclaycard/tms/v1/instrumentidentifiers/7030000000014911515/paymentinstruments"
        }
    },
    "id": "7030000000014911515",
    "object": "instrumentIdentifier",
    "state": "ACTIVE",
    "tokenizedCard": {
    "state": "ACTIVE",
    "number": "489537XXXXXX5914",
    "expirationMonth": "12",
    "expirationYear": "2022",
    "type": "visa",
    "card": {
      "suffix": "1515",
      "expirationMonth": "12",
      "expirationYear": "2031"
    },
    "metadata": {
      "cardArt": {
        "combinedAsset": {
          "id": "84cfb836af434859be62c766bdc9e510",
          "_links": {
            "self": {
              "href": "/tms/v2/tokens/7030080000051311515/vts/assets/card-art-combined"
            }
          }
        }
      },
      "issuer": {
        "name": "issuing bank name",
        "shortDescription": "The Bank Card",
        "longDescription": "The Bank Card Platinum Rewards",
        "country": "Country of issuing Bank",
        "accountPrefix": "BIN",
        "email": "[email protected]",
        "phoneNumber": "1112223333",
        "url": "http://www.example.com"
      }
    }
  },
    "card": {
        "number": "489537XXXXXX1515"
    },
    "issuer": {
        "paymentAccountReference": "V0010013019326121174070050420"
    },
    "metadata": {
        "creator": "testrest"
    }
}