v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
ACH

List ACH Transfers

get/ach

Query parameters

account_idstring

ID of the Account originating the transfer. Filterable.

counterparty_idstring

ID of the Counterparty receiving the transfer. Be sure that the ach section of the Counterparty contains non-null values. Filterable.

directionstring

Direction of funds flow. One of credit (send money to your counterparty) or debit (receive money from your counterparty). Filterable.

effective_datestring

The official effective date of the transaction, according to the ACH network. Filterable.

org_idstring

ID of your organization. Filterable.

servicestring

Either standard or sameday. Specifies same-day or standard processing. Filterable.

statusstring

Current status of the ACH transfer. Read-only. Possible values: pending, processing, sent, returned, canceled, error. Filterable.

trace_numberstring

15 digit trace number assigned to the ACH when it was originated. Not available at every bank. Filterable.

trace_suffixinteger
page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size ach elements, starting after the ach described by page_cursor. If no more achs are available, the resulting list will be empty.