API POST Fields
In addition to the Main Fields described in the API Basics > Introduction
Create Transfer
Field Name | Description | Required? |
cmd | create_transfer | Yes |
amount | The amount of the transfer in the currency below. | Yes |
currency | The cryptocurrency to withdraw. (BTC) | Yes |
merchant | The merchant ID to send the funds to, either this OR pbntag must be specified. Remember: this is a merchant ID and not a username. | See Desc |
toaddress | The toaddress to send the funds to, either this OR merchant must be specified. | See Desc |
auto_confirm | If set to 1, withdrawal will complete without email confirmation. | No |
Method:
POST URL: http://wallexpay.io/api/create_transfer
API Response
A successful call to get the 'create_transfer' command will give you a result similar to this (JSON):
{
"error": "ok",
"result": {
"id": "string",
"status": 0
}
}
Note: Transfers are performed as internal coin transfers/accounting entries when possible. For coins not supporting that ability a withdrawal is created instead.
Convert Coins
API POST Fields
In addition to the Main Fields described in the API Basics > Introduction
Convert Coins
Field Name | Description | Required? |
cmd | convert | Yes |
to | The cryptocurrency to convert to. (USD, NGN, etc.) | Yes |
Method:
POST URL: http://wallexpay.io/api/convert
API Response
A successful call to the 'convert' command will give you a result similar to this (JSON):
{
"error": "ok",
"result": "61588"
}Get Withdrawal History
API POST Fields
In addition to the Main Fields described in the API Basics > Introduction
Field Name | Description | Required? |
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 |
Method:
API Response
A successful call to get 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",
"send_address": "1BitcoinAddress",
"send_txid": "hex_txid"
}
]
}
The result will have the following fields:
id = The 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).
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)
Get Withdrawal Infо
API POST Fields
In addition to the Main Fields described in the API Basics > Introduction
Get Withdrawal Information
Field Name | Description | Required? |
cmd | get_withdrawal_info | Yes |
id | The withdrawal ID to query. | Yes |
Method:
API Response
A successful call to get 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 will 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)