Skip to main content
GET
/
blocklist
/
batch
/
{job_id}
cURL
curl --request GET \
  --url https://sandbox.hyperswitch.io/blocklist/batch/{job_id} \
  --header 'api-key: <api-key>'
{
  "job_id": "<string>",
  "merchant_id": "<string>",
  "total_rows": 1,
  "succeeded_rows": 1,
  "failed_rows": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

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.

Path Parameters

​
job_id
string
required

The job ID returned by the batch upload endpoint

Response

Batch blocklist job status

Response for GET /blocklist/batch/{job_id}.

​
job_id
string
required
​
merchant_id
string
required
​
status
enum<string>
required
Available options:
initiated,
processing,
completed,
failed
​
total_rows
integer<int32>
required
Required range: x >= 0
​
succeeded_rows
integer<int32>
required
Required range: x >= 0
​
failed_rows
integer<int32>
required
Required range: x >= 0
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required