Bin Lookup

The BIN Lookup endpoint uses the same authentication model as the Tokenize method in the Mobile API. See the documentation for generating the authentication key here.

Endpoints

Environment	URL
Test	https://test-htp.tokenex.com/api/sdk/BinLookup

API Parameters

Parameter	Data Type	Description
TokenExID	string	The merchant's TokenEx ID.
Timestamp	string	The timestamp (UTC) when the hash is generated, in `yyyyMMddHHmmss` format.
AuthenticationKey	string	The Authentication Key generated on the merchant's server.
Data	string	The PAN to lookup in BIN database
TokenScheme	enum	The Token Scheme to be used to tokenize the provided data. See https://docs.tokenex.com/?page=appendix#token-schemes for TokenSchemes.

Request

{
  "tokenexid": "YourTokenExID",
  "timestamp": "20180109161437",
  "authenticationKey": "3mHJFag1ICQiwRdSw1QY86WUvt3IDklswf6AA/q+wdU=",
  "data": "5454545454545454",
  "tokenScheme": "sixTOKENfour"
}

Response

{
    "Error": null,
    "Success": true,
    "ReferenceNumber": "23102312330562511610",
    "BinData": {
        "BinMin": "4984710000000000000",
        "BinMax": "4984719999999999999",
        "BinLength": 6,
        "CleanBankName": "",
        "ProductName": "Visa Classic",
        "CardBrand": "VISA",
        "CountryAlpha2": "US",
        "CountryName": "UNITED STATES OF AMERICA",
        "CountryNumeric": "840",
        "Type": "Debit",
        "BankName": "GBC INTERNATIONAL BANK",
        "BankUrl": "",
        "BankPhone": "",
        "ProductCode": "F",
        "Prepaid": false,
        "Regulated": false,
        "RegulatedName": "GOVERNMENT EXEMPT INTERCHANGE FEE",
        "Reloadable": false,
        "PanOrToken": "pan",
        "AccountUpdater": true,
        "Alm": false,
        "DomesticOnly": false,
        "GamblingBlocked": false,
        "Level2": false,
        "Level3": false,
        "IssuerCurrency": "USD",
        "CardSegmentType": "Consumer",
        "ComboCard": "",
        "CardBrandIsAdditional": false,
        "CorrelationId": "eyJGaWxlSWQiOjc2OTEsIlZlcnNpb24iOjQyfQ==",
        "SharedBin": false,
        "Cost": [
            {
                "CapFixedAmount": 0.21,
                "CapAdvaloremAmount": 0.0005,
                "CapTypeQualifierText": "US DURBIN REGULATION DEBIT VISA"
            }
        ],
        "Authentication": []
    }
}