Get blocklist

GET https://sandbox.hyperswitch.io/blocklist

Description

Retrieve blocked fingerprints.

Authentication

Header: api-key (string, 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. Do not expose this key on a website or embed it in a mobile application.

Query parameters

  • data_kind (enum, required) — Kind of the fingerprint list requested. Available options:

    • payment_method

    • card_bin

    • extended_card_bin

Example: cURL

curl
curl --request GET \
  --url https://sandbox.hyperswitch.io/blocklist \
  --header 'api-key: <api-key>'

Response: 200 application/json

Sample body:

Response fields:

  • fingerprint_id — string, required

  • data_kind — enum, required. Available options: payment_method, card_bin, extended_card_bin

  • created_at — string (date-time), required

  • Post blocklist: https://api-reference.hyperswitch.io/v1/blocklist/post-blocklist

  • Poll - Retrieve Poll Status: https://api-reference.hyperswitch.io/v1/poll/poll--retrieve-poll-status

Edit / Report issues

  • Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/blocklist/get-blocklist.mdx

  • Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/blocklist/get-blocklist