POST
/
refunds
/
list
curl --request POST \
  --url https://sandbox.hyperswitch.io/refunds/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",
  "payment_id": "<string>",
  "refund_id": "<string>",
  "profile_id": "<string>",
  "limit": 123,
  "offset": 123,
  "connector": [
    "<string>"
  ],
  "currency": [
    "AED"
  ],
  "refund_status": [
    "succeeded"
  ]
}'
{
  "count": 1,
  "total_count": 123,
  "data": [
    {
      "refund_id": "<string>",
      "payment_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "status": "succeeded",
      "reason": "<string>",
      "metadata": {},
      "error_message": "<string>",
      "error_code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "connector": "stripe",
      "profile_id": "<string>",
      "merchant_connector_id": "<string>"
    }
  ]
}

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
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

connector
string[] | null

The list of connectors to filter refunds list

currency
enum<string>[] | null

The list of currencies to filter refunds list

Available options:
AED,
ALL,
AMD,
ANG,
ARS,
AUD,
AWG,
AZN,
BBD,
BDT,
BHD,
BIF,
BMD,
BND,
BOB,
BRL,
BSD,
BWP,
BZD,
CAD,
CHF,
CLP,
CNY,
COP,
CRC,
CUP,
CZK,
DJF,
DKK,
DOP,
DZD,
EGP,
ETB,
EUR,
FJD,
GBP,
GHS,
GIP,
GMD,
GNF,
GTQ,
GYD,
HKD,
HNL,
HRK,
HTG,
HUF,
IDR,
ILS,
INR,
JMD,
JOD,
JPY,
KES,
KGS,
KHR,
KMF,
KRW,
KWD,
KYD,
KZT,
LAK,
LBP,
LKR,
LRD,
LSL,
MAD,
MDL,
MGA,
MKD,
MMK,
MNT,
MOP,
MUR,
MVR,
MWK,
MXN,
MYR,
NAD,
NGN,
NIO,
NOK,
NPR,
NZD,
OMR,
PEN,
PGK,
PHP,
PKR,
PLN,
PYG,
QAR,
RON,
RUB,
RWF,
SAR,
SCR,
SEK,
SGD,
SLL,
SOS,
SSP,
SVC,
SZL,
THB,
TRY,
TTD,
TWD,
TZS,
UGX,
USD,
UYU,
UZS,
VND,
VUV,
XAF,
XOF,
XPF,
YER,
ZAR
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

total_count
integer
required

The total number of refunds in the list

data
object[]
required

The List of refund response object