API Reference
API endpoint for all requests in production environment is:
https://app.cryptoprocessing.com/api/v2
API endpoint for all requests in test environment is:
https://app.sandbox.cryptoprocessing.com/api/v2
You obtain new address from CoinsPaid API (for some currencies it may be address and tag) and store it somewhere on your side. After that you show this address to your customer in order to make a deposit.
Customer sends some funds to this address.
When transaction is sent by a customer - CoinsPaid sends a callback to your callback url with transaction details. It contains status, address, currency, amount and fees. If status is successful, you should deposit respective amount to customer balance on your side.
You request to send amount of money to address.
Your request is validated on our side. If signature is correct, address is valid and you have enough balance - CoinsPaid responds you with the transaction object.
You will receive a callback when transaction status is updated.
Deposit with exchange flow
You don't want to touch or store cryptocurrency, but only use it as a payment method. Your customer deposits BTC, Coinspaid instantly converts it to EUR so that you would receive EUR on your CoinsPaid account.
You obtain new address from CoinsPaid API same as in deposit flow, but additionally pass another parameter "convert_to" in your request specifying resulting currency.
When new deposit is arriving, CoinsPaid converts all arriving funds to destination funds, and sends notifications as in regular deposit
Withdrawal with exchange flow
You wish to send Cryptocurrency from your Fiat currency balance. For example you want to send EUR amount but your customer receives money in BTC.
You do exactly same as in withdrawals, but you specify 2 currencies. One is a currency of your sending balance and Second is a cryptocurrency your Customer wishes to receive.
Your request is validated on our side. If signature is correct, address is valid and you have enough balance - CoinsPaid responds you with the transaction object.
You will receive a callback when transaction status is updated.
Futures flow
In order to guarantee receiving amount, rates should be fixed.
You send address for exchange (If it is not necessary to receive exchange rates you can skip this step)
You receive rates and their fixation time
To confirm futures You have to send exchange pair and amount due.
When new deposit is arriving, CoinsPaid converts all arriving funds to destination funds, and sends notifications as in regular deposit.
In case if received and sent amounts don't equal, CP converts it like normal deposit with exchange.
Limit for this operation is 10 000 EUR.
Invoices allow to conduct deposits with a fixed rate within a limited period of time disregarding the exchange rate fluctuations. In case it’s necessary to convert funds in fiat currency or convert it to another crypto currency this option will allow to visualize the exact amount of a sender’s currency required to receive the exact amount in a receiver’s currency. When a deposit is processed through this flow, a user is being redirected to the respective Invoice page via the preset link and just needs to follow instructions specified on it. It also allows to conduct refunds in case a user fails to manage to deposit within an established timeframe or discovers non-sufficient balance. All is required in that case is to follow the link with the respective instructions sent to an e-mail of a customer. Detailed information can be found here.
getPing
OK
Body must be a valid json object or array, example: {}
postGet list of supported currencies
{"data": [{"id": 1,"type": "crypto","currency": "BTC","minimum_amount": "0.001","deposit_fee_percent": "0.99","withdrawal_fee_percent": "0","precision": 8}]}
postGet list of exchangeable currency pairs
{"data": [{"currency_from": {"currency": "BTC","type": "crypto","min_amount": "0.00300000","min_amount_deposit_with_exchange": "0.00010000"},"currency_to": {"currency": "EUR","type": "fiat"},"rate_from": "1","rate_to": "8795.80000000"},{"currency_from": {"currency": "EUR","type": "fiat","min_amount": "25.00000000"},"currency_to": {"currency": "BTC","type": "crypto"},"rate_from": "1","rate_to": "8885.72951839"},{"currency_from": {"currency": "BCH","type": "crypto","min_amount": "0.00020000","min_amount_deposit_with_exchange": "0.00100000"},"currency_to": {"currency": "USD","type": "fiat"},"rate_from": "1","rate_to": "332.28264751"},{"currency_from": {"currency": "USD","type": "fiat","min_amount": "30.00000000"},"currency_to": {"currency": "BCH","type": "crypto"},"rate_from": "1","rate_to": "335.94361522"}]}
{"errors": {"currency_from": "The selected currency from is invalid.","currency_to": "The selected currency to is invalid."}}
postGet list of balances
{"data": [{"currency": "DOGE","type": "crypto","balance": "13234.91276375"},{"currency": "ADA","type": "crypto","balance": "7272.36400468"},{"currency": "EUR","type": "fiat","balance": "5973.97568920"},{"currency": "USDT","type": "crypto","balance": "0.00000000"}]}
postReceive cryptocurrency
{"data": {"id": 1,"currency": "BTC","convert_to": "EUR","address": "12983h13ro1hrt24it432t","tag": tag-123,"foreign_id": "user-id:2048"}}
{"errors": {"foreign_id": "The foreign id field is required."}}
Business logic for using cryptocurrency as a deposit method: You are willing to let your customer fund his EUR balance on your platform or website. You will have to generate an address in the desired cryptocurrency and specify EUR as a "convert_to" currency. This will allow you to let your Customer pay if his favorite currency and fund his balance in EUR. At the same time you will see respective EUR amount in your CoinsPaid merchant account. Hint: you don't have to generate new address for this customer anymore, address can be reused unlimited amount of times.
Make sure to use Bitcoin URI format bitcoin: in QR. Works the same way as "mailto:".
We do recommend making this QR clickable as customers may have a wallet set up on their computer or mobile phone.
We recommend specifying approximate current exchange rate.
postWithdraw cryptocurrency
{"data": {"id": 1,"foreign_id": "122929","type": "withdrawal","status": "processing","amount": "0.01000000","sender_amount": "0.01000000","sender_currency": "ETH","receiver_amount": "0.01000000","receiver_currency": "ETH"}}
{"errors": {"amount": "The amount must be at least 0.001."}}
Recommendation: ask customer to specify his payout address even before allowing him to deposit, this will improve experience and help to avoid mistakes with withdrawals in future.
Business logic for using cryptocurrency as a withdrawal method: Your customer requests a payout in Cryptocurrency from his EUR balance on your platform. You have to specify withdrawal amount in EUR and specify Cryptocurrency and its destination (sometimes it is not only Address). Example of such request <Send 3500 EUR to Bitcoin 3D2V3tushw7VLJYnK6vZVDpNcNmEG2a7QK">.
postCalculate exchange rates
{"data": {"sender_amount": 1,"sender_currency": "BTC","receiver_amount": "8549.81680000","receiver_currency": "EUR","fee_amount": "85.49816800","fee_currency": "BTC","price": "8549.81680000","ts_fixed": 1564293159,"ts_release": 1564293219,"fix_period": 60}}
{"errors": {"sender_currency": "Exchange is unavailable for given currencies"}}
{"errors": {"error code: 1015"}}
postExchange on fixed exchange rate
{"data": {"id": 2687667,"foreign_id": "knwi24op9","type": "exchange","sender_amount": "0.01","sender_currency": "BTC","receiver_amount": "63.52069015","receiver_currency": "EUR","fee_amount": "6.98727592","fee_currency": "EUR","price": "6352.06901520","status": "processing"}}
postExchange regardless the exchange rate
{"data": {"id": 2687669,"foreign_id": "wph27bmsp81","type": "exchange","sender_amount": "0.001","sender_currency": "BTC","receiver_amount": "6.33984642","receiver_currency": "EUR","fee_amount": "0.69738311","fee_currency": "EUR","price": "6339.84642127","status": "processing"}}
{"errors": {"sender_amount": "The amount must be at least 0.00300000 "}}
postCalculate rates for futures
{"data": {"addresses": [{"id": 384620,"currency": "BTC","convert_to": "USD","address": "3GQwSBQErsQ863RcuvCkub6SZBPHKuwSV7","tag": null,"foreign_id": "ds23fgk"}],"ts_fixed": 1581507311,"ts_release": 1581513311,"rates": {"BTCUSD": {"5.00000000": "10312.67153000","10.00000000": "10312.67153000","20.00000000": "10312.67153000","50.00000000": "10312.67153000","100.00000000": "10312.67153000","200.00000000": "10312.67153000","300.00000000": "10312.67153000"}}}}
{"errors": {"address": "Address is not found, incorrect or without exchange"}}
postConfirm futures transaction
{"data": {"futures_id": 92,"sender_currency": "BTC","receiver_currency": "USD","fee_currency": "USD","price": "10299.94946000","address": {"id": 384620,"currency": "BTC","convert_to": "USD","address": "3GQwSBQErsQ863RcuvCkub6SZBPHKuwSV7","tag": null,"foreign_id": "ds23fgk"},"sender_amount": "0.00292","receiver_amount": "30.00000000","fee_amount": "1.50000000","ts_fixed": 1581506566,"ts_release": 1581512566}}
{"errors": {"address": "Address is not found, incorrect or without exchange. Error can be related to incorrect sender or receiver currencies."}}
postCreate Invoice
{"data":{"id":79,"url":"https://app.coinspaid.com/invoice/RB9NZv","foreign_id":164,"name":"TEST NAME","status":"created","currency":"EUR","amount":"106.75","sender_currency":"BTC","sender_amount":null,"fixed_at":1581929889,"release_at":1581930789}}
{"errors":{"foreign_id":"The foreign id has already been taken."}}
A set of parameter included in URL that will allow to redirect a user to Payment Terminal. For more info navigate through this section of documentation.
Name | Description | Optionality | Type |
client_id | This is a unique ID that’s generated on the side of CoinsPaid | Required | int |
currency | ISO of a currency to receive funds in, example: BTC | Required | string |
amount | Amount of funds to withdraw, example: "3500" | Optional | numeric |
convert_to | In case you need on-the-fly exchange of all incoming funds (e.g. to EUR) specify this parameter as EUR or any other supported currency ISO, to see the list of available pairs check the method above | Optional | string |
is_iframe | The parameter that allows you to get an iframe-link (false by default). | Optional | boolean |
foreign_id | Unique foreign ID in your system, example: "164" | Required | string |
url_back | A link that allows you to get a user back to your system | Optional | url |
Status | Meaning |
confirmed | Final. You are safe to process this transaction |
not_confirmed | Transaction is not yet confirmed. |
cancelled | Final. This transaction is a double spend or cancelled withdrawal. Pay attention to this transaction. |
pending | This status may occur only after enabling withdrawal limits. Transaction exceeds set withdrawal limit, you need to confirm or decline it via backoffice of your merchant account. |
Type | Description |
Blockchain | Type of transactions that are written into blockchain. Such transactions (deposits and withdrawals) can be tracked via according explorer for suitable blockchain. This is the most common type of transactions. |
Internal | Type of transactions between two addresses within our processing (between separate merchant accounts or different addresses of the single merchant). Such transactions are not written in blockchain, but still can be tracked via our internal explorer - https://explorer.coinspaid.com/ |
Exchange | Type of transactions that requires exchange between crypto-fiat or crypto-crypto pairs. |
Transaction | Transition |
Successful deposit | not_confirmed -> confirmed |
Unsuccessful deposit | not_confirmed -> cancelled |
Successful withdrawal | confirmed |
Unsuccessful withdrawal | cancelled |
