List Inbound ACH Transfers

Changed on
get/inbound_ach_transfers

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/inbound_ach_transfers
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Inbound ACH Transfers to ones belonging to the specified Account.

account_number_idstring

Filter Inbound ACH Transfers to ones belonging to the specified Account Number.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

status.instring[]

Filter Inbound ACH Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

Response

Inbound ACH Transfer List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "acceptance": {
        "accepted_at": "2020-01-31T13:30:00Z",
        "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
      },
      "account_id": "account_in71c4amph0vgo2qllky",
      "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "addenda": null,
      "amount": 100,
      "automatically_resolves_at": "2020-01-31T13:30:00Z",
      "created_at": "2020-01-30T22:30:00Z",
      "decline": null,
      "direction": "credit",
      "effective_date": "2020-01-31",
      "id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev",
      "international_addenda": null,
      "notification_of_change": null,
      "originator_company_descriptive_date": "200131",
      "originator_company_discretionary_data": "WEB AUTOPAY",
      "originator_company_entry_description": "INVOICE 2468",
      "originator_company_id": "0987654321",
      "originator_company_name": "PAYROLL COMPANY",
      "originator_routing_number": "101050001",
      "receiver_id_number": null,
      "receiver_name": "Ian Crease",
      "settlement": {
        "settled_at": "2020-01-31T13:30:00Z",
        "settlement_schedule": "future_dated"
      },
      "standard_entry_class_code": "internet_initiated",
      "status": "accepted",
      "trace_number": "021000038461022",
      "transfer_return": null,
      "type": "inbound_ach_transfer"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • 444b48ffe786Revision changes
    • info

      added the required property //// to the response with the status

  • df2b1ead4c49Revision changes
    • breaking

      for the query request parameter limit, default value 100 was added