Network Tokens

Provision network tokens and cryptograms.

Provision a Network Token

Beta

Provisions a network token synchronously. If the merchant stores their cards with Checkout.com, then source ID can be used to request a network token for the given card. If the merchant does not store their cards with Checkout.com, then card details have to be provided.

SecurityOAuth2: OAuth

Request

Request Body schema: application/json

required

object (NetworkTokensRequestSource)

The source object

Responses

200

Responding with existing network token

201

Network token provisioned

401

Unauthorized

403

Forbidden

415

Unsupported Media Type

422

Invalid data was sent

500

Internal Server Error

502

Bad Gateway

504

Gateway Timeout

post/network-tokens

Request samples

Payload
curl
Java
C#
Python

application/json

{"source": {"type": "id",
"id": "src_wmlfc3zyhqzehihu7giusaaawu"
}
}

Response samples

application/json

{"card": {"last4": "6378",
"expiry_month": "5",
"expiry_year": "2025"
},
"network_token": {"id": "nt_xgu3isllqfyu7ktpk5z2yxbwna",
"state": "active",
"number": "5436424242424242",
"expiry_month": "5",
"expiry_year": "2025",
"type": "vts",
"payment_account_reference": "5001a9f027e5629d11e3949a0800a",
"created_on": "2020-02-11T15:57:32.435+00:00",
"modified_on": "2020-02-11T15:57:32.435+00:00"
},
"token_requestor_id": "1234567890",
"token_scheme_id": "scheme_visa_001",
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/network-tokens/nt_xgu3isllqfyu7ktpk5z2yxbwna"
},
"cryptogram": {"href": "https://{prefix}.api.checkout.com/network-tokens/nt_xgu3isllqfyu7ktpk5z2yxbwna/cryptograms"
},
"card-art": {"href": "https://card-art.checkout.com/00340aa7bd3de35cb1048369450d8df4"
}
}
}

Get Network Token

Beta

Given network token ID, this endpoint returns network token details: DPAN, expiry date, state, TRID and also card details like last four and expiry date.

SecurityOAuth2: OAuth

Request

path Parameters

network_token_id

required

string

Unique token ID assigned by Checkout.com for each token

Example: nt_xgu3isllqfyu7ktpk5z2yxbwna

Responses

200

Network Token details

401

Unauthorized

403

Forbidden

404

Network Token not found

500

Internal Server Error

502

Bad Gateway

504

Gateway Timeout

get/network-tokens/{network_token_id}

Request samples

curl
Java
C#
Python

Response samples

application/json

{"card": {"last4": "6378",
"expiry_month": "5",
"expiry_year": "2025"
},
"network_token": {"id": "nt_xgu3isllqfyu7ktpk5z2yxbwna",
"state": "active",
"number": "5436424242424242",
"expiry_month": "5",
"expiry_year": "2025",
"type": "vts",
"payment_account_reference": "5001a9f027e5629d11e3949a0800a",
"created_on": "2020-02-11T15:57:32.435+00:00",
"modified_on": "2020-02-11T15:57:32.435+00:00"
},
"token_requestor_id": "1234567890",
"token_scheme_id": "scheme_visa_001",
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/network-tokens/nt_xgu3isllqfyu7ktpk5z2yxbwna"
},
"cryptogram": {"href": "https://{prefix}.api.checkout.com/network-tokens/nt_xgu3isllqfyu7ktpk5z2yxbwna/cryptograms"
},
"card-art": {"href": "https://card-art.checkout.com/00340aa7bd3de35cb1048369450d8df4"
}
}
}

Request a cryptogram

Beta

Using network token ID as an input, this endpoint returns token cryptogram.

SecurityOAuth2: OAuth

Request

path Parameters

network_token_id

required

string

Unique token ID assigned by Checkout.com for each token

Example: nt_xgu3isllqfyu7ktpk5z2yxbwna

Request Body schema: application/json

transaction_type

required

string

Transaction type the cryptogram is requested for.

Enum: "ecom" "recurring" "pos" "aft"

Responses

201

Cryptogram from the network token

401

Unauthorized

403

Forbidden

404

Network Token not found

422

Invalid data was sent

500

Internal Server Error

502

Bad Gateway

504

Gateway Timeout

post/network-tokens/{network_token_id}/cryptograms

Request samples

Payload
curl
Java
C#
Python

application/json

{"transaction_type": "ecom"
}

Response samples

application/json

{"cryptogram": "AhJ3hnYAoAbVz5zg1e17MAACAAA=",
"eci": "7",
"_links": {"self": {"href": "https://{prefix}.api.checkout.com/network-tokens/nt_xgu3isllqfyu7ktpk5z2yxbwna/cryptograms"
},
"network-token": {"href": "https://{prefix}.api.checkout.com/network-tokens/nt_xgu3isllqfyu7ktpk5z2yxbwna"
}
}
}

Permanently deletes a network token

Beta

This endpoint is for permanently deleting a network token. A network token should be deleted when a payment instrument it is associated with is removed from file or if the security of the token has been compromised.

SecurityOAuth2: OAuth

Request

path Parameters

network_token_id

required

string

Unique token ID assigned by Checkout.com for each token

Example: nt_xgu3isllqfyu7ktpk5z2yxbwna

Request Body schema: application/json

initiated_by required	string Who initiated/requested the deletion of the token. Enum: "cardholder" "token_requestor"
reason required	string The reason for deleting the token. Enum: "fraud" "other"

Responses

204

400

Bad Request

401

Unauthorized

403

Forbidden

404

Network token not found

422

Invalid data was sent

500

Internal Server Error

502

Bad Gateway. Error from scheme

504

Timeout while waiting for a scheme response

patch/network-tokens/{network_token_id}/delete

Request samples

Payload
curl
Java
C#
Python

application/json

{"initiated_by": "token_requestor",
"reason": "other"
}

Response samples

application/json

{"request_id": "0HL80RJLS76I7",
"error_type": "request_invalid",
"error_codes": ["payment_source_required"
]
}

➔ Next to Standalone Account Updater