Skip to main content
POST
/
blocklist
/
batch
cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/blocklist/batch \
  --header 'Content-Type: multipart/form-data' \
  --header 'api-key: <api-key>'
{
  "job_id": "<string>",
  "total_rows": 1
}

Documentation Index

Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt

Use this file to discover all available pages before exploring further.

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.

Body

multipart/form-data

A multipart/form-data request with a file field containing a UTF-8 CSV (max 5 MB). The CSV must have a header row: type,data,metadata. type: one of card_bin (6 digits), extended_card_bin (8 digits), fingerprint. metadata: optional, key=value pairs separated by ; (e.g. reason=fraud;source=manual). Maximum 100,000 data rows.

The body is of type string.

Response

Batch blocklist job initiated

Response returned on a successful POST /blocklist/batch.

​
job_id
string
required
​
total_rows
integer<int32>
required
Required range: x >= 0
​
status
enum<string>
required
Available options:
initiated,
processing,
completed,
failed