curl --request GET \
--url https://sandbox.hyperswitch.io/blocklist/batch \
--header 'api-key: <api-key>'import requests
url = "https://sandbox.hyperswitch.io/blocklist/batch"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://sandbox.hyperswitch.io/blocklist/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/blocklist/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/blocklist/batch"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/blocklist/batch")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/blocklist/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"total_count": 1,
"data": [
{
"job_id": "<string>",
"merchant_id": "<string>",
"job_type": "upload",
"status": "initiated",
"total_rows": 1,
"succeeded_rows": 1,
"failed_rows": 1,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"downloadable": true,
"profile_id": "pro_abcdefghijklmnop",
"file_name": "<string>",
"metadata": {
"targets": [
{
"profile_id": "pro_abcdefghijklmnop",
"status": "initiated",
"processed_rows": 1,
"error_message": "<string>"
}
]
},
"expires_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"download_url": "<string>",
"download_url_expires_at": "2023-11-07T05:31:56Z"
}
]
}Blocklist batch list
curl --request GET \
--url https://sandbox.hyperswitch.io/blocklist/batch \
--header 'api-key: <api-key>'import requests
url = "https://sandbox.hyperswitch.io/blocklist/batch"
headers = {"api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'api-key': '<api-key>'}};
fetch('https://sandbox.hyperswitch.io/blocklist/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hyperswitch.io/blocklist/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/blocklist/batch"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.hyperswitch.io/blocklist/batch")
.header("api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/blocklist/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"total_count": 1,
"data": [
{
"job_id": "<string>",
"merchant_id": "<string>",
"job_type": "upload",
"status": "initiated",
"total_rows": 1,
"succeeded_rows": 1,
"failed_rows": 1,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"downloadable": true,
"profile_id": "pro_abcdefghijklmnop",
"file_name": "<string>",
"metadata": {
"targets": [
{
"profile_id": "pro_abcdefghijklmnop",
"status": "initiated",
"processed_rows": 1,
"error_message": "<string>"
}
]
},
"expires_at": "2023-11-07T05:31:56Z",
"error_message": "<string>",
"download_url": "<string>",
"download_url_expires_at": "2023-11-07T05:31:56Z"
}
]
}Authorizations
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
Restricts the listing to jobs run for this business profile, plus jobs that predate profile scoping. When no profile can be resolved, all of the merchant's jobs are returned, as before.
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.
Query Parameters
Maximum number of jobs to return (default 10, max 100)
x >= 0Zero-based offset for pagination (default 0)
x >= 0Restricts the listing to upload, export, or profile_clone jobs. All kinds are returned when omitted, newest first.
Distinguishes bulk upload, CSV export, and profile clone jobs.
upload, export, profile_clone Response
List of batch blocklist jobs. Rows report downloadable, but never download_url - fetch the link from GET /blocklist/batch/{job_id} when the merchant asks for that specific file.
Was this page helpful?