Payments

List payments

Retrieve a paginated list of payments with powerful filtering options. Payments represent individual transactions including one-time purchases, subscription payments, and refunds. Results are sorted by creation date (newest first) by default.

Authorization

Public key
x-fngs-public-key<token>

In: header

Query Parameters

term?string

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

ids?array<>

Array of UUIDs to filter by specific records.

number?string

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

Match^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$
userId?string

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

Formatuuid
subscriptionId?string

Deprecated. Use 'subscriptionNumber' instead. Filter by subscription number (as shown in the dashboard) to find all related orders/payments.

subscriptionNumber?string

Filter by subscription number (as shown in the dashboard) to find all related orders/payments.

Match^#?([0-9A-Za-z]{12,32}|[0-9]+)(-[0-9]+)?$
checkoutIds?unknown

Filter by checkout (checkoutElement) UUID(s). Pass a single checkoutId or multiple checkoutIds — returns orders/payments that originated from any of them. Single value: ?checkoutIds=. Multiple: ?checkoutIds=&checkoutIds=.

Formatarray (preprocessed)
customFields?string

Filter by custom field values. Pass a JSON object of fieldId/value pairs, e.g. {"playerName":"john_doe"}. Matches records that have a cart item whose custom fields contain all of the provided pairs (exact match). The JSON must be URL-encoded in the query string.

statuses?array<>

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

types?array<>

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

valueFrom?|

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

Formatdouble
Range-1.7976931348623157e+308 <= value <= 1.7976931348623157e+308
valueTo?|

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

Formatdouble
Range-1.7976931348623157e+308 <= value <= 1.7976931348623157e+308
currency?string

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

Value in

  • "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?string

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

Value in

  • "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?string

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

Value in

  • "createdAt"
  • "orderNumber"
  • "value"
createdFrom?|

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

Formatint64
Range0 <= value <= 9007199254740991
createdTo?|

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

Formatint64
Range0 <= value <= 9007199254740991
orderDirection?string

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

Value in

  • "ASC"
  • "DESC"
skip?|

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

Formatdouble
Range0 <= value <= 1.7976931348623157e+308
take?|

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

Formatdouble
Range0 <= value <= 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 Body

application/json

application/json

GET
/v0/payments/list
curl -X GET "https://example.com/v0/payments/list"
{  "status": "success",  "data": {    "payments": [      {        "object": "payment",        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "type": "one_time",        "number": "string",        "status": "PENDING",        "value": 0,        "tax": 0,        "fee": 0,        "currency": "AFN",        "currencyDecimals": null,        "createdAt": 0,        "userId": null,        "user": null,        "orderId": null,        "orderNumber": null,        "order": null,        "subscriptionId": null,        "subscription": null,        "checkoutId": null,        "discount": null,        "invoiceNumber": null,        "invoiceUrl": null,        "charges": null      }    ],    "count": -1.7976931348623157e+308  }}

Refund order payment PATCH

Refund a paid order via Stripe. Supports full and partial refunds. Requires write access, and refunds must be enabled for your workspace and on the platform — the endpoint returns 404 while refunds are not enabled; contact support to enable them. The customer is refunded first; the platform fee is adjusted for the refunded amount. Idempotency: when `idempotencyKey` is omitted, a key is derived from the request (amount, reason, metadata) and the order's refund state at request time. That protects true retries of an identical request, but a keyless retry after a lost response can be treated as a new request (and refund twice) once the first refund has applied — always send a stable `idempotencyKey` for retries. Repeating a non-exhausting partial refund with the same `idempotencyKey` returns the original refund and makes no further changes (no duplicate refund, status change, or notification). A repeat that would now be rejected by a fresh eligibility check — a full refund, an exhausting partial, or one exceeding the currently refundable amount — returns 400 instead; retry with a smaller/different request, or contact support to confirm the original refund's status.

Get payment details GET

Retrieve detailed information about a specific payment by its ID. Returns the full payment object including associated user, order, subscription, charges, and invoice details.