API POST Fields (in addition to the Main Fields described in the Introduction)
| Field Name |
|---|
| Convert Coins |
|---|
| cmd |
|---|
| Description | convert |
| Required? | Yes |
| amount |
|---|
| Description | The amount convert in the 'from' currency below. |
| Required? | Yes |
| from |
|---|
| Description | The cryptocurrency in your Coin Wallet to convert from. (BTC, LTC, etc.) |
| Required? | Yes |
| to |
|---|
| Description | The cryptocurrency to convert to. (BTC, LTC, etc.) |
| Required? | Yes |
| address |
|---|
| Description | The address to send the funds to. If blank or not included the coins will go to your CoinPayments Wallet. |
| Required? | No |
| dest_tag |
|---|
| Description | The destination tag to use for the withdrawal (for Ripple.) If 'address' is not included this has no effect. |
| Required? | No |
| Field Name | Description | Required? |
|---|
| Convert Coins |
|---|
| cmd | convert | Yes |
| amount | The amount convert in the 'from' currency below. | Yes |
| from | The cryptocurrency in your Coin Wallet to convert from. (BTC, LTC, etc.) | Yes |
| to | The cryptocurrency to convert to. (BTC, LTC, etc.) | Yes |
| address | The address to send the funds to. If blank or not included the coins will go to your CoinPayments Wallet. | No |
| dest_tag | The destination tag to use for the withdrawal (for Ripple.) If 'address' is not included this has no effect. | No |
API Response
A successful call to the 'convert' command will give you a result similar to this (JSON):
{
"error":"ok",
"result":{
"id":"61588"
}
}
