Skip to content

Get BINs

Get all available BINs (Bank Identification Numbers) for card creation

Endpoint: GET https://api.uncash.io/api/v1/bins

Response

Success Response

FieldTypeDescription
successbooleanIndicates if the request was successful
messagestringSuccess message
timestampstringISO 8601 timestamp
dataarrayArray of available BIN objects

BIN Object

FieldTypeDescription
idstringBIN identifier (UUID)
binstringBank Identification Number (6 digits)
networkstringCard network (e.g., "master", "visa")
threeDSboolean3D Secure support enabled
walletbooleanDigital wallet support enabled
currencystringSupported currency (e.g., "USD")
countrystringCountry code (e.g., "HK", "US")
initial_balancenumberInitial balance added to card upon creation

Request Example

bash
curl -X GET https://api.uncash.io/api/v1/bins \
  -H "Authorization: Bearer uc_your_api_token_here"
javascript
const response = await fetch('https://api.uncash.io/api/v1/bins', {
  headers: {
    'Authorization': 'Bearer uc_your_api_token_here'
  }
});

const data = await response.json();
python
import requests

url = "https://api.uncash.io/api/v1/bins"
headers = {"Authorization": "Bearer uc_your_api_token_here"}

response = requests.get(url, headers=headers)
data = response.json()

Response Example

json
{
  "success": true,
  "message": "Bins retrieved successfully",
  "data": [
    {
      "id": "bin-id",
      "bin": "55555",
      "network": "master",
      "threeDS": true,
      "wallet": true,
      "currency": "USD",
      "country": "HK",
      "initial_balance": 10
    },
    {
      "id": "bin-id",
      "bin": "453388",
      "network": "visa",
      "threeDS": false,
      "wallet": false,
      "currency": "USD",
      "country": "US",
      "initial_balance": 5
    }
  ],
  "timestamp": "2025-11-22T12:00:00.000Z"
}

BIN Properties Explained

  • network: The card network provider (Mastercard, Visa, etc.)
  • threeDS: Whether the BIN supports 3D Secure authentication for enhanced security
  • wallet: Whether the BIN supports digital wallet features (Apple Pay, Google Pay, etc.)
  • initial_balance: The starting balance that will be added to the card when created with this BIN
  • country: The issuing country for the BIN

Notes

BIN Selection: Choose the appropriate BIN ID when creating cards. Consider the network, threeDS, wallet, and country properties based on your use case. The initial_balance will be automatically deposited to the card upon creation.

Warning

Only BINs with status: "enabled" are returned by this endpoint. Disabled BINs cannot be used for card creation.

UnCash API Documentation