Introduction

Coinremitter is a leading Tether USD ERC20 payment gateway with solutions for Merchants and Business clients. It’s a decentralized USDTERC20 payment gateway that enables retailers to accept transactions in Tether USD ERC20.

This payment Tether USD ERC20 API allows you to integrate & accept Tether USD ERC20 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 Tether USD ERC20 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 ?

Supported Coins

Bitcoin

(BTC)

Litecoin

(LTC)

Bitcoin Cash

(BCH)

Ethereum

(ETH)

DogeCoin

(DOGE)

Tether USDT (Omni)

(USDT)

Test Coin

(TCN)

Koinon

(KOIN)

Dash

(DASH)

Tether USD ERC20

(USDTERC20)

Types of Flags

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 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.

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 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.

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 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

POST Create New Wallet Address

https://coinremitter.com/api/v2/USDTERC20/get-new-address

POST Parameters

api_key

Required
String

$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq

password

Required
String

123456

label

Optional
String

my_label

200: Success

Success Response.

{"flag":1,"msg":"New address created successfully .","action":"get-new-address","data":{"address":"MMtU5BzKcrewdTzru9QyT3YravQmzokh","label":"my_label"}}

flag

Integer

1

msg

String

New address created successfully.

data

Object

address: Newly created address.

label: Label assigned to that address.

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"get-new-address","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/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/v2/USDTERC20/validate-address

POST Parameters

api_key

Required
String

$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq

password

Required
String

123456

address

Required
String

MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK

200: Success

Success Response.

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

flag

Integer

1

msg

String

Success !

data

Object

Valid:
true: if the address will be valid, then the data will be return true.
false: if the address will be invalid, then the data will be return false.

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"validate-address","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/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/v2/USDTERC20/withdraw

POST Parameters

api_key

Required
String

$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq

password

Required
String

123456

to_address

Required
String

MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK

amount

Required
String

2

200: Success

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.00460000","processing_fees":"0.02000000","total_amount":"2.0246","to_address":"MLjDMFsobgk9Etj8KUKSpmHM6qG2qFK","wallet_id":"5c42a0ab846fe75142cfb2","wallet_name":"my-wallet","coin_short_name":"USDTERC20","date":"2019-06-02 01:02:03"}}

flag

Integer

1

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 applied to withdraw the amount. Check the transaction fees here.

processing_fees: Processing Fees which is applied to withdraw the amount. Check the processing fees here.

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

to_address: At this address, Fund will be sent.

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

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

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

date: Date and time of Transaction when the transaction is received or send.

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"withdraw","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/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' 
                                         
                                      

POST Get Transaction

https://coinremitter.com/api/v2/USDTERC20/get-transaction

POST Parameters

api_key

Required
String

$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq

password

Required
String

123456

id

Required
String

5b7e6f7d5aa55854e5726ac2

200: Success

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":"USDTERC20","wallet_id":"5f8a6fd164b6e25a78545e02","wallet_name":"my-wallet","address":"0xe82f1bea5e9d80edab36083013699895e6aa307d","amount":"2","confirmations":0,"date":"2020-10-22 15:32:11","transaction_fees":"0.00460000","processing_fees":"0.02000000","total_amount":"2.0246"}}

flag

Integer

1

msg

String

success

data

Object

id: you will get this id from your webhook response. Click here to check sample webhook data

txid: Blockchain transaction id

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: Merchant id of deposit or withdrawal transaction.

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

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.

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

processing_fees: if transaction type is "send" then this field will added in response. Check the processing fees here.

total_amount: if transaction type is "send" then this field will added in response. amount+transaction_fees+processing_fees=total_amount.

confirmations: Number of confirmation from blockchain transaction

date: UTC date and time when transaction registered

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"get-transaction","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/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/v2/USDTERC20/get-balance

POST Parameters

api_key

Required
String

$2y$10$8He07BlQm5SFyTNQVxwHM.7KW0q4Oaplw4i.8rDUldIxHbzBz7Rfu

password

Required
String

123456

200: Success

Success Response.

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

flag

Integer

1

msg

String

Get balance successfully

data

Object

balance: Total Available balance of a wallet.

wallet_name: Name of wallet.

coin_name: Full name of coin.

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"get-balance","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/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/v2/USDTERC20/create-invoice

POST Parameters

api_key

Required
String

$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq

password

Required
String

123456

amount

Required
String

2

name

Optional
String

random name

currency

Optional
String

EUR

expire_time

Optional
String

10

notify_url

Optional
String

http://yourdomain.com/notify-url

suceess_url

Optional
String

http://yourdomain.com/success-url

fail_url

Optional
String

http://yourdomain.com/fail-url

description

Optional
String

Hello world

custom_data1

Optional
String

Custom Data 1

custom data 2

Optional
String

Custom data 2

200: Success

Success Response.

{"flag":1,"msg":"success","action":"create-invoice","data":{"id":"5de7ab46b846fe6aa15931b2","invoice_id":"USDTERC20122","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/5de7ab46b846fe6aa15931b2","total_amount":{"USDTERC20":"2.21979838","USD":"2.21979838","EUR":"2"},"paid_amount":[],"usd_amount":"2.21979838","conversion_rate":{"USD_USDTERC20":"1.0","USDTERC20_USD":"1.0"},"base_currency":"EUR","coin":"USDTERC20","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","custom_data1":" custom data 1","custom_data2":" custom data 2"}}

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: URL of Invoice which displays Invoice details.

total_amount: Total Amount in fiat/crypto currency. (Object)

paid_amount: Paid amount in fiat/crypto currency. (Object)

usd_amount: Total Amount that user paid in USD.

conversion_rate: Rate of conversion when invoice create.

