increase-test
GET/ach_transfers

List ACH transfers

Lists ACH transfers, with optional filters for account, external account, status, idempotency key, and creation time. Use cursor and limit to retrieve pages, and pass comma-separated values for status.in.

10 parameters
cursorstringoptional
Return the page of entries after this cursor.
limitintegeroptional
Maximum number of transfers to return, from 1 to 100. Defaults to 100 when omitted.
Default:100
account_idstringoptional
Filter transfers to those originating from this account.
external_account_idstringoptional
Filter transfers to those made to this external account.
idempotency_keystringoptional
Filter to the transfer with this idempotency key. Must contain 1 to 200 characters.
status.inarray<string>optional
Filter by one or more statuses: pending_approval, pending_transfer_session_confirmation, canceled, pending_submission, pending_reviewing, requires_attention, rejected, submitted, or returned. Encode multiple values as a comma-separated string.
created_at.afterstringoptional
Return transfers created after this ISO 8601 timestamp.
created_at.beforestringoptional
Return transfers created before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return transfers created on or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return transfers created on or before this ISO 8601 timestamp.

3 status codes
200Returns a page containing an array of ACH transfer objects and a `next_cursor` for retrieving the next page.
dataarray<ACHTransfer>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 results in a client error.
5XXReturned when the request results in a server error.

Error handling

limit must be between 1 and 100, and idempotency_key must contain 1 to 200 characters. status.in accepts the documented ACH transfer statuses, and each created_at filter must be an ISO 8601 timestamp.