> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# payouts
> HSA/FSA payouts deposited for this store. Dates filter on the payout (value) date.
**Required scopes:** [`payments_read`](/docs/api-reference/v3/reference/scopes#scope-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.
Date}>
Inclusive first payout (value) date. Rejected when it is after `dateTo`.
Date}>
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
PayoutConnection!} required>
A paginated list of Payout items.
[PayoutEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
Payout!} required>
The item at this edge.
Money!} required>
Amount of the payout. Positive for both deposits and reversals.
DateTime}>
When the payout report confirmed this payout, as a UTC instant. Null until the report lands.
DateTime}>
When the payout was created, as a UTC instant.
Date}>
Banking value date of the payout (YYYY-MM-DD): the date the deposit is valued, not the order date.
Date}>
Estimated calendar date the funds arrive at the bank.
Opaque id of the payout. Pass it to `payoutBreakdown` for the per-order lines.
PayoutStatus!} required>
Settlement status of the payout.
PayoutType!} required>
Whether this row is a deposit or a reversal.
[Payout!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Money!} required>
Amount of the payout. Positive for both deposits and reversals.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
DateTime}>
When the payout report confirmed this payout, as a UTC instant. Null until the report lands.
DateTime}>
When the payout was created, as a UTC instant.
Date}>
Banking value date of the payout (YYYY-MM-DD): the date the deposit is valued, not the order date.
Date}>
Estimated calendar date the funds arrive at the bank.
Opaque id of the payout. Pass it to `payoutBreakdown` for the per-order lines.
PayoutStatus!} required>
Settlement status of the payout.
PayoutType!} required>
Whether this row is a deposit or a reversal.
PageInfo!} required>
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
```graphql theme={null}
query {
payouts(after: "...", before: "...", dateFrom: "...", dateTo: "...", first: 10, last: 10) {
nodes {
confirmedAt
createdAt
date
estimatedArrivalDate
id
status
type
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.