POST
/
refunds
/
list

Authorizations

​
api-key
string
headerrequired

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.

​
start_time
string
required

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

​
end_time
string | null

The end time to filter payments list or to get list of filters. If not passed the default time is now

​
payment_id
string | null

The identifier for the payment

​
refund_id
string | null

The identifier for the refund

​
profile_id
string | null

The identifier for business profile

​
limit
integer | null

Limit on the number of objects to return

​
offset
integer | null

The starting point within a list of objects

​
amount_filter
object
​
connector
string[] | null

The list of connectors to filter refunds list

​
merchant_connector_id
string[] | null

The list of merchant connector ids to filter the refunds list for selected label

​
currency
enum<string>[] | null

The list of currencies to filter refunds list

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,
CLP,
CNY,
COP,
CRC,
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,
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
​
refund_status
enum<string>[] | null

The list of refund statuses to filter refunds list

Available options:
succeeded,
failed,
pending,
review

Response

200 - application/json
​
count
integer
required

The number of refunds included in the list

Required range: x > 0
​
total_count
integer
required

The total number of refunds in the list

​
data
object[]
required

The List of refund response object

Refunds - RetrieveDisputes - Retrieve Dispute