Bitcoin Cash Payment Solutions

Bitcoin Cash payment gateway by coinremitter is leading solutions for Merchants and Business clients. It’s a decentralized BCH payment gateway that enables retailers to accept transactions in Bitcoin Cash.

This payment Bitcoin Cash API allows you to integrate & accept Bitcoin Cash payments into your website. The Payment API links the checkout system of your business to a payment processing network that allows your clients to make transactions from you.

Sign up today on Coinremitter Cryptocurrency Payment Gateway to introduce a new Bitcoin Cash payment mode and to benefit your current customers, gain new customers, save costs, and ultimately it will set you apart from your competitors!

This documentation explains about API request and response. All dates in any API response are based on the UTC timezone.

If you want use our plugins, you can check out Coinremitter: Crypto payment gateway on the GitHub account

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

All API has a rate limit, the free plan has a rate limit of 100, and the Pro plan has a rate limit of 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 ?

Types of Flags

Flag Value	Meaning	Example	Description

Operation Success

                                                                   
{
      "flag":1,
      "msg":"Success !",
      "action":"validate-address",
      "data":{
         "valid":true
      }
}

The operation has been completed successfully and you will get response code 200. However, if you want to see the expected result then you may check the data parameter of the response.

For example

validate-address : If the address is correct then you will get Flag 1 wheather valid parameter in data is true or false.

get-transaction : If the transaction is successful, then its flag will be 1. But it does not mean that your transaction has been confirmed. To check the confirmation of your transaction, you need to check it confirmation key-value under the data object.

Operation Fail

                                                                    Code : 200
                                                                    
{
       "flag": 0,
       "msg": "Invalid API key or password.",
       "data": []
}

Flag 0 means your operation has been failed. As a result, you will get a response of 200 or 500.

For example

You will get the Flag 0 with the response code 200 if the API key or password is false.

If there are internal server errors then you will get the Flag 0 with the 500 HTTP status code.

Validation Error

                                                                    
{
       "flag": 2,
       "msg": "The address field is required.",
       "action": "validate-address",
       "data": []
}

If the required field is blank or unset then you will get Flag 2. Validation error will be found even if the format of the amount is wrong.

For example

If you pass 1,000 in the amount then as a consequence you will get the validation error because there is comma in amount

Download Swagger JSON Download Postman JSON

Create New Wallet Address

https://coinremitter.com/api/v3/BCH/get-new-address

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API key

password Required	string	123456
Wallet Password

label Optional	string	my_label
Label of New Address

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

New address created successfully.

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

address:	It is address where fund is sent or received.
label:	Label that is assigned to the newly created address.
qr_code:	qr code image.

POST Create New Wallet Address https://coinremitter.com/api/v3/BCH/get-new-address

Parameter

api_key *

password *

label

api_key :

password :

label :

                                                                                   
                                                                                        
