Skip to main content
PATCH
cURL
Update a saved settlement beneficiary by ID.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

beneficiaryId
string
required

Body

application/json
nickname
string

Human-readable label for this beneficiary

isDefault
boolean

Whether this is the default beneficiary

beneficiaryType
enum<string>

bank or crypto — determines which fields apply

Available options:
bank,
crypto
accountName
string

Name on the bank account

accountNumber
string

Bank account number

bankName
string

Bank name (e.g. Equity Bank)

bankCode
string

Bank code / sort code (optional)

walletAddress
string

Crypto wallet address

chain
string

Blockchain chain (e.g. Polygon, Tron, BSC)

token
string

Token/asset symbol on the chain (e.g. USDT, USDC)

name
string

Full name of the beneficiary (display)

accountType
string

Account type: Exchange / Non-Custodial / Bank (legacy)

network
string

Network sub-type (legacy — prefer token field for asset)

Response

200 - undefined