Skip to main content
POST
Beneficiaries

Create

Response (201 Created):
The full account number is never returned. Beneficiaries are isolated by the authenticated tenant and environment. A test identifier cannot be used in live mode, and a cross-tenant identifier is treated as invalid.

List beneficiaries

Sign the request with your backend HMAC credential. limit is an integer from 1 to 100 and defaults to 50. The response is { "data": [...] }; each entry has the create-response fields plus status (active or disabled). This endpoint currently returns a bounded list with no pagination cursor. Use an active beneficiary for new payouts. Full account numbers are omitted from both create and list responses.

Stored or inline

POST /v1/payouts accepts exactly one of:
  • beneficiary_id: reuse a stored active beneficiary; or
  • beneficiary: send the complete object inline.
Inline destinations are fingerprinted within the tenant/environment boundary so idempotent retries do not create duplicate beneficiary records.