Beneficiaries
Verified recipients for payouts and remittances.
Overview
Beneficiaries are validated once (bank details, phone, ID) and reused across withdrawals and remittances.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /v1/beneficiaries | Create and enqueue verification. |
| GET | /v1/beneficiaries/{id} | Retrieve including verification status. |
| PATCH | /v1/beneficiaries/{id} | Update contact info (re-triggers verification if bank changes). |
| GET | /v1/beneficiaries | List with filters. |
| DELETE | /v1/beneficiaries/{id} | Soft-delete (blocks future payouts). |
POST /v1/beneficiaries
POST/v1/beneficiaries
Create and enqueue verification.
GET /v1/beneficiaries/{id}
GET/v1/beneficiaries/{id}
Retrieve including verification status.
PATCH /v1/beneficiaries/{id}
PATCH/v1/beneficiaries/{id}
Update contact info (re-triggers verification if bank changes).
GET /v1/beneficiaries
GET/v1/beneficiaries
List with filters.
DELETE /v1/beneficiaries/{id}
DELETE/v1/beneficiaries/{id}
Soft-delete (blocks future payouts).