Skip to main content
GET
Error

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

OK

​
accountAlias
string
required
Maximum string length: 256
Example:

"@person1"

​
accountId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
amount
object
required
​
assetCode
string
required
Required string length: 2 - 10
Example:

"BRL"

​
balance
object
required
​
balanceAffected
boolean<boolean>
required
Example:

true

​
balanceAfter
object
required
​
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"

​
id
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
ledgerId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
metadata
object
required
​
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
​
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"