Get Operation

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

{ "code": "ERR-0001", "detail": "Property foo is required but is missing.", "errors": [ { "location": "<string>", "message": "<string>", "value": "<unknown>" } ], "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "https://example.com/errors/example", "upstream": { "code": "E4001", "message": "account not found at provider" } }

Authorizations

Authorization

string

header

required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id

string

required

Organization ID (UUID)

ledger_id

string

required

Ledger ID (UUID)

account_id

string

required

Account ID (UUID)

operation_id

string

required

Operation ID (UUID)

Response

accountAlias

string

required

Maximum string length: 256

Example:

"@person1"

accountId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

amount

object

required

Show child attributes

assetCode

string

required

Required string length: 2 - 10

Example:

"BRL"

balance

object

required

Show child attributes

balanceAffected

boolean<boolean>

required

Example:

true

balanceAfter

object

required

Show child attributes

balanceId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

balanceKey

string

required

Maximum string length: 100

Example:

"asset-freeze"

chartOfAccounts

string

required

Maximum string length: 20

Example:

"1000"

createdAt

string<date-time>

required

Example:

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

deletedAt

string<date-time> | null

required

Example:

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

description

string

required

Maximum string length: 256

Example:

"Credit card operation"

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

ledgerId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

metadata

object

required

Show child attributes

organizationId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

route

string

required

Maximum string length: 250

Example:

"00000000-0000-0000-0000-000000000000"

status

object

required

Show child attributes

transactionId

string<uuid>

required

Example:

"00000000-0000-0000-0000-000000000000"

type

string

required

Maximum string length: 50

Example:

"DEBIT"

updatedAt

string<date-time>

required

Example:

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

direction

string

Maximum string length: 50

Example:

"debit"

routeCode

string

Maximum string length: 100

Example:

"ROUTE-001"

routeDescription

string

Maximum string length: 250

Example:

"Settlement route for service charges"

routeId

string<uuid>

Example:

"00000000-0000-0000-0000-000000000000"

Getting started

Current (v2)

Compatibility (v1)

Error handling

Authorizations

Path Parameters

Response