Skip to main content
GET
cURL

Authorizations

api-key
string
header
required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Profile-Id
string | null

Restricts the count to entries belonging to this business profile, plus entries with no profile. If omitted, the merchant's default profile is used; merchants with more than one profile have no default and will receive an error asking for this header.

Query Parameters

data_kind
enum<string>
required

Kind of blocklist entries to count card_bin (6 digits) and extended_card_bin (8 digits) are deprecated, use generic_card_bin, which accepts 6 to 10 digits.

Available options:
payment_method,
card_bin,
extended_card_bin,
generic_card_bin

Response

Blocklist entry counts

data_kind
enum<string>
required

card_bin (6 digits) and extended_card_bin (8 digits) are deprecated, use generic_card_bin, which accepts 6 to 10 digits.

Available options:
payment_method,
card_bin,
extended_card_bin,
generic_card_bin
total_count
integer
required

The total number of blocked entries for the given data_kind

Required range: x >= 0
counts_by_length
object | null

The number of blocked entries for each BIN length, keyed by the BIN length.

For generic_card_bin, this also includes entries blocked as card_bin or extended_card_bin. Omitted for payment_method, since fingerprints have a fixed length.