In a nutshell
Beneficiaries are saved payout destinations — named wallet addresses you can reference by ID instead of passing raw addresses every time you send funds. Think of them as your contacts list for crypto payments.
Beneficiaries are saved payout destinations — named wallet addresses you can reference by ID instead of passing raw addresses every time you send funds. Think of them as your contacts list for crypto payments.
Prerequisites
API Key
Get your API key from the Blockradar Dashboard. Navigate to Developers to generate one.
How It Works
Every time you send a payout, you need a destination address. For one-off transfers, passing the address directly is fine. But for recurring payments: payroll, partner settlements, user withdrawals to known wallets, storing and managing addresses manually introduces risk: typos, copy-paste errors, and no audit trail. Beneficiaries solve this by letting you register a destination address once, give it a name, and reference it by ID in all future payouts.Save Once, Use Many Times
Register a destination address as a named beneficiary and reuse it across any number of withdrawals.
Reduce Human Error
Eliminate copy-paste mistakes by referencing addresses by ID rather than entering them manually each time.
Audit Trail
Every beneficiary has a creation timestamp and name, making it easy to track who you’re paying and when the relationship was established.
Whitelisting
Use beneficiaries as part of an address whitelisting strategy to restrict payouts to pre-approved destinations only.
Creating a Beneficiary
Using a Beneficiary in a Payout
Once saved, reference the beneficiary ID when executing a withdrawal instead of passing the raw address.Managing Beneficiaries
| Action | Endpoint |
|---|---|
| Create | POST /v1/wallets/{walletId}/beneficiaries |
| Get All | GET /v1/wallets/{walletId}/beneficiaries |
| Get One | GET /v1/wallets/{walletId}/beneficiaries/{beneficiaryId} |
| Update | PATCH /v1/wallets/{walletId}/beneficiaries/{beneficiaryId} |
| Delete | DELETE /v1/wallets/{walletId}/beneficiaries/{beneficiaryId} |
Best Practices
- Name beneficiaries clearly — use names that identify the person, team, or purpose (e.g. “Finance Team - Polygon”, “User Payout - Alice”).
- Review regularly — periodically audit your beneficiary list and remove destinations that are no longer active.
- Combine with whitelisting — if your compliance requirements restrict payouts to approved addresses only, use beneficiaries as your whitelist layer.
API Reference
| Endpoint | Description |
|---|---|
| Create Beneficiary | Save a new destination address |
| Get All Beneficiaries | List all saved beneficiaries |
| Get Beneficiary | Fetch a single beneficiary by ID |
| Update Beneficiary | Update a beneficiary’s name or details |
| Delete Beneficiary | Remove a beneficiary |

