Required scopes: payments_read
Arguments
Forward pagination cursor — returns items after it. Cursors are positions in the filtered list, so a row can shift onto another page if new activity lands in the requested range.
Backward pagination cursor — returns items before it. Cursors are positions in the filtered list, so a row can shift onto another page if new activity lands in the requested range.
Inclusive first payout (value) date. Rejected when it is after dateTo.
Inclusive last payout (value) date.
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Returns
A paginated list of Payout items. The list of edges (each a node plus its pagination cursor). Opaque cursor for this item; pass to after/before to page from here.
The item at this edge. Amount of the payout. Positive for both deposits and reversals.
When the payout report confirmed this payout, as a UTC instant. Null until the report lands.
When the payout was created, as a UTC instant.
Banking value date of the payout (YYYY-MM-DD): the date the deposit is valued, not the order date.
Estimated calendar date the funds arrive at the bank.
Opaque id of the payout. Pass it to payoutBreakdown for the per-order lines.
Settlement status of the payout.
Whether this row is a deposit or a reversal.
The nodes in this page, without the edge/cursor wrapper — a convenience over edges. Amount of the payout. Positive for both deposits and reversals. The exact amount as a decimal string (e.g. “19.99”).
ISO 4217 currency code (e.g. USD).
When the payout report confirmed this payout, as a UTC instant. Null until the report lands.
When the payout was created, as a UTC instant.
Banking value date of the payout (YYYY-MM-DD): the date the deposit is valued, not the order date.
Estimated calendar date the funds arrive at the bank.
Opaque id of the payout. Pass it to payoutBreakdown for the per-order lines.
Settlement status of the payout.
Whether this row is a deposit or a reversal.
Pagination metadata for the current page. Cursor of the last edge in this page; pass to after to page forward.
Whether more items exist after this page (drives forward pagination with first/after).
Whether more items exist before this page (drives backward pagination with last/before).
Cursor of the first edge in this page; pass to before to page backward.
Example