Sign in
Transactions

Update transaction metadata

Update the note and/or category of an existing transaction. Use null values to clear existing data.

patch/transaction/{transactionId}

Path parameters

transactionIdstring uuid required

ID for this transaction

Request body

categoryIdstring uuid required

How to update the transaction's category. Omit field to keep current, send null to clear, send ID to set.

notestring nullable required

How to update the transaction's note. Omit field to keep current, send null/empty to clear, send text to set.

Response

accountIdstring uuid required

The external-facing account identifier for the Mercury account that owns this transaction

amountnumber required
bankDescriptionstring nullable
checkNumberstring nullable

Present for check deposits and mailed checks; Nothing otherwise.

compliantWithReceiptPolicyboolean required
counterpartyIdstring uuid required

ID for a Mercury account.

counterpartyNamestring required
counterpartyNicknamestring nullable
createdAtstring yyyy-mm-ddThh:MM:ssZ required
creditAccountPeriodIdstring uuid

ID for the credit statement period

dashboardLinkstring required
estimatedDeliveryDatestring yyyy-mm-ddThh:MM:ssZ required
externalMemostring nullable
failedAtstring yyyy-mm-ddThh:MM:ssZ
feeIdstring uuid

ID for this transaction

generalLedgerCodeNamestring nullable

Deprecated: use transactionGlAllocations instead. This field does not reflect GL codes assigned via Mercury auto-categorization rules. Preserved for backwards compatibility.

hasGeneratedReceiptboolean required
idstring uuid required

ID for this transaction

kind'externalTransfer' | 'internalTransfer' | 'outgoingPayment' | 'creditCardCredit' | 'creditCardTransaction' | 'debitCardCredit' | 'debitCardTransaction' | 'cardInternationalTransactionFee' | 'cardInternationalTransactionFeeRebate' | 'cardInternationalTransactionFeeReversal' | 'cardInternationalTransactionFeeRebateReversal' | 'incomingDomesticWire' | 'checkDeposit' | 'incomingInternationalWire' | 'treasuryTransfer' | 'currencyCloudReturn' | 'wireFee' | 'personalBankingSubscriptionFee' | 'billingEngineSubscriptionFee' | 'expenseReimbursement' | 'exogenousWireDrawdown' | 'interestPayment' | 'other' required
mercuryCategory'Other' | 'Advertising' | 'Airlines' | 'AlcoholAndBars' | 'BooksAndNewspaper' | 'CarRental' | 'Charity' | 'Clothing' | 'Conferences' | 'Education' | 'Electronics' | 'Entertainment' | 'FacilitiesExpenses' | 'Fees' | 'FoodDelivery' | 'FuelAndGas' | 'Gambling' | 'GovernmentServices' | 'Grocery' | 'GroundTransportation' | 'Insurance' | 'InternetAndTelephone' | 'Legal' | 'Lodging' | 'Medical' | 'Memberships' | 'OfficeSupplies' | 'OtherTravel' | 'Parking' | 'Political' | 'ProfessionalServices' | 'Restaurants' | 'Retail' | 'RideshareAndTaxis' | 'Shipping' | 'Software' | 'Taxes' | 'Utilities' | 'VehicleExpenses'
notestring nullable
postedAtstring yyyy-mm-ddThh:MM:ssZ
reasonForFailurestring nullable
requestIdstring nullable
status'pending' | 'sent' | 'cancelled' | 'failed' | 'reversed' | 'blocked' required
trackingNumberstring nullable

Present for transactions that have tracking numbers (e.g., RTP, ACH, wires); Nothing otherwise.

Example response

{
  "createdAt": "2016-07-22T00:00:00Z",
  "estimatedDeliveryDate": "2016-07-22T00:00:00Z",
  "failedAt": "2016-07-22T00:00:00Z",
  "postedAt": "2016-07-22T00:00:00Z"
}

Changes