base_currency: Base currency in which invoice generated. currency like GBP, EUR and many more.

coin: Coin short name.

name: Name will display on invoice.

description: Description will display on invoice.

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: 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

notify_url: Invoice notification received at notify url.

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 and time.

invoice_date: Invoice created date and time.

custom_data1: It Will return same value.

custom_data2: It Will return same value.

last_updated_date: Last updated date and time of Invoice

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"create-invoice","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/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' 
      --form custom_data1='Custom Data 1' 
      --form custom data 2='Custom data 2' 
                                         
                                      

POST Get invoice

https://coinremitter.com/api/v2/USDTERC20/get-invoice

POST Parameters

api_key

Required
String

$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq

password

Required
String

123456

invoice_id

Required
String

USDTERC20002

200: Success

Success Response.

{"flag":1,"msg":"success","action":"get-invoice","data":{"id":"5b7650458ebb8d306365624a2","invoice_id":"USDTERC20002","merchant_id":"5bc46fb28ebb8d363d2657347","url":"https://coinremitter.com/invoice/5b7650458efbb8306365624a2","total_amount":{"USDTERC20":"2.21979838","USD":"2.21979838","EUR":"2"},"paid_amount":[],"usd_amount":"2.21979838","conversion_rate":{"USD_USDTERC20":"1.0","USDTERC20_USD":"1.0"},"base_currency":"EUR","coin":"USDTERC20","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","custom_data1":" custom data 1","custom_data2":" custom data 2"}}

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: URL of Invoice which displays Invoice details.

total_amount: Total Amount in fiat/crypto currency. (Object)

paid_amount: Paid amount in fiat/crypto currency. (Object)

usd_amount: Total Amount that user paid in USD.

conversion_rate: Rate of conversion when invoice create.

base_currency: Base currency in which invoice generated. currency like GBP, EUR and many more.

coin: Coin short name.

name: Name will display on invoice.

description: Description will display on invoice.

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: 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

notify_url: Invoice notification received at notify url.

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 and time.

invoice_date: Invoice created date and time.

custom_data1: It Will return same value.

custom_data2: It Will return same value.

last_updated_date: Last updated date and time of Invoice

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"get-invoice","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

                                      
curl --request POST 
   --url https://coinremitter.com/api/v2/USDTERC20/get-invoice 
   --header 'content-type: multipart/form-data' 
      --form api_key='$2y$10$oEj.DQbFaErQpUhce41IhO.dhBgnKBgtpCdQvo29wuEkcQV0yyW2eq' 
      --form password='123456' 
      --form invoice_id='USDTERC20002' 
                                         
                                      

GET Get Coin USD Price

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

200: Success

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}}}

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.

500: Error

Error Response.

{"flag":0,"msg":"Oops something went wrong !","action":"get-coin-rate","data":[]}

flag

Integer

0

msg

String

Oops something went wrong !

data

Object

[]

Webhook Deposit/Withdraw Response

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

200: Success

Success Response.

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

id

INTEGER

1

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.

merchant_id

STRING

Merchant id of deposit or withdrawal transaction.

type

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

coin_short_name

String

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

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.

transaction_fees

STRING

if transaction type is "send" then this field will added in response. Check the transaction fees here.

processing_fees

STRING

if transaction type is "send" then this field will added in response. Check the processing fees here.

total_amount

STRING

if transaction type is "send" then this field will added in response. amount+transaction_fees+processing_fees=total_amount.

confirmations

STRING

Confirmation of transaction which you receive from server.

Date

DATE

Date and time of Transaction when the transaction is received or send.

Notify Invoice Response

You will received Notification data on Invoice Payment

200: Success

Success Response.

{"id":"5b7650458ebb8306365624a2","invoice_id":"USDTERC20002","merchant_id":"5bc46fb28ebb8363d2657347","url":"https://coinremitter.com/invoice/b7650458ebb8306365624a2","total_amount":{"USDTERC20":"2.21979838","USD":"2.21979838","EUR":"2"},"paid_amount":{"USDTERC20":"2.21979838","USD":"2.21979838","EUR":"2"},"usd_amount":"2.21979838","conversion_rate":{"USD_USDTERC20":"1.0","USDTERC20_USD":"1.0"},"base_currency":"EUR","coin":"USDTERC20","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"}

id

INTEGER

Unique Id of Invoice.

invoice_id

STRING

Id of Invoice.

merchant_id

STRING

Id of Merchant who is created Invoice.

url

STRING

URL of Invoice which displays Invoice details.

total_amount

OBJECT

Amount Which is Payable for Invoice.

paid_amount

OBJECT

Total paid amount of Invoice.

usd_amount

OBJECT

Total Amount in USD.

conversion_rate

OBJECT

Rate of conversion when invoice create.

base_currency

STRING

base_currency: Base currency in which invoice generated. currency like GBP, EUR and many more.

coin

STRING

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

name

STRING

Invoice name which entered by user when create invoice.

description

STRING

If user entered description at time of create invoice, notify data will return that description.

wallet_id

STRING

Wallet ID will appear of that wallet in which invoice created.

wallet_name

STRING

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

address

STRING

Invoice address in which paid amount credited.

payment_history

OBJECT

Payment History displays all transactions of Invoice Payment

status/status_code

STRING/INTEGER

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

STRING

If Invoice Payment is paid successfully, Invoice redirect to the suceess url.

fail_url

STRING

If Invoice Payment is failed, Invoice redirect to the fail url.

notify_url

STRING

Invoice notification received at notify url.

expire_on

Date

Invoice expired date and time.

invoice_date

Date

Invoice created date and time.

last_updated_date

Date

Last date and time of Invoice Update.

custom_data1

STRING

It Will returns the same value.

custom_data2

STRING

It Will returns the same value.

;