List Incoming ACHs

List Incoming ACHs

curl --request GET \
  --url https://api.treasuryprime.com/incoming_ach \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "account_id": "<string>",
      "account_number": "<string>",
      "account_type": "<string>",
      "amount": "<string>",
      "bank_id": "<string>",
      "company_desc": "<string>",
      "company_id": "<string>",
      "company_name": "<string>",
      "description": "<string>",
      "direction": "<string>",
      "effective_date": "<string>",
      "exception_type": "<string>",
      "id": "<string>",
      "nacha_body": {
        "batches": [
          {}
        ],
        "destination": {},
        "file_id": "<string>",
        "origin": {},
        "reference_code": "<string>"
      },
      "name": "<string>",
      "org_id": "<string>",
      "original_transaction_id": "<string>",
      "related_transaction_ids": [
        "<string>"
      ],
      "sec_code": "<string>",
      "status": "<string>",
      "trace_number": "<string>",
      "transaction_code": "<string>"
    }
  ]
}

GET

incoming_ach

List Incoming ACHs

curl --request GET \
  --url https://api.treasuryprime.com/incoming_ach \
  --header 'Authorization: Basic <encoded-value>'

{
  "data": [
    {
      "account_id": "<string>",
      "account_number": "<string>",
      "account_type": "<string>",
      "amount": "<string>",
      "bank_id": "<string>",
      "company_desc": "<string>",
      "company_id": "<string>",
      "company_name": "<string>",
      "description": "<string>",
      "direction": "<string>",
      "effective_date": "<string>",
      "exception_type": "<string>",
      "id": "<string>",
      "nacha_body": {
        "batches": [
          {}
        ],
        "destination": {},
        "file_id": "<string>",
        "origin": {},
        "reference_code": "<string>"
      },
      "name": "<string>",
      "org_id": "<string>",
      "original_transaction_id": "<string>",
      "related_transaction_ids": [
        "<string>"
      ],
      "sec_code": "<string>",
      "status": "<string>",
      "trace_number": "<string>",
      "transaction_code": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

account_id

string

ID of the Account receiving the transfer. Filterable.

account_number

string

Receiving bank account number. Filterable.

original_transaction_id

string

ID of the transaction that the incoming ACH is directly related to. Filterable.

status

string

One of done, failed, pending, or returned. Filterable.

page_cursor

string

Pagination cursor, value is the object ID.

page_size

integer

default:100

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

Required range: x >= 1

from_date

string

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

to_date

string

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

Response

200 - application/json

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

data

object[]

Show child attributes

data.account_id

string

ID of the Account receiving the transfer. Filterable.

data.account_number

string

Receiving bank account number. Filterable.

data.account_type

string

The type of the receiving account, such as checking or savings

data.amount

string

Amount of money transferred, with two decimal precision

data.bank_id

string

ID of the bank with which the account is associated

data.company_desc

string

10-character field that can be used by the originator to describe the payment

data.company_id

string

Code that the originating bank uses to identify the originator

data.company_name

string

Name of the company initiating the incoming ACH

data.description

string

Description that appears on the transaction record associated with the incoming ACH object

data.direction

string

Direction of funds flow. One of credit (money deposited into this account), or debit (money withdrawn from this account)

data.effective_date

string

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

data.exception_type

string

The exception that caused this ACH to be returned

data.id

string

Unique identifier for object

data.nacha_body

object

Data from the relevant NACHA file about the incoming ACH

Show child attributes

data.nacha_body.batches

object[]

data.nacha_body.destination

object

data.nacha_body.file_id

string

data.nacha_body.origin

object

data.nacha_body.reference_code

string

data.name

string

The name of the receiver as obtained from the incoming ACH

data.org_id

string

ID of the organization with which the object is associated

data.original_transaction_id

string

ID of the transaction that the incoming ACH is directly related to. Filterable.

List of all transaction IDs associated with the incoming ACH

data.sec_code

string

One of arc, ccd, cie, cor, ctx, dne, iat, pos, ppd, tel, or web. Specifies the transfer type, according to the ACH network

data.status

string

One of done, failed, pending, or returned. Filterable.

data.trace_number

string

Internal identifier used by the originating bank

data.transaction_code

string

Transaction code for this entry in the NACHA file

Overview Fetch an Incoming ACH

⌘I

Introduction

Account

Account Opening

Cards

Payments

Testing

Utilities

Authorizations

Query Parameters

Response