increase-test
GET/check_deposits

List check deposits

Lists check deposits, with optional filters for account, creation time, or idempotency key. Use cursor to continue from a previous page and limit to control the number of results; the limit defaults to and cannot exceed 100. Results include a next_cursor for fetching the next page when more results are available.

8 parameters
cursorstringoptional
Return the page of check deposits after this cursor.
limitintegeroptional
Maximum number of check deposits to return. Must be at least 1 and cannot exceed 100. Defaults to 100 when omitted.
Default:100
account_idstringoptional
Filter check deposits to those belonging to this account.
created_at.afterstringoptional
Return check deposits created after this ISO 8601 date-time.
created_at.beforestringoptional
Return check deposits created before this ISO 8601 date-time.
created_at.on_or_afterstringoptional
Return check deposits created at or after this ISO 8601 date-time.
created_at.on_or_beforestringoptional
Return check deposits created at or before this ISO 8601 date-time.
idempotency_keystringoptional
Filter to the check deposit with this idempotency key. Must be between 1 and 200 characters.

3 status codes
200Returns a list response containing check deposit objects in `data` and a `next_cursor` for retrieving the next page; `next_cursor` is null when there is no next page.
dataarray<CheckDeposit>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

limit must be at least 1 and cannot exceed 100; it defaults to 100 when omitted. Timestamp filters must use ISO 8601 date-time values, and idempotency_key must be between 1 and 200 characters.