v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Incoming ACH

Update an Incoming ACH

patch/incoming_ach/{id}

Path parameters

idstring required

Unique identifier for object

Unique identifier for object

Request body

descriptionstring

Optional transaction description used when posting the return to the ledger

return_codestring

Return code to use when returning the incoming ACH. One of: R10, R20, or R29

statusstring

Updated status for the incoming ACH. Possible values: return to return a payment

Response

The incoming_ach updated

account_idstring

ID of the Account receiving the transfer. Filterable.

account_numberstring

Receiving bank account number. Filterable.

account_typestring

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

amountstring

Amount of money transferred, with two decimal precision

bank_idstring

ID of the bank with which the account is associated

company_descstring

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

company_idstring

Code that the originating bank uses to identify the originator

company_namestring

Name of the company initiating the incoming ACH

descriptionstring

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

directionstring

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

effective_datestring

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

exception_typestring

The exception that caused this ACH to be returned

idstring

Unique identifier for object

namestring

The name of the receiver as obtained from the incoming ACH

org_idstring

ID of the organization with which the object is associated

original_transaction_idstring

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

related_transaction_idsstring[]

List of all transaction IDs associated with the incoming ACH

sec_codestring

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

statusstring

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

trace_numberstring

Internal identifier used by the originating bank

transaction_codestring

Transaction code for this entry in the NACHA file