GuidesAPI ReferenceRelease Notes

Bin Lookup

Suggest Edits

📘

BIN lookup is a subscription service. Contact [email protected] or [email protected] to gain access to our BIN lookup product.

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

EnvironmentURL
Testhttps://test-htp.tokenex.com/api/sdk/BinLookup

API Parameters

ParameterData TypeDescription
TokenExIDstringThe merchant's TokenEx ID.
TimestampstringThe timestamp (UTC) when the hash is generated, in yyyyMMddHHmmss format.
AuthenticationKeystringThe Authentication Key generated on the merchant's server.
PanstringThe PAN to lookup in BIN database
TokenSchemeenumThe 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=",
  "pan": "4109931020342877",
  "tokenScheme": "sixTOKENfour"
}

Response

{
    "Error": null,
    "Success": true,
    "ReferenceNumber": "24032109095063825804",
    "BinData": {
        "BinMin": "4109931020000000000",
        "BinMax": "4109931029999999999",
        "BinLength": 8,
        "CleanBankName": "Metro Credit Union",
        "ProductName": "Visa Traditional",
        "CardBrand": "VISA",
        "CountryAlpha2": "US",
        "CountryName": "UNITED STATES OF AMERICA",
        "CountryNumeric": "840",
        "Type": "Credit",
        "BankName": "METRO CREDIT UNION",
        "BankUrl": "",
        "BankPhone": "",
        "ProductCode": "A",
        "Prepaid": false,
        "Regulated": false,
        "RegulatedName": "GOVERNMENT EXEMPT INTERCHANGE FEE",
        "Reloadable": false,
        "PanOrToken": "pan",
        "AccountUpdater": false,
        "Alm": false,
        "DomesticOnly": false,
        "GamblingBlocked": false,
        "Level2": false,
        "Level3": false,
        "IssuerCurrency": "USD",
        "CardSegmentType": "Consumer",
        "ComboCard": "",
        "CardBrandIsAdditional": false,
        "CorrelationId": "eyJGaWxlSWQiOjcxMzcsIlZlcnNpb24iOjQwfQ==",
        "SharedBin": false,
        "Cost": [],
        "Authentication": [],
        "AdditionalCardBrands": []
    }
}

Updated 17 days ago