Skip to main content
GET
Get an account

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Path Parameters

id
string
required

The id.

Response

OK

id
string

acc_…

code
string

TYPE:GROUP:CCY[:PARTY|SEQ], for example LIA:WAL:NGN:0193

name
string
type
enum<string>
Available options:
ASSET,
LIABILITY,
EQUITY,
INCOME,
EXPENSE
normalSide
enum<string>
Available options:
DEBIT,
CREDIT
currency
string
ownerRef
string

opaque product-side id; never PII

status
enum<string>
Available options:
ACTIVE,
FROZEN,
CLOSED
category
enum<string>

What the console groups by. Derived from the code's group segment.

WALLET: customer money

SETTLEMENT: mirror of a partner omnibus

INTERNAL: suspense, clearing, fees, FX position, equity

Available options:
WALLET,
SETTLEMENT,
INTERNAL
balance
object
overdraftLimit
string

Minor units, as a string.

pendingApprovalId
string

Set while a freeze or unfreeze approval is waiting.

namedAccounts
object[]
createdAt
string<date-time>
updatedAt
string<date-time>