BIN Lookup

curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/bin/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>' \
  --data '
{
  "bin": "41111111"
}
'

import requests

url = "https://api-pacb-uat.eximpe.com/pg/bin/"

payload = { "bin": "41111111" }
headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "X-Merchant-ID": "<api-key>",
    "X-API-Version": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'X-Merchant-ID': '<api-key>',
    'X-API-Version': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({bin: '41111111'})
};

fetch('https://api-pacb-uat.eximpe.com/pg/bin/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-pacb-uat.eximpe.com/pg/bin/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bin' => '41111111'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Version: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>",
    "X-Merchant-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-pacb-uat.eximpe.com/pg/bin/"

	payload := strings.NewReader("{\n  \"bin\": \"41111111\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("X-Merchant-ID", "<api-key>")
	req.Header.Add("X-API-Version", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-pacb-uat.eximpe.com/pg/bin/")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("X-Merchant-ID", "<api-key>")
  .header("X-API-Version", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bin\": \"41111111\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-pacb-uat.eximpe.com/pg/bin/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-Merchant-ID"] = '<api-key>'
request["X-API-Version"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bin\": \"41111111\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "BIN lookup successful",
  "data": {
    "bank": "hdfc bank",
    "network": "visa",
    "card_type": "credit_card",
    "is_domestic": true
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_BIN_001",
    "message": "Validation error",
    "details": {
      "bin": "BIN code must be 8 digits"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_AUTH_000",
    "message": "Missing credentials",
    "details": {
      "authentication": "Missing credentials."
    }
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_SERVICE_ERROR_000",
    "message": "Payment gateway error",
    "details": {
      "error": "An unexpected error occurred. Please try again later"
    }
  }
}

POST

bin

BIN Lookup

curl --request POST \
  --url https://api-pacb-uat.eximpe.com/pg/bin/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>' \
  --header 'X-Merchant-ID: <api-key>' \
  --data '
{
  "bin": "41111111"
}
'

import requests

url = "https://api-pacb-uat.eximpe.com/pg/bin/"

payload = { "bin": "41111111" }
headers = {
    "X-Client-ID": "<api-key>",
    "X-Client-Secret": "<api-key>",
    "X-Merchant-ID": "<api-key>",
    "X-API-Version": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Client-ID': '<api-key>',
    'X-Client-Secret': '<api-key>',
    'X-Merchant-ID': '<api-key>',
    'X-API-Version': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({bin: '41111111'})
};

fetch('https://api-pacb-uat.eximpe.com/pg/bin/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-pacb-uat.eximpe.com/pg/bin/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'bin' => '41111111'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Version: <api-key>",
    "X-Client-ID: <api-key>",
    "X-Client-Secret: <api-key>",
    "X-Merchant-ID: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api-pacb-uat.eximpe.com/pg/bin/"

	payload := strings.NewReader("{\n  \"bin\": \"41111111\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Client-ID", "<api-key>")
	req.Header.Add("X-Client-Secret", "<api-key>")
	req.Header.Add("X-Merchant-ID", "<api-key>")
	req.Header.Add("X-API-Version", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api-pacb-uat.eximpe.com/pg/bin/")
  .header("X-Client-ID", "<api-key>")
  .header("X-Client-Secret", "<api-key>")
  .header("X-Merchant-ID", "<api-key>")
  .header("X-API-Version", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bin\": \"41111111\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-pacb-uat.eximpe.com/pg/bin/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-ID"] = '<api-key>'
request["X-Client-Secret"] = '<api-key>'
request["X-Merchant-ID"] = '<api-key>'
request["X-API-Version"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bin\": \"41111111\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "BIN lookup successful",
  "data": {
    "bank": "hdfc bank",
    "network": "visa",
    "card_type": "credit_card",
    "is_domestic": true
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_BIN_001",
    "message": "Validation error",
    "details": {
      "bin": "BIN code must be 8 digits"
    }
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_AUTH_000",
    "message": "Missing credentials",
    "details": {
      "authentication": "Missing credentials."
    }
  }
}

{
  "success": false,
  "error": {
    "code": "ERR_SERVICE_ERROR_000",
    "message": "Payment gateway error",
    "details": {
      "error": "An unexpected error occurred. Please try again later"
    }
  }
}

Overview

The BIN Lookup endpoint allows you to retrieve card information by providing the first 8 digits of a card number (BIN). This is useful for identifying card details before processing a payment, enabling you to:

Determine card network (visa, mastercard, rupay, amex, etc.)
Identify card type (credit or debit)
Get bank information
Check if the card is domestic or international

This endpoint helps you provide better user experience by pre-validating card information and displaying appropriate payment options.

Production Requirement: In production, this feature needs to be enabled for your account to receive BIN lookup values. Please contact support to enable BIN lookup functionality for your production environment.

Use Cases

Pre-validation: Validate card details before submitting payment
UI Enhancement: Show card network logo or bank name as user types
Payment Flow Optimization: Determine payment method eligibility based on card type
Fraud Prevention: Identify potentially suspicious cards before processing

Request

Endpoint

POST /pg/bin/

Headers

Header	Required	Description
`X-Client-ID`	Yes	Your Client ID
`X-Client-Secret`	Yes	Your Client Secret
`X-Merchant-ID`	Conditionally	Required for PSP merchants managing multiple merchant accounts
`X-API-Version: V2 (e.g., “v2.0.0”))
`Content-Type`	Yes	Must be `application/json`

Request Body

Parameter	Type	Required	Description	Constraints
`bin`	string	Yes	BIN code (first 8 digits of card number)	Pattern: `^[0-9]{6,9}$`

Example Request

curl -X POST https://api-pacb-uat.eximpe.com/pg/bin/ \
  -H "Content-Type: application/json" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -d '{
    "bin": "41111111"
  }'

Response

Success Response (200 OK)

{
  "success": true,
  "message": "BIN lookup successful",
  "data": {
    "bank": "hdfc bank",
    "network": "visa",
    "card_type": "credit_card",
    "is_domestic": true
  }
}

Response Fields

Field	Type	Description
`success`	boolean	Indicates if the request was successful
`message`	string	Response message
`data`	object	BIN lookup data
`data.bank`	string	Bank name that issued the card
`data.network`	string	Card network (visa, mastercard, rupay, amex, diners, maestro, sbi_maestro)
`data.card_type`	string	Card type (`credit_card` or `debit_card`)
`data.is_domestic`	boolean	Whether the card is domestic (issued in India) or international

Error Responses

400 Bad Request - Invalid BIN

{
  "success": false,
  "error": {
    "code": "ERR_BIN_001",
    "message": "Validation error",
    "details": {
      "bin": "BIN code must be 8 digits"
    }
  }
}

401 Unauthorized

{
  "success": false,
  "error": {
    "code": "ERR_AUTH_000",
    "message": "Missing credentials",
    "details": {
      "authentication": "Missing credentials."
    }
  }
}

500 Internal Server Error

{
  "success": false,
  "error": {
    "code": "ERR_SERVICE_ERROR_000",
    "message": "Payment gateway error",
    "details": {
      "error": "An unexpected error occurred. Please try again later"
    }
  }
}

Examples

JavaScript/TypeScript

async function lookupBIN(binCode) {
  const response = await fetch('https://api-pacb-uat.eximpe.com/pg/bin/', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-Client-ID': 'your-client-id',
      'X-Client-Secret': 'your-client-secret'
    },
    body: JSON.stringify({
      bin: binCode
    })
  });

  const data = await response.json();
  
  if (data.success) {
    console.log('Network:', data.data.network);
    console.log('Card Type:', data.data.card_type);
    console.log('Bank:', data.data.bank);
    console.log('Domestic:', data.data.is_domestic);
  } else {
    console.error('Error:', data.error);
  }
  
  return data;
}

// Usage
lookupBIN('41111111');

Python

import requests

def lookup_bin(bin_code):
    url = "https://api-pacb-uat.eximpe.com/pg/bin/"
    headers = {
        "Content-Type": "application/json",
        "X-Client-ID": "your-client-id",
        "X-Client-Secret": "your-client-secret"
    }
    payload = {
        "bin": bin_code
    }
    
    response = requests.post(url, json=payload, headers=headers)
    data = response.json()
    
    if data.get("success"):
        bin_data = data["data"]
        print(f"Network: {bin_data.get('network')}")
        print(f"Card Type: {bin_data.get('card_type')}")
        print(f"Bank: {bin_data.get('bank')}")
        print(f"Domestic: {bin_data.get('is_domestic')}")
    else:
        print(f"Error: {data.get('error')}")
    
    return data

# Usage
lookup_bin("41111111")

Notes

BIN code must be 8 digits
The endpoint returns null values for fields that cannot be determined
Card network values (visa, mastercard, etc.)
Bank names are returned
is_domestic is true for cards issued in India, false for international cards

Authorizations

X-Client-ID

string

header

required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret

string

header

required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-Merchant-ID

string

header

required

Merchant Identifier - The unique ID for the merchant account. This is required for PSP (Payment Service Provider) merchants who manage multiple merchant accounts. You can find merchant IDs in the Merchant Management section of the dashboard.

X-API-Version

string

header

required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Body

application/json

BIN lookup request

bin

string

required

BIN code (first 6-8 digits of card number)

Pattern: ^[0-9]{6,9}$

Example:

"41111111"

Response

BIN lookup successful

success

boolean

required

Indicates if the request was successful

message

string

required

Response message

data

object

required

Show child attributes

Simulate VBA Transfer MERCHANT APPROVED

Order

Payment

Card Tokens

Merchant

Settlement

Refund

Subscriptions

Payment Links

Virtual Bank Accounts

Utilities

Webhooks

BIN Lookup

Overview

Use Cases

Request

Endpoint

Headers

Request Body

Example Request

Response

Success Response (200 OK)

Response Fields

Error Responses

400 Bad Request - Invalid BIN

401 Unauthorized

500 Internal Server Error

Examples

JavaScript/TypeScript

Python

Notes

Authorizations

Body

Response

​Overview

​Use Cases

​Request

​Endpoint

​Headers

​Request Body

​Example Request

​Response

​Success Response (200 OK)

​Response Fields

​Error Responses

​400 Bad Request - Invalid BIN

​401 Unauthorized

​500 Internal Server Error

​Examples

​JavaScript/TypeScript

​Python

​Notes

Authorizations

Body

Response

Overview

Use Cases

Request

Endpoint

Headers

Request Body

Example Request

Response

Success Response (200 OK)

Response Fields

Error Responses

400 Bad Request - Invalid BIN

401 Unauthorized

500 Internal Server Error

Examples

JavaScript/TypeScript

Python

Notes