Payments

List payments

GET/payments
Authentication
ApiKeyAuth
Execution
synchronous

Parameters

  • limitintegerquery

    Default: 20

    ≥ 1 · ≤ 100

  • cursorstringquery
    Opaque cursor from a previous page's nextCursor.

    max length 512

  • createdAfterstring (date-time)query
    Inclusive lower bound on createdAt.
  • createdBeforestring (date-time)query
    Exclusive upper bound on createdAt.
  • statusstringquery
    pending awaiting the customer — also after a failed attempt, while the customer may retry · processing customer acted, settlement in flight · completed funds credited · failed not used for payments: one never paid ends expired · cancelled · expired checkout TTL elapsed unpaid (a customer who committed just before the deadline can still turn it completed) · refunded. (partially_refunded is not reported yet.)

    Allowed values: pendingprocessingcompletedfailedcancelledexpiredrefunded

  • merchantReferencestringquery
    Exact match on your merchant reference. Returns at most one item.

    max length 100

Responses

A page of payments.

Headers

  • X-Request-Idstring
    The request's trace id: the same value a problem body carries as traceId. Quote it when you contact support. A replayed response (Idempotent-Replayed: true) carries the replay's own; its body keeps the original request's traceId.
  • RateLimit-Limitinteger
  • RateLimit-Remaininginteger
  • RateLimit-Resetinteger
    Seconds until the window resets.

Schema application/json

  • itemsarray<Payment>
    • idstringrequired
      A payment's id. Opaque — use it as you received it.

      Example: pay_019985c24a6e7c3b9f102d5e8a1b3c4d

      pattern ^pay_[0-9a-f]{32}$

    • merchantReferencestringrequired
      Your own reference for this payment, as you sent it.
    • statusstringrequired
      pending awaiting the customer — also after a failed attempt, while the customer may retry · processing customer acted, settlement in flight · completed funds credited · failed not used for payments: one never paid ends expired · cancelled · expired checkout TTL elapsed unpaid (a customer who committed just before the deadline can still turn it completed) · refunded. (partially_refunded is not reported yet.)

      Allowed values: pendingprocessingcompletedfailedcancelledexpiredrefunded

    • amountMoneyrequired
      Decimal amount as a string — never a float, never minor units. An amount you send may carry no more decimal places than its currency has (and never more than 8); trailing zeros do not count, so 10.100 EUR is fine and 10.123 EUR is 400 validation_failed on amount.value. An amount the API returns is written with exactly as many decimal places as its currency has (at most 8): 10.10 EUR, never 10.1.
    • feeobject
      Present once the payment is completed: the fee charged to you on it, in the payment's currency. You were credited amount less this.
    • methodstringrequired
      How the customer pays — the same vocabulary as PayoutMethod. jeton_wallet: the customer pays from their Jeton account on the checkout page. More methods will come; GET /payment-methods lists those enabled for you.

      Allowed values: jeton_wallet

    • checkoutobject
      Present while the payment is pending or processing.
    • customerCustomer
      The payer. Only the e-mail is reported for now; name, phone and country are not provided yet. The checkout page's language is the payment's own language, not a customer field.
    • payerobject
      Present once the payment is completed: the Jeton user who actually paid. Distinct from customer, which is what you sent. Pass payer.customerNumber as destination.customerNumber on POST /payouts to pay the same customer back.
    • languagestring
      The checkout page's language as you sent it. Absent when you sent none.

      pattern ^[a-z]{2}$

    • createdAtstring (date-time)required
      RFC 3339, UTC, with millisecond precision.

      Example: 2026-09-18T10:15:30.123Z

    • updatedAtstring (date-time)required
      Last change. It never moves backwards, so use it to discard stale webhook snapshots.

      Example: 2026-09-18T10:15:30.123Z

    • completedAtstring (date-time)
      Present once the payment is completed — when the funds were credited.

      Example: 2026-09-18T10:15:30.123Z

  • hasMorebooleanrequired
  • nextCursorstringnullable
    Pass as cursor to fetch the next page. null when hasMore is false.