v1

latestOpenAPI 3.0.32026-08-0623677345.2 KB

Payments

List ACH transfers

Lists ACH transfers. By default, archived transfers are excluded; pass status=archived to include them.

get/ach_transfers/

pageinteger

Page number to retrieve (1-indexed).

page_sizeinteger

Number of items per page.

orderingstring

Field to sort results by. Prefix with - for descending order (e.g. -created).

status'archived' | 'finalized' | 'incomplete' | 'pending'

amountnumber

balancenumber

datestring date-time

descriptionstring

x-simple-workspacestring required

Workspace (account) identifier. Required for every request.

x-piriod-test-modeboolean

Whether to operate against test-mode data. Defaults to false.

Paginated ACH-transfer list.

countinteger required

Total number of items matching the filter.

nextstring uri nullable

URL of the next page, or null if last page.

previousstring uri nullable

URL of the previous page, or null if first page.

{
  "count": 142
}