Skip to main content
GET
/
blocklist
/
batch
cURL
curl --request GET \
  --url https://sandbox.hyperswitch.io/blocklist/batch \
  --header 'api-key: <api-key>'
{
  "count": 1,
  "total_count": 1,
  "data": [
    {
      "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.

Query Parameters

​
limit
integer<int32> | null

Maximum number of jobs to return (default 10, max 100)

Required range: x >= 0
​
offset
integer<int32> | null

Zero-based offset for pagination (default 0)

Required range: x >= 0

Response

200 - application/json

List of batch blocklist jobs

Response for GET /blocklist/batch.

​
count
integer
required
Required range: x >= 0
​
total_count
integer
required
Required range: x >= 0
​
data
object[]
required