Must Read

This documentation explains about API request and response. All dates in any api response is UTC timezone.

If you want use our plugins, you can visit our official coinremitter github account

Pass header data in every API "Accept:application/json", However it is optional

All api have rate limit, Free plan have rate limit 100 and Pro plan have rate limit 500. Make sure you are checking x-ratelimit-remaining and x-ratelimit-limit response header of api. when you exceed rate limit you will get "Too Many Attempts" response with "429" http status code . Rate limit will reset after every 1 minute. it means if you have free plan, you can call 100 apis per minute. you can upgrade plan from your dashboard to increase rate limit or if you want to increase rate limit greater than 500, you can contact us

All API call require API key and password. How to get my API Key and Password ?

Supported Coins

Logo Full Name Short Names
Bitcoin BTC
Litecoin LTC
Bitcoin Cash BCH
Bitcoin Gold BTG
DogeCoin DOGE
Tether USDT USDT
Test Coin TCN
Koinon KOIN
Dash DASH

Webhook Response

You will received webhook data on Deposit/Withdraw. What is Webhook ?
                                               
                                                   {"id":"5de12919fbf03e30dc659198","txid":"7a6ca109c7c651f9b70a7d4dc8fa77de322e420119c5d2470bce7f08ba0cd1d6","explorer_url":"http://btc.com/exp/7a6ca109c7c651f9b70a7d4dc8fa7...","merchant_id":"5bc46fb28ebb8363d2657347","type":"receive","coin_short_name":"BTC","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"mayur101","address":"MP78UQoDpkehY7mMy2Cn9HSfysz4wbCeN1","amount":"0.003","confirmations":"3","date":"2019-06-02 01:02:03"}
                                               
                                           
Field Type Description
id String Unique id of transaction.
txid String It is Transaction Id of respected blockchain (Coin / token).
explorer_url String Third party explorer url where you can cross check transaction status.
type String

receive: When you get deposit amount, type will be receive.

send: When you withdraw amount from your wallet, type will be send.

wallet_id String Wallet ID from you sent or received amount.
wallet_name String Wallet name from you sent or received amount.
address String Address on which you have received amount or sent amount.
amount String Amount that you sent or received.
confirmations String Confirmation of transaction which you receive from server.
                                 
                                 
                              

POST Create New Wallet Address

https://coinremitter.com/api/v1/{coin_short_name}/get-new-address

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API key
password 123456 Required Wallet Password
label my_label Optional Label of New Address

{"flag":1,"msg":"New address created successfully !","action":"get-new-address","data":{"address":"MMtU5BzKcrew9BdTzru9QyT3YravQmzokh","label":"my_label"}}
Field Type Description
flag Integer 1
msg String New address created successfully !
data Object

address: Newly created address.

label: Label assigned to that address.


{"flag":0,"msg":"Oops something went wrong !!!","action":"get-new-address","data":[]}
Field Type Description
flag Integer 0
msg String Oops something went wrong !!!
data Object []
Example RequestCreate New Wallet Address
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/get-new-address 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form label='my_label' 
                                       
                                 

POST Validate Address

https://coinremitter.com/api/v1/{coin_short_name}/validate-address

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API Key
password 123456 Required Wallet Password
address MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK Required Address which you want to validate.

{"flag":1,"msg":"Success !","action":"validate-address","data":{"valid":true}}
Field Type Description
flag Integer 1
msg String Success !
data Object

valid:Boolean - true or false.


{"flag":0,"msg":"Fail","action":"validate-address","data":{"valid":false}}
Field Type Description
flag Integer 0
msg String Fail
data Object <p><b>valid:</b>Boolean - false.</p>
Example RequestValidate Address
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/validate-address 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form address='MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK' 
                                       
                                 

POST Withdraw

https://coinremitter.com/api/v1/{coin_short_name}/withdraw

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API Key
password 123456 Required Wallet Password
to_address MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK Required Address of in which you want to send amount
amount 0.003 Required Total amount which you want to send

{"flag":1,"msg":"Amount Successfully Withdraw !","action":"withdraw","data":{"id":"5b5ff10a8ebb830edb4e2a22","txid":"1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28","explorer_url":"http://btc.com/exp/1147aca98ced7684907bd469e80cdf74...","amount":0.1,"transaction_fees":0.001,"processing_fees":0.00023,"total_amount":0.10123,"to_address":"MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my_wallet","coin_short_name":"BTC","date":"2019-06-02 01:02:03"}}
Field Type Description
flag Integer
msg String Amount Successfully Withdraw !
data Object

id: Unique Id of withdraw transaction.

txid: Blockchain Transaction id of withdrawal.

explorer_url: Third party explorer url where you can cross check transaction status.

amount: Amount which is withdraw for given address.

transaction_fees: Transaction Fees which is apply on withdraw amount.

processing_fees: Processing Fees which is apply for withdrawal Process.

total_amount: Amount that deducted from your wallet. amount+transaction_fees+processing_fees=total_amount.

to_address: To address displays address in which Withdraw amount will send.

wallet_id: Wallet ID will appear of that wallet in which transaction created.

wallet_name: Wallet name will appear of that wallet in which transaction done.

date: Transaction Date in UTC time zone 24 hour formate. Type: String


{"flag":0,"msg":"Oops something went wrong !!!","action":"withdraw","data":[]}
Field Type Description
flag Integer 2
msg String The To Address field is required
data Object []
Example RequestWithdraw
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/withdraw 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form to_address='MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK' 
      --form amount='0.003' 
                                       
                                 

POST Get Transaction

https://coinremitter.com/api/v1/{coin_short_name}/get-transaction

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API Key
password 123456 Required Wallet Password
id 5b7e6f7d5aa55854e5726ac2 Required Unique id of your Transaction

{"flag":1,"msg":"success","action":"get-transaction","data":{"id":"5b73f51a8ebb83149d18cf63","txid":"c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d","explorer_url":"http://btc.com/exp/c4b853d4be7586798870a4aa7...","type":"receive","merchant_id":"5bc46fb28ebb8363d2657347","coin_short_name":"BTC","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my_wallet","address":"QbrhNkto3732i36NYmZUNwCo4gvTJK3992","amount":0.0003,"confirmations":3,"date":"2018-08-15 15:10:42"}}
Field Type Description
flag Integer 1
msg String success
data Object

id: Unique Id of transaction.

txid: Transaction Id of fetch transaction.

explorer_url: Third party explorer url where you can cross check transaction status.

type:
receive: When you get deposit amount, type displays receive.
send: When you withdraw amount from any address, type displays send.

merchant_id: Id of Merchant.

coin_short_name: Coin short name will appear of that coin in which transaction done.

transaction_fees: if transaction type is "send" then this field will added in response.

processing_fees: if transaction type is "send" then this field will added in response.

total_amount: if transaction type is "send" then this field will added in response.

wallet_id: Wallet ID will appear of that wallet in which transaction created.

wallet_name: Wallet name will appear of that wallet in which transaction done.

address: Address displays address in which transaction amount receive or send.

amount: Transaction amount which is send or received.

confirmations: Confirmation of transaction which you receive from server.

date: Time of Transaction when transaction is received or send.


{"flag":0,"msg":"Oops something went wrong !!!","action":"get-transaction","data":[]}
Field Type Description
flag Integer 0
msg String Oops something went wrong !!!
data Object []
Example RequestGet Transaction
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/get-transaction 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form id='5b7e6f7d5aa55854e5726ac2' 
                                       
                                 

POST Get wallet balance

https://coinremitter.com/api/v1/{coin_short_name}/get-balance

Body

formdata
Field Value Type Description
api_key $2y$10$8He07BlQm5SFyTNQVxwHM.7KW0q4Oaplw4i.8rDUldIxHbzBz7Rfu Required Wallet API Key
password 123456 Required Wallet Password

{"flag":1,"msg":"Get balance successfully","action":"get-balance","data":{"balance":0.2457,"wallet_name":"Test Wallet","coin_name":"Bitcoin"}}
Field Type Description
flag Integer 1
msg String Get balance successfully
data Float

balance: Total Avaialbe balance of wallet.

wallet_name: Name of wallet.

coin_name: Full name of coin.


{"flag":0,"msg":"Oops something went wrong !!!","action":"get-balance","data":[]}
Field Type Description
flag Integer 0
msg String Oops something went wrong !!!
data Object []
Example RequestGet wallet balance
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/get-balance 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$8He07BlQm5SFyTNQVxwHM.7KW0q4Oaplw4i.8rDUldIxHbzBz7Rfu' 
      --form password='123456' 
                                       
                                 

POST Create invoice

https://coinremitter.com/api/v1/{coin_short_name}/create-invoice

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API Key
password 123456 Required Wallet Password
amount 25 Required Invoice Amount
name random name Optional Name which you want to see on Invoice
currency inr Optional Invoice amount currency
expire_time 10 Optional Invoice expiry time
notify_url http://yourdomain.com/notify-url Optional URL on which you will be notify about payment
suceess_url http://yourdomain.com/success-url Optional After payment done url redirect to success url
fail_url http://yourdomain.com/fail-url Optional On payment fail url redirect to fail url
description Hello world Optional Invoice description

{"flag":1,"msg":"success","action":"create-invoice","data":{"id":"5de7ab46b846fe6aa15931b2","invoice_id":"BTC122","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/5de7ab46b846fe6aa15931b2","total_amount":{"BTC":0.004816,"USD":0.35102499,"INR":25},"paid_amount":[],"conversion_rate":{"USD_BTC":0.00013719,"BTC_USD":7289.01,"BTC_INR":519,"INR_BTC":0.000193,"INR_USD":0.014041,"USD_INR":71.22},"base_currency":"INR","coin":"BTC","name":"random name","description":"Hello world","wallet_name":"My Test Wallet","address":"QbrhNkto3732i36NYmZUNwCo4gvTJK3992","status":"Pending","status_code":0,"notify_url":"http://yourdomain.com/notify-url","suceess_url":"http://yourdomain.com/success-url","fail_url":"http://yourdomain.com/fail-url","expire_on":"2018-12-06 10:35:57","invoice_date":"2019-12-04 18:19:10","last_updated_date":"2019-12-04 18:19:10"}}
Field Type Description
flag Integer 1
msg String success
data Object

id: Unique Id of Invoice.

invoice_id: Id of Invoice.

merchant_id: Id of Merchant who is created Invoice.

url: Invoice Check Payment URL.

total_amount: Total Amount of Invoice which is you will received.

paid_amount: Total amount that user paid.

conversion_rate: Rate of conversion when invoice create.

base_currency: Base currency in which invoice generated.

coin: Coin short name will appear of that coin in which invoice created.

name: Name will display on invoice. Optional, Allowed 10 characters

description: Description will display on invoice. Optional, Allowed 50 characters

wallet_name: Wallet name will appear of that wallet in which invoice created.

address: Address displays address of Invoice in which you will receive payment.

status:
Pending: If invoice payment which is not processed then Invoice status is pending.
Paid: If Invoice amount fully paid then status shows Paid.
Under Paid: If Invoice amount partially paid then status shows Under Paid.
Over Paid: If Invoice amount paid more than pay amount then status shows Over Paid.
Expired: If Invoice expired by system then status shows Expired.
Cancelled: If you cancel the invoice then invoice status shows Cancelled.

status_code:
0: Pending
1: Paid
2: Under Paid
3: Over Paid
4: Expired
5: Cancelled

suceess_url: If Invoice paid successfully, Invoice redirect to the suceess_url.

fail_url: If Invoice cancel by user, Invoice redirect to the fail_url.

expire_on : Invoice expired date time.

invoice_date: Invoice created date time.

last_updated_date: Last updated date of Invoice


{"flag":0,"msg":"Oops something went wrong !!!","action":"create-invoice","data":[]}
Field Type Description
flag Integer 0
msg String Oops something went wrong !!!
data Object []
Example RequestCreate invoice
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/create-invoice 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form amount='25' 
      --form name='random name' 
      --form currency='inr' 
      --form expire_time='10' 
      --form notify_url='http://yourdomain.com/notify-url' 
      --form suceess_url='http://yourdomain.com/success-url' 
      --form fail_url='http://yourdomain.com/fail-url' 
      --form description='Hello world' 
                                       
                                 

POST Get invoice

https://coinremitter.com/api/v1/{coin_short_name}/get-invoice

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API Key
password 123456 Required Wallet Password
invoice_id BTC002 Required Invoice ID which you want to get

{"flag":1,"msg":"success","action":"get-invoice","data":{"id":"5b7650458ebb8306365624a2","invoice_id":"BTC002","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/5b7650458ebb8306365624a2","total_amount":{"BTC":0.001926,"USD":0.14041,"INR":10},"paid_amount":{"BTC":0.001926,"USD":0.14041,"INR":10},"conversion_rate":{"USD_BTC":0.00013719,"BTC_USD":7289.01,"BTC_INR":519123.2922,"INR_BTC":0.000193,"INR_USD":0.014041,"USD_INR":71.22},"base_currency":"INR","coin":"BTC","name":"random name","description":"Hello world","wallet_name":"New Test-LTC","address":"rger54654fgsd4h6u7dgsg","payment_history":[{"txid":"c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d","explorer_url":"http://btc.com/exp/c4b853d4be7586798870a4aa766e3bb781eddb...","amount":0.005,"date":"2019-12-02 12:09:02","confirmation":781},{"txid":"a2541253ab72d7cf29f2f9becb1e31320dd0ed418f761ab1973dc9e412a51c7f","explorer_url":"http://btc.com/exp/a2541253ab72d7cf29f2f9becb1e31320dd0ed...","amount":0.005,"date":"2019-12-02 12:15:02","confirmation":778}],"status":"Pending","status_code":0,"suceess_url":"http://yourdomain.com/success-url","fail_url":"http://yourdomain.com/fail-url","expire_on":"2018-12-06 10:35:57","invoice_date":"2018-08-17 10:04:13","last_updated_date":"2018-08-17 10:04:13"}}
Field Type Description
flag Integer 1
msg String success
data Object

id: Unique Id of Invoice.

invoice_id: Id of Invoice.

merchant_id: Id of Merchant who is created Invoice.

url: Invoice Check Payment URL.

total_amount: Total Amount of Invoice which is you will received.

paid_amount: Total Paid amount of invoice amount.

conversion_rate: Rate of conversion when invoice create.

base_currency: Base currency in which invoice generated.

coin: Coin short name will appear of that coin in which invoice created.

name: Name will display on invoice. Optional, Allowed 10 characters

description: Description will display on invoice. Optional, Allowed 50 characters

wallet_name: Wallet name will appear of that wallet in which invoice created.

address: Address displays address of Invoice in which you will receive payment.

payment_history: Payment History displays all transactions of Invoice Payment.

status:
Pending(0): If invoice payment which is not processed then Invoice status is pending.
Paid(1): If Invoice amount fully paid then status shows Paid.
Under Paid(2): If Invoice amount partially paid then status shows Under Paid.
Over Paid(3): If Invoice amount paid more than pay amount then status shows Over Paid.
Expired(4): If Invoice expired by system then status shows Expired.
Cancelled(5): If you cancel the invoice then invoice status shows Cancelled.

suceess_url: If Invoice Payment is paid successfully, Invoice redirect to the suceess_url.

fail_url: If Invoice Payment is failed, Invoice redirect to the fail_url.

expire_on : Invoice expired date time.

invoice_date: Invoice created date time.

last_updated_date: Last updated date of Invoice


{"flag":0,"msg":"Oops something went wrong !!!","action":"get-invoice","data":[]}
Field Type Description
flag Integer 0
msg String Oops something went wrong !!!
data Object []
Example RequestGet invoice
                                    
   curl --request POST 
   --url https://coinremitter.com/api/v1/BTC/get-invoice 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form invoice_id='BTC002' 
                                       
                                 

GET Get Coin USD Price

https://coinremitter.com/api/v1/get-coin-rate

Body

formdata
Field Value Type Description
api_key $2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq Required Wallet API Key
password 123456 Required Wallet Password

{"flag":1,"msg":"success","action":"get-coin-rate","data":{"BTC":{"symbol":"BTC","name":"Bitcoin","price":7289.01},"LTC":{"symbol":"LTC","name":"Litecoin","price":145.51},"DOGE":{"symbol":"DOGE","name":"DogeCoin","price":0.0001}}}
Field Type Description
flag Integer 1
msg String success
data Object

BTC:
symbol: Short name of Coin
name: Full name of coin.
price: USD price of 1 BTC.

LTC:
symbol: Short name of Coin
name: Full name of coin.
price: USD price of 1 LTC.

DOGE:
symbol: Short name of Coin
name: Full name of coin.
price: USD price of 1 DOGE.


{"flag":0,"msg":"Oops something went wrong !!!","action":"get-coin-rate","data":[]}
Field Type Description
flag Integer 0
msg String Oops something went wrong !!!
data Object []
Example RequestGet Coin USD Price
                                    
   curl --request GET 
   --url https://coinremitter.com/api/v1/get-coin-rate 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
                                       
                                 

Notify Response

You will received Notification data on Invoice Payment
                                          
                                               {"id":"5de4b1235aa55814b8223952","invoice_id":"BTC080","url":"https://coinremitter.com/invoice/5de48b77b846fe407d049fa2","total_amount":0.01,"paid_amount":0.01,"usd_amount":72.8901,"coin":"BTC","name":"My Test Wallet","description":"Description","wallet_name":"New Test-LTC","address":"QbqVdiLvPGGrm4DqduNUWbj3r8fLAz8UtV","payment_history":"[{'txid':'c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d','explorer_url':'http://btc.com/exp/c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d','amount':0.005,'date':'2019-12-02 12:09:02','confirmation':134},{'txid':'a2541253ab72d7cf29f2f9becb1e31320dd0ed418f761ab1973dc9e412a51c7f','explorer_url':'http://btc.com/exp/a2541253ab72d7cf29f2f9becb1e31320dd0ed418f761ab1973dc9e412a51c7f','amount':0.005,'date':'2019-12-02 12:15:02','confirmation':131}]","status":"Paid","status_code":1,"suceess_url":"yourdomain.com/success-url","fail_url":"yourdomain.com/fail-url","notify_url":"yourdomain.com/notify-url","expire_on":"2018-12-06 10:35:57","invoice_date":"2019-12-02 12:07:23","last_updated_date":"2019-12-02 12:15:02"}
                                          
                                       
Field Description
id Unique ID of Invoice.
invoice_id ID of Invoice on which notification received.
url URL of Invoice which displays Invoice details.
total_amount Amount Which is Payable for Invoice.
paid_amount Total paid amount of Invoice.
usd_amount Total Amount in USD.
coin Coin short name will appear of that coin in which invoice created.
name Invoice name which entered by user when create invoice.
description If user entered description at time of create invoice, notify data will return that description.
wallet_id Wallet ID will appear of that wallet in which invoice created.
wallet_name Wallet name will appear of that wallet in which invoice created.
address Invoice address in which paid amount credited.
payment_history Payment History displays all transactions of Invoice Payment
status/status_code

Pending(0) : If invoice payment which is not processed then Invoice status is pending.

Paid(1) : If Invoice amount fully paid then status shows Paid.

Under Paid(2) : If Invoice amount partially paid then status shows Under Paid.

Over Paid(3) : If Invoice amount paid more than pay amount then status shows Over Paid.

Expired(4) : If Invoice expired by system then status shows Expired.

Cancelled(5) : If you cancel the invoice then invoice status shows Cancelled.

suceess_url If Invoice Payment is paid successfully, Invoice redirect to the suceess_url.
fail_url If Invoice Payment is failed, Invoice redirect to the fail_url.
notify_url Invoice notification received at notify_url.
expire_on Invoice expired date.
invoice_date Invoice created date.
last_updated_date Last date of Invoice Update.