Actualizar una Transacción

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "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}"

payload = {
    "description": "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: '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}', 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}",
  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' => '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}"

	payload := strings.NewReader("{\n  \"description\": \"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}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"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}")

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\": \"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",
  "parentTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "route": "<string>",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>",
      "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": {}
    }
  ],
  "metadata": {}
}

PATCH

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

Actualizar una Transacción

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "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}"

payload = {
    "description": "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: '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}', 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}",
  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' => '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}"

	payload := strings.NewReader("{\n  \"description\": \"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}")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"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}")

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\": \"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",
  "parentTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "route": "<string>",
  "routeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>",
      "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": {}
    }
  ],
  "metadata": {}
}

Encabezados

Content-Type

string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id

string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization

string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id

string<uuid>

requerido

El identificador único de la Organización asociada al Ledger.

ledger_id

string<uuid>

requerido

El identificador único del Ledger asociado.

transaction_id

string<uuid>

requerido

El identificador único de la transacción que desea recuperar.

Cuerpo

application/json

description

string

La descripción de la transacción.

metadata

object

Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.

Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.

Show child attributes

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

string<uuid>

El identificador único de la transacción.

parentTransactionId

string<uuid> | null

El identificador único de la transacción padre/original para reversiones. Este campo es completado por el servidor cuando una transacción es revertida y debe ser tratado como solo lectura por los clientes.

organizationId

string<uuid>

El identificador único de la Organización.

ledgerId

string<uuid>

El identificador único del Ledger.

description

string

Descripción de la transacción.

route

string

Especifica la Ruta de Transacción asociada a la transacción.

routeId

string<uuid>

El identificador único de la Ruta de Transacción aplicada a esta transacción.

status

object

El estado de la transacción (pendiente, completada, revertida).

Show child attributes

amount

string

El monto enviado.

assetCode

string

El nombre del activo utilizado en la operación.

chartOfAccountsGroupName

string

El nombre del grupo del plan de cuentas.

source

string[]

La lista de cuentas utilizadas como origen.

destination

string[]

La lista de cuentas utilizadas como destino.

createdAt

string<date-time>

Fecha y hora de creación (UTC).

updatedAt

string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt

string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).

operations

object[]

Show child attributes

metadata

object

Show child attributes

Recuperar una Transacción

Revertir una Transacción

⌘I