Skip to main content
GET
Error

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

organization_id
string
obrigatório

Organization ID (UUID)

ledger_id
string
obrigatório

Ledger ID (UUID)

account_id
string
obrigatório

Account ID (UUID)

operation_id
string
obrigatório

Operation ID (UUID)

Resposta

OK

accountAlias
string
obrigatório
Maximum string length: 256
Exemplo:

"@person1"

accountId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

amount
object
obrigatório
assetCode
string
obrigatório
Required string length: 2 - 10
Exemplo:

"BRL"

balance
object
obrigatório
balanceAffected
boolean<boolean>
obrigatório
Exemplo:

true

balanceAfter
object
obrigatório
balanceId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

balanceKey
string
obrigatório
Maximum string length: 100
Exemplo:

"asset-freeze"

chartOfAccounts
string
obrigatório
Maximum string length: 20
Exemplo:

"1000"

createdAt
string<date-time>
obrigatório
Exemplo:

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

deletedAt
string<date-time> | null
obrigatório
Exemplo:

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

description
string
obrigatório
Maximum string length: 256
Exemplo:

"Credit card operation"

id
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

metadata
object
obrigatório
organizationId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

route
string
obrigatório
Maximum string length: 250
Exemplo:

"00000000-0000-0000-0000-000000000000"

status
object
obrigatório
transactionId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

type
string
obrigatório
Maximum string length: 50
Exemplo:

"DEBIT"

updatedAt
string<date-time>
obrigatório
Exemplo:

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

direction
string
Maximum string length: 50
Exemplo:

"debit"

routeCode
string
Maximum string length: 100
Exemplo:

"ROUTE-001"

routeDescription
string
Maximum string length: 250
Exemplo:

"Settlement route for service charges"

routeId
string<uuid>
Exemplo:

"00000000-0000-0000-0000-000000000000"