v1

latestOpenAPI 3.0.0Proprietary2026-07-2233792.6 KB

Crypto Wallet

Generate Wallet Address

Generates a permanent deposit wallet address for a specified asset. Each address is unique and reusable, so you only need to call this once per user per asset. Store the returned address and display it for future deposits. Optionally pass bank details and autoSettlement so incoming crypto can be paid out to that bank.

A trade.address.created webhook is sent as a fallback once the address is live, containing the address, asset, and label.

post/trades/sell/assets/{id}/generate-address

Path parameters

idstring required

ID of the crypto asset. Returned by the list sell assets endpoint.

Request body

labelstring required

A unique name for the wallet address.

bankIdstring

Optional. Bank identifier from the GET /payments/banks endpoint. Only required if you want to automatically offramp deposits to a bank account. Must be provided together with accountNumber.

narrationstring

Optional. A short note included with bank settlement payouts. Maximum 32 characters. Only applies when bankId and accountNumber are provided.

accountNumberstring

Optional. Bank account number for automatic offramp. Only required if you want deposits to this address to be automatically settled to a bank account. Must be provided together with bankId.

autoSettlementboolean

Optional. When true, incoming crypto to this address is auto-settled to the linked bank. Omit or use false to keep funds in the wallet.

Example request

{
  "label": "unique-identifier",
  "bankId": "39",
  "narration": "Breet payout",
  "accountNumber": "215842XXXX",
  "autoSettlement": true
}

Response

Wallet address generated successfully