Console
Docs/Core concepts

Payouts

Recipients, balances, releases and settlement instructions.

#The payout sequence

  1. Create a recipient: POST /v1/recipients with app_ref, display_name, kind, category.
  2. Add a destination (the phone number money goes to): POST /v1/recipients/{id}/destinations.
  3. Read balances: GET /v1/recipients/{id}/balances returns pending, unreleased, available, reserved, paid. Only available can be paid.
  4. Release a delivered payment: POST /v1/releases.
  5. Pay:
    • POST /v1/settlements creates an instruction; POST /v1/settlements/{id}/executed records that the app executed it (for app_escrow).
    • POST /v1/withdrawals records a recipient's own request; it does not execute anything itself.
  6. 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.

Reference

Every route, parameter and response is generated from the OpenAPI 3.1 document.

Open the API reference