Skip to main content
GET
Retrieve an allocation

Authorizations

Authorization
string
header
required

Authorization: Bearer <key>. Sandbox keys start with mgw_test_ and live keys start with mgw_live_. Each key works only in its own environment, and a live key works only from the IP addresses or ranges registered for it.

Path Parameters

id
string
required

The allocation's id.

Response

An allocation.

object
string
required
Allowed value: "allocation"
id
string
required

Unique identifier for the allocation, also used as the broker's reference for the deposit. Starts with alc_.

account
string
required
amount_kobo
integer<int64>
required
state
enum<string>
required

sending: reserved, and the send is in progress. booked: the broker booked it into the account's balance. uncertain: we don't know whether the broker booked it. The amount stays reserved, we don't send it again, and we reconcile it with the broker. rejected: the broker rejected it, and the amount is returned to your wallet. refused: it never reached the broker, and the amount is returned to your wallet.

Available options:
sending,
booked,
uncertain,
rejected,
refused
reason
string | null
required

A sentence explaining the allocation's current state. It's for people to read, so don't use it in your logic.

reject_reason
enum<string> | null
required

Why the broker rejected the allocation. Set only when state is rejected.

Available options:
invalid_amount,
closed_financial_year,
account_not_at_broker,
rejected_by_broker,
null
created_at
string<date-time>
required
updated_at
string<date-time>
required