increase-test
GET/check_transfers

List check transfers

Lists check transfers, with optional filters for account, status, idempotency key, and creation time. Use cursor to continue through results, and limit to set the page size; the limit defaults to and cannot exceed 100. The response includes a next_cursor when another page is available.

9 parameters
cursorstringoptional
Return the page of check transfers after this cursor.
limitintegeroptional
Maximum number of check transfers to return. Must be at least 1 and cannot exceed 100. Defaults to 100 when omitted.
Default:100
account_idstringoptional
Filter check transfers to those originating from this account.
idempotency_keystringoptional
Filter to the check transfer with this idempotency key. Must be between 1 and 200 characters.
status.inarray<string>optional
Filter by one or more statuses, supplied as a comma-delimited list: pending_approval, canceled, pending_submission, pending_reviewing, requires_attention, rejected, pending_mailing, mailed, deposited, stopped, or returned.
created_at.afterstringoptional
Return check transfers created after this ISO 8601 date-time.
created_at.beforestringoptional
Return check transfers created before this ISO 8601 date-time.
created_at.on_or_afterstringoptional
Return check transfers created at or after this ISO 8601 date-time.
created_at.on_or_beforestringoptional
Return check transfers created at or before this ISO 8601 date-time.

3 status codes
200Returns a list response containing check transfer objects in `data` and a `next_cursor` for retrieving the next page; `next_cursor` is null when there is no next page.
dataarray<CheckTransfer>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. Values for status.in must be among the documented check transfer statuses, idempotency_key must be between 1 and 200 characters, and timestamp filters must use ISO 8601 date-time values.