Coinremitter is a leading Litecoin payment gateway with solutions for Merchants and Business clients. It’s a decentralized LTC payment gateway that enables retailers to accept transactions in Litecoin.
This payment Litecoin API allows you to integrate & accept Litecoin 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 Litecoin Cryptocurrency Payment Gateway and introduce a new payment mode 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 ?
(BTC)
(LTC)
(BCH)
(ETH)
(DOGE)
(USDT)
(TCN)
(DASH)
(USDTERC20)
Flag Value | Meaning | Example | Description |
---|---|---|---|
1 | 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 examplevalidate-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. |
0 | Operation Fail |
Code : 200{ "flag": 0, "msg": "Invalid API key or password.", "data": [] } Code : 500{ "flag": 0, "msg": "Oops something went wrong", "action": "validate-address", "data": {} } |
Flag 0 means your operation has been failed. As a result, you will get a response of 200 or 500. For exampleYou 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. |
2 | 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 exampleIf you pass 1,000 in the amount then as a consequence you will get the validation error because there is comma in amount |
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
my_label
Success Response.
{"flag":1,"msg":"New address created successfully .","action":"get-new-address","data":{"address":"MMtU5BzKcrewdTzru9QyT3YravQmzokh","label":"my_label","qr_code":"https://coinremitter.com/qr/ltc/image.png"}}
1
New address created successfully.
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.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-new-address","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/get-new-address
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form label='my_label'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK
Success Response.
{"flag":1,"msg":"Success !","action":"validate-address","data":{"valid":true}}
1
Success !
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".
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"validate-address","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/validate-address
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form address='MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK
2
Success Response.
{"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.00002000","processing_fees":"0.00460000","total_amount":"2.00462","to_address":"MLjDMFsobgk9Etj8KUKSpmHM6qG2qFK","wallet_id":"5c42a0ab846fe75142cfb2","wallet_name":"my-wallet","coin_short_name":"LTC","date":"2019-06-02 01:02:03"}}
1
Amount Successfully Withdraw.
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.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"withdraw","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/withdraw
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form to_address='MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK'
--form amount='2'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
5b7e6f7d5aa55854e5726ac2
Success Response.
{"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":"LTC","wallet_id":"5f8a6fd164b6e25a78545e02","wallet_name":"my-wallet","address":"0xe82f1bea5e9d80edab36083013699895e6aa307d","amount":"2","confirmations":0,"date":"2020-10-22 15:32:11","transaction_fees":"0.00002000","processing_fees":"0.00460000","total_amount":"2.00462"}}
1
success
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.
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.
confirmations: Number of confirmation from the blockchain transaction.
date: UTC date & time of transaction.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-transaction","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/get-transaction
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form id='5b7e6f7d5aa55854e5726ac2'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK
Success Response.
{"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":"LTC","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":"LTC","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my-wallet","address":"MP78UQoDpkehY7mMy2Cn9HSfysz4wbCeN1","amount":"1","confirmations":2,"date":"2018-08-17 10:05:13"}]}
1
success
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.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-transaction-by-address","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/get-transaction-by-address
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form address='MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK'
$2y$10$8He07BlQm5SFyTNQVxwHM.7KW0q4Oaplw4i.8rDUldIxHbzBz7Rfu
123456
Success Response.
{"flag":1,"msg":"Get balance successfully","action":"get-balance","data":{"balance":0.2457,"wallet_name":"my-wallet","coin_name":"Litecoin"}}
1
Get balance successfully
balance: Total balance available in a wallet.
wallet_name: Name of wallet.
coin_name: Full name of coin.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-balance","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/get-balance
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$8He07BlQm5SFyTNQVxwHM.7KW0q4Oaplw4i.8rDUldIxHbzBz7Rfu'
--form password='123456'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
2
random name
EUR
10
http://yourdomain.com/notify-url
http://yourdomain.com/success-url
http://yourdomain.com/fail-url
Hello world
Success Response.
{"flag":1,"msg":"success","action":"create-invoice","data":{"id":"5de7ab46b846fe6aa15931b2","invoice_id":"LTC122","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/5de7ab46b846fe6aa15931b2","total_amount":{"LTC":"0.047229753","USD":"2.21979838","EUR":"2"},"paid_amount":[],"usd_amount":"2.21979838","conversion_rate":{"USD_LTC":"0.02127660","LTC_USD":"47.0"},"base_currency":"EUR","coin":"LTC","name":"random name","description":"Hello world","wallet_name":"my-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"}}
1
success
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/crypto currency. (Object)
paid_amount: Paid amount in fiat/crypto currency. (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 crypto currency. 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
suceess_url: If the invoice is successfully paid, the invoice page will be redirected to the success URL.
notify_url: Payment notification will be sent to this URL. To check sample data on notify URL, Click here
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)
last_updated_date: Updated date and time of invoice. (UTC time)
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"create-invoice","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/create-invoice
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form amount='2'
--form name='random name'
--form currency='EUR'
--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'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
LTC002
Success Response.
{"flag":1,"msg":"success","action":"get-invoice","data":{"id":"5b7650458ebb8d306365624a2","invoice_id":"LTC002","merchant_id":"5bc46fb28ebb8d363d2657347","url":"https://coinremitter.com/invoice/5b7650458efbb8306365624a2","total_amount":{"LTC":"0.047229753","USD":"2.21979838","EUR":"2"},"paid_amount":[],"usd_amount":"2.21979838","conversion_rate":{"USD_LTC":"0.02127660","LTC_USD":"47.0"},"base_currency":"EUR","coin":"LTC","name":"random name","description":"Hello world","wallet_name":"my-wallet","address":"rger54654fgsd4h6du7dgsg","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":"2018-08-17 10:04:13","last_updated_date":"2018-08-17 10:04:13"}}
1
success
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/crypto currency. (Object)
paid_amount: Paid amount in fiat/crypto currency. (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 crypto currency. 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
suceess_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)
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-invoice","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/get-invoice
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form invoice_id='LTC002'
$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq
123456
USD
1
Success Response.
{"flag":1,"msg":"success","action":"get-fiat-to-crypto-rate","data":{"crypto_amount":"0.02123593","crypto_symbol":"LTC","crypto_currency":"Litecoin","fiat_amount":"1","fiat_symbol":"USD"}}
1
success
crypto_amount: Amount of crypto currency.
crypto_symbol: Short name of crypto currency.
crypto_currency: Full name of crypto currency.
fiat_amount: Amount of fiat currency.
fiat_symbol: Short name of fiat currency.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-fiat-to-crypto-rate","data":[]}
0
Oops something went wrong !
[]
curl --request POST
--url https://coinremitter.com/api/v3/LTC/get-fiat-to-crypto-rate
--header 'content-type: multipart/form-data'
--form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq'
--form password='123456'
--form fiat_symbol='USD'
--form fiat_amount='1'
Success Response.
{"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}}}
1
success
BTC:
symbol: Short name of coin. E.g BTC
name: Full name of coin. E.G Bitcoin
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.
Error Response.
{"flag":0,"msg":"Oops something went wrong !","action":"get-coin-rate","data":[]}
0
Oops something went wrong !
[]
Success Response.
{"id":"5b7650458ebb8306365624a2","txid":"7a6ca109c7c651f9b70a7d4dc8fa77de322e420119c5d2470bce7f08ba0cd1d6","explorer_url":"http://coin-explorer-url/exp/7a6ca109c7c651f9b70a7d4dc8fa7...","merchant_id":"5bc46fb28ebb8363d2657347","type":"receive","coin_short_name":"LTC","wallet_id":"5c42ea0ab846fe751421cfb2","wallet_name":"my-wallet","address":"MP78UQoDpkehY7mMy2Cn9HSfysz4wbCeN1","amount":"2","confirmations":3,"date":"2018-08-17 10:04:13"}
Unique ID of transaction.
Blockchain transaction ID.
Third party explorer URL where the transaction status can be cross-checked.
Unique ID of merchant account.
Symbol of coin. E.g BTC for Bitcoin.
Unique ID of wallet.
Name of the wallet.
It is address where fund is sent or received.
Amount that you sent or received.
This field will be added in response, if the transaction type is "send". To check the transaction fees, Click here.
This field will be added in response, if the transaction type is "send". To check the processing fees, Click here.
This field will be added in response, if the transaction type is "send". amount+transaction_fees+processing_fees=total_amount.
Number of confirmation from the blockchain transaction.
UTC date & time of transaction.
Success Response.
{"id":"5b7650458ebb8306365624a2","invoice_id":"LTC002","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/b7650458ebb8306365624a2","total_amount":{"LTC":"0.047229753","USD":"2.21979838","EUR":"2"},"paid_amount":{"LTC":"0.047229753","USD":"2.21979838","EUR":"2"},"usd_amount":"2.21979838","conversion_rate":{"USD_LTC":"0.02127660","LTC_USD":"47.0"},"base_currency":"EUR","coin":"LTC","name":"random name","description":"Hello world","wallet_name":"my-wallet","address":"rger54654gsd4h6u7dgsg","payment_history":[{"txid":"20879ba9a186030a12d7999ec3aa8d53270cfbf535d124b810bc252712448","explorer_url":"http://coin-explorer-url/c4b853d4be7586798870a4aa766e3bb78ddb...","amount":2,"date":"2019-12-02 12:09:02","confirmation":1}],"status":"Paid","status_code":1,"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":"2018-08-17 10:04:13","last_updated_date":"2018-08-17 10:04:13"}
Unique ID of Invoice.
ID of Invoice.
Unique ID of your account.
Invoice URL that displays Invoice details.
Total Amount in fiat/crypto currency. (Object)
Paid amount in fiat/crypto currency. (Object)
Total invoice amount in USD.
Rate of conversion when invoice created.
Symbol of coin. E.g BTC for Bitcoin.
Name of the invoice.
Description of the invoice.
Unique ID of wallet.
Name of wallet.
It is address where fund is sent or received.
Payment history displays all transactions of invoice payment.
status:
Pending(0): 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(1): When invoice is received full amount, invoice status will be shown as "Paid".
Under Paid(2): If the payment of the invoice has been paid in part, the invoice status is shown as "Under paid".
Over Paid(3): If the payment of the invoice is greater than amount value, the status of the invoice is shown as "Overpaid".
Expired(4): if the payment of the invoice does not complete before the expiry time, the status of the invoice is shown as "Expired".
Cancelled(5): if a customer cancels the invoice, the status of the invoice is shown as "Cancelled".
If the invoice is successfully paid, the invoice page will be redirected to the success URL.
If invoice is cancelled by the user, invoice will be redirected to the failed URL.
Payment notification will be sent to this URL. To check sample data on notify URL, Click here
Expiry date of invoice. (UTC time)
Invoice created date. (UTC time)
Updated date and time of invoice. (UTC time)