Post blocklist

Add an entry to the blocklist.

Request

Authorization

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. Don't expose this key on a website or embed it in a mobile application.

Content-Type

application/json

Body (application/json)

• type (string, enum, required) Available option:

  • card_bin

• data (string, required)

cURL

curl --request POST \
  --url https://sandbox.hyperswitch.io/blocklist \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "type": "card_bin",
  "data": "<string>"
}
'

Response

Status: 200 Content-Type: application/json Description: Fingerprint Blocked

Response example

{
  "fingerprint_id": "<string>",
  "data_kind": "payment_method",
  "created_at": "2023-11-07T05:31:56Z"
}

Response fields

• fingerprint_id (string, required)

• data_kind (enum, required) Available options:

  • payment_method

  • card_bin

  • extended_card_bin

• created_at (string, required)

Related endpoints

• GET /blocklist — Get blocklist: https://api-reference.hyperswitch.io/v1/blocklist/get-blocklist

• DELETE /blocklist — Delete blocklist: https://api-reference.hyperswitch.io/v1/blocklist/delete-blocklist

Report an issue or suggest edits

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

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