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 whose blocklist is exported. 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.

Response

Blocklist export started

Response for POST /blocklist/export.

export_id
string
required

Present for support and log correlation.

status
enum<string>
required
Available options:
initiated,
processing,
completed,
failed
file_name
string
required

The name this export will download as.