Guides

Receive money

Create an endpoint, simulate an inbound credit, read the balance.

Stand up a place to be paid, simulate a payment into it, and watch the balance land. Three calls.

01 · Mint a collection child

External money needs an endpoint whose receive posture is external_and_internal — a collection child.

POST /v1/programmable-endpoints
{ "template": "customer_balance_collection_child",
  "owner": { "kind": "existing_account_owner",
             "ownerRef": "…", "ownerKind": "business-entity" },
  "valueUnit": { "kind": "fiat", "currency": "NGN" } }

The response carries the endpoint's locator: accountRef, endpointRef, holdingRef.

02 · Simulate an inbound credit

Point the credit at the endpoint you just minted.

POST /v1/sandbox/inbound-credits
{ "accountRef": "…", "endpointRef": "…", "holdingRef": "…",
  "valueUnit": { "kind": "fiat", "currency": "NGN" },
  "amountMinorUnits": "2500" }

It answers 202 — evidence published; posting projects asynchronously.

03 · Read the balance
Read by account and endpoint; the settled and available amounts come back per holding.
```
GET /v1/balances/current?accountRef=…&endpointRef=…
```
The credit lands as available balance once the projection catches up — poll if you funded a moment ago.