v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Beneficiaries

Create

This endpoint allows you to add a beneficiary to a specific wallet.

Body Parameters

Key	Required	Type	Description
name	true	string	The name of the beneficiary (e.g., "Ledger Wallet").
address	true	string	The wallet address of the beneficiary.
settlementFrequency	false	enum	How often settlements should occur. Possible values: INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY.
isWhitelisted	false	boolean	Indicates whether the beneficiary address should be whitelisted. Whitelisted addresses restrict withdrawals to only whitelisted addresses for enhanced security.

post/v1/wallets/{walletId}/beneficiaries

Response

200

messagestring

statusCodenumber

Example response

{
  "data": {
    "address": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
    "createdAt": "2025-08-27T22:27:17.071Z",
    "id": "cc7a86eb-28f8-49e0-aa77-eb01bb38ad2b",
    "isActive": true,
    "isSettlement": true,
    "isWhitelisted": true,
    "name": "Ledger Wallet",
    "settlementFrequency": "DAILY",
    "updatedAt": "2025-08-27T22:27:17.071Z"
  },
  "message": "Beneficiary created successfully",
  "statusCode": 200
}