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)

​
code
string
required

Account external code (e.g. BRL)

Response

OK

​
alias
string | null
required
Maximum string length: 100
Example:

"@treasury_checking"

​
assetCode
string
required
Maximum string length: 100
Example:

"USD"

​
blocked
boolean | null
required
​
createdAt
string<date-time>
required
Example:

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

​
deletedAt
string<date-time> | null
required
Example:

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

​
entityId
string | null
required
Maximum string length: 256
Example:

"EXT-ACC-12345"

​
id
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
ledgerId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
name
string
required
Maximum string length: 256
Example:

"Corporate Checking Account"

​
organizationId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
parentAccountId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

​
portfolioId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

​
segmentId
string<uuid> | null
required
Example:

"00000000-0000-0000-0000-000000000000"

​
status
object
required
​
type
string
required
Example:

"deposit"

​
updatedAt
string<date-time>
required
Example:

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

​
metadata
object