Skip to main content
A beneficiary is a saved payout destination (bank account, mobile money, stablecoin address, and so on). Create one once, then reference its id on every payout.

Flow

  1. Inspect corridors for the scheme and required fields
  2. POST /v1/beneficiaries with those fields
  3. Pass beneficiary_id to payouts

Updates and archive

  • PATCH /v1/beneficiaries/{id} — change mutable fields (name, metadata)
  • POST /v1/beneficiaries/{id}/archive — soft-delete; existing payouts keep their snapshot
List with GET /v1/beneficiaries. Fetch one with GET /v1/beneficiaries/{id}.

Next