Refunds - List

Lists all the refunds associated with the merchant, or for a specific payment if payment_id is provided

POST /refunds/list

Refunds - List

cURL

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": 50,
  "offset": 10000,
  "amount_filter": {
    "start_amount": 123,
    "end_amount": 123
  },
  "connector": [
    "<string>"
  ],
  "merchant_connector_id": [
    "<string>"
  ],
  "currency": [],
  "refund_status": []
}
'

200

{
  "count": 1,
  "total_count": 123,
  "data": [
    {
      "refund_id": "<string>",
      "payment_id": "<string>",
      "amount": 6540,
      "currency": "<string>",
      "status": "succeeded",
      "connector": "stripe",
      "reason": "<string>",
      "metadata": {},
      "error_message": "<string>",
      "error_code": "<string>",
      "unified_code": "<string>",
      "unified_message": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "profile_id": "<string>",
      "merchant_connector_id": "<string>",
      "split_refunds": {
        "stripe_split_refund": {
          "revert_platform_fee": true,
          "revert_transfer": true
        }
      },
      "issuer_error_code": "<string>",
      "issuer_error_message": "<string>",
      "raw_connector_response": "<string>",
      "connector_refund_id": "<string>"
    }
  ]
}

Authorizations

api-key · string · header · required

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<date-time> · 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<date-time> | 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<int32> | null

Required range: 1 <= x <= 100

offset · integer<int32>

Required range: 0 <= x <= 20000

amount_filter · object | null

Show child attributes

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

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

refund_status · enum<string>[] | null

The list of refund statuses to filter refunds list

The status for refunds

Available options: succeeded, failed, pending, review

Response

200 - application/json

List of refunds

count · integer · required

The number of refunds included in the list

Required range: x >= 0

total_count · integer<int64> · required

The total number of refunds in the list

data · object[] · required

The List of refund response object

Show child attributes