Notes
Transfers are performed as internal coin transfers/accounting entries when possible. For coins not supporting that ability a withdrawal is created instead.
API POST Fields (in addition to the Main Fields described in the Introduction)
| Field Name |
|---|
| Create Transfer |
|---|
| cmd |
|---|
| Description | create_transfer |
| Required? | Yes |
| amount |
|---|
| Description | The amount of the transfer in the currency below. |
| Required? | Yes |
| currency |
|---|
| Description | The cryptocurrency to withdraw. (BTC, LTC, etc.) |
| Required? | Yes |
| merchant |
|---|
| Description | 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. |
| Required? | See Desc |
| pbntag |
|---|
| Description | The $PayByName tag to send the funds to, either this OR merchant must be specified. |
| Required? | See Desc |
| auto_confirm |
|---|
| Description | If set to 1, withdrawal will complete without email confirmation. |
| Required? | No |
| note |
|---|
| Description | This lets you set the note for the withdrawal. |
| Required? | No |
| Field Name | Description | Required? |
|---|
| Create Transfer |
|---|
| cmd | create_transfer | Yes |
| amount | The amount of the transfer in the currency below. | Yes |
| currency | The cryptocurrency to withdraw. (BTC, LTC, etc.) | 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 |
| pbntag | The $PayByName tag 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 |
| note | This lets you set the note for the withdrawal. | No |
API Response
A successful call to the 'create_transfer' command will give you a result similar to this (JSON):
{
"error":"ok",
"result":{
"id":"string",
"status":0,
}
}
The result wil have the following fields:
- id = The CoinPayments transfer/withdrawal ID. (This is not a coin network TX ID.)
- status = 0 or 1. 0 = Transfer created, waiting for email confirmation. 1 = Transfer created with no email confirmation needed.
