Payouts - List using filters
curl --request POST \
--url https://sandbox.hyperswitch.io/payouts/list \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_order_reference_id": "merchant_order_ref_123",
"profile_id": "<string>",
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"limit": 50,
"offset": 10000,
"connector": [
"wise",
"adyen"
],
"status": [
"pending",
"failed"
],
"payout_method": [
"bank",
"card"
]
}
'import requests
url = "https://sandbox.hyperswitch.io/payouts/list"
payload = {
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_order_reference_id": "merchant_order_ref_123",
"profile_id": "<string>",
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"limit": 50,
"offset": 10000,
"connector": ["wise", "adyen"],
"status": ["pending", "failed"],
"payout_method": ["bank", "card"]
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
payout_id: '187282ab-40ef-47a9-9206-5099ba31e432',
merchant_order_reference_id: 'merchant_order_ref_123',
profile_id: '<string>',
customer_id: 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
limit: 50,
offset: 10000,
connector: ['wise', 'adyen'],
status: ['pending', 'failed'],
payout_method: ['bank', 'card']
})
};
fetch('https://sandbox.hyperswitch.io/payouts/list', 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/payouts/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'payout_id' => '187282ab-40ef-47a9-9206-5099ba31e432',
'merchant_order_reference_id' => 'merchant_order_ref_123',
'profile_id' => '<string>',
'customer_id' => 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
'limit' => 50,
'offset' => 10000,
'connector' => [
'wise',
'adyen'
],
'status' => [
'pending',
'failed'
],
'payout_method' => [
'bank',
'card'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/payouts/list"
payload := strings.NewReader("{\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"payout_id\": \"187282ab-40ef-47a9-9206-5099ba31e432\",\n \"merchant_order_reference_id\": \"merchant_order_ref_123\",\n \"profile_id\": \"<string>\",\n \"customer_id\": \"cus_y3oqhf46pyzuxjbcn2giaqnb44\",\n \"limit\": 50,\n \"offset\": 10000,\n \"connector\": [\n \"wise\",\n \"adyen\"\n ],\n \"status\": [\n \"pending\",\n \"failed\"\n ],\n \"payout_method\": [\n \"bank\",\n \"card\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/payouts/list")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"payout_id\": \"187282ab-40ef-47a9-9206-5099ba31e432\",\n \"merchant_order_reference_id\": \"merchant_order_ref_123\",\n \"profile_id\": \"<string>\",\n \"customer_id\": \"cus_y3oqhf46pyzuxjbcn2giaqnb44\",\n \"limit\": 50,\n \"offset\": 10000,\n \"connector\": [\n \"wise\",\n \"adyen\"\n ],\n \"status\": [\n \"pending\",\n \"failed\"\n ],\n \"payout_method\": [\n \"bank\",\n \"card\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/payouts/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"payout_id\": \"187282ab-40ef-47a9-9206-5099ba31e432\",\n \"merchant_order_reference_id\": \"merchant_order_ref_123\",\n \"profile_id\": \"<string>\",\n \"customer_id\": \"cus_y3oqhf46pyzuxjbcn2giaqnb44\",\n \"limit\": 50,\n \"offset\": 10000,\n \"connector\": [\n \"wise\",\n \"adyen\"\n ],\n \"status\": [\n \"pending\",\n \"failed\"\n ],\n \"payout_method\": [\n \"bank\",\n \"card\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"size": 1,
"data": [
{
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_id": "merchant_1668273825",
"amount": 1000,
"currency": "AED",
"auto_fulfill": true,
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
"return_url": "https://hyperswitch.io",
"business_country": "AF",
"entity_type": "Individual",
"recurring": false,
"status": "success",
"profile_id": "<string>",
"merchant_order_reference_id": "merchant_order_ref_123",
"connector": "wise",
"payout_type": "card",
"payout_method_data": {
"card": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_holder_name": "John Doe",
"card_issuer": "<string>",
"card_network": "Visa",
"card_type": "<string>",
"card_issuing_country": "<string>",
"bank_code": "<string>",
"last4": "<string>",
"card_isin": "<string>",
"card_extended_bin": "<string>"
}
},
"source_bank_data": {
"card": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_holder_name": "John Doe",
"card_issuer": "<string>",
"card_network": "Visa",
"card_type": "<string>",
"card_issuing_country": "<string>",
"bank_code": "<string>",
"last4": "<string>",
"card_isin": "<string>",
"card_extended_bin": "<string>"
}
},
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1",
"customer_document_details": {
"document_type": "cpf",
"document_number": "12345678911"
}
},
"business_label": "food",
"description": "It's my first payout request",
"billing_descriptor": {
"reference": "<string>",
"statement_descriptor": "<string>"
},
"metadata": {},
"merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
"error_message": "Failed while verifying the card",
"error_code": "E0001",
"created": "2022-09-10T10:11:12Z",
"connector_transaction_id": "S3FC9G9M2MVFDXT5",
"connector_eligibility_reference_id": "8ad8bf30-5789-52be-a80a-72908abf5f9d",
"priority": "instant",
"attempts": [
{
"attempt_id": "<string>",
"status": "success",
"amount": 6583,
"currency": "AED",
"connector": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"payment_method": "card",
"payout_method_type": "ach",
"connector_transaction_id": "<string>",
"cancellation_reason": "<string>",
"unified_code": "UE_000",
"unified_message": "Invalid card details"
}
],
"payout_link": {
"payout_link_id": "<string>",
"link": "<string>"
},
"email": "johntest@test.com",
"name": "John Test",
"phone": "9123456789",
"phone_country_code": "+1",
"unified_code": "UE_000",
"unified_message": "Invalid card details",
"payout_method_id": "<string>"
}
],
"total_count": 123
}Payouts
Payouts - List using filters
POST
/
payouts
/
list
Payouts - List using filters
curl --request POST \
--url https://sandbox.hyperswitch.io/payouts/list \
--header 'Content-Type: application/json' \
--header 'api-key: <api-key>' \
--data '
{
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_order_reference_id": "merchant_order_ref_123",
"profile_id": "<string>",
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"limit": 50,
"offset": 10000,
"connector": [
"wise",
"adyen"
],
"status": [
"pending",
"failed"
],
"payout_method": [
"bank",
"card"
]
}
'import requests
url = "https://sandbox.hyperswitch.io/payouts/list"
payload = {
"start_time": "2023-11-07T05:31:56Z",
"end_time": "2023-11-07T05:31:56Z",
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_order_reference_id": "merchant_order_ref_123",
"profile_id": "<string>",
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"limit": 50,
"offset": 10000,
"connector": ["wise", "adyen"],
"status": ["pending", "failed"],
"payout_method": ["bank", "card"]
}
headers = {
"api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start_time: '2023-11-07T05:31:56Z',
end_time: '2023-11-07T05:31:56Z',
payout_id: '187282ab-40ef-47a9-9206-5099ba31e432',
merchant_order_reference_id: 'merchant_order_ref_123',
profile_id: '<string>',
customer_id: 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
limit: 50,
offset: 10000,
connector: ['wise', 'adyen'],
status: ['pending', 'failed'],
payout_method: ['bank', 'card']
})
};
fetch('https://sandbox.hyperswitch.io/payouts/list', 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/payouts/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_time' => '2023-11-07T05:31:56Z',
'end_time' => '2023-11-07T05:31:56Z',
'payout_id' => '187282ab-40ef-47a9-9206-5099ba31e432',
'merchant_order_reference_id' => 'merchant_order_ref_123',
'profile_id' => '<string>',
'customer_id' => 'cus_y3oqhf46pyzuxjbcn2giaqnb44',
'limit' => 50,
'offset' => 10000,
'connector' => [
'wise',
'adyen'
],
'status' => [
'pending',
'failed'
],
'payout_method' => [
'bank',
'card'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hyperswitch.io/payouts/list"
payload := strings.NewReader("{\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"payout_id\": \"187282ab-40ef-47a9-9206-5099ba31e432\",\n \"merchant_order_reference_id\": \"merchant_order_ref_123\",\n \"profile_id\": \"<string>\",\n \"customer_id\": \"cus_y3oqhf46pyzuxjbcn2giaqnb44\",\n \"limit\": 50,\n \"offset\": 10000,\n \"connector\": [\n \"wise\",\n \"adyen\"\n ],\n \"status\": [\n \"pending\",\n \"failed\"\n ],\n \"payout_method\": [\n \"bank\",\n \"card\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/payouts/list")
.header("api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"payout_id\": \"187282ab-40ef-47a9-9206-5099ba31e432\",\n \"merchant_order_reference_id\": \"merchant_order_ref_123\",\n \"profile_id\": \"<string>\",\n \"customer_id\": \"cus_y3oqhf46pyzuxjbcn2giaqnb44\",\n \"limit\": 50,\n \"offset\": 10000,\n \"connector\": [\n \"wise\",\n \"adyen\"\n ],\n \"status\": [\n \"pending\",\n \"failed\"\n ],\n \"payout_method\": [\n \"bank\",\n \"card\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/payouts/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_time\": \"2023-11-07T05:31:56Z\",\n \"end_time\": \"2023-11-07T05:31:56Z\",\n \"payout_id\": \"187282ab-40ef-47a9-9206-5099ba31e432\",\n \"merchant_order_reference_id\": \"merchant_order_ref_123\",\n \"profile_id\": \"<string>\",\n \"customer_id\": \"cus_y3oqhf46pyzuxjbcn2giaqnb44\",\n \"limit\": 50,\n \"offset\": 10000,\n \"connector\": [\n \"wise\",\n \"adyen\"\n ],\n \"status\": [\n \"pending\",\n \"failed\"\n ],\n \"payout_method\": [\n \"bank\",\n \"card\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"size": 1,
"data": [
{
"payout_id": "187282ab-40ef-47a9-9206-5099ba31e432",
"merchant_id": "merchant_1668273825",
"amount": 1000,
"currency": "AED",
"auto_fulfill": true,
"customer_id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"client_secret": "pay_U42c409qyHwOkWo3vK60_secret_el9ksDkiB8hi6j9N78yo",
"return_url": "https://hyperswitch.io",
"business_country": "AF",
"entity_type": "Individual",
"recurring": false,
"status": "success",
"profile_id": "<string>",
"merchant_order_reference_id": "merchant_order_ref_123",
"connector": "wise",
"payout_type": "card",
"payout_method_data": {
"card": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_holder_name": "John Doe",
"card_issuer": "<string>",
"card_network": "Visa",
"card_type": "<string>",
"card_issuing_country": "<string>",
"bank_code": "<string>",
"last4": "<string>",
"card_isin": "<string>",
"card_extended_bin": "<string>"
}
},
"source_bank_data": {
"card": {
"card_exp_month": "01",
"card_exp_year": "2026",
"card_holder_name": "John Doe",
"card_issuer": "<string>",
"card_network": "Visa",
"card_type": "<string>",
"card_issuing_country": "<string>",
"bank_code": "<string>",
"last4": "<string>",
"card_isin": "<string>",
"card_extended_bin": "<string>"
}
},
"billing": {
"address": {
"city": "New York",
"country": "AF",
"line1": "123, King Street",
"line2": "Powelson Avenue",
"line3": "Bridgewater",
"zip": "08807",
"state": "New York",
"first_name": "John",
"last_name": "Doe",
"origin_zip": "08807"
},
"phone": {
"number": "9123456789",
"country_code": "+1"
},
"email": "<string>"
},
"customer": {
"id": "cus_y3oqhf46pyzuxjbcn2giaqnb44",
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1",
"customer_document_details": {
"document_type": "cpf",
"document_number": "12345678911"
}
},
"business_label": "food",
"description": "It's my first payout request",
"billing_descriptor": {
"reference": "<string>",
"statement_descriptor": "<string>"
},
"metadata": {},
"merchant_connector_id": "mca_sAD3OZLATetvjLOYhUSy",
"error_message": "Failed while verifying the card",
"error_code": "E0001",
"created": "2022-09-10T10:11:12Z",
"connector_transaction_id": "S3FC9G9M2MVFDXT5",
"connector_eligibility_reference_id": "8ad8bf30-5789-52be-a80a-72908abf5f9d",
"priority": "instant",
"attempts": [
{
"attempt_id": "<string>",
"status": "success",
"amount": 6583,
"currency": "AED",
"connector": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"payment_method": "card",
"payout_method_type": "ach",
"connector_transaction_id": "<string>",
"cancellation_reason": "<string>",
"unified_code": "UE_000",
"unified_message": "Invalid card details"
}
],
"payout_link": {
"payout_link_id": "<string>",
"link": "<string>"
},
"email": "johntest@test.com",
"name": "John Test",
"phone": "9123456789",
"phone_country_code": "+1",
"unified_code": "UE_000",
"unified_message": "Invalid card details",
"payout_method_id": "<string>"
}
],
"total_count": 123
}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.
Body
application/json
A type representing a range of time for filtering, including a mandatory start time and an optional end time.
The start time to filter payments list or to get list of filters. To get list of filters start time is needed to be passed
The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.
Available options:
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW, ZWL Type of entity to whom the payout is being carried out to, select from the given list of options
Available options:
Individual, Company, NonProfit, PublicSector, NaturalPerson, lowercase, Personal The end time to filter payments list or to get list of filters. If not passed the default time is now
The identifier for payout
Required string length:
30Example:
"187282ab-40ef-47a9-9206-5099ba31e432"
The merchant order reference ID for payout
Maximum string length:
255Example:
"merchant_order_ref_123"
The identifier for business profile
The identifier for customer
Example:
"cus_y3oqhf46pyzuxjbcn2giaqnb44"
Required range:
1 <= x <= 100Required range:
0 <= x <= 20000The list of connectors to filter payouts list
Available options:
adyen, adyenplatform, cybersource, deutschebank, ebanx, gigadat, gotyme_sanlam, loonio, nomupay, nuvei, payone, paypal, stripe, truelayer, trustly, wise, worldpay, worldpayxml, envoy, itaubank, santander Example:
["wise", "adyen"]
The list of payout status to filter payouts list
Available options:
success, failed, cancelled, initiated, expired, reversed, pending, ineligible, not_permitted, requires_creation, requires_confirmation, requires_payout_method_data, requires_fulfillment, requires_vendor_account_creation Example:
["pending", "failed"]
The list of payout methods to filter payouts list
The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.
Available options:
card, bank, wallet, bank_redirect Example:
["bank", "card"]
Was this page helpful?