Payouts - List available filters

POST /payouts/filter

Try it: https://sandbox.hyperswitch.io/payouts/filter

Example request

cURL
curl --request POST \
  --url https://sandbox.hyperswitch.io/payouts/filter \
  --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"
}
'

Example response (200)

{
  "connector": [
    "adyen"
  ],
  "currency": [
    "AED"
  ],
  "status": [
    "success"
  ],
  "payout_method": [
    "card"
  ]
}

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

Content-Type: 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) — optional The end time to filter payments list or to get list of filters. If not passed the default time is now

Response (200) — Filters listed

  • connector (enum[]) — required The list of available connector filters

Available connector options

adyen, adyenplatform, cybersource, ebanx, gigadat, loonio, nomupay, nuvei, payone, paypal, stripe, wise, worldpay, worldpayxml

  • currency (enum[]) — 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 currency options (ISO 4217)

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

  • status (enum[]) — required The list of available payout status filters

Available status options

success, failed, cancelled, initiated, expired, reversed, pending, ineligible, requires_creation, requires_confirmation, requires_payout_method_data, requires_fulfillment, requires_vendor_account_creation

  • payout_method (enum[]) — required The list of available payout method filters The payout_type of the payout request is a mandatory field for confirming the payouts. It should be specified in the Create request. If not provided, it must be updated in the Payout Update request before it can be confirmed.

Available payout method options

card, bank, wallet, bank_redirect

Suggest edits: https://github.com/juspay/hyperswitch/edit/main/api-reference/v1/payouts/payouts--list-filters.mdx Raise issue: https://github.com/juspay/hyperswitch/issues/new?title=Issue%20on%20docs&body=Path:%20/v1/payouts/payouts--list-filters

Related:

  • Payouts - List: https://api-reference.hyperswitch.io/v1/payouts/payouts--list

  • Payouts - List using filters: https://api-reference.hyperswitch.io/v1/payouts/payouts--filter

PreviousRouting - Rule EvaluateNextPayments - Get