About this endpoint
What it does
Searches the BIN database by attribute filters — brand, bank, card type, level, country, or prefix — and returns a paginated list of matching BIN records.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| prefix | String | No | BIN starts-with filter (digits, ≤8). |
| brand | String | No | Card brand filter. |
| type | Enum | No | Card type filter. Allowed values: DEBIT, CREDIT, CHARGE. |
| level | String | No | Card level filter. |
| country | String | No | Issuer country filter (alpha-2). |
| bank | String | No | Issuer name filter (fuzzy). |
| bankExact | String | No | Issuer name filter (exact). |
| limit | Integer | No | Results per page. Default: 25. Min: 1. Max: 100. |
| offset | Integer | No | Pagination offset. Default: 0. |
| withTotal | Enum | No | Set to 1 to include an exact total count for page X of Y. |
Response
Returns a paginated JSON object: results holds the matching BIN records, while count, limit, offset, and hasMore describe the page.
| Attribute | Type | Description |
|---|---|---|
| success | Boolean | Whether the request succeeded. |
| code | Integer | Numeric response code. |
| count | Integer | Number of results in this page. |
| hasMore | Boolean | Whether more results exist beyond this page. |
| limit | Integer | Page size used. |
| offset | Integer | Pagination offset used. |
| results | Array | Matching BIN records. |
| results[].number / bin | Integer | The BIN. |
| results[].scheme / brand | String | Card network. |
| results[].type | String | DEBIT, CREDIT, or CHARGE. |
| results[].level | String | Card tier/level (may be blank). |
| results[].is_commercial | Boolean | Whether it's a commercial/business card. |
| results[].is_prepaid | Boolean | Whether it's a prepaid card. |
| results[].currency | String | Card's billing currency. |
| results[].issuer | Object | Issuing bank — name, website, phone. |
| results[].country | Object | Issuing country — name, alpha2/alpha3, currency. |



