Create Withdrawal


Withdrawals send coins to a specified address over the coin networks. Withdrawal is only allowed using Default Merchant Api key and Api secret.


Field Name Description Required?
Create Withdrawal
cmd create_withdrawal Yes
amount The amount of the withdrawal in the currency below. Yes
currency The cryptocurrency to withdraw. (BTC, LTC, etc.) Yes
currency2 Optional currency to use to to withdraw 'amount' worth of 'currency2' in 'currency' coin. This is for exchange rate calculation only and will not convert coins or change which currency is withdrawn.
For example, to withdraw 1.00 USD worth of BTC you would specify 'currency'='BTC', 'currency2'='USD', and 'amount'='1.00'
address The address to send the funds to, either this OR pbntag must be specified.
Remember: this must be an address in currency's network.
See Desc
note This lets you set the note for the withdrawal. No

API Response

A successful call to the 'create_withdrawal' command will give you a result similar to this (JSON):
      "id":"hex string",
      "amount":1.00, // The amount withdrawn
The result wil have the following fields:
  • id = The LivePay withdrawal ID. (This is not a coin network TX ID.)
  • status = 0 or 1. 0 = Withdrawal created, waiting for email confirmation. 1 = Withdrawal created with no email confirmation needed.