Skip to main content
GET
/
v0
/
payments
/
list
List payments
curl --request GET \
  --url https://api.fungies.io/v0/payments/list \
  --header 'x-fngs-public-key: <api-key>'
{
  "status": "<string>",
  "data": {
    "payments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "one_time",
        "number": "<string>",
        "status": "PENDING",
        "createdAt": 4503599627370495,
        "object": "payment",
        "value": 0,
        "tax": 0,
        "fee": 0,
        "currency": null,
        "currencyDecimals": null,
        "userId": null,
        "user": null,
        "orderId": null,
        "orderNumber": null,
        "order": null,
        "subscriptionId": null,
        "subscription": null,
        "discount": null,
        "invoiceNumber": null,
        "invoiceUrl": null,
        "charges": null
      }
    ],
    "count": 0
  }
}

Authorizations

​
x-fngs-public-key
string
header
required

Query Parameters

​
term
string

Search term to filter results. Matches against order/payment number, user email, or transaction ID.

​
ids
string<uuid>[]

Array of UUIDs to filter by specific records.

​
number
string

Filter by exact order/payment number (e.g., #ABC123DEF456).

​
userId
string<uuid>

Filter by the user's UUID who made the order/payment.

​
subscriptionId
string

Filter by subscription ID to find all related orders/payments.

​
statuses
enum<string>[]

Filter by status values. Available options: - PENDING: Being processed - PAID: Completed successfully - FAILED: Payment failed - UNPAID: Not yet attempted - CANCELLED: Was cancelled - REFUNDED: Fully refunded - PARTIALLY_REFUNDED: Partially refunded - EXPIRED: Expired before completion

Available options:
PENDING,
PAID,
FAILED,
UNPAID,
CANCELLED,
REFUNDED,
PARTIALLY_REFUNDED,
EXPIRED
​
types
enum<string>[]

Filter by payment types. Available options: - one_time: Single purchase payment - subscription_initial: First payment of a subscription - subscription_update: Subscription plan change payment - subscription_interval: Recurring subscription payment - subscription_extra: Additional subscription charge - claim_free: Free product claim

Available options:
one_time,
subscription_initial,
subscription_update,
subscription_interval,
subscription_extra,
claim_free
​
valueFrom
number<double> | null

Minimum value in smallest currency unit (e.g., cents). Filter for amounts greater than or equal to this value.

Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308
​
valueTo
number<double> | null

Maximum value in smallest currency unit (e.g., cents). Filter for amounts less than or equal to this value.

Required range: -1.7976931348623157e+308 <= x <= 1.7976931348623157e+308
​
currency
enum<string>

Filter by ISO 4217 currency code (e.g., USD, EUR, GBP).

Available options:
AFN,
ALL,
DZD,
AOA,
ARS,
AMD,
AWG,
AUD,
AZN,
BSD,
BDT,
BBD,
BZD,
BMD,
BOB,
BAM,
BWP,
BRL,
BHD,
GBP,
BND,
BGN,
BIF,
BYN,
KHR,
CAD,
CVE,
KYD,
KWD,
XAF,
XPF,
CLP,
CNY,
COP,
KMF,
CDF,
CRC,
HRK,
CZK,
DKK,
DJF,
DOP,
XCD,
EGP,
ETB,
EUR,
FKP,
FJD,
GMD,
GEL,
GIP,
GTQ,
GNF,
GYD,
HTG,
HNL,
HKD,
HUF,
ISK,
INR,
IDR,
ILS,
JMD,
JPY,
JOD,
KZT,
KES,
KGS,
LAK,
LBP,
LSL,
LRD,
MOP,
MKD,
MGA,
MWK,
MYR,
MVR,
MRO,
MUR,
MXN,
MDL,
MNT,
MAD,
MZN,
MMK,
NAD,
NPR,
ANG,
TWD,
NZD,
NIO,
NGN,
NOK,
OMR,
PKR,
PAB,
PGK,
PYG,
PEN,
PHP,
PLN,
QAR,
RON,
RUB,
RWF,
SHP,
SVC,
WST,
STD,
SAR,
RSD,
SCR,
SLL,
SGD,
SBD,
SOS,
ZAR,
KRW,
LKR,
SRD,
SZL,
SEK,
CHF,
TJS,
TZS,
THB,
TND,
TOP,
TTD,
TRY,
UGX,
UAH,
AED,
UYU,
USD,
UZS,
VUV,
VEF,
VND,
XOF,
YER,
ZMW,
SLE,
XCG,
SSP,
VES,
MRU,
STN,
VED
​
country
enum<string>

Filter by ISO 3166-1 alpha-2 country code of the buyer (e.g., US, GB, DE).

Available options:
AF,
AX,
AL,
DZ,
AD,
AO,
AI,
AQ,
AG,
AR,
AM,
AW,
AU,
AT,
AZ,
BS,
BH,
BD,
BB,
BY,
BE,
BZ,
BJ,
BM,
BT,
BO,
BA,
BW,
BV,
BR,
IO,
VG,
BN,
BG,
BF,
BI,
KH,
CM,
CA,
CV,
BQ,
KY,
CF,
TD,
CL,
CN,
CO,
KM,
CG,
CD,
CK,
CR,
CI,
HR,
CW,
CY,
CZ,
DK,
DJ,
DM,
DO,
EC,
EG,
SV,
GQ,
ER,
EE,
SZ,
ET,
FK,
FO,
FJ,
FI,
FR,
GF,
PF,
TF,
GA,
GM,
GE,
DE,
GH,
GI,
GR,
GL,
GD,
GP,
GU,
GT,
GG,
GN,
GW,
GY,
HT,
HN,
HK,
HU,
IS,
IN,
ID,
IQ,
IE,
IM,
IL,
IT,
JM,
JP,
JE,
JO,
KZ,
KE,
KI,
XK,
KW,
KG,
LA,
LV,
LB,
LS,
LR,
LY,
LI,
LT,
LU,
MO,
MG,
MW,
MY,
MV,
ML,
MT,
MQ,
MR,
MU,
YT,
MX,
MD,
MC,
MN,
ME,
MS,
MA,
MZ,
MM,
NA,
NR,
NP,
NL,
NC,
NZ,
NI,
NE,
NG,
NU,
MK,
NO,
OM,
PK,
PS,
PA,
PG,
PY,
PE,
PH,
PN,
PL,
PT,
PR,
QA,
RE,
RO,
RU,
RW,
WS,
SM,
ST,
SA,
SN,
RS,
SC,
SL,
SG,
SX,
SK,
SI,
SB,
SO,
ZA,
GS,
KR,
SS,
ES,
LK,
BL,
SH,
KN,
LC,
MF,
PM,
VC,
SD,
SR,
SJ,
SE,
CH,
TW,
TJ,
TZ,
TH,
TL,
TG,
TK,
TO,
TT,
TN,
TR,
TM,
TC,
TV,
UG,
UA,
AE,
GB,
US,
UY,
UZ,
VU,
VA,
VE,
VN,
WF,
EH,
YE,
ZM,
ZW
​
orderBy
enum<string>

Field to sort results by. Common options: createdAt, orderNumber, value.

Available options:
createdAt,
orderNumber,
value
​
createdFrom
integer<int64> | null

Filter payments created on or after this timestamp. Accepts Unix timestamp in seconds or milliseconds.

Required range: 0 <= x <= 9007199254740991
​
createdTo
integer<int64> | null

Filter payments created on or before this timestamp. Accepts Unix timestamp in seconds or milliseconds.

Required range: 0 <= x <= 9007199254740991
​
orderDirection
enum<string>

Sort direction for results. 'ASC' for ascending (oldest/lowest first), 'DESC' for descending (newest/highest first).

Available options:
ASC,
DESC
​
skip
number<double> | null

Number of records to skip for offset-based pagination. Use with 'take' parameter.

Required range: 0 <= x <= 1.7976931348623157e+308
​
take
number<double> | null

Maximum number of records to return (page size). Use with 'skip' parameter for pagination.

Required range: 0 <= x <= 1.7976931348623157e+308
​
archived

If true, return only archived/deleted records. If false or omitted, return only active records.

​
withArchived

If true, include archived records in results alongside active records.

​
returnCount

If true, include the total count of matching records in the response. Useful for pagination UI.

Response

GET /v0/payments/list Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required