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

Path Parameters

job_id
string
required

The job ID returned by the batch upload endpoint, or the export ID returned by POST /blocklist/export

Response

Batch blocklist job status. For a completed export whose file is still stored, this is where the short-lived download_url is issued.

One batch blocklist job, as returned by the listing and by GET /blocklist/batch/{job_id}.

job_id
string
required
merchant_id
string
required
job_type
enum<string>
required

Distinguishes bulk upload, CSV export, and profile clone jobs.

Available options:
upload,
export,
profile_clone
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
downloadable
boolean
required

Whether this job's file can be fetched right now.

profile_id
string | null

The profile that owns this job; for a clone job, the profile whose entries are copied.

Example:

"pro_abcdefghijklmnop"

file_name
string | null

The file the merchant uploaded, or the name the export downloads as. Clone jobs return null.

metadata
object | null

Progress of a profile-clone job across its target profiles.

expires_at
string<date-time> | null

Exports only: when the stored file is removed by the storage lifecycle rule.

error_message
string | null
download_url
string | null

Exports only: short-lived signed link, generated per request and never stored. Null in the listing, which does not mint a link per row.

download_url_expires_at
string<date-time> | null