Skip to main content
POST
/
api
/
ledger
/
v2
/
{ledger}
/
transactions
/
{id}
/
metadata
Set the metadata of a transaction by its ID
curl --request POST \
  --url http://localhost/api/ledger/v2/{ledger}/transactions/{id}/metadata \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "admin": "true"
}
'
This response has no body data.

Documentation Index

Fetch the complete documentation index at: https://docs.formance.com/llms.txt

Use this file to discover all available pages before exploring further.

Attach key-value metadata to a transaction. Use for storing order IDs, customer references, or audit information.

​
Parameters

ledger: The name of the ledger containing the transaction. (e.g., ledger001) id: The transaction ID to add metadata to. (e.g., 1234) dryRun: When true, validates the request without persisting changes. Idempotency-Key: Unique key to ensure the request is processed exactly once. (e.g., meta-tx-abc123)

​
Request Body

Key-value pairs to add to the transaction.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Idempotency-Key
string

Use an idempotency key

Path Parameters

​
ledger
string
required

Name of the ledger.

Example:

"ledger001"

​
id
integer<bigint>
required

Transaction ID.

Required range: x >= 0
Example:

1234

Query Parameters

​
dryRun
boolean

Set the dryRun mode. Dry run mode doesn't add the logs to the database or publish a message to the message broker.

Example:

true

Body

application/json

metadata

​
{key}
string

Response