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)

alias
string
obrigatório

Account alias (e.g. @person1)

Resposta

OK

alias
string | null
obrigatório
Maximum string length: 100
Exemplo:

"@treasury_checking"

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

"USD"

blocked
boolean | null
obrigatório
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"

entityId
string | null
obrigatório
Maximum string length: 256
Exemplo:

"EXT-ACC-12345"

holderCheckSkipped
boolean
obrigatório
Exemplo:

false

holderId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

id
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

ledgerId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

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

"Corporate Checking Account"

organizationId
string<uuid>
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

parentAccountId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

portfolioId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

segmentId
string<uuid> | null
obrigatório
Exemplo:

"00000000-0000-0000-0000-000000000000"

status
object
obrigatório
type
string
obrigatório
Exemplo:

"deposit"

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

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

metadata
object