v1

latestOpenAPI 3.1.02026-07-261520561.4 KB

Transaction

Update a Transaction

patch/transaction/{id}

Path parameters

idstring required

Unique identifier for object

Request body

categorystring

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

userdataobject

Arbitrary user data that can be attached to the object

Response

The transaction updated

account_idstring

Account ID

ach_idstring

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

amountstring

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.

balancestring

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

billpay_payment_idstring

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

book_idstring

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

card_idstring

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

categorystring

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

check_idstring

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

check_numberstring

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

datestring

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.

descstring

Transaction description

extended_timestampstring

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

extended_timestamp_precisestring

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.

fednow_idstring

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

fingerprintstring

A unique fingerprint for this transaction

human_readable_descriptionstring

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.

idstring

Unique identifier for object

incoming_ach_idstring

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

incoming_wireobject

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

incoming_wire_idstring

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

issued_check_idstring

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

network_transfer_idstring

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

related_transfer_idsstring[]

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

summarystring

Summary description of the transaction

trace_idstring

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.

typestring

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

type_sourcestring

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

userdataobject

Arbitrary user data that can be attached to the object

wirestring

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

wire_idstring

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