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 lookup 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.

X-Connected-Merchant-Id
string | null

Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.

Query Parameters

data
string
required

The raw value to check against the blocklist, e.g. a card BIN

transaction_type
enum<string> | null

Looks up only payment or payout when selected. When omitted, both are included. Legacy NULL transaction namespaces belong to payment. The transaction namespace of a blocklist entry, stored as text.

Available options:
payment,
payout

Response

All matches within the resolved profile, including merchant-wide entries. transaction_types contains distinct matching payment/payout namespaces, without data kinds or profile IDs.

data
string
required
blocked
boolean
required

Whether any entry matches within the resolved profile and selected transaction namespaces.

transaction_types
enum<string>[]
required

Distinct transaction types that block data, empty when blocked is false.

The transaction namespace of a blocklist entry, stored as text.

Available options:
payment,
payout