v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Beneficiaries

Update

This endpoint allows you to update the details of a specific beneficiary associated with a wallet.

Body Parameters

Key	Required	Type	Description
name	false	string	The name of the beneficiary.
isSettlement	false	boolean	Indicates if the beneficiary is set for settlement.
settlementFrequency	false*	enum	The settlement frequency (INSTANT, DAILY, WEEKLY, MONTHLY, YEARLY). Required only if isSettlement = true.
isWhitelisted	false	boolean	Indicates whether the beneficiary address should be whitelisted. Whitelisted addresses restrict withdrawals to only whitelisted addresses for enhanced security.
isActive	false	boolean	Determines whether the beneficiary is active.

patch/v1/wallets/{walletId}/beneficiaries/{id}

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": "WEEKLY",
    "updatedAt": "2025-08-27T22:27:17.071Z"
  },
  "message": "Beneficiary updated successfully",
  "statusCode": 200
}