#The payout sequence
- Create a recipient:
POST /v1/recipientswithapp_ref,display_name,kind,category. - Add a destination (the phone number money goes to):
POST /v1/recipients/{id}/destinations. - Read balances:
GET /v1/recipients/{id}/balancesreturnspending,unreleased,available,reserved,paid. Onlyavailablecan be paid. - Release a delivered payment:
POST /v1/releases. - Pay:
POST /v1/settlementscreates an instruction;POST /v1/settlements/{id}/executedrecords that the app executed it (forapp_escrow).POST /v1/withdrawalsrecords a recipient's own request; it does not execute anything itself.
- Read state:
GET /v1/settlements,GET /v1/settlements/{id},GET /v1/withdrawals/{id}.
#Balances
Amounts draw on available minus reserved. An instruction above the balance is refused.