Get BIN Options
Returns available BIN categories and their BIN configurations for card issuance. Use this to discover which BINs are available before issuing a card.
Endpoint​
POST /api/v2/organizations/{org_id}/bin-options
Path Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
org_id | string | Yes | Your organization ID |
Query Parameters​
| Parameter | Type | Required | Description |
|---|---|---|---|
accountIds | array | No | Filter by wallet IDs |
companyProviderIds | array | No | Filter by provider IDs |
binCategories | array | No | Filter by category types (e.g. travel, advertising) |
page | integer | No | Page number |
quantity | integer | No | Items per page |
Request​
curl -X POST "https://api.4pay.cc/api/v2/organizations/{org_id}/bin-options" \
-H "Authorization: Bearer YOUR_API_KEY"
With filters:
curl -X POST "https://api.4pay.cc/api/v2/organizations/{org_id}/bin-options?binCategories=travel&binCategories=advertising" \
-H "Authorization: Bearer YOUR_API_KEY"
Response​
200 OK
{
"data": [
{
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"type": "travel",
"name": "Travel Cards",
"description": "BINs optimized for travel bookings",
"bins": [
{
"cardProviderBinId": "ff246e21-3bda-4e47-83fb-05203939fe5b",
"bin": "411111",
"cardNetwork": "Visa",
"country": "US",
"tokenizations": ["Apple pay", "Google pay"]
}
]
}
],
"pagination": {
"quantity": 10,
"totalQuantity": 10,
"currentPage": 1,
"pages": 1
}
}
Response Fields​
| Field | Type | Description |
|---|---|---|
id | string | BIN category ID — use as binCategoryId when issuing a card |
type | string | Category type (e.g. travel, advertising) |
name | string | Human-readable category name |
bins[].cardProviderBinId | string | BIN ID — use as cardProviderBinId when issuing a card |
bins[].bin | string | First 6 digits of card numbers in this BIN |
bins[].cardNetwork | string | Visa or Mastercard |
bins[].country | string | Issuing country (ISO 3166-1 alpha-2) |
bins[].tokenizations | array | Supported tokenizations: Apple pay, Google pay |