Buy assets

Mints AUDD to one of your registered wallets, paid for from a deposit virtual account.

Four things must already exist: a DEPOSIT bank account holding cleared AUD, an ACTIVE wallet registered with POST /wallets/external, the id of the AUDD asset on that wallet's network from GET /assets, and enough available balance to cover the amount. The wallet and the asset must be on the same network.

The AUD is debited from the funding account as a WITHDRAWAL balance record, visible through GET /bank-accounts/{id}/balance-records. Minting is asynchronous: the response carries a transactionId you can follow with GET /transactions/{id}, and completion time depends on the chain.

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 holding the cleared AUD that funds the mint.

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 receives the minted AUDD. Must be ACTIVE and on the same network as the asset.

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 mint. 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

Optional note carried with the mint, where the network supports one.

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. Insufficient funds in the bank account are also rejected here.

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