Error

A valid request URL is required to generate request examples

{
  "amount": "1500",
  "assetCode": "BRL",
  "chartOfAccountsGroupName": "Chart of accounts group name",
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Transaction description",
  "destination": [
    "@person2"
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "operations": [
    {
      "accountAlias": "@person1",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "amount": {
        "value": "1500"
      },
      "assetCode": "BRL",
      "balance": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceAffected": true,
      "balanceAfter": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceId": "00000000-0000-0000-0000-000000000000",
      "balanceKey": "asset-freeze",
      "chartOfAccounts": "1000",
      "createdAt": "2021-01-01T00:00:00Z",
      "deletedAt": "2021-01-01T00:00:00Z",
      "description": "Credit card operation",
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerId": "00000000-0000-0000-0000-000000000000",
      "metadata": {},
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "route": "00000000-0000-0000-0000-000000000000",
      "status": {
        "code": "ACTIVE",
        "description": "Active status"
      },
      "transactionId": "00000000-0000-0000-0000-000000000000",
      "type": "DEBIT",
      "updatedAt": "2021-01-01T00:00:00Z",
      "direction": "debit",
      "routeCode": "ROUTE-001",
      "routeDescription": "Settlement route for service charges",
      "routeId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "route": "00000000-0000-0000-0000-000000000000",
  "source": [
    "@person1"
  ],
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "updatedAt": "2021-01-01T00:00:00Z",
  "metadata": {},
  "parentTransactionId": "00000000-0000-0000-0000-000000000000",
  "routeId": "00000000-0000-0000-0000-000000000000"
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

Revertir una Transacción

deprecated

Usa este endpoint para revertir una transacción existente generando automáticamente una nueva en la dirección opuesta a la original. La nueva transacción se vincula a la original usando el campo parentTransactionId, asegurando la trazabilidad completa entre ambas operaciones. Importante: Solo las transacciones con estado APPROVED pueden ser revertidas. Si la transacción original ya tiene un padre (es decir, ya fue revertida), la solicitud será rechazada. Si la operación tiene éxito, este endpoint crea la transacción de reversión y devuelve un código 201 junto con el contenido de la transacción creada.

POST

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

revert

Error

A valid request URL is required to generate request examples

{
  "amount": "1500",
  "assetCode": "BRL",
  "chartOfAccountsGroupName": "Chart of accounts group name",
  "createdAt": "2021-01-01T00:00:00Z",
  "deletedAt": "2021-01-01T00:00:00Z",
  "description": "Transaction description",
  "destination": [
    "@person2"
  ],
  "id": "00000000-0000-0000-0000-000000000000",
  "ledgerId": "00000000-0000-0000-0000-000000000000",
  "operations": [
    {
      "accountAlias": "@person1",
      "accountId": "00000000-0000-0000-0000-000000000000",
      "amount": {
        "value": "1500"
      },
      "assetCode": "BRL",
      "balance": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceAffected": true,
      "balanceAfter": {
        "available": "1500",
        "onHold": "500",
        "overdraftUsed": "130",
        "version": 2
      },
      "balanceId": "00000000-0000-0000-0000-000000000000",
      "balanceKey": "asset-freeze",
      "chartOfAccounts": "1000",
      "createdAt": "2021-01-01T00:00:00Z",
      "deletedAt": "2021-01-01T00:00:00Z",
      "description": "Credit card operation",
      "id": "00000000-0000-0000-0000-000000000000",
      "ledgerId": "00000000-0000-0000-0000-000000000000",
      "metadata": {},
      "organizationId": "00000000-0000-0000-0000-000000000000",
      "route": "00000000-0000-0000-0000-000000000000",
      "status": {
        "code": "ACTIVE",
        "description": "Active status"
      },
      "transactionId": "00000000-0000-0000-0000-000000000000",
      "type": "DEBIT",
      "updatedAt": "2021-01-01T00:00:00Z",
      "direction": "debit",
      "routeCode": "ROUTE-001",
      "routeDescription": "Settlement route for service charges",
      "routeId": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "organizationId": "00000000-0000-0000-0000-000000000000",
  "route": "00000000-0000-0000-0000-000000000000",
  "source": [
    "@person1"
  ],
  "status": {
    "code": "ACTIVE",
    "description": "Active status"
  },
  "updatedAt": "2021-01-01T00:00:00Z",
  "metadata": {},
  "parentTransactionId": "00000000-0000-0000-0000-000000000000",
  "routeId": "00000000-0000-0000-0000-000000000000"
}

{
  "code": "0065",
  "message": "<string>",
  "title": "Invalid Path Parameter",
  "entityType": "Account",
  "fields": {}
}

Autorizaciones

Authorization

string

header

requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id

string

requerido

Organization ID (UUID)

ledger_id

string

requerido

Ledger ID (UUID)

transaction_id

string

requerido

Transaction ID (UUID)

Respuesta

Created

amount

string | null

requerido

Ejemplo:

"1500"

assetCode

string

requerido

Required string length: 2 - 10

Ejemplo:

"BRL"

chartOfAccountsGroupName

string

requerido

Maximum string length: 256

Ejemplo:

"Chart of accounts group name"

createdAt

string<date-time>

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

deletedAt

string<date-time> | null

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

description

string

requerido

Maximum string length: 256

Ejemplo:

"Transaction description"

destination

string[] | null

requerido

Ejemplo:

["@person2"]

string<uuid>

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId

string<uuid>

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

operations

object[] | null

requerido

Show child attributes

organizationId

string<uuid>

requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

route

string

requerido

Maximum string length: 250

Ejemplo:

"00000000-0000-0000-0000-000000000000"

source

string[] | null

requerido

Ejemplo:

["@person1"]

status

object

requerido

Show child attributes

updatedAt

string<date-time>

requerido

Ejemplo:

"2021-01-01T00:00:00Z"

metadata

object

Show child attributes

parentTransactionId

string<uuid>

Ejemplo:

"00000000-0000-0000-0000-000000000000"

routeId

string<uuid>

Ejemplo:

"00000000-0000-0000-0000-000000000000"

Primeros pasos

Actual (v2)

Compatibilidad (v1)

Manejo de errores

Revertir una Transacción

Autorizaciones

Parámetros de ruta

Respuesta