Get cycle snapshot history for deposit account [beta]

Return the complete cycle history for a deposit account, with one record per cycle, enabling audit, statement generation, and reconciliation workflows without requiring reconstruction from individual events.

Cycles are returned in descending order, from the most recent to the oldest. The currently active cycle is the only record with active set to true. Its status is reported as IN_GRACE when the request is made during the cycle's grace period. Accounts in their initial cycle return a single record, while accounts with incomplete historical data return only the cycles available.

Results are paginated using the page and perPage query parameters. Identification of the active cycle is based on the account's full cycle history and is not limited to the cycles included in the current page.

All cycle lifecycle dates are calculated from 00:00 in the account division's timezone applicable to that cycle. If no division timezone is configured, UTC is used.

Cycle history remains available for the lifetime of an open account, including after a product has been detached. Following account closure, cycle history might be removed according to the retention policy configured for the environment. By default, cycle history is retained indefinitely.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Account ID

Query Params
integer
Defaults to 1

Page number, starting at 1. Values lower than 1 fall back to 1. A page beyond the last one returns an empty list with next_page set to false.

integer
≤ 100
Defaults to 20

Number of cycles per page. Values lower than 1 fall back to 20, and values greater than 100 are capped at 100.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json