Skip to main content
GET
Get the organisation's credit wallet

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Ankra-Organisation-Id
string<uuid>

Act in another organisation the token's owner is an active member of; defaults to the token's own organisation.

Response

The organisation's credit wallet

present
boolean
required

False for an organisation nobody has credited.

state
enum<string>
required
Available options:
absent,
funded,
low,
grace,
restricted,
frozen
currency
string
required
balance_micros
integer
required

The balance in millionths of the currency unit.

balance_display
string
required
overdraft_micros
integer
required
net_position_micros
integer
required
net_position_display
string
required
frozen_at
string<date-time> | null
required
frozen_reason
string | null
required
zero_balance_at
string<date-time> | null
required
first_credited_at
string<date-time> | null
required
lots
object[]
required

The open lots in the order they are spent.

top_ups_enabled
boolean
required
min_top_up_cents
integer
required
max_top_up_cents
integer
required