BIN Checker API Documentation
Our BIN Checker API lookup function allows you to automate BIN checker by a simple HTTP GET request. For casual user who is not interested to use API, similar function is available in BIN Checker page.
The function will return the result in either XML or JSON format. You can parse both format easily into various programming languages and platforms.
This page will describe on how to use our BIN Checker API and the expected result you will receive from our systems.
As part of system security and protection, you require to have an API key in order to access our API function, which will be given once you register for API Access.
General Request Format
BIN Checker through our API is very simple. What you need to do is make a GET request. Below is the example on hot to make request.
https://api.bincodes.com/bin/?format=[FORMAT]&api_key=[API_KEY]&bin=[BIN]OR https://api.bincodes.com/bin/[FORMAT]/[API_KEY]/[BIN]/
Input Data | Explanation |
---|---|
[FORMAT] | Specify the format of the output. Accept "xml" or "json". |
[API_KEY] | API Key assign to your account. |
[BIN] | BIN which you would like to check. |
1. XML Format Example
If you want to get the result in XML format, simply follow the example API request as below,
https://api.bincodes.com/bin/?format=xml&api_key=9fc53b3db09ca830488d19546a4fc2a1&bin=515735OR https://api.bincodes.com/bin/xml/9fc53b3db09ca830488d19546a4fc2a1/515735/
Expected Result in XML Format
<?xml version="1.0" encoding="utf-8" ?> <result> <bin>515735</bin> <bank>CITIBANK, N.A.</bank> <card>MASTERCARD</card> <type>CREDIT</type> <level>WORLD CARD</level> <country>UNITED STATES</country> <countrycode>US</countrycode> <website>HTTPS://ONLINE.CITIBANK.COM/</website> <phone>1-800-374-9700</phone> <valid>true</valid> </result>
2. JSON Format Example
If you want to get the result in JSON format, simply follow the example API request as below,
https://api.bincodes.com/bin/?format=json&api_key=9fc53b3db09ca830488d19546a4fc2a1&bin=515735OR https://api.bincodes.com/bin/json/9fc53b3db09ca830488d19546a4fc2a1/515735/
Expected Result in JSON Format
{ "bin": "515735", "bank": "CITIBANK, N.A.", "card": "MASTERCARD", "type": "CREDIT", "level": "WORLD CARD", "country": "UNITED STATES", "countrycode": "US", "website": "HTTPS://ONLINE.CITIBANK.COM/", "phone": "1-800-374-9700", "valid": "true" }
In some cases, the API may return a response containing error message. Below you can find a description of all possible error messages.
Error ID | Error Message | Explanation |
---|---|---|
1001 | API Key Not Specified | You need to specify your API Key while making API request. Kindly check the API Key in user area. |
1002 | Invalid API Key | Please make sure that you specify the correct API Key assign to your account. Kindly check the correct API Key in the user area. |
1003 | Suspended API Key | Your API Key was suspended due to system abuse. Kindly contact support. |
1004 | API Usage Limit Exceeded | You have exceeded the daily limit allocated to your account. You may purchase additional credit in the user area. |
1005 | Zero Premium API Credit | You need to have Premium API Credits in order to use Premium API functions. You may purchase credit in the user area. |
1006 | Insufficient API Credit | You need to have sufficient Premium API Credits in order to use Multiple Lookup API. You may purchase additional credit in the user area. |
1007 | IP Address Not Allowed | You enable IP Address whitelist but your current IP address is not in the list. You need to whitelist your IP adreess in the user area. |
1010 | BIN Not Specified | You need to specify BIN you want to check. |
1011 | Invalid BIN | Please make sure that you specify BIN in the correct format which is 6 digits long. |
1012 | BIN Not Found | The BIN that you submitted is not found in our database. |
1013 | Credit Card or Debit Card Number Not Specified | You need to specify Credit Card or Debit Card Number you want to check. |
1014 | Invalid Credit Card or Debit Card Number | Please make sure that you specify the correct Credit Card or Debit Card Number. |
1015 | Invalid Credit Card or Debit Card Number Length | Please make sure that the Credit Card or Debit Card Number has the correct length. |
1016 | Invalid Checksum | The Credit Card or Debit Card Number is invalid as it contains the wrong checksum. |
1017 | Unsupported BIN to Generate | The BIN that you submitted is not supported to generate credit card numbers. |
1018 | Unsupported Input Data to Generate | The Input Data that you submitted is not supported to generate credit card numbers. |
1019 | Country or Card or Bank Input Error | To search through API, please ensure you enter the correct country code, card brand and at least contain 3 characters of for Bank input. |
1020 | BINS Input Error | Only numbers with length between 1 to 6 digits allowed. |
1021 | Zero BIN Found | Search yield zero result. |