Skip to main content
GET
List all ACHes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

account_id
string

Return ACHes associated with this account_id.

Pattern: ^account_\w+$
account_number
string

Return ACHes associated with this account_number.

Maximum string length: 17
account_number_id
string

Return ACHes associated with this account_number_id.

Pattern: ^account_number_\w+$
counterparty_account_number
string

Return ACHes associated with this counterparty's account_number.

Maximum string length: 17
direction
enum<string>

Return ACHes with this direction. Who is initiating the transaction.

outgoing: You are sending a transaction to a counterparty. incoming: You are receiving a transaction from a counterparty.

Available options:
outgoing,
incoming
Example:

"outgoing"

status
enum<string>

Return ACHes with this status. The current status of the ACH object.

Available options:
scheduled,
processing,
submitted,
posted,
canceled,
under_review,
approved,
rejected,
pending_return,
returned,
pending_dishonored_return,
return_dishonored,
pending_contested_return,
return_contested
Example:

"submitted"

transaction_type
enum<string>

Return ACHes with this transaction_type. ACH transaction type.

Available options:
credit,
debit
Example:

"credit"

created_at
object

A set of filters on the list using the object’s field created_at.

limit
integer
default:10

Maximum number of objects to be returned.

Required range: 1 <= x <= 100
starting_after
string

A cursor for use in pagination; this is an ID that defines your place in the list.

Pattern: ^ach_\w+$
ending_before
string

A cursor for use in pagination; this is an ID that defines your place in the list.

Pattern: ^ach_\w+$

Response

A list of ACHes

objects
object[]
required
has_more
boolean
required

Indicates whether more results are available.