Skip to main content
POST
/
trades
/
sell
/
assets
/
{id}
/
generate-address
Generate Wallet Address
curl --request POST \
  --url https://api.breet.io/v1/trades/sell/assets/{id}/generate-address \
  --header 'Content-Type: application/json' \
  --header 'X-Breet-Env: <api-key>' \
  --header 'x-app-id: <api-key>' \
  --header 'x-app-secret: <api-key>' \
  --data '
{
  "label": "unique-identifier",
  "bankId": "39",
  "narration": "Breet payout",
  "accountNumber": "215842XXXX",
  "autoSettlement": true
}
'
{
  "message": "wallet address generated successfully",
  "success": true,
  "data": {
    "id": "6932dc98c2ceccdea367388a",
    "address": "TV8dNYYBgL3xLbQcJLMBNavY4gYNqPF8Jv"
  },
  "meta": {},
  "summary": {},
  "stats": {}
}

Authorizations

​
x-app-id
string
header
required

Your application ID from the Breet dashboard

​
x-app-secret
string
header
required

Your application secret from the Breet dashboard

​
X-Breet-Env
string
header
required

Environment selector: development or production

Path Parameters

​
id
string
required

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

Body

application/json
​
label
string
required

A unique name for the wallet address.

​
bankId
string

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.

​
narration
string

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

​
accountNumber
string

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.

​
autoSettlement
boolean

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.

Response

Wallet address generated successfully