Addresses returned by this API are for personal use deposits and reuse the same personal address(es) in your wallet. Deposits to these addresses don't send IPNs. For commercial-use addresses and/or ones that send IPNs see '
get_callback_address'.
API POST Fields (in addition to the Main Fields described in the Introduction)
Field Name | Description | Required? |
---|
Get Deposit Address |
---|
cmd | get_deposit_address | Yes |
currency | The currency the buyer will be sending. | Yes |
API Response
A successful call to the 'get_callback_address' or 'get_deposit_address' command will give you a result similar to this (JSON):
{
"error":"ok",
"result":{
"address":"1BitcoinAddress",
"pubkey":"",
"dest_tag":100,
}
}
The result will have the following fields:
- address = The address to deposit the selected coin into your CoinPayments Wallet.
- pubkey = NXT Only: The pubkey to attach the 1st time you send to the address to activate it.
- dest_tag = For coins needing a destination tag, payment ID, etc. (like Ripple or Monero) to set for depositing into your CoinPayments Wallet.
- alt_address = Optional alternate representation of an address such as X-address format for Ripple or legacy V-prefix for Velas EVM.