API POST Fields (in addition to the Main Fields described in the Introduction)
| Field Name |
|---|
| Get Withdrawal History |
|---|
| cmd |
|---|
| Description | get_withdrawal_history |
| Required? | Yes |
| limit |
|---|
| Description | The maximum number of withdrawals to return from 1-100. (default: 25) |
| Required? | No |
| start |
|---|
| Description | What withdrawals # to start from (for iteration/pagination.) (default: 0, starts with your newest withdrawals.) |
| Required? | No |
| newer |
|---|
| Description | Return withdrawals submitted at the given Unix timestamp or later. (default: 0) |
| Required? | No |
| Field Name | Description | Required? |
|---|
| Get Withdrawal History |
|---|
| cmd | get_withdrawal_history | Yes |
| limit | The maximum number of withdrawals to return from 1-100. (default: 25) | No |
| start | What withdrawals # to start from (for iteration/pagination.) (default: 0, starts with your newest withdrawals.) | No |
| newer | Return withdrawals submitted at the given Unix timestamp or later. (default: 0) | No |
API Response
A successful call to the 'get_withdrawal_history' command will give you a result similar to this (JSON):
{
"error":"ok",
"result":[{
"id":"CW...",
"time_created":1391924372,
"status":2,
"status_text":"Complete",
"coin":"BTC",
"amount":40000000,
"amountf":"0.40000000",
"note":"Your Withdrawal Note",
"send_address":"1BitcoinAddress",
"send_dest_tag":"4782384",
"send_txid":"hex_txid"
}]
}
The result wil have the following fields:
- id = This withdrawal ID.
- 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).
- note = The withdrawal note (if you have one set.)
- send_address = The address the withdrawal was sent to. (only in response if status == 2)
- send_dest_tag = The destination tag/payment ID/etc. the withdrawal was sent to. (only in response if coin supports destination tags/payment IDs/etc.)
- send_txid = The coin TX ID of the send. (only in response if status == 2)
