FOformancehq
Transactions

Save transaction metadata

Changed on

Saves metadata for a specific transaction in the ledger. Requires ledger:WriteMetadata scope (included in the default ledger:write mapping).

post/v3/{ledgerName}/transactions/{transactionId}/metadata

Request

  • Base URL
    http://localhost:9000
  • URL
    http://localhost:9000/v3/{ledgerName}/transactions/{transactionId}/metadata
  • Auth
    • HTTP bearer
    • or none

Path parameters

ledgerNamestring required

Name of the ledger

transactionIdinteger required

Transaction ID

Headers

Idempotency-Keystring

Idempotency key for the request

Request body

object required

Metadata key-value pairs (supports typed values)

Example request

{
  "reason": "correction",
  "source": "support",
  "priority": 1
}

Response

Transaction metadata saved successfully

Changes

  • f5e817eca038Revision changes
    • info

      api operation id saveTransactionMetadata removed and replaced with v3SaveTransactionMetadata

  • 3da23d327316Revision changes
    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the non-success response with the status