Disclaimer banner cps-icon-v2

This documentation applies to the Legacy platform. If your dashboard matches the screenshot shown here, please refer to the new platform documentation.

Disclaimer banner image
New documentation
Disclaimer banner image

Get Withdrawal Information

API POST Fields (in addition to the Main Fields described in the Introduction)

Field Name
Get Withdrawal Information
cmd
Descriptionget_withdrawal_info
Required?Yes
id
DescriptionThe withdrawal ID to query.
Required?Yes
Field NameDescriptionRequired?
Get Withdrawal Information
cmdget_withdrawal_infoYes
idThe withdrawal ID to query.Yes

API Response

A successful call to the 'get_withdrawal_info' command will give you a result similar to this (JSON):
{  
   "error":"ok",
   "result":{  
      "time_created":1391924372,
      "status":2,
      "status_text":"Complete",
      "coin":"BTC",
      "amount":40000000,
      "amountf":"0.40000000",
      "send_address":"1BitcoinAddress",
      "send_txid":"hex_txid"
   }
}
The result wil have the following fields:
  • time_created = The time the withdrawal request was submitted.
  • status = The status of the withdrawal (-1 = Cancelled, 0 = Waiting for email confirmation, 1 = Pending, 2 = Complete).
  • status_text = The status of the withdrawal in text format.
  • coin = The ticker symbol of the coin for the withdrawal.
  • amount = The amount of the withdrawal (in Satoshis).
  • amountf = The amount of the withdrawal (as a floating point number).
  • send_address = The address the withdrawal was sent to. (only in response if status == 2)
  • send_txid = The coin TX ID of the send. (only in response if status == 2)