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)

​
balance_id
string
required

Balance ID (UUID)

Response

OK

​
accountId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
accountType
string
required
Maximum string length: 50
Example:

"creditCard"

​
alias
string
required
Maximum string length: 256
Example:

"@person1"

​
allowReceiving
boolean
required
Example:

true

​
allowSending
boolean
required
Example:

true

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

"USD"

​
available
string
required
Example:

"1500"

​
createdAt
string<date-time>
required
Example:

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

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

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

​
id
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
key
string
required
Maximum string length: 100
Example:

"asset-freeze"

​
ledgerId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
onHold
string
required
Example:

"500"

​
organizationId
string<uuid>
required
Example:

"00000000-0000-0000-0000-000000000000"

​
overdraftUsed
string
required
Example:

"0"

​
updatedAt
string<date-time>
required
Example:

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

​
version
integer<int64>
required
Required range: x >= 1
Example:

1

​
direction
string
Example:

"credit"

​
metadata
object
​
settings
object