curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payments/list \
--header 'Authorization: <api-key>' \
--header 'X-Profile-Id: <x-profile-id>'import requests
url = "https://sandbox.hyperswitch.io/v2/payments/list"
headers = {
"X-Profile-Id": "<x-profile-id>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Profile-Id': '<x-profile-id>', Authorization: '<api-key>'}
};
fetch('https://sandbox.hyperswitch.io/v2/payments/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/v2/payments/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"X-Profile-Id: <x-profile-id>"
],
]);
$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/v2/payments/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Profile-Id", "<x-profile-id>")
req.Header.Add("Authorization", "<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/v2/payments/list")
.header("X-Profile-Id", "<x-profile-id>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/v2/payments/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"total_count": 123,
"data": [
{
"id": "0a_pay_01926c58bc6e77c09e809964e72af8c8",
"merchant_id": "merchant_1668273825",
"profile_id": "<string>",
"status": "requires_confirmation",
"amount": {
"currency": "AED",
"external_tax_calculation": "skip",
"surcharge_calculation": "skip",
"net_amount": 123,
"amount_capturable": 123,
"order_amount": 6540,
"shipping_cost": 123,
"order_tax_amount": 123,
"surcharge_amount": 123,
"tax_on_surcharge": 123,
"amount_to_capture": 123,
"amount_captured": 123
},
"created": "2022-09-10T10:11:12Z",
"attempt_count": 123,
"return_url": "https://hyperswitch.io",
"is_split_payment": true,
"customer_id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
"payment_method_id": "<string>",
"payment_method_type": "card",
"payment_method_subtype": "ach",
"connector": "absa_sanlam",
"merchant_connector_id": "<string>",
"customer": {
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1"
},
"merchant_reference_id": "<string>",
"connector_payment_id": "993672945374576J",
"connector_response_reference_id": "<string>",
"metadata": {},
"description": "It's my first payment request",
"authentication_type": "three_ds",
"capture_method": "automatic",
"setup_future_usage": "off_session",
"error": {
"code": "card_declined",
"message": "The card was declined.",
"reason": "The card was declined.",
"unified_code": "card_declined",
"unified_message": "The card was declined.",
"network_advice_code": "01",
"network_decline_code": "05",
"network_error_message": "Do not retry"
},
"cancellation_reason": "<string>",
"order_details": "[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]",
"statement_descriptor": "Hyperswitch Router",
"allowed_payment_method_types": [
"ach"
],
"authorization_count": 123,
"modified_at": "2022-09-10T10:11:12Z"
}
]
}Payments - List
List payments and their total count within the authenticated X-Profile-Id. An optional profile_id query filter must match X-Profile-Id.
curl --request GET \
--url https://sandbox.hyperswitch.io/v2/payments/list \
--header 'Authorization: <api-key>' \
--header 'X-Profile-Id: <x-profile-id>'import requests
url = "https://sandbox.hyperswitch.io/v2/payments/list"
headers = {
"X-Profile-Id": "<x-profile-id>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Profile-Id': '<x-profile-id>', Authorization: '<api-key>'}
};
fetch('https://sandbox.hyperswitch.io/v2/payments/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/v2/payments/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"X-Profile-Id: <x-profile-id>"
],
]);
$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/v2/payments/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Profile-Id", "<x-profile-id>")
req.Header.Add("Authorization", "<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/v2/payments/list")
.header("X-Profile-Id", "<x-profile-id>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hyperswitch.io/v2/payments/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Profile-Id"] = '<x-profile-id>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"count": 1,
"total_count": 123,
"data": [
{
"id": "0a_pay_01926c58bc6e77c09e809964e72af8c8",
"merchant_id": "merchant_1668273825",
"profile_id": "<string>",
"status": "requires_confirmation",
"amount": {
"currency": "AED",
"external_tax_calculation": "skip",
"surcharge_calculation": "skip",
"net_amount": 123,
"amount_capturable": 123,
"order_amount": 6540,
"shipping_cost": 123,
"order_tax_amount": 123,
"surcharge_amount": 123,
"tax_on_surcharge": 123,
"amount_to_capture": 123,
"amount_captured": 123
},
"created": "2022-09-10T10:11:12Z",
"attempt_count": 123,
"return_url": "https://hyperswitch.io",
"is_split_payment": true,
"customer_id": "0a_cus_01926c58bc6e77c09e809964e72af8c8",
"payment_method_id": "<string>",
"payment_method_type": "card",
"payment_method_subtype": "ach",
"connector": "absa_sanlam",
"merchant_connector_id": "<string>",
"customer": {
"name": "John Doe",
"email": "johntest@test.com",
"phone": "9123456789",
"phone_country_code": "+1"
},
"merchant_reference_id": "<string>",
"connector_payment_id": "993672945374576J",
"connector_response_reference_id": "<string>",
"metadata": {},
"description": "It's my first payment request",
"authentication_type": "three_ds",
"capture_method": "automatic",
"setup_future_usage": "off_session",
"error": {
"code": "card_declined",
"message": "The card was declined.",
"reason": "The card was declined.",
"unified_code": "card_declined",
"unified_message": "The card was declined.",
"network_advice_code": "01",
"network_decline_code": "05",
"network_error_message": "Do not retry"
},
"cancellation_reason": "<string>",
"order_details": "[{\n \"product_name\": \"gillete creme\",\n \"quantity\": 15,\n \"amount\" : 900\n }]",
"statement_descriptor": "Hyperswitch Router",
"allowed_payment_method_types": [
"ach"
],
"authorization_count": 123,
"modified_at": "2022-09-10T10:11:12Z"
}
]
}Authorizations
Headers
Query Parameters
The connector to filter payments list
absa_sanlam, authipay, adyenplatform, stripe_billing_test, phonypay, fauxpay, pretendpay, stripe_test, adyen_test, checkout_test, paypal_test, aci, adyen, affirm, airwallex, amazonpay, archipel, authorizedotnet, bambora, bamboraapac, bankofamerica, barclaycard, betterpayment, billwerk, bitpay, bluesnap, blackhawknetwork, calida, boku, braintree, breadpay, cardinal, cashtocode, celero, chargebee, checkbook, checkout, citigate, coinbase, coingate, custombilling, cryptopay, ctp_mastercard, ctp_visa, cybersource, cybersourcedecisionmanager, d24, datatrans, deutschebank, digitalvirgo, dlocal, dwolla, ebanx, ecommpay, envoy, elavon, etisalat, elavon_pg, facilitapay, finix, fiserv, fiservemea, fiservcommercehub, fiuu, flexiti, forte, getnet, gigadat, givepayments, globalpay, globalpayments_heartland, globalpayments_realex, globepay, gocardless, gotyme_sanlam, gpayments, hipay, helcim, hyperpg, hyperswitch_vault, interpayments, inespay, iatapay, ilixium, imerchantsolutions, itaubank, jpmorgan, jpmorgan_orbital, juspay, juspaythreedsserver, klarna, loonio, merchante, mifinity, mollie, moneris, multisafepay, netcetera, nexinets, nexixpay, nmi, nomupay, noon, nordea, novalnet, nuvei, opennode, paybox, paydotcom, payhound, payload, payme, paynearme, payone, paypal, paysafe, paystack, paytm, payconex, payu, peachpayments, payjustnow, payjustnowinstore, phonepe, placetopay, powertranz, prophetpay, rapyd, razorpay, recurly, redsys, revolv3, saferpay, santander, shift4, silverflow, square, stax, stripe, stripebilling, taxjar, threedsecureio, tesouro, tokenex, tokenio, trustly, truelayer, trustpay, trustpayments, tsys, tsys_transit, vgs, volt, wellsfargo, wise, worldline, worldpay, worldpayraft, worldpayvantiv, worldpayxml, worldpaymodular, signifyd, nsure, plaid, riskified, sanlam_payshield, xendit, zen, zift, zsl The currency to filter payments list
The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.
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 The payment status to filter payments list
Represents the overall status of a payment intent. The status transitions through various states depending on the payment method, confirmation, capture method, and any subsequent actions (like customer authentication or manual capture).
succeeded, failed, cancelled, cancelled_post_capture, processing, requires_customer_action, requires_merchant_action, requires_payment_method, requires_confirmation, requires_capture, partially_captured, partially_captured_and_capturable, partially_authorized_and_requires_capture, partially_captured_and_processing, conflicted, expired, review The payment method type to filter payments list
Indicates the type of payment method. Eg: 'card', 'wallet', etc.
card, card_redirect, pay_later, wallet, bank_redirect, bank_transfer, crypto, bank_debit, reward, real_time_payment, upi, voucher, gift_card, open_banking, mobile_payment, network_token The payment method subtype to filter payments list
Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets.
ach, affirm, afterpay_clearpay, alfamart, ali_pay, ali_pay_hk, alma, amazon_pay, paysera, apple_pay, atome, bacs, bancontact_card, becs, benefit, bizum, blik, bluecode, boleto, bca_bank_transfer, bni_va, breadpay, bri_va, bhn_card_network, card_redirect, cimb_va, classic, credit, crypto_currency, cashapp, dana, danamon_va, debit, duit_now, efecty, eft, eft_debit_order, eps, flexiti, fps, evoucher, giropay, givex, google_pay, go_pay, gcash, ideal, interac, indomaret, klarna, kakao_pay, local_bank_redirect, mandiri_va, knet, mb_way, mobile_pay, momo, momo_atm, multibanco, neteller, online_banking_thailand, online_banking_czech_republic, online_banking_finland, online_banking_fpx, online_banking_poland, online_banking_slovakia, oxxo, pago_efectivo, permata_bank_transfer, open_banking_uk, pay_bright, payjustnow, paypal, paze, pix, pix_key, pix_emv, pix_qr, pix_automatico_qr, pix_automatico_push, pay_safe_card, przelewy24, prompt_pay, pse, qris, red_compra, red_pagos, samsung_pay, sepa, sepa_bank_transfer, sepa_guarenteed_debit, skrill, sofort, swish, touch_n_go, trustly, twint, upi_collect, upi_intent, upi_qr, vipps, viet_qr, venmo, walley, wero, we_chat_pay, seven_eleven, lawson, mini_stop, family_mart, seicomart, pay_easy, local_bank_transfer, mifinity, open_banking_pis, direct_carrier_billing, instant_bank_transfer, instant_bank_transfer_finland, instant_bank_transfer_poland, revolut_pay, indonesian_bank_transfer, open_banking, network_token, payshap, payshap_proxy, ted The authentication type to filter payments list
Specifies the type of cardholder authentication to be applied for a payment.
ThreeDs: Requests 3D Secure (3DS) authentication. If the card is enrolled, 3DS authentication will be activated, potentially shifting chargeback liability to the issuer.NoThreeDs: Indicates that 3D Secure authentication should not be performed. The liability for chargebacks typically remains with the merchant. This is often the default if not specified.
Note: The actual authentication behavior can also be influenced by merchant configuration and specific connector defaults. Some connectors might still enforce 3DS or bypass it regardless of this parameter.
three_ds, no_three_ds The card networks to filter payments list
Indicates the card network.
Visa, Mastercard, AmericanExpress, JCB, DinersClub, Discover, CartesBancaires, UnionPay, Interac, RuPay, Maestro, Star, Pulse, Accel, Nyce, Prop, PrivateLabel, Dinacard, AirPlus, Aurore, EftposAustralia, GeCapital, Uatp Response
Successfully retrieved a payment list
Was this page helpful?