BIN Lookup Service and TMS
TMS
When some types of tokens are provisioned,
TMS
returns the BIN
details that are provided by the BIN Lookup Service. This section shows you how to
retrieve the BIN information provided by the BIN Lookup Service for a PAN or network
token.IMPORTANT
You must be enabled for network tokenization to retrieve BIN
details using
TMS
.TMS
returns BIN data when you send a request to create or
retrieve these token types:For more information about using the BIN Lookup Service, see the
BIN Lookup Service Developer Guide
Endpoints
- Instrument Identifier Tokens
- Test:GEThttps://apitest.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
- Test:POSThttps://apitest.cybersource.com/tms/v1/instrumentidentifiers?retrieveBinDetails=true
- Production:GEThttps://api.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
- Production:POSThttps://api.cybersource.com/tms/v1/instrumentidentifiers?retrieveBinDetails=true
- Production in India:GEThttps://api.in.cybersource.com/tms/v1/instrumentidentifiers/{instrumentIdentifierTokenId}?retrieveBinDetails=true
- Production in India:POSThttps://api.in.cybersource.com/tms/v1/instrumentidentifiers?retrieveBinDetails=true
- Payment Instrument Tokens
- Test:GEThttps://apitest.cybersource.com/tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
- Test:POSThttps://apitest.cybersource.com/tms/v1/paymentinstruments?retrieveBinDetails=true
- Production:GEThttps://api.cybersource.com/tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
- Production:POSThttps://api.cybersource.com/tms/v1/paymentinstruments?retrieveBinDetails=true
- Production in India:GEThttps://api.in.cybersource.com/tms/v1/paymentinstruments/{paymentInstrumentTokenId}?retrieveBinDetails=true
- Production in India:POSThttps://api.in.cybersource.com/tms/v1/paymentinstruments?retrieveBinDetails=true
{instrumentIdentifierTokenId}
{paymentInstrumentTokenId}
id
field when you created the token.REST Example: Retrieving an Instrument Identifier with BIN Details
Request
GEThttps://apitest.cybersource.com/tms/v1/instrumentidentifiers/7049989999918257179?retrieveBinDetails=true
Response to a Successful Request
{ "_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" } } } } }