Disputes - Disputes Filters

Lists all the filters associated with disputes

GET /disputes/filter

Disputes - Disputes Filters

cURL

curl --request GET \
  --url https://sandbox.hyperswitch.io/disputes/filter \
  --header 'api-key: <api-key>'

200

{
  "connector": {},
  "currency": [
    "AED"
  ],
  "dispute_status": [
    "dispute_opened"
  ],
  "dispute_stage": [
    "pre_dispute"
  ]
}

Authorizations

api_keyjwt_key

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.

Headers

X-Connected-Merchant-Id · string | null

Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.

Response

200 - application/json

List of filters

connector · object · required

The map of available connector filters, where the key is the connector name and the value is a list of MerchantConnectorInfo instances

Show child attributes

currency · enum<string>[] · required

The list of available currency filters

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

dispute_status · enum<string>[] · required

The list of available dispute status filters

Status of the dispute

Available options: dispute_opened, dispute_expired, dispute_accepted, dispute_cancelled, dispute_challenged, dispute_won, dispute_lost

dispute_stage · enum<string>[] · required

The list of available dispute stage filters

Stage of the dispute

Available options: pre_dispute, dispute, pre_arbitration, arbitration, dispute_reversal