▣ DATA VALIDATION · FINANCE

Search & Filter BIN Database API

What it does

BIN Lookup helps you search card issuer data by bank and card attributes. Send query parameters such as bank, type, brand, level, prefix, country, or bankExact, and get back a response envelope with a numeric code, a success flag, and module blocks.

Use it when you need to check a card prefix against issuer metadata before accepting a payment, filtering test card sets, or grouping payment traffic by brand or card type. The search supports pagination with limit and offset, and can optionally include total counts with withTotal=1.

The type filter accepts DEBIT, CREDIT, or CHARGE, which makes it useful for payment flows that need to distinguish card classes. You can combine filters to narrow results by bank name, exact bank name, country, brand, or level.

BIN Lookup is a lightweight way to query BIN-related records without parsing payment data yourself. It is useful anywhere you need issuer lookup, card classification, or BIN-based filtering in real time.

GET

BIN Search

https://api.eu.apyhub.com/quadlem/bin-search

QUICKSTART

GUIDE

Quickstart

Use the following request to browse BIN records and filter them by card type. Pagination parameters let you retrieve the results in manageable pages.

curl -X GET "https://api.eu.apyhub.com/quadlem/bin-search?type=DEBIT&limit=25&offset=0&withTotal=1" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

A successful request returns a paginated list of BIN records matching the specified filters, along with pagination metadata.

{
  "success": true,
  "code": 200,
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "results": [
    {
      "number": 10051,
      "bin": 10051,
      "scheme": "EXAMPLE BRAND",
      "type": "DEBIT",
      "currency": "EUR",
      "issuer": {
        "name": ""
      },
      "country": {
        "name": "ITALY",
        "alpha2": "IT",
        "currency": "EUR"
      }
    }
  ]
}

Note: The results array is truncated in this example. The full response returns up to the specified limit of BIN records per page. Use the offset parameter to retrieve additional pages of results.

TRY ITLIVE · 40 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

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

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.

Query parameters

Name

Type

Description

bankOPTIONAL

string

—

typeOPTIONAL

string

DEBIT · CREDIT · CHARGE

—

brandOPTIONAL

string

—

levelOPTIONAL

string

—

limitOPTIONAL

integer

—

DEFAULT 25

offsetOPTIONAL

integer

—

DEFAULT 0

prefixOPTIONAL

string

—

countryOPTIONAL

string

—

bankExactOPTIONAL

string

—

withTotalOPTIONAL

string

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.