Sell assets

Redeems AUDD you have already sent to the burn wallet, settling the AUD into one of your deposit virtual accounts.

Send the AUDD on chain first, then call this with the resulting blockchainTxId. Retrieve the burn wallet address with GET /trades/burn-wallet/{id} beforehand.

Settlement is asynchronous and is confirmed by webhook rather than in this response: the AUD arrives as a DEPOSIT balance record carrying a tradeId that matches the trade returned here. Match on that tradeId, not on the description, to tell a burn settlement apart from an ordinary customer deposit.

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

Id of the deposit virtual account the redeemed AUD settles into.

string
enum
required

Currency of the trade. It must match the currency of the bank account, and a mismatch is rejected with bank_account.invalid_currency.

Allowed:
string
required

Id of the registered wallet that sent the AUDD to the burn wallet.

string
required

Id of the AUDD asset on the wallet's network, from GET /assets?network=. An id that does not resolve is rejected with trade.asset_not_found.

number
required

Amount of AUDD to burn, which must equal the amount sent on chain. Must be at least 1, and carry no more decimal places than the currency's minor unit allows, which is 2 for AUD. A finer amount is rejected with trade.invalid_asset_decimal_places.

string

The transaction hash or id of the on-chain transfer that moved the AUDD to the burn wallet. Required whenever verifyExternalPaymentAmount is true, which is the default, so in practice every burn from a wallet you hold yourself must supply it. Omitting it is rejected with trade.blockchain_transaction_id_required.

boolean
Defaults to true

Whether the amount observed on chain is checked against assetAmount.

Headers
string
required

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

Responses

400

Invalid input, with a messageKey identifying the rule that failed: trade.bank_account_required, trade.wallet_required, trade.asset_required, trade.asset_amount_required, bank_account.currency_required, bank_account.invalid_amount (assetAmount may have at most 7 decimal places), and trade.asset_not_found when assetId does not resolve.

401

Unauthorized. The bearer token is missing, expired or invalid.

404

Not found. The bank account or wallet does not resolve to a record you can see.

500

Internal server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json