Skip to main content
POST
/
payouts
/
filter
Payouts - List available filters
curl --request POST \
  --url https://sandbox.foldd.com/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"
}
'
{
  "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 Foldd 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

Response

200 - application/json

Filters listed

​
connector
enum<string>[]
required

The list of available connector filters

Available options:
adyen,
adyenplatform,
cybersource,
ebanx,
nomupay,
payone,
paypal,
stripe,
wise
​
currency
enum<string>[]
required

The list of available currency filters

The three letter ISO currency code in uppercase. Eg: 'USD' for the United States Dollar.

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
​
status
enum<string>[]
required

The list of available payout status filters

Available 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<string>[]
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 options:
card,
bank,
wallet