BIN Lookup Service
When some types of tokens are provisioned, Token Management Service (TMS) returns the BIN details that are provided by the BIN Lookup Service. This section describes how to retrieve the BIN information provided by the BIN Lookup Service for a PAN or network token.
TMS returns BIN data when you send a request to create or retrieve these token types:
- Payment instrument tokens
- Instrument identifier tokens
Endpoints
Instrument Identifier Tokens
GET /tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
GET /tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
GET /tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
GET /tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
GET /tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
POST /tms/v1/instrumentidentifiers?retrieveBinDetails=true
POST /tms/v1/instrumentidentifiers?retrieveBinDetails=true
POST /tms/v1/instrumentidentifiers?retrieveBinDetails=true
POST /tms/v1/instrumentidentifiers?retrieveBinDetails=true
POST /tms/v1/instrumentidentifiers?retrieveBinDetails=true
Payment Instrument Tokens
GET /tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
GET /tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
GET /tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
GET /tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
GET /tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
POST /tms/v1/paymentinstruments?retrieveBinDetails=true
POST /tms/v1/paymentinstruments?retrieveBinDetails=true
POST /tms/v1/paymentinstruments?retrieveBinDetails=true
POST /tms/v1/paymentinstruments?retrieveBinDetails=true
POST /tms/v1/paymentinstruments?retrieveBinDetails=true
Path parameters
{instrumentIdentifierTokenId} and {paymentInstrumentTokenId} are the token IDs that are returned in the id field when you created the token.
Example
GET /tms/v1/instrumentidentifiers/7049989999918257179?retrieveBinDetails=true{ "_links": { "self": { "href": "/tms/v1/instrumentidentifiers/7049989999918257179" }, "paymentInstruments": { "href": "/tms/v1/instrumentidentifiers/7049989999918257179/paymentinstruments" }, "tokenized-cards": { "href": "/tms/v2/tokenized-cards/23589328AA5A15CDE063A2598D0A702B" } }, "id": "7049989999918257179", "object": "instrumentIdentifier", "state": "ACTIVE", "tokenizedCard": { "id": "23589328AA5A15CDE063A2598D0A702B", "state": "ACTIVE", "enrollmentId": "abea32809655e12383cd1b006e119d01", "tokenReferenceId": "131db9889f4c503b240519cca8f35901", "number": "489537XXXXXX5398", "expirationMonth": "12", "expirationYear": "2030", "type": "visa", "card": { "suffix": "7179", "expirationMonth": "12", "expirationYear": "2030" }, "metadata": { "cardArt": { "combinedAsset": { "id": "8f64614def1a41d39ea8acae4616bf6f", "_links": { "self": { "href": "/tms/v2/tokens/7049989999918257179/vts/assets/card-art-combined" } } }, "brandLogoAsset": { "id": "00000000000000000000000000001071", "_links": { "self": { "href": "/tms/v2/tokens/7049989999918257179/vts/assets/brand-logo" } } }, "foregroundColor": "1af0f0" }, "issuer": { "shortDescription": "shortDescription", "longDescription": "longDescription" } }, "source": "ONFILE" }, "card": { "number": "462294XXXXXX7179" }, "issuer": { "paymentAccountReference": "V0010013024023377525412642508" }, "metadata": { "creator": "mid" }, "_embedded": { "binLookup": { "issuer": { "country": "US" }, "status": "COMPLETED", "paymentAccountInformation": { "card": { "type": "001", "brandName": "VISA", "credentialType": "PAN", "cardType": "VISA" } } } }}Thanks for your feedback!
Last published: October 28, 2026