PATCH
/
transaction
/
{id}
curl --request PATCH \
  --url https://api.treasuryprime.com/transaction/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "category": "interest"
}'
{
  "ach_id": "ach_1234567",
  "amount": "1975.00",
  "balance": "256147.27",
  "billpay_payment_id": null,
  "book_id": null,
  "card_id": null,
  "category": "interest",
  "check_id": null,
  "check_number": null,
  "date": "2017-11-27",
  "desc": "EXT-XFER Sq. Nbr.: 123456",
  "extended_timestamp": "2017-11-27T01:02:03Z",
  "extended_timestamp_precise": "2017-11-27T01:02:03.400Z",
  "fingerprint": "2k7vxetham4i1v3ceb5vs6",
  "id": "ttx_113333abcd",
  "incoming_ach_id": null,
  "incoming_wire": null,
  "incoming_wire_id": null,
  "issued_check_id": null,
  "network_transfer_id": null,
  "related_transfer_ids": [],
  "summary": "ACME CORP VENDOR PMT",
  "trace_id": null,
  "type": "deposit",
  "type_source": null,
  "userdata": null,
  "wire": null,
  "wire_id": null
}

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 transaction to update
​
category
string

One of: interest, fees, or null. Update this field to indicate if the transaction is an interest or fee payment

​
userdata
object

Arbitrary user data that can be attached to the object

Response

200 - application/json
The transaction updated
​
account_id
string

Account ID

​
ach_id
string

The ID of the ACH object that originated this transaction, if any. Otherwise null

​
amount
string

Transaction amount. Positive values indicate a credit while negative values indicate a debit. Note that transactions with type hold have an amount, but they do not change the balance.

​
balance
string

Account balance immediately after this transaction. Transactions of type hold do not affect the balance.

​
billpay_payment_id
string

The ID of the BillPay object that originated this transaction, if any. Otherwise null

​
book_id
string

The ID of the Book Transfer object that originated this transaction, if any. Otherwise null. Filterable.

​
card_id
string

The ID of the Card Object that originated this transaction, if any. Otherwise null. Filterable.

​
category
string

One of: interest, fees, or null. Update this field to indicate if the transaction is an interest or fee payment

​
check_id
string

The ID of the Check Deposit object that originated this transaction, if any. Otherwise null. Filterable.

​
check_number
string

If this transaction is for an outbound check, the number of the check. Otherwise null

​
date
string

Date of the transaction, ISO 8601 format ('YYYY-MM-DD'). Received directly from the bank, often without time zone adjustment. Might differ in date compared to extended_timestamp and extended_timestamp_precise due to timezones.

​
desc
string

Transaction description

​
extended_timestamp
string

Timestamp of the transaction, ISO 8601 format ('YYYY-MM-DDThh:mm:ssZ'). Limited availability. Always in UTC

​
extended_timestamp_precise
string

Timestamp of the transaction, ISO 8601 format with subsecond precision ('YYYY-MM-DDThh:mm:ss.SSS[SSS]Z'). The precision could be millisecond or microsecond depending on source data. Limited availability. Always in UTC.

​
fingerprint
string

A unique fingerprint for this transaction

​
human_readable_description
string

A user-friendly description. Note, there may be a short period (less than 60 seconds) after a transaction is accessible through our API where this field is not yet populated.

​
id
string

Unique identifier for object

​
incoming_ach_id
string

The ID of the Incoming ACH object that originated this transaction, if any. Otherwise null. Filterable.

​
incoming_wire
object

Data related to the wire that originated this transaction, if any. Otherwise null

​
incoming_wire_id
string

The ID of the Incoming ACH object that originated this transaction, if any. Otherwise null. Filterable.

​
issued_check_id
string

The ID of the Issued Check Object that originated this transaction, if any. Otherwise null. Filterable.

​
network_transfer_id
string

The ID of the Network Transfer that originated this transaction, if any. Otherwise null. Filterable.

​
related_transfer_ids
string[]

The IDs of the related transactions, if any. Otherwise null

​
summary
string

Summary description of the transaction

​
trace_id
string

A common id used to tie multiple, related transactions together. Currently used to connect hold and hold_release transactions to a debit and to link transactions to their related card events. Filterable.

​
type
string

Type of transaction. One of charge, deposit, hold, hold_release, interest, payment, reversal, withdrawal, or null. Filterable.

​
type_source
string

The type of payment that initiated this transaction, if any. One of ach, bank, book, card, check, or wire. Otherwise null. Limited availability.

​
userdata
object

Arbitrary user data that can be attached to the object

​
wire
string

For wire transactions, the Fedwire description, if any. Otherwise null.

​
wire_id
string

The ID of the Wire object that originated this transaction, if any. Otherwise null. Filterable.

Was this page helpful?