Update an Operation

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Credit pix - Updated",
  "metadata": {
    "notes": "Payment reference updated",
    "originalAmount": "1000",
    "channel": "pix",
    "updatedBy": "system",
    "reason": "customer_request"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

payload = {
    "description": "Credit pix - Updated",
    "metadata": {
        "notes": "Payment reference updated",
        "originalAmount": "1000",
        "channel": "pix",
        "updatedBy": "system",
        "reason": "customer_request"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Credit pix - Updated',
    metadata: {
      notes: 'Payment reference updated',
      originalAmount: '1000',
      channel: 'pix',
      updatedBy: 'system',
      reason: 'customer_request'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Credit pix - Updated',
    'metadata' => [
        'notes' => 'Payment reference updated',
        'originalAmount' => '1000',
        'channel' => 'pix',
        'updatedBy' => 'system',
        'reason' => 'customer_request'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

	payload := strings.NewReader("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "assetCode": "<string>",
  "chartOfAccounts": "<string>",
  "route": "<string>",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeCode": "<string>",
  "routeDescription": "<string>",
  "amount": {
    "value": "<string>"
  },
  "balance": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "balanceAfter": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "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": {}
}

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

operations

{operation_id}

Update an Operation

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Credit pix - Updated",
  "metadata": {
    "notes": "Payment reference updated",
    "originalAmount": "1000",
    "channel": "pix",
    "updatedBy": "system",
    "reason": "customer_request"
  }
}
'

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

payload = {
    "description": "Credit pix - Updated",
    "metadata": {
        "notes": "Payment reference updated",
        "originalAmount": "1000",
        "channel": "pix",
        "updatedBy": "system",
        "reason": "customer_request"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Credit pix - Updated',
    metadata: {
      notes: 'Payment reference updated',
      originalAmount: '1000',
      channel: 'pix',
      updatedBy: 'system',
      reason: 'customer_request'
    }
  })
};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Credit pix - Updated',
    'metadata' => [
        'notes' => 'Payment reference updated',
        'originalAmount' => '1000',
        'channel' => 'pix',
        'updatedBy' => 'system',
        'reason' => 'customer_request'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}"

	payload := strings.NewReader("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Credit pix - Updated\",\n  \"metadata\": {\n    \"notes\": \"Payment reference updated\",\n    \"originalAmount\": \"1000\",\n    \"channel\": \"pix\",\n    \"updatedBy\": \"system\",\n    \"reason\": \"customer_request\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "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>",
  "assetCode": "<string>",
  "chartOfAccounts": "<string>",
  "route": "<string>",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "routeCode": "<string>",
  "routeDescription": "<string>",
  "amount": {
    "value": "<string>"
  },
  "balance": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "balanceAfter": {
    "available": "<string>",
    "onHold": "<string>",
    "version": 123,
    "overdraftUsed": "<string>"
  },
  "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": {}
}

Headers

Content-Type

string

The type of media of the resource. Recommended value is application/json.

X-Request-Id

string<uuid>

A unique identifier used to trace and track each request.

Authorization

string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id

string<uuid>

required

The unique identifier of the Organization associated with the Ledger.

ledger_id

string<uuid>

required

The unique identifier of the associated Ledger.

operation_id

string<uuid>

required

The unique identifier of the operation that you want to retrieve.

transaction_id

string<uuid>

required

The unique identifier of the transaction you want to retrieve.

Body

application/json

description

string

The description for the operation.

Maximum string length: 256

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

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.

Show child attributes

Response

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

string<uuid>

The unique identifier of the Operation.

transactionId

string<uuid>

The unique identifier of the Transaction.

organizationId

string<uuid>

The unique identifier of the Organization.

ledgerId

string<uuid>

The unique identifier of the Ledger.

accountId

string<uuid>

The unique identifier of the Account.

accountAlias

string

The alias for the account used in the operation.

balanceId

string

The unique identifier of the Balance.

balanceKey

string

The unique key that identifies the Balance.

description

string

Description of the transaction.

type

enum<string>

The type of the operation. OVERDRAFT identifies system-generated companion operations on the internal "overdraft" balance — direction then carries the lifecycle semantics (debit for a draw, credit for a repayment). BLOCK and UNBLOCK identify operations produced by the block/unblock transaction endpoints; direction still carries the debit/credit semantics.

Available options:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE,

OVERDRAFT,

BLOCK,

UNBLOCK

assetCode

string

The name of the asset used in the operation.

chartOfAccounts

string

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

route

string

deprecated

Deprecated. Use routeId instead. Will be removed in the next major version. The unique ID of the operation route for this transaction leg.

routeId

string<uuid>

The unique identifier of the operation route associated with this operation. Companion overdraft operations inherit this value from the primary operation that triggered them.

routeCode

string

A human-readable code for the operation route, useful for audit trail and traceability.

Maximum string length: 100

routeDescription

string

The description of the operation route associated with this operation.

direction

enum<string>

The direction of the operation in double-entry accounting.

Available options:

debit,

credit

amount

object

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

Show child attributes

balance

object

An object containing information about the balance before the operation.

Show child attributes

balanceAfter

object

An object containing information about the balance after the operation.

Show child attributes

status

object

The transaction status (pending, completed, reversed).

Show child attributes

balanceAffected

boolean

If true, indicates that the operation affected the account balance.

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

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

Retrieve an Operation

Create an Operation Route

Getting started

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

Metadata Indexes API

Holders API

Instruments API

Billing Packages API

Packages API

Billing Calculation API

Estimation API

Encryption API

Protection API

Asset Rates API

Error handling

Fees Engine

Update an Operation

Headers

Path Parameters

Body

Response