Skip to main content

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​

ParameterTypeRequiredDescription
org_idstringYesYour organization ID

Query Parameters​

ParameterTypeRequiredDescription
accountIdsarrayNoFilter by wallet IDs
companyProviderIdsarrayNoFilter by provider IDs
binCategoriesarrayNoFilter by category types (e.g. travel, advertising)
pageintegerNoPage number
quantityintegerNoItems 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​

FieldTypeDescription
idstringBIN category ID — use as binCategoryId when issuing a card
typestringCategory type (e.g. travel, advertising)
namestringHuman-readable category name
bins[].cardProviderBinIdstringBIN ID — use as cardProviderBinId when issuing a card
bins[].binstringFirst 6 digits of card numbers in this BIN
bins[].cardNetworkstringVisa or Mastercard
bins[].countrystringIssuing country (ISO 3166-1 alpha-2)
bins[].tokenizationsarraySupported tokenizations: Apple pay, Google pay