Deposit Handling

You will be notified of deposits to callback addresses via Instant Payment Notifications (IPNs).

Fees

Note: Since callback addresses are designed for commercial use they incur the same 0.5% fee on deposits as transactions created with 'create_transaction'. For personal use deposits that reuse the same personal address(es) in your wallet that have no fee but don't send IPNs see 'get_deposit_address'.

API POST Fields (in addition to the Main Fields described in the Introduction)

Field Name	Description	Required?
Get Callback Address
cmd	get_callback_address	Yes
currency	The currency the buyer will be sending.	Yes
ipn_url	URL for your IPN callbacks. If not set it will use the IPN URL in your Edit Settings page if you have one set.	No
label	Optionally sets the address label.	No
eip55	If set to 1 encodes the address in EIP-55 mixed case format for ETH/ERC20 + clones. This is safely ignored for other coin types.	No

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.