v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

ACH

List sent ACH transactions

get/ach

Query parameters

incoming_ach_idstring uuid

Example:b01db9c7-78f2-4a99-8aca-1231d32f9b96

ID of the linked incoming ACH entry. This is filled only for outgoing ACH entries that are returns and links to the originally received incoming entry.

trace_nosstring[]

Comma-separated list of trace numbers to filter by. Maximum 100 values.

end_effective_datestring date

Example:2022-03-25

End of the effective date range query

start_effective_datestring date

Example:2022-03-15

Start of the effective date range query

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

effective_datestring date

Example:2022-03-15

Effective date of the transaction

Response

List of sent ACH transactions.

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "transactions": [
    {
      "account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "account_name": "Bruce Wayne",
      "account_no": "122455799",
      "amount": 1560,
      "bank_id": 1,
      "company_entry_description": "PAYROLL",
      "company_name": "Asdf Finance",
      "effective_date": "2022-03-25",
      "external_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "hold": {
        "availability_time": "2010-05-06T12:23:34.321Z"
      },
      "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "incoming_ach_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "partner_id": 2,
      "return_data": {
        "code": "R01",
        "dishonored_return_code": "69",
        "dishonored_return_settlement_date": "256",
        "dishonored_return_trace": "123456780000069",
        "field_errors": "05",
        "original_dfi_no": "364275034",
        "original_trace": "123456780000069",
        "return_code": "13",
        "return_settlement_date": "256",
        "return_trace": "123456780000069"
      },
      "source_account_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "source_account_name": "Thomas Anderson",
      "source_account_no": "123638791329",
      "trace_no": "123456780000069"
    }
  ],
  "next_page_token": "a8937a0d"
}