Crypto v3 (beta)
The v3 crypto endpoints TypeIDs, snake_case fields and the v3 error body (see the API v3 overview).
Create a Deposit Wallet
Opens a deposit wallet for an account in one coin, at the custodian BlockWyre uses for that coin, and answers its address. Coins sent to the address are credited to the account's balance in that coin.
List Deposit Wallets
The deposit wallets of the workspace or of one account, newest first. Wallets created through v2 are listed too. Counterparties are not: they have their own list.
Get a Deposit Wallet
One deposit wallet, by id. A wallet created through v2 can be read too, by its id in TypeID form.
Rename a Deposit Wallet
Changes a deposit wallet's label. Nothing else about the wallet changes: its coin and address are fixed.
Deposit Wallet Totals
Four counts over the deposit wallets: how many there are, how many accounts hold one, how many counterparties are saved, and the coin with the most wallets.
Save a Counterparty
Saves a destination an account can withdraw to: a coin and an address, plus the memo on chains that route by one. v2 calls it a beneficiary; it is the same record.
List Counterparties
The saved withdrawal destinations of the workspace or of one account, newest first. Beneficiaries saved through v2 are listed too. Deleted counterparties are not.
Get a Counterparty
One saved withdrawal destination, by id. A beneficiary saved through v2 can be read too, by its id in TypeID form.
Rename a Counterparty
Changes a counterparty's label. The label is the only thing that can change: the coin, address and memo are what the counterparty is. To pay a different address, save a new counterparty.
Delete a Counterparty
Removes a counterparty, so it is no longer listed and cannot be withdrawn to. Refused while a withdrawal to it is still open. The record is kept, so the withdrawals that named it still find it, and saving the same destination again brings it back with the same id.
Preview a Crypto Withdrawal
Quotes a withdrawal to a counterparty without making it: the fee, what the counterparty receives, and whether the account's balance covers it. Nothing is stored and nothing is reserved; the id it answers cannot be looked up.
Create a Crypto Withdrawal
Sends crypto from an account's balance to one of its counterparties. The amount is reserved on the balance at once, moving from its available to its pendingdebits, and the withdrawal starts pending. For five minutes, until graceends_at, it can be cancelled; then it is submitted to the custodian and sent to the network.
Get a Crypto Withdrawal
One crypto withdrawal created through v3, by id. Withdrawals created through v2 are not found here: read them through v2.
Cancel a Crypto Withdrawal
Cancels a withdrawal that is still pending, waiting out its grace period (graceendsat). The reserved amount returns to the account's available balance. Once the withdrawal is submitted to the custodian it is processing, and it can no longer be cancelled.