Revert a Transaction

curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/revert

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentTransactionId": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "route": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "amount": "<string>",
  "assetCode": "<string>",
  "chartOfAccountsGroupName": "<string>",
  "source": [
    "<string>"
  ],
  "destination": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "operations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountAlias": "<string>",
      "balanceId": "<string>",
      "balanceKey": "<string>",
      "description": "<string>",
      "type": "CREDIT",
      "assetCode": "<string>",
      "chartOfAccounts": "<string>",
      "route": "<string>",
      "amount": {
        "value": "<string>"
      },
      "balance": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "balanceAfter": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "balanceAffected": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "metadata": {}
}

Revert a Transaction

Use this endpoint to reverse an existing transaction by automatically generating a new one in the opposite direction of the original. The new transaction is linked to the original using the parentTransactionId field, ensuring full traceability between both operations.

Important: Only transactions with status APPROVED can be reverted. If the original transaction already has a parent (i.e., was already reverted) the request will be rejected. On success this endpoint creates the reversing transaction and returns 201 Created with the created transaction payload.

POST

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

revert

Revert a Transaction

curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/revert

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentTransactionId": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "route": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "amount": "<string>",
  "assetCode": "<string>",
  "chartOfAccountsGroupName": "<string>",
  "source": [
    "<string>"
  ],
  "destination": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "operations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountAlias": "<string>",
      "balanceId": "<string>",
      "balanceKey": "<string>",
      "description": "<string>",
      "type": "CREDIT",
      "assetCode": "<string>",
      "chartOfAccounts": "<string>",
      "route": "<string>",
      "amount": {
        "value": "<string>"
      },
      "balance": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "balanceAfter": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "balanceAffected": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "metadata": {}
}

Headers

Authorization

string

The authorization token. This header is required if your environment has the Access Manager enabled.

X-Request-Id

string

A unique identifier used to trace and track each request.

Path Parameters

organization_id

string

required

The unique identifier of the Organization associated with the Ledger.

ledger_id

string

required

The unique identifier of the associated Ledger.

transaction_id

string

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.

string<uuid>

The unique identifier of the transaction.

parentTransactionId

string

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.

organizationId

string<uuid>

The unique identifier of the Organization.

ledgerId

string<uuid>

The unique identifier of the Ledger.

description

string

Description of the transaction.

route

string

Specifies the Transaction Route associated with the transaction.

status

object

The transaction status (pending, completed, reversed).

Show child attributes

status.code

string

Transaction status code.

status.description

string

Transaction status description.

amount

string

The sent amount.

assetCode

string

The name of the asset used in the operation.

chartOfAccountsGroupName

string

The name of the chart-of-accounts group.

source

string[]

The list of accounts used as source.

destination

string[]

The list of accounts used as destination.

createdAt

string<date-time>

Timestamp of creation (UTC).

updatedAt

string<date-time>

Timestamp of last update (UTC).

deletedAt

string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

operations

object[]

Show child attributes

operations.id

string<uuid>

The unique identifier of the Operation.

operations.transactionId

string<uuid>

The unique identifier of the Transaction.

operations.organizationId

string<uuid>

The unique identifier of the Organization.

operations.ledgerId

string<uuid>

The unique identifier of the Ledger.

operations.accountId

string<uuid>

The unique identifier of the Account.

operations.accountAlias

string

The alias for the account used in the operation.

operations.balanceId

string

The unique identifier of the Balance.

operations.balanceKey

string

The key identifier of the Balance.

operations.description

string

A description for the operation.

operations.type

enum<string>

The type of the operation.

Available options:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE

operations.assetCode

string

The code that identifies the sent asset.

operations.chartOfAccounts

string

The name of the Chart-of-Accounts that the operation belongs to.

operations.route

string

Specifies the Operation Route for each individual debit or credit operation.

operations.amount

object

An object containing information about the amount used in the operation.

Show child attributes

operations.amount.value

string

The amount that will be sent.

operations.balance

object

An object containing information about the balance before the operation.

Show child attributes

operations.balance.available

string

Previous available balance.

operations.balance.onHold

string

Amount on hold/reserved.

operations.balance.version

integer

Balance version, which is updated with each transaction.

operations.balanceAfter

object

An object containing information about the balance after the operation.

Show child attributes

operations.balanceAfter.available

string

Current available balance.

operations.balanceAfter.onHold

string

Amount on hold/reserved.

operations.balanceAfter.version

integer

Balance version, which is updated with each transaction.

operations.status

object

The transaction status (pending, completed, reversed).

Show child attributes

operations.status.code

string

Transaction status code.

operations.status.description

string | null

Transaction status description.

operations.balanceAffected

boolean

Indicates whether the operation had an impact on the account balance.

operations.createdAt

string<date-time>

Timestamp of creation (UTC).

operations.updatedAt

string<date-time>

Timestamp of last update (UTC).

operations.deletedAt

string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

operations.metadata

object

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

Show child attributes

operations.metadata.{key}

string

metadata

object

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

Show child attributes

metadata.{key}

string

Update a Transaction

Create an Inflow Transaction

⌘I

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Error handling

Revert a Transaction

Headers

Path Parameters

Response