Developers

Payouts

List payouts

GET/payouts

Your payouts, every channel's — the API's, the portal's, a batch file's and the legacy /v1 contract's — newest first. status=pending covers a payout held before it is sent.

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
    Lifecycle of a payout. pending accepted, not sent yet (a payout held for review included — the hold is never named) · processing executing on the rail · completed · failed · cancelled withdrawn by the platform before it was sent. Terminal: completed, failed, cancelled.

    Allowed values: pendingprocessingcompletedfailedcancelled

  • methodstringquery
    Which payout product moved the money — the same vocabulary payments use for money coming in. Derived by the server from the destination; it is never sent. It decides the fee, the limits and how the payout behaves: jeton_wallet settles instantly on the internal ledger, bank_transfer travels on a bank rail, crypto settles on-chain.

    Allowed values: jeton_walletbank_transfercrypto

  • merchantReferencestringquery
    Exact match on your merchant reference. At most one item is not failed.

    max length 100

  • sourceAccountIdstringquery
    One of your accounts. Another merchant's matches nothing.

    Example: acc_AAAAAAAAAAc

    pattern ^acc_[A-Za-z0-9_-]{11}$

Responses

A page of payouts.

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<Payout>
    • idstringrequired
      The ledger id of the payout's debit — the same entry GET /accounts/{accountId}/transactions shows.

      Example: txn_AAAAAAAAB3Y

      pattern ^txn_[A-Za-z0-9_-]{11}$

    • merchantReferencestring
      Your own reference for this payout, as you sent it. Absent on a payout made without one (portal, batch).
    • statusstringrequired
      Lifecycle of a payout. pending accepted, not sent yet (a payout held for review included — the hold is never named) · processing executing on the rail · completed · failed · cancelled withdrawn by the platform before it was sent. Terminal: completed, failed, cancelled.

      Allowed values: pendingprocessingcompletedfailedcancelled

    • methodstringrequired
      Which payout product moved the money — the same vocabulary payments use for money coming in. Derived by the server from the destination; it is never sent. It decides the fee, the limits and how the payout behaves: jeton_wallet settles instantly on the internal ledger, bank_transfer travels on a bank rail, crypto settles on-chain.

      Allowed values: jeton_walletbank_transfercrypto

    • 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.
    • feeobjectrequired
      Fee charged on top of amount, in the payout currency. On the POST response, the fee quoted the moment before the payout was sent — a bank payout is charged exactly that; a read shows what the ledger charged.
    • totalDebitedobjectrequired
      amount + fee: what leaves the source account.
    • destinationone ofrequired
      Where the money went, as the ledger records it: a bank account's iban, accountHolderName, bic and country; a crypto wallet's network and address; a Jeton payout's individual by accountHolderName, the name the ledger shows — never by the customerNumber, email or phone it was sent to, and not on the POST response.
    • sourceAccountIdstringrequired
      Opaque account identifier. Treat as a string; never parse or construct it.

      Example: acc_AAAAAAAAAAc

      pattern ^acc_[A-Za-z0-9_-]{11}$

    • railstring
      How the money travelled within its method. sepa · sepa_instant · swift · instant_bank_transfer for bank_transfer, crypto for crypto, jeton_internal for jeton_wallet.

      Allowed values: sepasepa_instantswiftinstant_bank_transfercryptojeton_internal

    • descriptionstring
    • failureobject
      Present when status is failed.
    • updatedAtstring (date-time)required
      The last change the ledger recorded on the payout. The POST response's timestamps are the ledger's too, so a later GET never shows an earlier updatedAt.

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

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

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

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

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

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