{"flag":1,"msg":"New address created successfully .","action":"get-new-address","data":{"address":"MMtU5BzKcrewdTzru9QyT3YravQmzokh","label":"my_label","qr_code":"https://coinremitter.com/qr/bch/image.png"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/get-new-address 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form label=' '

Validate Address

https://coinremitter.com/api/v3/BCH/validate-address

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

address Required	string	MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK
Address which you want to validate.

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

Success !

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

Valid:

true: If the address is valid, the valid data returned as "true".
false: If the address is invalid, the valid data returned as "false".

POST Validate Address https://coinremitter.com/api/v3/BCH/validate-address

Parameter

api_key *

password *

address *

api_key :

password :

address :

                                                                                   
                                                                                        
{"flag":1,"msg":"Success !","action":"validate-address","data":{"valid":true}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/validate-address 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form address=' '

Withdraw

https://coinremitter.com/api/v3/BCH/withdraw

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

to_address Required	string	MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK
Address of in which you want to send amount

amount Required	string	2
Total amount which you want to send

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

Amount Successfully Withdraw.

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

id:	Unique ID of withdrawal transaction.
txid:	blockchain transaction id.
explorer_url:	Third party explorer URL where the transaction status can be cross-checked.
amount:	The amount of transactions that are sent or withdrawn to a given address.
transaction_fees:	The transaction fees that are paid for sending or withdrawing the amount. To check the transaction fees, Click here.
processing_fees:	The processing fees that are paid for sending or withdrawing the amount. To check the processing fees, Click here.
total_amount:	The amount that is deducted from your wallet. amount+transaction_fees+processing_fees=total_amount.
to_address:	It is address where fund is sent or received.
wallet_id:	Unique ID of wallet.
wallet_name:	Name of the wallet.
coin_short_name:	Symbol of coin. E.g. BTC for Bitcoin.
date:	UTC date & time of transaction.

POST Withdraw https://coinremitter.com/api/v3/BCH/withdraw

Parameter

api_key *

password *

to_address *

amount *

api_key :

password :

to_address :

amount :

                                                                                   
                                                                                        
{"flag":1,"msg":"Amount Successfully Withdraw.","action":"withdraw","data":{"id":"5b5ff10a8ebb830edb4e2a22","txid":"1147aca98ced7684907bd469e80f7482f40a1aaf75c1e55f7a60f725ba28","explorer_url":"http://coin-explorer-url/1147aca98ced7684907bd46......","amount":2,"transaction_fees":"0.00100000","processing_fees":"0.10000000","total_amount":"2.101","to_address":"MLjDMFsobgk9Etj8KUKSpmHM6qG2qFK","wallet_id":"5c42a0ab846fe75142cfb2","wallet_name":"my-wallet","coin_short_name":"BCH","date":"2019-06-02 01:02:03"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/withdraw 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form to_address=' '
                                                                                                                                                                                      --form amount=' '

Get Transaction

https://coinremitter.com/api/v3/BCH/get-transaction

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

id Required	string	5b7e6f7d5aa55854e5726ac2
Unique id of your Transaction

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

success

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

id:	Unique id of transaction.
txid:	Transaction ID of blockchain transaction.
explorer_url:	Third party explorer URL where the transaction status can be cross-checked.
type:	receive: When you receive an amount from any address, the type will be shown as "receive". send: When you send or withdraw an amount to any address, the type will be shown as "send".
merchant_id:	Unique ID of your account.
coin_short_name:	Symbol of coin. E.g. BTC for Bitcoin.
wallet_id:	Unique ID of wallet.
wallet_name:	Name of the wallet.
address:	It is address where fund is sent or received.
amount:	The amount of transactions that are sent or received.
confirmations:	Number of confirmation from the blockchain transaction.
date:	UTC date & time of transaction.
transaction_fees:	This field will be added in response, if the transaction type is "send". To check the transaction fees, Click here.
processing_fees:	This field will be added in response, if the transaction type is "send". To check the processing fees, Click here.
total_amount:	This field will be added in response, if the transaction type is "send". amount+transaction_fees+processing_fees=total_amount.

POST Get Transaction https://coinremitter.com/api/v3/BCH/get-transaction

Parameter

api_key *

password *

id *

api_key :

password :

id :

                                                                                   
                                                                                        
{"flag":1,"msg":"success","action":"get-transaction","data":{"id":"5b5ff10a8ebb830edb4e2a22","txid":"c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d","explorer_url":"http://coin-explorer-url/c4b853d4be7586798870a4aa7...","type":"send","merchant_id":"5ef04e355b10c01d5436f0c2","coin_short_name":"BCH","wallet_id":"5f8a6fd164b6e25a78545e02","wallet_name":"my-wallet","address":"0xe82f1bea5e9d80edab36083013699895e6aa307d","amount":"2","confirmations":0,"date":"2020-10-22 15:32:11","transaction_fees":"0.00100000","processing_fees":"0.10000000","total_amount":"2.101"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/get-transaction 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form id=' '

Get Transaction By Address

https://coinremitter.com/api/v3/BCH/get-transaction-by-address

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

address Required	string	MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK
Address

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

success

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

id:	Unique ID of transaction
txid:	Blockchain transaction ID.
explorer_url:	Third party explorer URL where the transaction status can be cross-checked.
merchant_id:	Unique ID of merchant account.
type:	RECEIVE: WHEN YOU RECEIVE THE DEPOSIT AMOUNT FROM ANY ADDRESS, THE TYPE WILL BE SHOWN AS "RECEIVE".
coin_short_name:	Symbol of coin. E.g. BTC for Bitcoin.
wallet_id:	Unique ID of wallet.
wallet_name:	Name of the wallet.
address:	It is address where fund is sent or received.
amount:	The amount of transactions that are received.
confirmations:	Number of confirmation from the blockchain transaction.
Date:	UTC date & time of transaction.

POST Get Transaction By Address https://coinremitter.com/api/v3/BCH/get-transaction-by-address

Parameter

api_key *

password *

address *

api_key :

password :

address :

                                                                                   
                                                                                        
{"flag":1,"msg":"success","action":"get-transaction-by-address","data":[{"id":"5b7650458ebb8306365624a2","txid":"7a6ca109c7c651f9b70a7d4dc8fa77de322e420119c5d2470bce7f08ba0cd1d6","explorer_url":"http://coin-explorer-url/exp/7a6ca109c7c651f9b70a7d4dc8fa7...","merchant_id":"5bc46fb28ebb8363d2657347","type":"receive","coin_short_name":"BCH","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my-wallet","address":"MP78UQoDpkehY7mMy2Cn9HSfysz4wbCeN1","amount":"2","confirmations":3,"date":"2018-08-17 10:04:13"},{"id":"23sdew232158ebb8306365624a2","txid":"7a6ca109c7c651f9b70fdgfg44er34re7de322e420119c5d2470bce7f08ba0cd1d6","explorer_url":"http://coin-explorer-url/exp/2322ereer344c7c651f9b70a7d4dc8fa7...","merchant_id":"3434df4w28ebb8363d2657347","type":"receive","coin_short_name":"BCH","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my-wallet","address":"MP78UQoDpkehY7mMy2Cn9HSfysz4wbCeN1","amount":"1","confirmations":2,"date":"2018-08-17 10:05:13"}]}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/get-transaction-by-address 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form address=' '

Get Wallet Balance

https://coinremitter.com/api/v3/BCH/get-balance

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$8He07BlQm5SFyTNQVxwHM.7KW0q4Oaplw4i.8rDUldIxHbzBz7Rfu
Wallet API Key

password Required	string	123456
Wallet Password

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

Get balance successfully

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

balance:	Total balance available in a wallet.
wallet_name:	Name of wallet.
coin_name:	Full name of coin.

POST Get Wallet Balance https://coinremitter.com/api/v3/BCH/get-balance

Parameter

api_key *

password *

api_key :

password :

                                                                                   
                                                                                        
{"flag":1,"msg":"Get balance successfully","action":"get-balance","data":{"balance":0.2457,"wallet_name":"my-wallet","coin_name":"Bitcoin Cash"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/get-balance 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '

Create Invoice

https://coinremitter.com/api/v3/BCH/create-invoice

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

amount Required	string	2
Invoice Amount

name Optional	string	random name
Name which you want to see on Invoice

currency Optional	string	EUR
Invoice amount currency

expire_time Optional	string	10
Invoice expiry time in minutes.

notify_url Optional	string	http://yourdomain.com/notify-url
URL on which you will be notify about payment

success_url Optional	string	http://yourdomain.com/success-url
After payment done url redirect to success url

fail_url Optional	string	http://yourdomain.com/fail-url
On payment fail url redirect to fail url

description Optional	string	Hello world
Invoice description

custom_data1 Optional	string	custom_data1
custom_data1

custom_data2 Optional	string	custom_data2
custom_data2

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

success

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

id:	Unique ID of Invoice.
invoice_id:	ID of Invoice.
merchant_id:	Unique ID of your account.
url:	Invoice URL that displays invoice details.
total_amount:	Total Amount in fiat/cryptocurrency. (Object)
paid_amount:	Paid amount in fiat/cryptocurrency. (Object)
usd_amount:	Total invoice amount in USD.
conversion_rate:	Rate of conversion when invoice created.
base_currency:	It will be fiat currency like GBP, EUR and many more. It will be the equivalent amount of cryptocurrency. E.g. If you want to create a Bitcoin invoice equivalent of 10 EUR then EUR will be considered as base_currency and an equivalent amount of bitcoin invoice will be created.
coin:	Symbol of coin. E.g. BTC for Bitcoin.
name:	Name of the invoice.
description:	Description of the invoice. It will display on invoice.
wallet_name:	Name of the wallet.
address:	It is address where fund is sent or received.
status:	Pending: If the payment of the invoice is not received, then the invoice status is shown as "Pending". It will be initial status when the invoice is created. Paid: When invoice is received full amount, invoice status will be shown as "Paid". Under Paid: If the payment of the invoice has been paid in part, the invoice status is shown as "Under paid". Over Paid: f the payment of the invoice is greater than amount value, the status of the invoice is shown as "Overpaid". Expired: if the payment of the invoice does not complete before the expiry time, the status of the invoice is shown as "Expired". Cancelled: if customer cancels the invoice, the status of the invoice is shown as "Cancelled".
status_code:	0: Pending 1: Paid 2: Underpaid 3: Over Paid 4: Expired 5: Cancelled
notify_url:	Payment notification will be sent to this URL. To check sample data on notify URL, Click here
success_url:	If the invoice is successfully paid, the invoice page will be redirected to the success URL.
fail_url:	If invoice is cancelled by the user, invoice will be redirected to the failed URL.
expire_on:	Expiry date of invoice. (UTC time)
invoice_date:	Invoice created date. (UTC time)
custom_data1:	Same data will return while creating an invoice.
custom_data2:	Same data will return while creating an invoice.
last_updated_date:	Updated date and time of invoice. (UTC time)

POST Create Invoice https://coinremitter.com/api/v3/BCH/create-invoice

Parameter

api_key *

password *

amount *

name

currency

expire_time

notify_url

success_url

fail_url

description

custom_data1

custom_data2

api_key :

password :

amount :

name :

currency :

expire_time :

notify_url :

success_url :

fail_url :

description :

custom_data1 :

custom_data2 :

                                                                                   
                                                                                        
{"flag":1,"msg":"success","action":"create-invoice","data":{"id":"5de7ab46b846fe6aa15931b2","invoice_id":"BCH122","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/5de7ab46b846fe6aa15931b2","total_amount":{"BCH":"0.00943552","USD":"2.21979838","EUR":"2"},"paid_amount":[],"usd_amount":"2.21979838","conversion_rate":{"USD_BCH":"0.00425062","BCH_USD":"235.26"},"base_currency":"EUR","coin":"BCH","name":"random name","description":"Hello world","wallet_name":"my-wallet","address":"QbrhNkto3732i36NYmZUNwCo4gvTJK3992","status":"Pending","status_code":0,"notify_url":"http://yourdomain.com/notify-url","success_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","custom_data1":"custom_data1","custom_data2":"custom_data2","last_updated_date":"2019-12-04 18:19:10"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/create-invoice 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form amount=' '
                                                                                                                                                                                      --form name=' '
                                                                                                                                                                                      --form currency=' '
                                                                                                                                                                                      --form expire_time=' '
                                                                                                                                                                                      --form notify_url=' '
                                                                                                                                                                                      --form success_url=' '
                                                                                                                                                                                      --form fail_url=' '
                                                                                                                                                                                      --form description=' '
                                                                                                                                                                                      --form custom_data1=' '
                                                                                                                                                                                      --form custom_data2=' '

Get Invoice

https://coinremitter.com/api/v3/BCH/get-invoice

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

invoice_id Required	string	BCH002
Invoice ID which you want to get

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

success

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

id:	Unique ID of Invoice.
invoice_id:	ID of Invoice.
merchant_id:	Unique ID of your account.
url:	Invoice URL that displays invoice details.
total_amount:	Total Amount in fiat/cryptocurrency. (Object)
paid_amount:	Paid amount in fiat/cryptocurrency. (Object)
usd_amount:	Total invoice amount in USD.
conversion_rate:	Rate of conversion when invoice created.
base_currency:	It will be fiat currency like GBP, EUR and many more. It will be the equivalent amount of cryptocurrency. E.g. If you want to create a Bitcoin invoice equivalent of 10 EUR then EUR will be considered as base_currency and an equivalent amount of bitcoin invoice will be created.
coin:	Symbol of coin E.g. BTC for Bitcoin.
name:	Name of the invoice.
description:	Description of the invoice.
wallet_name:	Name of the wallet.
address:	It is address where fund is sent or received.
payment_history:	Payment history displays all transactions of invoice payment.
status:	Pending: If the payment of the invoice is not received, then the invoice status is shown as "Pending". It will be initial status when the invoice is created. Paid: When invoice is received full amount, invoice status will be shown as "Paid". Under Paid: If the payment of the invoice has been paid in part, the invoice status is shown as "Under paid". Over Paid: If the payment of the invoice is greater than amount value, the status of the invoice is shown as "Overpaid". Expired: if the payment of the invoice does not complete before the expiry time, the status of the invoice is shown as "Expired". Cancelled: if customer cancels the invoice, the status of the invoice is shown as "Cancelled".
status_code:	0: Pending 1: Paid 2: Underpaid 3: Over Paid 4: Expired 5: Cancelled
notify_url:	Payment notification will be sent to this URL. To check sample data on notify URL, Click here
success_url:	If the invoice is successfully paid, the invoice page will be redirected to the success URL.
fail_url:	If invoice is cancelled by the user, invoice will be redirected to the failed URL.
expire_on:	Expiry date of invoice. (UTC time)
invoice_date:	Invoice created date. (UTC time)
custom_data1:	Same data will return while creating an invoice.
custom_data2:	Same data will return while creating an invoice.
last_updated_date:	Updated date and time of invoice. (UTC time)

POST Get Invoice https://coinremitter.com/api/v3/BCH/get-invoice

Parameter

api_key *

password *

invoice_id *

api_key :

password :

invoice_id :

                                                                                   
                                                                                        
{"flag":1,"msg":"success","action":"get-invoice","data":{"id":"5b7650458ebb8d306365624a2","invoice_id":"BCH002","merchant_id":"5bc46fb28ebb8d363d2657347","url":"https://coinremitter.com/invoice/5b7650458efbb8306365624a2","total_amount":{"BCH":"0.00943552","USD":"2.21979838","EUR":"2"},"paid_amount":{"BCH":"0.00943552","USD":"2.21979838","EUR":"2"},"usd_amount":"2.21979838","conversion_rate":{"USD_BCH":"0.00425062","BCH_USD":"235.26"},"base_currency":"EUR","coin":"BCH","name":"random name","description":"Hello world","wallet_name":"my-wallet","address":"rger54654fgsd4h6du7dgsg","payment_history":[{"txid":"3758c16f18fe868274bca152ca1g29fd7163bda59e8b514650c9825979","explorer_url":"http://coin-explorer-url/3758c16f18fe868274bca152cf...","amount":"0.00943552","date":"2021-02-27 15:05:02","confirmation":3}],"status":"Paid","status_code":1,"notify_url":"http://yourdomain.com/notify-url","success_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","custom_data1":"custom_data1","custom_data2":"custom_data2","last_updated_date":"2018-08-17 10:04:13"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/get-invoice 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form invoice_id=' '

Get Fiat To Crypto Rate

https://coinremitter.com/api/v3/BCH/get-fiat-to-crypto-rate

Request Parameter

Parameter	Type	Sample Value

api_key Required	string	$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
Wallet API Key

password Required	string	123456
Wallet Password

fiat_symbol Required	string	USD
Fiat Symbol

fiat_amount Required	string	1
Fiat Amount

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

success

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

crypto_amount:	Amount of cryptocurrency.
crypto_symbol:	Short name of cryptocurrency.
crypto_currency:	Full name of cryptocurrency.
fiat_amount:	Amount of fiat currency.
fiat_symbol:	Short name of fiat currency.

POST Get Fiat To Crypto Rate https://coinremitter.com/api/v3/BCH/get-fiat-to-crypto-rate

Parameter

api_key *

password *

fiat_symbol *

fiat_amount *

api_key :

password :

fiat_symbol :

fiat_amount :

                                                                                   
                                                                                        
{"flag":1,"msg":"success","action":"get-fiat-to-crypto-rate","data":{"crypto_amount":"0.02123593","crypto_symbol":"BCH","crypto_currency":"Bitcoin Cash","fiat_amount":"1","fiat_symbol":"USD"}}

                                                                                       
                                                                                          
                                                                                        curl --request POST 
                                                                                           --url https://coinremitter.com/api/v3/BCH/get-fiat-to-crypto-rate 
                                                                                           --header 'content-type: multipart/form-data' 
                                                                                                                                                                                      --form api_key=' '
                                                                                                                                                                                      --form password=' '
                                                                                                                                                                                      --form fiat_symbol=' '
                                                                                                                                                                                      --form fiat_amount=' '

Get Coin USD Price

GET Get Coin USD Price https://coinremitter.com/api/v3/get-coin-rate

                                                                                   
                                                                                        
{"flag":1,"msg":"success","action":"get-coin-rate","data":{"BTC":{"symbol":"BTC","name":"Bitcoin","price":10886.83},"LTC":{"symbol":"LTC","name":"Litecoin","price":47},"DOGE":{"symbol":"DOGE","name":"DogeCoin","price":235.26}}}

Response

Response	Type	Sample Value

flag

Integer

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

String

success

It explain reason of response. Do not compare this message in your code

data

Object

It is data object

symbol:	Short name of coin. E.g. BTC
name:	Full name of coin. E.g. Bitcoin
price:	USD price of 1 BTC.

Deposit/Withdraw Response

You will received webhook data on Deposit/Withdraw. What is Webhook ?

                                                       
                                                            
{"id":"5b7650458ebb8306365624a2","txid":"7a6ca109c7c651f9b70a7d4dc8fa77de322e420119c5d2470bce7f08ba0cd1d6","explorer_url":"http://coin-explorer-url/exp/7a6ca109c7c651f9b70a7d4dc8fa7...","merchant_id":"5bc46fb28ebb8363d2657347","type":"receive","coin_short_name":"BCH","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my-wallet","address_label":"address-label","address":"MP78UQoDpkehY7mMy2Cn9HSfysz4wbCeN1","amount":"2","confirmations":3,"date":"2018-08-17 10:04:13"}

Notify Invoice Response

You will received Notification data on Invoice Payment

                                                                                                                        
                                                                
{"id":"5b7650458ebb8d306365624a2","invoice_id":"BCH002","merchant_id":"5bc46fb28ebb8d363d2657347","url":"https://coinremitter.com/invoice/5b7650458efbb8306365624a2","total_amount":{"BCH":"0.00943552","USD":"2.21979838","EUR":"2"},"paid_amount":{"BCH":"0.00943552","USD":"2.21979838","EUR":"2"},"usd_amount":"2.21979838","conversion_rate":{"USD_BCH":"0.00425062","BCH_USD":"235.26"},"base_currency":"EUR","coin":"BCH","name":"random name","description":"Hello world","wallet_name":"my-wallet","address":"rger54654fgsd4h6du7dgsg","payment_history":[{"txid":"3758c16f18fe868274bca152ca1g29fd7163bda59e8b514650c9825979","explorer_url":"http://coin-explorer-url/3758c16f18fe868274bca152cf...","amount":"0.00943552","date":"2021-02-27 15:05:02","confirmation":3}],"status":"Paid","status_code":1,"notify_url":"http://yourdomain.com/notify-url","success_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","custom_data1":"custom_data1","custom_data2":"custom_data2","last_updated_date":"2018-08-17 10:04:13"}

Bitcoin Cash Payment Solutions

Types of Flags

Flag Value

Meaning

Example

Description

Code : 200

Create New Wallet Address

Request Parameter

Parameter

Type

Sample Value

api_key

Wallet API key

password

Wallet Password

label

Label of New Address

Response

Response

Type

Sample Value

flag

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

It explain reason of response. Do not compare this message in your code

data

It is data object

address:

It is address where fund is sent or received.

label:

Label that is assigned to the newly created address.

qr_code:

qr code image.

POST Create New Wallet Address https://coinremitter.com/api/v3/BCH/get-new-address

Parameter

Request

api_key :

password :

label :

Response (200 Ok - https status code)

Curl

Validate Address

Request Parameter

Parameter

Type

Sample Value

api_key

Wallet API Key

password

Wallet Password

address

Address which you want to validate.

Response

Response

Type

Sample Value

flag

It indicates success or failure. 1 = success, 0 = fail. Read more

msg

It explain reason of response. Do not compare this message in your code

data

It is data object

Valid:

true: If the address is valid, the valid data returned as "true".false: If the address is invalid, the valid data returned as "false".

POST Validate Address https://coinremitter.com/api/v3/BCH/validate-address

Parameter

Request

api_key :

password :

address :

Response (200 Ok - https status code)

Curl

Withdraw

Request Parameter

Parameter

Type

Sample Value

api_key

Wallet API Key

true: If the address is valid, the valid data returned as "true".
false: If the address is invalid, the valid data returned as "false".