Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The type of media of the resource. Must be application/json.
A unique identifier used to trace and track each request.
A unique key that ensures transaction idempotency. If not provided, the system automatically generates a hash based on the transaction data.
The time-to-live for the key, defined in seconds.
Path Parameters
The unique identifier of the Organization associated with the Ledger.
The unique identifier of the associated Ledger.
Body
A description for the transaction.
An object containing information about the transaction that will be sent.
Indicates whether the transaction should follow a two-step process: authorization followed by execution. When set to true, the transaction is created in a pending state, reserving funds (on_hold) without immediately moving them. A subsequent commit is required to finalize the transfer.
Specifies the Transaction Route associated with the transaction. Important: When Transaction Routing validation is enabled for your Ledger, this field becomes mandatory and must match an existing id from your configured Transaction Routes. However, when validation is disabled (default behavior), this field is optional and accepts any free-form string.
The time when the transaction was made. Used to add past transactions. Must be a date in the past.
An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.
Response
Indicates that the resource was successfully created and the operation was completed as expected.
The unique identifier of the transaction.
The unique identifier of the Organization.
The unique identifier of the Ledger.
Description of the transaction.
Specifies the Transaction Route associated with the transaction.
The transaction status (pending, completed, reversed).
The sent amount.
The name of the asset used in the operation.
The name of the chart-of-accounts group.
The list of accounts used as source.
The list of accounts used as destination.
Timestamp of creation (UTC).
Timestamp of last update (UTC).
Timestamp of soft deletion, if applicable (UTC).
An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.