Skip to main content

Network Tokens

Network Tokens enables merchants to convert raw card details into secure, network-issued tokens. The network token endpoints support one-time purchases, card-on-file transactions, subscriptions and other recurring or cross-border payments by issuing tokens that automatically update on card reissues and boost authorization rates—all without ever storing PANs.

Create a Network Token

Creates a Network Token.

POST
https://api.basistheory.com/network-tokens
Copy

Permissions

network_token:create

Request

curl -L 'https://api.basistheory.com/network-tokens' \
-H 'BT-API-KEY: <API_KEY>' \
-H 'Content-Type: application/json' \
-d '{
"data": {
"number": "4111111111111111",
"expiration_month": "03",
"expiration_year": "2027",
"cvc": "123"
},
"cardholder_info": {
"name": "Jonh Doe",
"address": {
"line1": "123 Main Street",
"line2": "Apt 4B",
"line3": "Building 7",
"postal_code": "90210",
"city": "Beverly Hills",
"state_code": "CA",
"country_code": "USA"
}
}
}'

Request Parameters

AttributeRequiredTypeDescription
dataYesobjectCard details required to generate a network token
data.numberYesstringThe card number to tokenize
data.expiration_monthYesstringThe card's expiration month
data.expiration_yearYesstringThe card's four-digit expiration year
data.cvcYesstringThe card's verification code
cardholder_infoYesobjectThe cardholder information

Cardholder Information

AttributeRequiredTypeDescription
nameYesstringThe full name of the cardholder
addressYesobjectThe cardholder address details

Address Details

AttributeRequiredTypeDescription
line1YesstringThe first line of the street address
line2NostringThe second line of the street address
line3NostringThe third line of the street address
postal_codeYesstringThe postal code of the address
cityYesstringThe city of the address
state_codeNostringThe state or province code of the address
country_codeYesstringThe country code of the address

Response

Returns a network token object if successful. Returns an error if there were validation errors, or the network token failed to create.

{
"id": "1a97a7f6-5d7e-4a8e-ad08-c2472cfedf7f",
"tenant_id": "a4ed655d-325e-4490-8c5a-2ff288db7aa5",
"data": {
"number": "XXXXXXXXXXXX2426",
"expiration_month": 12,
"expiration_year": 2029
},
"network_token": {
"bin": "433561",
"last4": "2426",
"expiration_month": 12,
"expiration_year": 2029,
"brand": "visa",
"funding": "debit",
"issuer": {
"country": "US",
"name": "CENTRAL FEDERAL SAVINGS AND LOAN ASSOCIATION"
},
"issuer_country": {
"alpha2": "US",
"name": "UNITED STATES OF AMERICA",
"numeric": "840"
},
"segment": "Consumer",
"additional": [
{
"brand": "star",
"funding": "debit",
"issuer": {
"country": "US"
}
}
]
},
"status": "active",
"created_by": "f8dee6b4-2f92-4052-81f9-8b0fc8078a6e",
"created_at": "2025-05-07T17:04:06.3338559+00:00"
}

Get a network token

Retrieves a Network Token.

GET
https://api.basistheory.com/network-tokens/{id}
Copy

Permissions

network_token:read network_token:reveal

At least one of these permissions is required to access the information. The network-token:read permission displays the card number in data.number with a masked format (showing only the last 4 digits), while the network-token:reveal permission provides access to view the complete unmasked card number.

If both permissions are set, the network-token:reveal permission will take precedence and display the complete unmasked card number.

Request

curl -L 'https://api.basistheory.com/network-tokens/485fcc69-e105-4239-b821-92c612f9b03d' \
-H 'BT-API-KEY: <API_KEY>' \
-H 'Content-Type: application/json'

Request Parameters

AttributeRequiredTypeDescription
idYesstringThe ID of the network token to retrieve

Response

Returns a network token object if successful. Returns an error if there were validation errors, or the network token failed to retrieve.

{
"id": "1a97a7f6-5d7e-4a8e-ad08-c2472cfedf7f",
"tenant_id": "a4ed655d-325e-4490-8c5a-2ff288db7aa5",
"data": {
"number": "XXXXXXXXXXXX2426",
"expiration_month": 12,
"expiration_year": 2029
},
"network_token": {
"bin": "433561",
"last4": "2426",
"expiration_month": 12,
"expiration_year": 2029,
"brand": "visa",
"funding": "debit",
"issuer": {
"country": "US",
"name": "CENTRAL FEDERAL SAVINGS AND LOAN ASSOCIATION"
},
"issuer_country": {
"alpha2": "US",
"name": "UNITED STATES OF AMERICA",
"numeric": "840"
},
"segment": "Consumer",
"additional": [
{
"brand": "star",
"funding": "debit",
"issuer": {
"country": "US"
}
}
]
},
"status": "active",
"created_by": "f8dee6b4-2f92-4052-81f9-8b0fc8078a6e",
"created_at": "2025-05-07T17:04:06.3338559+00:00"
}

