v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

ACH

List Incoming ACH Transactions

🚧 Beta This is a Beta endpoint for use by early adopters. Do not use this endpoint with real customers. Feedback from the community is welcome. Any breaking changes to this endpoint will be pre-announced.

get/ach/incoming

Query parameters

statusstring

Status of the transaction

settlement_date_tostring date

Example:2023-09-25

End of the settlement date range query

settlement_date_fromstring date

Example:2023-09-15

Start of the settlement date range query

account_idstring uuid

Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

uuid representing an account

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

Response

Incoming ACH transactions list

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_no": "122455799",
      "amount": 10000,
      "company_entry_description": "PAYROLL",
      "company_name": "Asdf Finance",
      "customer_id": "46fac778-90c0-4d55-9a21-a587e564e7b5",
      "decline_reason": "Suspected fraud",
      "effective_date": "2022-03-25",
      "iat_info": {
        "originator_address": {
          "city_state_province": "San Francisco*CA",
          "country_postal_code": "US*10036"
        },
        "receiver_address": {
          "city_state_province": "San Francisco*CA",
          "country_postal_code": "US*10036"
        }
      },
      "id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "notification_of_change": {
        "change_code": "C01",
        "corrected_data": "122455799",
        "original_dfi_no": "364275034",
        "original_trace": "123456780000069"
      },
      "originating_routing_number": "364275034",
      "outgoing_ach_id": "b01db9c7-78f2-4a99-8aca-1231d32f9b96",
      "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"
      },
      "sec_code": "WEB",
      "settlement_date": "2022-03-25",
      "tenant": "abcdef_ghijkl",
      "trace_no": "123456780000069"
    }
  ],
  "next_page_token": "a8937a0d"
}