Skip to main content
POST
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

The business profile every entry in this upload is blocked under. Resolution follows the same rules as blocking a single entry.

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.

Body

multipart/form-data

A multipart/form-data request with a file field containing a UTF-8 CSV (max 5 MiB). The part's filename is recorded on the job and returned as file_name. The CSV must have a header row: type,data,metadata. type: one of generic_card_bin (6 to 10 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