Migrating from Legacy
Basic Architecture
Authentication
Requesting Routes
Currencies & Exchange Rates
Create Payment (Invoice)
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Create Payment | cmd | create_transaction | |
| Payment Amount | amount | 5 | The amount of the payment in the original currency (currency1) |
| Currency 1 | currency1 | USD | The original currency of the payment (amount value) |
| Currency 2 | currency2 | BTC | The currency the buyer will be transacting in |
| Buyer Email | buyer_email | user@coinpayments.net | The buyer's email address |
POST /api.php
- POST Invoice
currency- Currency of the invoice items and amount.payment.refundEmail- Required buyer's email address to handle overpayments.
The invoice builder can be utilized within the dashboard.
Leverage payoutOverrides to configure payout destination or perform an automatic currency conversion.
Currencies are now referenced by currency ids instead of symbols.
Redirect URLs are currently only supported for "Buy Now" buttons.
Configure webhook notifications.
Callback Addresses
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Callback Address | cmd | get_callback_address | Retrieve callback addresses. |
| Notification | ipn_url | {url} | Define your URL for IPN callbacks. |
POST /api.php
Configure webhook notifications.
Review address types to determine the best architecture for your integration.
Deposit Addresses
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Deposit Addresses | cmd | get_deposit_address | Retrieve deposit addresses. |
| Currency | currency | BTC | The currency the buyer will be sending. |
POST /api.php
Configure webhook notifications.
Review address types to determine the best architecture for your integration.
Payment Information
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Multiple Transactions | cmd | get_tx_info_multi | Get transaction information. |
| Tx Filter | txid | 0239023-9032290-92309023 | Filter by transaction id. |
POST /api.php
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Transaction | cmd | get_tx_info | Get transaction information. |
| Tx Filter | txid | 0239023-9032290-92309023 | Filter by transaction id. |
| Additional Data | full | 0239023-9032290-92309023 | Include raw checkout and shipping data. |
POST /api.php
- GET Transactions
- GET Transaction
Coin Balances
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Coin Balances | cmd | balances | Retrieve coin balances. |
| Threshold | all | 1 | Whether the response should include all coins, even with a 0 balance. |
POST /api.php
- GET Wallets
- GET Wallet by ID
Create Transfer
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Create Transfer | cmd | create_transfer | Create internal coin transfer. |
| Amount | amount | 10 | The amount of the transfer in currency. |
| Currency | currency | BTC | The currency symbol. |
| Auto Confirmation | auto_confirm | 0 | Whether the transfer should process without email confirmation. |
POST /api.php
- POST Spend Request
amountCurrency- Utilize this property to define theamountin the provided currency.
- POST Spend Request Confirmation
You can utilize the toCurrency property to create an automatic currency conversion.
You can sweep and consolidate funds from multiple addresses with our wallet consolidation feature.
Create Withdrawal
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Create Withdrawal | cmd | create_withdrawal | Send coins to specified address or $PayByName tag. |
| Amount | amount | 10 | The amount of the transfer in currency. |
| Currency | currency | BTC | The currency symbol. |
| Currency 2 | currency2 | ETH | Optional currency to use to to withdraw amount worth of currency2 in currency coin. |
| Address | address | 0x72819... | The address to send funds to. |
| Notifications | ipn_url | {url} | URL for IPN callbacks. |
| Auto Confirmation | auto_confirm | 0 | Whether the transfer should process without email confirmation. |
POST /api.php
- POST Spend Request
amountCurrency- Utilize this property to define theamountin the provided currency.
- POST Spend Request Confirmation
Configure webhook notifications.
You can utilize the toCurrency property to create an automatic currency conversion.
You can sweep and consolidate funds from multiple addresses with our wallet consolidation feature.
Cancel Withdrawal
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Cancel Withdrawal | cmd | cancel_withdrawal | Cancel withdrawal request. |
| ID | id | {id} | The withdrawal ID to cancel. |
POST /api.php
- POST Spend Request
- POST Spend Request Confirmation
As withdrawals are a two-step process, the transaction will automatically expire if not confirmed.
Currency Conversion
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Convert Coins | cmd | convert | Cancel withdrawal request. |
| Amount | amount | 5 | The amount to convert in the from currency. |
| From Currency | from | BTC | The cryptocurrency to convert from. |
| To Currency | to | ETH | The cryptocurrency to convert to. |
| Address | address | 0x81892... | The address to send funds to. (if excluded, to CoinPayments wallet) |
POST /api.php
- POST Spend Request
- POST Spend Request Confirmation
You can utilize the toCurrency property to create an automatic currency conversion.
Conversion Limits
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Conversion Limits | cmd | convert_limits | Retrieve currency conversion limits. |
| From Currency | from | BTC | The cryptocurrency to convert from. |
| To Currency | to | ETH | The cryptocurrency to convert to. |
POST /api.php
Withdrawal History
View Comparison
| Operation | Parameter | Value | Description |
|---|---|---|---|
| Get Withdrawal History | cmd | get_withdrawal_history | Retrieve account withdrawal history. |
| Limit | limit | 25 | The maximum number of withdrawals to return. |
| Start | start | 0 | The withdrawal number to start from (for pagination). |
| Timestamp | newer | 1751525855 | Return withdrawals submitted at the given Unix timestamp or later. |
POST /api.php
- GET Transactions
- GET Transaction
Need more help with your integration? Contact us!