Generate a Cryptogram

Generate a cryptogram for a network token.

POST
https://api.basistheory.com/network-tokens/{id}/cryptogram
Copy

Permissions

network_token:cryptogram

Request

curl -L -X POST 'https://api.flock-dev.com/network-tokens/2c1577f3-6c1b-4575-9488-13202405fefe/cryptogram' \
-H 'BT-API-KEY: <API_KEY>' \
-H 'Content-Type: application/json'

Request Parameters

AttributeRequiredTypeDescription
idYesstringThe ID of the network token to create cryptogram

Response

Returns a cryptogram object if successful. Returns an error if there were validation errors, or the cryptogram failed to create.

{
"cryptogram": "2z8pd6WGPUi/BBesvjJcyw==",
"eci": "07"
}

Delete a Network Token

Deletes a Network Token.

DELETE
https://api.basistheory.com/network-tokens/{id}
Copy

Permissions

network_token:delete

Request

curl -L -X DELETE 'https://api.basistheory.com/network-tokens/485fcc69-e105-4239-b821-92c612f9b03d' \
-H 'BT-API-KEY: <API_KEY>' \
-H 'Content-Type: application/json'

Request Parameters

AttributeRequiredTypeDescription
idYesstringThe ID of the network token to delete

Response

Returns a 204 No Content response if successful. Returns an error if there were validation errors, or the network token failed to delete.

Network Token Object

AttributeTypeDescription
idstringUnique identifier of the network token
tenant_iduuidThe tenant ID associated with the network token
data.numberstringMasked card number
data.expiration_monthintegerCard's expiration month
data.expiration_yearintegerCard's expiration year
network_tokenobjectAn object containing the card data. See Card Details for more information.
created_byuuidID of the entity that created the network token
created_atdateTimestamp of when the network token was created

Card Details

AttributeTypeDescription
binstringSix to eight digit BIN of the card
last4stringLast four digits of the card
expiration_monthnumberThe 2-digit expiration month of the card
expiration_yearnumberThe 4-digit expiration year of the card
brandstringThe primary card brand
fundingstringThe primary funding type of the card
segmentstringThe segmentation of the card (eg., Consumer, Commercial)
issuerobjectDescribes the contry and issuing bank. See Issuer for details
issuer_countryobject
 .alpha2stringIssuing country ISO3166 alpha country code
 .numericstringIssuing country ISO3166 numeric country code
 .namestringIssuing country name
authenticationstringThe authentication type required for this card
additionalarrayContains additional details associated to the same BIN number. See Card Additional for details.
Card properties shows the primary card details, while Card.additional provides additional card details found for the same BIN.
If a card number does not correspond to any known BIN Details, then brand, funding, issuer_country, and authentication will default to null and the default BIN will be returned.

Card Additional

AttributeTypeDescription
brandstringAn additional card brand
fundingstringAn additional funding type of the card
authenticationstringAn additional authentication type required for this card
issuerobjectDescribes the contry and issuing bank. See Issuer for details

Issuer

AttributeTypeDescription
countrystringIssuing country ISO3166 alpha country code
namestringIssuing bank name

Card Brands

The following card brands are supported in the card property (primary details). Please note that the additional property may contain extra card brands not listed in this table.
BrandDescription
american-expressAmerican Express
diners-clubDiners Club
discoverDiscover
ebtEBT
eloElo
hipercardHipercard
jcbJCB
mastercardMastercard
mirMIR
private-labelPrivate Label
proprietaryProprietary
unionpayUnionPay
visaVisa

Card Funding Types

Funding TypeDescription
creditCredit Card
debitDebit Card
prepaidPrepaid Card

Authentication Types

Authentication TypeDescription
sca_requiredIndicates that Strong Customer Authentication (SCA) is required (e.g. 3DS)

Cryptogram Object

AttributeTypeDescription
cryptogramstringThe cryptogram generated for the network token
ecistringThe ECI value associated with the cryptogram