PATCH
/
incoming_ach
/
{id}
curl --request PATCH \
  --url https://api.treasuryprime.com/incoming_ach/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Returned as fraudulent",
  "return_code": "R29",
  "status": "return"
}'
{
  "account_id": "acct_11jbx6ve3c8an",
  "account_number": "1371971315",
  "account_type": "checking",
  "amount": "100.00",
  "bank_id": "bank_treasuryprime",
  "company_desc": null,
  "company_id": "000000000",
  "company_name": "Prime of Treasury Inc.",
  "created_at": "2023-08-15T14:47:35Z",
  "description": "Returned as fraudulent",
  "direction": "credit",
  "effective_date": "2023-08-15",
  "id": "inach_11jdq4073ea9k",
  "nacha_body": {
    "batches": [
      {
        "_mac": "",
        "batch_number": 1,
        "company": {
          "id": "823419438",
          "name": "Example Corp"
        },
        "description": "LOREM IPSUM",
        "descriptive_date": "",
        "discretionary_data": "",
        "effective_date": "2021-04-14T00:00:00Z",
        "entries": [
          {
            "addenda": [],
            "amount": 25,
            "direction": "credit",
            "discretionary_data": "",
            "id_number": "11gap2hytfy17a",
            "receiver": {
              "account_number": "123456798",
              "account_type": "checking",
              "name": "George Washington",
              "routing_number": "017014038"
            },
            "trace_number": "24015053925610",
            "transaction_type": "payment"
          }
        ],
        "odfi_id": "02806504",
        "originator_status_code": "dfi",
        "sec_code": "ppd",
        "settlement_date": "167"
      }
    ],
    "created_at": "2021-04-12T11:25:00.000Z",
    "destination": {
      "id": " 074000022",
      "name": "EXAMPLE BANK NON CO"
    },
    "file_id": "K",
    "origin": {
      "id": " 075000051",
      "name": "M&I"
    },
    "reference_code": ""
  },
  "name": null,
  "org_id": "org_1h648t6pkmg",
  "original_transaction_id": null,
  "related_transaction_ids": [],
  "return_code": "R29",
  "sec_code": "ccd",
  "status": "return",
  "trace_number": "1692110855251",
  "transaction_code": null,
  "updated_at": "2023-08-15T14:47:35Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique identifier for object

Body

application/json
The incoming_ach to update
​
description
string

Optional transaction description used when posting the return to the ledger

​
return_code
string

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

​
status
string

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

Response

200 - application/json
The incoming_ach updated
​
account_id
string

ID of the Account receiving the transfer. Filterable.

​
account_number
string

Receiving bank account number. Filterable.

​
account_type
string

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

​
amount
string

Amount of money transferred, with two decimal precision

​
bank_id
string

ID of the bank with which the account is associated

​
company_desc
string

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

​
company_id
string

Code that the originating bank uses to identify the originator

​
company_name
string

Name of the company initiating the incoming ACH

​
description
string

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

​
direction
string

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

​
effective_date
string

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

​
id
string

Unique identifier for object

​
nacha_body
object

Data from the relevant NACHA file about the incoming ACH

​
name
string

The name of the receiver as obtained from the incoming ACH

​
org_id
string

ID of the organization with which the object is associated

​
original_transaction_id
string

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

​
related_transaction_ids
string[]

List of all transaction IDs associated with the incoming ACH

​
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

​
status
string

One of done, failed, pending, or returned

​
trace_number
string

Internal identifier used by the originating bank

​
transaction_code
string

Transaction code for this entry in the NACHA file