Update an Operation

Metadata is applied as an RFC 7396 merge patch: a body without metadata, or with an empty metadata object, leaves the stored metadata as it is; a key sent as null is deleted; any other key is added or replaced; metadata sent as null deletes every key the client wrote.

PATCH /v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id}

Update an Operation

cURL

curl --request PATCH \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/operations/{operation_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Credit card operation",
  "metadata": {}
}
'

200

{
  "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"
}

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)

operation_id · string · requerido

Operation ID (UUID)

Cuerpo

application/json

description · string

Maximum string length: 256

Ejemplo:

"Credit card operation"

metadata · object

Show child attributes

Respuesta

200

application/json

OK

accountAlias · string · requerido

Maximum string length: 256

Ejemplo:

"@person1"

accountId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

amount · object · requerido

Show child attributes

assetCode · string · requerido

Required string length: 2 - 10

Ejemplo:

"BRL"

balance · object · requerido

Show child attributes

balanceAffected · boolean<boolean> · requerido

Ejemplo:

true

balanceAfter · object · requerido

Show child attributes

balanceId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

balanceKey · string · requerido

Maximum string length: 100

Ejemplo:

"asset-freeze"

chartOfAccounts · string · requerido

Maximum string length: 20

Ejemplo:

"1000"

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:

"Credit card operation"

id · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

metadata · object · 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"

status · object · requerido

Show child attributes

transactionId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

type · string · requerido

Maximum string length: 50

Ejemplo:

"DEBIT"

updatedAt · string<date-time> · requerido

Ejemplo:

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

direction · string

Maximum string length: 50

Ejemplo:

"debit"

routeCode · string

Maximum string length: 100

Ejemplo:

"ROUTE-001"

routeDescription · string

Maximum string length: 250

Ejemplo:

"Settlement route for service charges"

routeId · string<uuid>

Ejemplo:

"00000000-0000-0000-0000-000000000000"