Get distributor burn wallet by asset ID

Returns the AUDD burn wallets for an asset, which is where you send AUDD before calling POST /trades/sell. Note that the path parameter is the ASSET id, not a wallet id.

The response carries tradeWallet, the single burn wallet resolved for the caller (unchanged from earlier versions of this API), and burnWallets, the full pool of burn wallets the caller may pay. Each entry has id, publicKey, network and status. Clients with one burn wallet get a one-entry list equal to tradeWallet.

The pool is static: repeated calls return the same list, and assigning an address to a customer and releasing it after the hold window is the client's responsibility. Cache the list, pass the chosen entry's id as tradeWalletId on POST /trades/sell, and refresh it periodically or when a sell is rejected with trade.wallet_not_eligible.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The id of the AUDD asset being burned, from GET /assets.

Query Params
string

Whether the amount sent on chain is checked against the burn request. Defaults to true.

string

Optional. The id of your registered wallet that will send the AUDD. When supplied, burnWallets includes any burn wallet mapped specifically to that wallet as well as those mapped to your company. When omitted, the pool is resolved from your company alone and tradeWallet is its first entry; every entry is accepted for a sell from any of your wallets.

Headers
string
required

Bearer JWT obtained from POST /mfa/login. Send as "Bearer ". Expires after 5 minutes.

Responses
200

Success. Body: tradeWallet (the resolved burn wallet), burnWallets (array of burn wallets with id, publicKey, network, status), asset, distributorCompany, distributorWallet when walletId was supplied, buyEnabled, sellEnabled.

400

Invalid request. Returned when the path parameter is not an asset id that resolves, when walletId names a wallet that cannot be used with this asset, or (asset.distributor_wallet_required) when walletId is omitted by a caller that does not belong to a company.

401

Unauthorized

403

Forbidden

404

Not found

500

Internal server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!