v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Transactions API

Cancel a Pending Transaction

Use this endpoint to cancel a pending transaction that was previously created and placed on hold. Only transactions in PENDING status can be cancelled; cancelling a transaction in any other status returns 422 (ErrCommitTransactionNotPending, code 0099).

post/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/cancel

Path parameters

organization_idstring uuid required

The unique identifier of the Organization associated with the Ledger.

ledger_idstring uuid required

The unique identifier of the associated Ledger.

transaction_idstring uuid required

The unique identifier of the transaction you want to retrieve.

Response

Indicates that the request was successful and the response contains the expected data.

idstring uuid

The unique identifier of the transaction.

parentTransactionIdstring uuid nullable

The unique identifier of the parent/original transaction for reversals. This field is populated by the server when a transaction is reverted and should be treated as read-only by clients.

organizationIdstring uuid

The unique identifier of the Organization.

ledgerIdstring uuid

The unique identifier of the Ledger.

descriptionstring

Description of the transaction.

routestring

Specifies the Transaction Route associated with the transaction.

routeIdstring uuid

The unique identifier of the Transaction Route applied to this transaction.

amountstring

The sent amount.

assetCodestring

The name of the asset used in the operation.

chartOfAccountsGroupNamestring

The name of the chart-of-accounts group.

sourcestring[]

The list of accounts used as source.

destinationstring[]

The list of accounts used as destination.

createdAtstring date-time

Timestamp of creation (UTC).

updatedAtstring date-time

Timestamp of last update (UTC).

deletedAtstring date-time nullable

Timestamp of soft deletion, if applicable (UTC).

metadataMetadata

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'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.