Create Settlement Beneficiary

curl --request POST \ --url https://sandbox-api.kotanipay.com/api/v3/integrator/settlement-config/beneficiaries \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "nickname": "<string>", "isDefault": true, "accountName": "<string>", "accountNumber": "<string>", "bankName": "<string>", "bankCode": "<string>", "walletAddress": "<string>", "chain": "<string>", "token": "<string>", "name": "<string>", "accountType": "<string>", "network": "<string>" } '

Authorizations

Authorization

string

header

required

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

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

201 - undefined