Bitcoin Payment Solution

BTC API by Coinremitter is a leading Bitcoin payment solution for business owners. It lets you accept crypto payments on your business website. By integrating this crypto API, you can let your customers pay in Bitcoin during the checkout process. This crypto payment API offers various features from creating invoices to making easy withdrawals, being an ideal crypto payment gateway to accept Bitcoin payments.

Sign up today on Coinremitter Cryptocurrency Payment Gateway to introduce a new Bitcoin 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 ?

Download Swagger JSON Download Postman JSON

API Responses: Error Codes With Meanings

Error code HTTP Code Description
1001 400 This indicates the validation error. You may have left one or more fields empty or have added invalid values.
1002 500 This indicates the server error. You can wait for some time and try again later after this gets resolved.
1003 200 This indicates invalid credentials. Please carefully check and re-enter your wallet credentials if you face this error.
1004 401 This indicates that your account may be inactive or you haven’t enabled using API credentials. If you’re facing this error, you can log in and enable API credentials.
1005 404 This indicates that the server is unable to find the requested resource. Either it is moved or deleted.
1006 429 This indicates that the rate limit of maximum API requests per minute has been exceeded. You can make an API call after some time if you get this response.
1007 503 This indicates that the service is under maintenance. You can start making API calls once the service gets updated successfully.

Create New Address

You can create an address and share it with customers to accept payments. You can add a label to add an indication (e.g. products, services, specific regions, etc) to a wallet address.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

label

STRING

Alphanumeric lable. Max 20 characters.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

wallet_id:

Wallet id.

wallet_name:

Wallet name.

coin:

Coin full name. E.g. Bitcoin.

coin_symbol:

Symbol of coin. E.g. BTC for Bitcoin.

coin_logo:

Coin logo url.

blockchain_network_name:

Blockchain network name.

contract_address:

Contract address of token.

contract_address_url:

Explorer url of contract address.

chain_id:

Blockchain id for EVM coins.

address:

It is address where Coins/Tokens is sent or received.

explorer_url:

Third party explorer URL where the address can be cross-checked.

label:

Label that is assigned to the newly created address.

qr_code:

Image url of address QR code.

minimum_deposit_amount:

Minimum deposite amount for coin.Below this amount transaction is not accepted.

remaining_address_limit:

It indicates remaining address limit for the wallet. If the value is -1, means you have pro plan and you can create unlimited addresses from this wallet.

wrn_msg:

This warning message should display to the user.

expire_on:

Expiry date of address. Read More

expire_on_timestamp:

Timestamp of expiry time.
Post

https://api.coinremitter.com/v1/wallet/address/create

curl --request POST \
--url https://api.coinremitter.com/v1/address/create \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'label=""'

Response 

{
    "success": true,
    "data": {
        "wallet_id": "6746c765xxxxxxxxxxxxxx",
        "wallet_name": "BTC-wallet",
        "coin": "Bitcoin",
        "coin_symbol": "BTC",
        "coin_logo": "https://api.coinremitter.com/assets/images/coins/32x32/BTC.png",
        "blockchain_network_name": "Bitcoin Main Net",
        "contract_address": "",
        "contract_address_url": "",
        "chain_id": "1",
        "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "explorer_url": "https://www.blockchain.com/explorer/addresses/btc/xxxxxxxxxxxxxxxxxxxxxxxxxxxx?from=coinremitter",
        "label": "BTC1",
        "qr_code": "https://qr_code.com/qr?margin=1&size=200&text=xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "minimum_deposit_amount": "1",
        "remaining_address_limit": 499,
        "wrn_msg": "",
        "expire_on": "2025-06-21 09:34:07",
        "expire_on_timestamp": 1750498447000
    }
}

Validate Address

Check whether the given address is valid or not. This can be helpful in preventing fund loss by knowing a valid address before making a withdrawal.

Parameters

Request Header

x-api-key*

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

address *

STRING

Address which you want to validate.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

status:
true: If the address format correct.
false: If the address format NOT correct.
Post

https://api.coinremitter.com/v1/wallet/address/validate

curl --request POST \
--url https://api.coinremitter.com/v1/address/validate \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'address=""'

Response 

{
    "success": true,
    "data": {
        "valid": true
    }
}

Estimate Withdrawal Cost

You can calculate fees for various withdrawal speeds and get the estimated withdrawal amount including fees. Estimated withdrawal cost = withdrawal amount + transaction fee + processing fee.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

amount*

STRING

Total amount which you want to send

address

STRING

Address of in which you want to send amount

withdrawal_speed

STRING

You can set default withdrawal speed from your wallet settings.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

amount:
Amount want to send.
transaction_fee:
Transactions fee for given amount.
processing_fee:
Processing fee for given amount.
total_amount:
transaction_fee+processing_fee+amount. Amount to be deducted from wallet.
fees_structure:
Fee structure.
Post

https://api.coinremitter.com/v1/wallet/withdraw/estimate

curl --request POST \
--url https://api.coinremitter.com/v1/withdraw
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'amount=""' \
--form 'address=""'

Response 

{
    "success": true,
    "data": {
        "amount": "1.00000000",
        "transaction_fee": "0.10000000",
        "processing_fee": "0.01000000",
        "total_amount": "1.11000000",
        "fees_structure": {
            "transaction_fee": "0.01",
            "processing_fee": "0.23%"
        }
    }
}

Withdraw

You can transfer your funds to an external wallet address and choose your preferred withdrawal speed. Selecting 'Low' will process the transaction at a slower confirmation speed, while 'Priority' ensures faster confirmation. For a customized withdrawal speed, you can create a support ticket.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

address *

STRING

Address of in which you want to send amount

amount*

STRING

Total amount which you want to send

withdrawal_speed

STRING

You can set withdrawal speed.i.e. low,medium,priority. Default it will take withdraw speed from wallet setting.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

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:
Sent or Withdrawn amount 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 Coins/Tokens is sent or received.
wallet_id:
Unique ID of wallet.
wallet_name:
Name of the wallet.
coin_symbol:
Symbol of coin. E.g. BTC for Bitcoin.
coin:
Coin full name. E.g. Bitcoin.
date:
UTC date & time of transaction.
transaction_timestamp:
Timestamp of transaction created.
remaining_withdraw_limit_24h:
Reamaining wallet withdrawal limit for 24 hour.
Post

https://api.coinremitter.com/v1/wallet/withdraw

curl --request POST \
--url https://api.coinremitter.com/v1/withdraw
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'amount=""' \
--form 'address=""'

Response 

{
    "success": true,
    "data": {
        "id": "674edd35765xxxxxxxxxxxxxx",
        "txid": "1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "amount": "1.00000000",
        "transaction_fees": "0.10000000",
        "processing_fees": "0.01000000",
        "total_amount": "1.11000000",
        "to_address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "wallet_id": "6746c765xxxxxxxxxxxxxx",
        "wallet_name": "BTC-wallet",
        "coin_symbol": "BTC",
        "coin": "Bitcoin",
        "date": "2024-12-03 10:28:05",
        "transaction_timestamp": 1733221685000,
        "remaining_withdraw_limit_24h": "49"
    }
}

Get Transaction

This can be primarily used to know whether the transaction is confirmed or not. The requested transaction details will be obtained by ID (Generated from coinremitter), Please note, that 'id' is not a blockchain transaction ID.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

id *

STRING

Unique id of your transaction. It is not blockchain transaction id. you will get this id from webhook data.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

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 the deposit 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".
status:
confirm: When transaction have more confirmation than coin required confirmations.
pending: When transaction have less confirmation than coin required confirmations.
status_code:
0: pending
1: confirm
coin:
Coin full name. E.g.Bitcoin.
coin_symbol:
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 Coins/Tokens is sent or received.
label:
Label of the address.
amount:
The amount of transactions that are sent / received.
confirmations:
Number of confirmation from the blockchain transaction.
required_confirmations:
At least this number of confirmations is required to confirm the transaction.
amount:
Transaction amount with fees.
date:
UTC date & time of transaction.
transaction_timestamp:
Transaction crated timestamp.
Post

https://api.coinremitter.com/v1/wallet/transaction

curl --request POST \
--url https://api.coinremitter.com/v1/transaction \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'id=""'

Response 

{
    "success": true,
    "data": {
        "id": "674edd35765xxxxxxxxxxxxxx",
        "txid": "1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "confirmations": 5,
        "required_confirmations": 3,
        "status": "confirm",
        "status_code": 1,
        "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?from=coinremitter",
        "type": "receive",
        "coin": "Bitcoin",
        "coin_symbol": "BTC",
        "wallet_id": "6746c765xxxxxxxxxxxxxx",
        "wallet_name": "BTC-wallet",
        "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "label": "BTC1",
        "amount": "1.00000000",
        "date": "2024-12-02 09:18:55",
        "transaction_timestamp": 1733131135000
    }
}

Get Transactions By Address

Get the details of the transaction list done on a specific address. This will track the transactions of Coinremitter addresses only.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

address *

STRING

Address

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

coin:
Coin full name. E.g.Bitcoin.
coin_symbol:
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 Coins/Tokens is sent or received.
expire_on:
Expiry date of address.
expire_on_timestamp:
Timestamp of expiry time.
label:
Label of the address.
required_confirmations:
At least this number of confirmations is required to confirm the transaction.
confirm_amount:
Total confirm amount of address.
pending_amount:
Total unconfirm amount of address.
transactions:
List of transactions,below keys are inside transaction object.
- id:
Unique transaction id generated by coinremitter.
- txid:
Blockchain transaction ID.
- explorer_url:
Third party explorer URL where the transaction status can be cross-checked.
- type:
receive: When you receive the deposit amount from any address, the type will be shown as "receive".
- amount:
The amount of transactions that are received.
- confirm_amount:
Confirm amount of address.
- pending_amount:
Unconfirm amount of address.
- confirmations:
Number of confirmation from the blockchain transaction.
- status:
confirm: When transaction have more confirmation than coin required confirmations.
pending: When transaction have less confirmation than coin required confirmations.
- status_code:
0: pending
1: confirm
- date:
UTC date & time of transaction.
- transaction_timestamp:
Transaction created timestamp.
Post

https://api.coinremitter.com/v1/wallet/address/transactions

curl --request POST \
--url https://api.coinremitter.com/v1/address/transactions \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'address=""'

Response 

{
    "success": true,
    "data": {
        "coin": "Bitcoin",
        "coin_symbol": "BTC",
        "wallet_name": "BTC-wallet",
        "wallet_id": "6746c765xxxxxxxxxxxxxx",
        "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "expire_on": "2025-05-26 07:16:53",
        "expire_on_timestamp": 1748243813000,
        "label": "BTC1",
        "required_confirmations": 3,
        "confirm_amount": "2.00000000",
        "pending_amount": "0.00000000",
        "transactions": [
            {
                "id": "674edd35765xxxxxxxxxxxxxx",
                "txid": "1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "confirmations": 3,
                "status": "confirm",
                "status_code": 1,
                "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "type": "receive",
                "amount": "2.00000000",
                "date": "2024-11-29 11:15:20",
                "transaction_timestamp": 1732878920000,
                "confirm_amount": "2.00000000",
                "pending_amount": "0.00000000"
            }
        ]
    }
}

Get Wallet Balance

Know the balance in your Coinremitter wallet.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

balance:
Total balance available in a wallet.
wallet_id:
Unique ID of wallet.
wallet_name:
Name of wallet.
coin:
Coin full name. E.g.Bitcoin
coin_symbol:
Symbol of coin. E.g. BTC for Bitcoin.

coin_logo:

Coin logo url.

blockchain_network_name:

Blockchain network name.

contract_address:

Contract address of token.

contract_address_url:

Explorer url of contract address.

chain_id:

Blockchain id for EVM coins.

explorer_url:

Third party explorer URL.

minimum_deposit_amount:

Minimum deposite amount for coin.Below this amount transaction is not accepted.
remaining_withdraw_limit_24h:
Reamaining wallet widhrawal limit for 24 hour.
Post

https://api.coinremitter.com/v1/wallet/balance

curl --request POST \
--url https://api.coinremitter.com/v1/wallet/balance \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD'

Response 

{
    "success": true,
    "data": {
        "wallet_id": "6746c765xxxxxxxxxxxxxx",
        "wallet_name": "BTC-wallet",
        "coin_symbol": "BTC",
        "coin": "Bitcoin",
        "coin_logo": "https://api.coinremitter.com/assets/images/coins/32x32/BTC.png",
        "blockchain_network_name": "Bitcoin Main Net",
        "contract_address": "",
        "contract_address_url": "",
        "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/",
        "chain_id": "1",
        "remaining_withdraw_limit_24h": "49",
        "balance": "84.73000000",
        "minimum_deposit_amount": "0.1"
    }
}

Create Invoice

The created invoice can be shared with customers to request payments. You can receive notifications of successful payments and can also notify your consumers about successful or failed transactions.

Parameters

Request Header

x-api-key *

STRING

Wallet API key

x-api-password *

STRING

Wallet API Password

Request

amount *

STRING

Invoice Amount.

name

STRING

It will display on invoice. Max 30 characters. It will display wallet name if this name is empty.

email

STRING

Coinremitter will send invoice to email (Optional).

fiat_currency

STRING
It will be fiat currency like GBP, EUR and
  • USD : United States Dollar
  • SLE : Sierra Leonean Leone
  • ZWL : Zimbabwean Dollar
  • JEP : Jersey Pound
  • ZMW : Zambian Kwacha
  • YER : Yemeni Rial
  • XPF : CFP Franc
  • XOF : West African CFA franc
  • XCD : East Caribbean Dollar
  • XDR : Special Drawing Rights
  • XAF : Central African CFA Franc
  • WST : Samoan Tālā
  • VUV : Vanuatu Vatu
  • VES : Venezuelan Bolívar Soberano
  • UZS : Uzbekistani So'm
  • UGX : Ugandan Shilling
  • TZS : Tanzanian Shilling
  • TVD : Tuvaluan Dollar
  • TTD : Trinidad and Tobago Dollar
  • TOP : Tongan Paʻanga
  • TND : Tunisian Dinar
  • TMT : Turkmenistan Manat
  • TJS : Tajikistani Somoni
  • SZL : Eswatini Lilangeni
  • SYP : Syrian Pound
  • STN : São Tomé and Príncipe Dobra
  • SSP : South Sudanese Pound
  • SRD : Surinamese Dollar
  • SOS : Somali Shilling
  • SLL : Sierra Leonean Leone
  • SHP : Saint Helena Pound
  • SDG : Sudanese Pound
  • SCR : Seychellois Rupee
  • SBD : Solomon Islands Dollar
  • RWF : Rwandan Franc
  • RSD : Serbian Dinar
  • QAR : Qatari Riyal
  • PGK : Papua New Guinean Kina
  • OMR : Omani Rial
  • NPR : Nepalese Rupee
  • NIO : Nicaraguan Córdoba
  • NGN : Nigerian Naira
  • NAD : Namibian Dollar
  • MWK : Malawian Kwacha
  • MZN : Mozambican Metical
  • MUR : Mauritian Rupee
  • MRU : Mauritanian Ouguiya
  • MOP : Macanese Pataca
  • MNT : Mongolian Tögrög
  • MMK : Burmese Kyat
  • MKD : Macedonian Denar
  • MGA : Malagasy Ariary
  • MAD : Moroccan Dirham
  • MDL : Moldovan Leu
  • LYD : Libyan Dinar
  • LSL : Lesotho Loti
  • LRD : Liberian Dollar
  • LKR : Sri Lanka Rupee
  • LBP : Lebanese Pound
  • LAK : Lao Kip
  • KYD : Cayman Islands Dollar
  • KMF : Comorian Franc
  • KWD : Kuwaiti Dinar
  • KID : Kiribati Dollar
  • KHR : Cambodian Riel
  • KGS : Kyrgyzstani Som
  • JOD : Jordanian Dinar
  • KES : Kenyan Shilling
  • JMD : Jamaican Dollar
  • IRR : Iranian Rial
  • IQD : Iraqi Dinar
  • IMP : Manx Pound
  • HNL : Honduran Lempira
  • HTG : Haitian Gourde
  • GYD : Guyanese Dollar
  • GMD : Gambian Dalasi
  • GNF : Guinean Franc
  • GIP : Gibraltar Pound
  • GHS : Ghanaian Cedi
  • GGP : Guernsey Pound
  • GEL : Georgian Lari
  • FKP : Falkland Islands Pound
  • FOK : Faroese Króna
  • ERN : Eritrean Nakfa
  • ETB : Ethiopian Birr
  • DZD : Algerian Dinar
  • DJF : Djiboutian Franc
  • CVE : Cape Verdean Escudo
  • CUP : Cuban Peso
  • CUC :
  • CRC : Costa Rican Colon
  • CDF : Congolese Franc
  • BYN : Belarusian Ruble
  • BZD : Belize Dollar
  • BWP : Botswana Pula
  • BTN : Bhutanese Ngultrum
  • BOB : Bolivian Boliviano
  • BND : Brunei Dollar
  • BMD : Bermudian Dollar
  • BHD : Bahraini Dinar
  • BIF : Burundian Franc
  • BDT : Bangladeshi Taka
  • BBD : Barbados Dollar
  • BAM : Bosnia and Herzegovina Convertible Mark
  • AZN : Azerbaijani Manat
  • AWG : Aruban Florin
  • ANG : Netherlands Antillian Guilder
  • AOA : Angolan Kwanza
  • AMD : Armenian Dram
  • ALL : Albanian Lek
  • AFN : Afghan Afghani
  • MVR : Maldivian Rufiyaa
  • MXN : Mexican Peso
  • CLP : Chilean Peso
  • COP : Colombian Peso
  • PAB : Panamanian Balboa
  • TWD : New Taiwan Dollar
  • PHP : Philippine Peso
  • DKK : Danish Krone
  • HUF : Hungarian Forint
  • SEK : Swedish Krona
  • IDR : Indonesian Rupiah
  • BGN : Bulgarian Lev
  • TRY : Turkish Lira
  • NOK : Norwegian Krone
  • ZAR : South African Rand
  • AUD : Australian Dollar
  • FJD : Fiji Dollar
  • PEN : Peruvian Sol
  • UYU : Uruguayan Peso
  • JPY : Japanese Yen
  • KRW : South Korean Won
  • PLN : Polish Złoty
  • BSD : Bahamian Dollar
  • EGP : Egyptian Pound
  • GTQ : Guatemalan Quetzal
  • KZT : Kazakhstani Tenge
  • UAH : Ukrainian Hryvnia
  • VND : Vietnamese Đồng
  • CAD : Canadian Dollar
  • HKD : Hong Kong Dollar
  • CZK : Czech Koruna
  • GBP : Pound Sterling
  • RON : Romanian Leu
  • BRL : Brazilian Real
  • RUB : Russian Ruble
  • EUR : Euro
  • MYR : Malaysian Ringgit
  • CNY : Chinese Renminbi
  • NZD : New Zealand Dollar
  • SGD : Singapore Dollar
  • ILS : Israeli New Shekel
  • AED : UAE Dirham
  • ARS : Argentine Peso
  • DOP : Dominican Peso
  • PKR : Pakistani Rupee
  • PYG : Paraguayan Guaraní
  • SAR : Saudi Riyal
  • ISK : Icelandic Króna
  • INR : Indian Rupee
  • HRK : Croatian Kuna
  • THB : Thai Baht
  • CHF : Swiss Franc
. 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 fiat_currency and an equivalent amount of Bitcoin invoice will be created.

expiry_time_in_minutes

STRING

Invoice expiry time in minutes. Default 1440 minutes.

notify_url

STRING

URL on which you will be notify about payment.

success_url

STRING

User will be redirected to this url once payment done.

fail_url

STRING

User will be redirected to this url when user cancel payment.

description

STRING

It will display on invoice. Max 255 characters.

custom_data1

STRING

This data will be included in notify_url. Max 30 characters.

custom_data2

STRING

This data will be included in notify_url. Max 30 characters.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

id:
Unique ID of Invoice.
invoice_id:
ID of Invoice.
url:
Public URL of invoice.
total_amount:
Total Amount in fiat/cryptocurrency.(Object)
paid_amount:
Paid amount in fiat/cryptocurrency.(Object)
amount:
Invoice amount in cryptocurrency.
usd_amount:
Total invoice amount in USD.
conversion_rate:
Rate of conversion when invoice created.(Object)
fiat_currency:
It will be fiat currency like GBP, EUR and
  • USD : United States Dollar
  • SLE : Sierra Leonean Leone
  • ZWL : Zimbabwean Dollar
  • JEP : Jersey Pound
  • ZMW : Zambian Kwacha
  • YER : Yemeni Rial
  • XPF : CFP Franc
  • XOF : West African CFA franc
  • XCD : East Caribbean Dollar
  • XDR : Special Drawing Rights
  • XAF : Central African CFA Franc
  • WST : Samoan Tālā
  • VUV : Vanuatu Vatu
  • VES : Venezuelan Bolívar Soberano
  • UZS : Uzbekistani So'm
  • UGX : Ugandan Shilling
  • TZS : Tanzanian Shilling
  • TVD : Tuvaluan Dollar
  • TTD : Trinidad and Tobago Dollar
  • TOP : Tongan Paʻanga
  • TND : Tunisian Dinar
  • TMT : Turkmenistan Manat
  • TJS : Tajikistani Somoni
  • SZL : Eswatini Lilangeni
  • SYP : Syrian Pound
  • STN : São Tomé and Príncipe Dobra
  • SSP : South Sudanese Pound
  • SRD : Surinamese Dollar
  • SOS : Somali Shilling
  • SLL : Sierra Leonean Leone
  • SHP : Saint Helena Pound
  • SDG : Sudanese Pound
  • SCR : Seychellois Rupee
  • SBD : Solomon Islands Dollar
  • RWF : Rwandan Franc
  • RSD : Serbian Dinar
  • QAR : Qatari Riyal
  • PGK : Papua New Guinean Kina
  • OMR : Omani Rial
  • NPR : Nepalese Rupee
  • NIO : Nicaraguan Córdoba
  • NGN : Nigerian Naira
  • NAD : Namibian Dollar
  • MWK : Malawian Kwacha
  • MZN : Mozambican Metical
  • MUR : Mauritian Rupee
  • MRU : Mauritanian Ouguiya
  • MOP : Macanese Pataca
  • MNT : Mongolian Tögrög
  • MMK : Burmese Kyat
  • MKD : Macedonian Denar
  • MGA : Malagasy Ariary
  • MAD : Moroccan Dirham
  • MDL : Moldovan Leu
  • LYD : Libyan Dinar
  • LSL : Lesotho Loti
  • LRD : Liberian Dollar
  • LKR : Sri Lanka Rupee
  • LBP : Lebanese Pound
  • LAK : Lao Kip
  • KYD : Cayman Islands Dollar
  • KMF : Comorian Franc
  • KWD : Kuwaiti Dinar
  • KID : Kiribati Dollar
  • KHR : Cambodian Riel
  • KGS : Kyrgyzstani Som
  • JOD : Jordanian Dinar
  • KES : Kenyan Shilling
  • JMD : Jamaican Dollar
  • IRR : Iranian Rial
  • IQD : Iraqi Dinar
  • IMP : Manx Pound
  • HNL : Honduran Lempira
  • HTG : Haitian Gourde
  • GYD : Guyanese Dollar
  • GMD : Gambian Dalasi
  • GNF : Guinean Franc
  • GIP : Gibraltar Pound
  • GHS : Ghanaian Cedi
  • GGP : Guernsey Pound
  • GEL : Georgian Lari
  • FKP : Falkland Islands Pound
  • FOK : Faroese Króna
  • ERN : Eritrean Nakfa
  • ETB : Ethiopian Birr
  • DZD : Algerian Dinar
  • DJF : Djiboutian Franc
  • CVE : Cape Verdean Escudo
  • CUP : Cuban Peso
  • CUC :
  • CRC : Costa Rican Colon
  • CDF : Congolese Franc
  • BYN : Belarusian Ruble
  • BZD : Belize Dollar
  • BWP : Botswana Pula
  • BTN : Bhutanese Ngultrum
  • BOB : Bolivian Boliviano
  • BND : Brunei Dollar
  • BMD : Bermudian Dollar
  • BHD : Bahraini Dinar
  • BIF : Burundian Franc
  • BDT : Bangladeshi Taka
  • BBD : Barbados Dollar
  • BAM : Bosnia and Herzegovina Convertible Mark
  • AZN : Azerbaijani Manat
  • AWG : Aruban Florin
  • ANG : Netherlands Antillian Guilder
  • AOA : Angolan Kwanza
  • AMD : Armenian Dram
  • ALL : Albanian Lek
  • AFN : Afghan Afghani
  • MVR : Maldivian Rufiyaa
  • MXN : Mexican Peso
  • CLP : Chilean Peso
  • COP : Colombian Peso
  • PAB : Panamanian Balboa
  • TWD : New Taiwan Dollar
  • PHP : Philippine Peso
  • DKK : Danish Krone
  • HUF : Hungarian Forint
  • SEK : Swedish Krona
  • IDR : Indonesian Rupiah
  • BGN : Bulgarian Lev
  • TRY : Turkish Lira
  • NOK : Norwegian Krone
  • ZAR : South African Rand
  • AUD : Australian Dollar
  • FJD : Fiji Dollar
  • PEN : Peruvian Sol
  • UYU : Uruguayan Peso
  • JPY : Japanese Yen
  • KRW : South Korean Won
  • PLN : Polish Złoty
  • BSD : Bahamian Dollar
  • EGP : Egyptian Pound
  • GTQ : Guatemalan Quetzal
  • KZT : Kazakhstani Tenge
  • UAH : Ukrainian Hryvnia
  • VND : Vietnamese Đồng
  • CAD : Canadian Dollar
  • HKD : Hong Kong Dollar
  • CZK : Czech Koruna
  • GBP : Pound Sterling
  • RON : Romanian Leu
  • BRL : Brazilian Real
  • RUB : Russian Ruble
  • EUR : Euro
  • MYR : Malaysian Ringgit
  • CNY : Chinese Renminbi
  • NZD : New Zealand Dollar
  • SGD : Singapore Dollar
  • ILS : Israeli New Shekel
  • AED : UAE Dirham
  • ARS : Argentine Peso
  • DOP : Dominican Peso
  • PKR : Pakistani Rupee
  • PYG : Paraguayan Guaraní
  • SAR : Saudi Riyal
  • ISK : Icelandic Króna
  • INR : Indian Rupee
  • HRK : Croatian Kuna
  • THB : Thai Baht
  • CHF : Swiss Franc
. 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 fiat_currency and an equivalent amount of Bitcoin invoice will be created.
coin:
Coin full name. E.g. Bitcoin.
coin_symbol:
Symbol of coin. E.g. BTC for Bitcoin.
name:
Name of the invoice.
description:
Description of the invoice. It will display on invoice.
wallet_id:
Unique ID of wallet.
wallet_name:
Name of the wallet.
merchant_id:
Unique ID of merchant.
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 "Over Paid".
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: Under Paid
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)
expire_on_timestamp:
Timestamp of expiry time.
invoice_date:
Invoice created date. (UTC time)
invoice_timestamp:
Timestamp of invoice created date.
delete_after:
The invoice is valid for 365 days from the date of creation and will be automatically deleted after this period. Ensure no coins or tokens are sent to the invoice address once it has been deleted.
delete_after_timestamp:
Timestamp of delete_after date.
custom_data1:
Custom data 1 set by you.
custom_data2:
Custom data 2 set by you.
Post

https://api.coinremitter.com/v1/invoice/create

curl --request POST \
--url https://api.coinremitter.com/v1/invoice/create \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'amount="2"' \
--form 'name=""' \
--form 'currency=""' \
--form 'expiry_time_in_minutes=""' \
--form 'notify_url=""' \
--form 'success_url=""' \
--form 'fail_url=""' \
--form 'description=""' \
--form 'custom_data1=""' \
--form 'custom_data2=""'

Response 

{
    "success": true,
    "data": {
        "id": "674edd35765xxxxxxxxxxxxxx",
        "invoice_id": "0wBv07n",
        "url": "https://coinremitter.com/invoice/view/674edd35765xxxxxxxxxxxxxx",
        "total_amount": {
            "BTC": "0.03000000",
            "USD": "10.6293"
        },
        "paid_amount": {
            "BTC": "0.01000000",
            "USD": "3.5431"
        },
        "usd_amount": "10.63",
        "amount": "0.03000000",
        "conversion_rate": {
            "USD_BTC": "0.00282239",
            "BTC_USD": "354.31000000"
        },
        "fiat_currency": "",
        "coin": "Bitcoin",
        "coin_symbol": "BTC",
        "name": "BTC-wallet",
        "description": "",
        "wallet_name": "BTC-wallet",
        "wallet_id": "673d6a3fdfxxxxxxxxxxxxxx",
        "merchant_id": "6746c765xxxxxxxxxxxxxx",
        "status": "Pending",
        "status_code": 0,
        "success_url": "",
        "fail_url": "",
        "notify_url": "",
        "expire_on": "",
        "expire_on_timestamp": "",
        "invoice_date": "2024-12-03 10:41:13",
        "custom_data1": "",
        "custom_data2": "",
        "invoice_timestamp": 1733222473000,
        "delete_after": "2025-06-01 10:41:13",
        "delete_after_timestamp": 1748774473000
    }
}

Get Invoice

Enter the invoice ID to know its status and other details such as the total received amount, and pending amount. This can be helpful to know whether the invoice is pending, underpaid, paid, overpaid, expired, or canceled. You can initiate or hold the delivery based on the payment status.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

id:
Unique ID of Invoice.
invoice_id:
ID of Invoice.
url:
Public URL of invoice.
total_amount:
Total Amount in fiat/cryptocurrency.(Object)
paid_amount:
Paid amount in fiat/cryptocurrency.(Object)
amount:
Invoice amount in cryptocurrency.
usd_amount:
Total invoice amount in USD.
conversion_rate:
Rate of conversion when invoice created.(Object)
fiat_currency:
It will be fiat currency like GBP, EUR and
  • USD : United States Dollar
  • SLE : Sierra Leonean Leone
  • ZWL : Zimbabwean Dollar
  • JEP : Jersey Pound
  • ZMW : Zambian Kwacha
  • YER : Yemeni Rial
  • XPF : CFP Franc
  • XOF : West African CFA franc
  • XCD : East Caribbean Dollar
  • XDR : Special Drawing Rights
  • XAF : Central African CFA Franc
  • WST : Samoan Tālā
  • VUV : Vanuatu Vatu
  • VES : Venezuelan Bolívar Soberano
  • UZS : Uzbekistani So'm
  • UGX : Ugandan Shilling
  • TZS : Tanzanian Shilling
  • TVD : Tuvaluan Dollar
  • TTD : Trinidad and Tobago Dollar
  • TOP : Tongan Paʻanga
  • TND : Tunisian Dinar
  • TMT : Turkmenistan Manat
  • TJS : Tajikistani Somoni
  • SZL : Eswatini Lilangeni
  • SYP : Syrian Pound
  • STN : São Tomé and Príncipe Dobra
  • SSP : South Sudanese Pound
  • SRD : Surinamese Dollar
  • SOS : Somali Shilling
  • SLL : Sierra Leonean Leone
  • SHP : Saint Helena Pound
  • SDG : Sudanese Pound
  • SCR : Seychellois Rupee
  • SBD : Solomon Islands Dollar
  • RWF : Rwandan Franc
  • RSD : Serbian Dinar
  • QAR : Qatari Riyal
  • PGK : Papua New Guinean Kina
  • OMR : Omani Rial
  • NPR : Nepalese Rupee
  • NIO : Nicaraguan Córdoba
  • NGN : Nigerian Naira
  • NAD : Namibian Dollar
  • MWK : Malawian Kwacha
  • MZN : Mozambican Metical
  • MUR : Mauritian Rupee
  • MRU : Mauritanian Ouguiya
  • MOP : Macanese Pataca
  • MNT : Mongolian Tögrög
  • MMK : Burmese Kyat
  • MKD : Macedonian Denar
  • MGA : Malagasy Ariary
  • MAD : Moroccan Dirham
  • MDL : Moldovan Leu
  • LYD : Libyan Dinar
  • LSL : Lesotho Loti
  • LRD : Liberian Dollar
  • LKR : Sri Lanka Rupee
  • LBP : Lebanese Pound
  • LAK : Lao Kip
  • KYD : Cayman Islands Dollar
  • KMF : Comorian Franc
  • KWD : Kuwaiti Dinar
  • KID : Kiribati Dollar
  • KHR : Cambodian Riel
  • KGS : Kyrgyzstani Som
  • JOD : Jordanian Dinar
  • KES : Kenyan Shilling
  • JMD : Jamaican Dollar
  • IRR : Iranian Rial
  • IQD : Iraqi Dinar
  • IMP : Manx Pound
  • HNL : Honduran Lempira
  • HTG : Haitian Gourde
  • GYD : Guyanese Dollar
  • GMD : Gambian Dalasi
  • GNF : Guinean Franc
  • GIP : Gibraltar Pound
  • GHS : Ghanaian Cedi
  • GGP : Guernsey Pound
  • GEL : Georgian Lari
  • FKP : Falkland Islands Pound
  • FOK : Faroese Króna
  • ERN : Eritrean Nakfa
  • ETB : Ethiopian Birr
  • DZD : Algerian Dinar
  • DJF : Djiboutian Franc
  • CVE : Cape Verdean Escudo
  • CUP : Cuban Peso
  • CUC :
  • CRC : Costa Rican Colon
  • CDF : Congolese Franc
  • BYN : Belarusian Ruble
  • BZD : Belize Dollar
  • BWP : Botswana Pula
  • BTN : Bhutanese Ngultrum
  • BOB : Bolivian Boliviano
  • BND : Brunei Dollar
  • BMD : Bermudian Dollar
  • BHD : Bahraini Dinar
  • BIF : Burundian Franc
  • BDT : Bangladeshi Taka
  • BBD : Barbados Dollar
  • BAM : Bosnia and Herzegovina Convertible Mark
  • AZN : Azerbaijani Manat
  • AWG : Aruban Florin
  • ANG : Netherlands Antillian Guilder
  • AOA : Angolan Kwanza
  • AMD : Armenian Dram
  • ALL : Albanian Lek
  • AFN : Afghan Afghani
  • MVR : Maldivian Rufiyaa
  • MXN : Mexican Peso
  • CLP : Chilean Peso
  • COP : Colombian Peso
  • PAB : Panamanian Balboa
  • TWD : New Taiwan Dollar
  • PHP : Philippine Peso
  • DKK : Danish Krone
  • HUF : Hungarian Forint
  • SEK : Swedish Krona
  • IDR : Indonesian Rupiah
  • BGN : Bulgarian Lev
  • TRY : Turkish Lira
  • NOK : Norwegian Krone
  • ZAR : South African Rand
  • AUD : Australian Dollar
  • FJD : Fiji Dollar
  • PEN : Peruvian Sol
  • UYU : Uruguayan Peso
  • JPY : Japanese Yen
  • KRW : South Korean Won
  • PLN : Polish Złoty
  • BSD : Bahamian Dollar
  • EGP : Egyptian Pound
  • GTQ : Guatemalan Quetzal
  • KZT : Kazakhstani Tenge
  • UAH : Ukrainian Hryvnia
  • VND : Vietnamese Đồng
  • CAD : Canadian Dollar
  • HKD : Hong Kong Dollar
  • CZK : Czech Koruna
  • GBP : Pound Sterling
  • RON : Romanian Leu
  • BRL : Brazilian Real
  • RUB : Russian Ruble
  • EUR : Euro
  • MYR : Malaysian Ringgit
  • CNY : Chinese Renminbi
  • NZD : New Zealand Dollar
  • SGD : Singapore Dollar
  • ILS : Israeli New Shekel
  • AED : UAE Dirham
  • ARS : Argentine Peso
  • DOP : Dominican Peso
  • PKR : Pakistani Rupee
  • PYG : Paraguayan Guaraní
  • SAR : Saudi Riyal
  • ISK : Icelandic Króna
  • INR : Indian Rupee
  • HRK : Croatian Kuna
  • THB : Thai Baht
  • CHF : Swiss Franc
. 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 fiat_currency and an equivalent amount of Bitcoin invoice will be created.
coin:
Coin full name. E.g. Bitcoin.
coin_symbol:
Symbol of coin. E.g. BTC for Bitcoin.
name:
Name of the invoice.
description:
Description of the invoice. It will display on invoice.
wallet_id:
Unique ID of wallet.
wallet_name:
Name of the wallet.
merchant_id:
Unique ID of merchant.
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 "Over Paid".
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: Under Paid
3: Over Paid
4: Expired
5: Cancelled
payment_history:
Invoice payment history.
- txid:
Transaction ID of blockchain transaction.
- explorer_url:
Third party explorer URL where the transaction status can be cross-checked.
- amount:
The amount of transactions that received.
- date:
UTC date & time of transaction.
- confirmation:
Number of confirmation from the blockchain transaction.
- required_confirmations:
At least this number of confirmations is required to confirm the transaction.
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)
expire_on_timestamp:
Timestamp of expiry time.
invoice_date:
Invoice created date. (UTC time)
invoice_timestamp:
Timestamp of invoice created date.
delete_after:
The invoice is valid for 365 days from the date of creation and will be automatically deleted after this period. Ensure no coins or tokens are sent to the invoice address once it has been deleted.
delete_after_timestamp:
Timestamp of delete_after date.
custom_data1:
Same data will return while creating an invoice.
custom_data2:
Same data will return while creating an invoice.
Post

https://api.coinremitter.com/v1/invoice/get

curl --request POST \
--url https://api.coinremitter.com/v1/invoice \
--header 'x-api-key: WALLET_API_KEY' \
--header 'x-api-password: WALLET_API_PASSWORD' \
--form 'invoice_id=""'

Response 

{
    "success": true,
    "data": {
        "id": "674edd35765xxxxxxxxxxxxxx",
        "invoice_id": "FJkJEOx",
        "url": "https://coinremitter.com/invoice/view/674edd35765xxxxxxxxxxxxxx",
        "total_amount": {
            "BTC": "0.03000000",
            "USD": "10.6293"
        },
        "paid_amount": {
            "BTC": "0.01000000",
            "USD": "3.5431"
        },
        "usd_amount": "10.63",
        "amount": "0.03000000",
        "conversion_rate": {
            "USD_BTC": "0.00282239",
            "BTC_USD": "354.31000000"
        },
        "fiat_currency": "",
        "coin": "Bitcoin",
        "coin_symbol": "BTC",
        "name": "BTC-wallet",
        "description": "",
        "wallet_name": "BTC-wallet",
        "wallet_id": "673d6a3fdfxxxxxxxxxxxxxx",
        "merchant_id": "6746c765xxxxxxxxxxxxxx",
        "payment_history": [
            {
                "txid": "1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
                "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?from=coinremitter",
                "amount": "0.01000000",
                "date": "2024-11-20 05:34:41",
                "confirmation": 5,
                "required_confirmations": 3
            }
        ],
        "status": "Under Paid",
        "status_code": 2,
        "success_url": "",
        "fail_url": "",
        "notify_url": "",
        "expire_on": "",
        "expire_on_timestamp": "",
        "invoice_date": "2024-11-20 05:33:57",
        "custom_data1": "",
        "custom_data2": "",
        "invoice_timestamp": 1732080837000,
        "delete_after": "2025-05-19 05:33:57",
        "delete_after_timestamp": 1747632837000
    }
}

Wallet Webhook

You will receive webhook data on your URL when you receive or send payment to your coinremitter wallet address. How to set a webhook URL?.This IPN content-type will be multipart/form-data.

Response

id:
Unique id of your transaction. It is not blockchain transaction id. you will get this id from webhook data.
txid:
Blockchain transaction ID.
explorer_url:
Third party explorer URL where the transaction status can be cross-checked.
merchant_id:
Unique ID of your account.
type:
receive: When you receive the deposit 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".
coin_symbol:
Symbol of coin. E.g. BTC for Bitcoin.
coin:
Name of coin. E.g. Bitcoin.
wallet_id:
Unique ID of wallet.
wallet_name:
Name of the wallet.
label:
Label of the address.
address:
It is address where Coins/Tokens is sent or received.
amount:
The amount of transactions that are sent / received.
confirmations:
Number of confirmation from the blockchain transaction.
date:
UTC date & time of transaction.

Response

{
    "id":"674edd35765xxxxxxxxxxxxxx",
    "txid":"1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "explorer_url":"https://www.blockchain.com/explorer/transactions/btc/1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "merchant_id":"5bc46fb28ebb8363d2657347",
    "type":"receive",
    "coin_symbol":"BTC",
    "coin":"Bitcoin",
    "wallet_id":"874rtd35765xxxxxxxxxxxxxx",
    "wallet_name":"BTC-wallet",
    "label":"address-label",
    "address":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "amount":"2",
    "confirmations":3,
    "date":"2018-08-17 10:04:13"
}

Invoice Notify

You will be notified of the invoice payment data. This IPN content-type will be multipart/form-data.

Response

id:
Unique ID of Invoice.
invoice_id:
ID of Invoice.
url:
Public URL of invoice.
total_amount:
Total Amount in fiat/cryptocurrency.(Object)
paid_amount:
Paid amount in fiat/cryptocurrency.(Object)
amount:
Invoice amount in cryptocurrency.
usd_amount:
Total invoice amount in USD.
conversion_rate:
Rate of conversion when invoice created.(Object)
fiat_currency:
It will be fiat currency like GBP, EUR and
  • USD : United States Dollar
  • SLE : Sierra Leonean Leone
  • ZWL : Zimbabwean Dollar
  • JEP : Jersey Pound
  • ZMW : Zambian Kwacha
  • YER : Yemeni Rial
  • XPF : CFP Franc
  • XOF : West African CFA franc
  • XCD : East Caribbean Dollar
  • XDR : Special Drawing Rights
  • XAF : Central African CFA Franc
  • WST : Samoan Tālā
  • VUV : Vanuatu Vatu
  • VES : Venezuelan Bolívar Soberano
  • UZS : Uzbekistani So'm
  • UGX : Ugandan Shilling
  • TZS : Tanzanian Shilling
  • TVD : Tuvaluan Dollar
  • TTD : Trinidad and Tobago Dollar
  • TOP : Tongan Paʻanga
  • TND : Tunisian Dinar
  • TMT : Turkmenistan Manat
  • TJS : Tajikistani Somoni
  • SZL : Eswatini Lilangeni
  • SYP : Syrian Pound
  • STN : São Tomé and Príncipe Dobra
  • SSP : South Sudanese Pound
  • SRD : Surinamese Dollar
  • SOS : Somali Shilling
  • SLL : Sierra Leonean Leone
  • SHP : Saint Helena Pound
  • SDG : Sudanese Pound
  • SCR : Seychellois Rupee
  • SBD : Solomon Islands Dollar
  • RWF : Rwandan Franc
  • RSD : Serbian Dinar
  • QAR : Qatari Riyal
  • PGK : Papua New Guinean Kina
  • OMR : Omani Rial
  • NPR : Nepalese Rupee
  • NIO : Nicaraguan Córdoba
  • NGN : Nigerian Naira
  • NAD : Namibian Dollar
  • MWK : Malawian Kwacha
  • MZN : Mozambican Metical
  • MUR : Mauritian Rupee
  • MRU : Mauritanian Ouguiya
  • MOP : Macanese Pataca
  • MNT : Mongolian Tögrög
  • MMK : Burmese Kyat
  • MKD : Macedonian Denar
  • MGA : Malagasy Ariary
  • MAD : Moroccan Dirham
  • MDL : Moldovan Leu
  • LYD : Libyan Dinar
  • LSL : Lesotho Loti
  • LRD : Liberian Dollar
  • LKR : Sri Lanka Rupee
  • LBP : Lebanese Pound
  • LAK : Lao Kip
  • KYD : Cayman Islands Dollar
  • KMF : Comorian Franc
  • KWD : Kuwaiti Dinar
  • KID : Kiribati Dollar
  • KHR : Cambodian Riel
  • KGS : Kyrgyzstani Som
  • JOD : Jordanian Dinar
  • KES : Kenyan Shilling
  • JMD : Jamaican Dollar
  • IRR : Iranian Rial
  • IQD : Iraqi Dinar
  • IMP : Manx Pound
  • HNL : Honduran Lempira
  • HTG : Haitian Gourde
  • GYD : Guyanese Dollar
  • GMD : Gambian Dalasi
  • GNF : Guinean Franc
  • GIP : Gibraltar Pound
  • GHS : Ghanaian Cedi
  • GGP : Guernsey Pound
  • GEL : Georgian Lari
  • FKP : Falkland Islands Pound
  • FOK : Faroese Króna
  • ERN : Eritrean Nakfa
  • ETB : Ethiopian Birr
  • DZD : Algerian Dinar
  • DJF : Djiboutian Franc
  • CVE : Cape Verdean Escudo
  • CUP : Cuban Peso
  • CUC :
  • CRC : Costa Rican Colon
  • CDF : Congolese Franc
  • BYN : Belarusian Ruble
  • BZD : Belize Dollar
  • BWP : Botswana Pula
  • BTN : Bhutanese Ngultrum
  • BOB : Bolivian Boliviano
  • BND : Brunei Dollar
  • BMD : Bermudian Dollar
  • BHD : Bahraini Dinar
  • BIF : Burundian Franc
  • BDT : Bangladeshi Taka
  • BBD : Barbados Dollar
  • BAM : Bosnia and Herzegovina Convertible Mark
  • AZN : Azerbaijani Manat
  • AWG : Aruban Florin
  • ANG : Netherlands Antillian Guilder
  • AOA : Angolan Kwanza
  • AMD : Armenian Dram
  • ALL : Albanian Lek
  • AFN : Afghan Afghani
  • MVR : Maldivian Rufiyaa
  • MXN : Mexican Peso
  • CLP : Chilean Peso
  • COP : Colombian Peso
  • PAB : Panamanian Balboa
  • TWD : New Taiwan Dollar
  • PHP : Philippine Peso
  • DKK : Danish Krone
  • HUF : Hungarian Forint
  • SEK : Swedish Krona
  • IDR : Indonesian Rupiah
  • BGN : Bulgarian Lev
  • TRY : Turkish Lira
  • NOK : Norwegian Krone
  • ZAR : South African Rand
  • AUD : Australian Dollar
  • FJD : Fiji Dollar
  • PEN : Peruvian Sol
  • UYU : Uruguayan Peso
  • JPY : Japanese Yen
  • KRW : South Korean Won
  • PLN : Polish Złoty
  • BSD : Bahamian Dollar
  • EGP : Egyptian Pound
  • GTQ : Guatemalan Quetzal
  • KZT : Kazakhstani Tenge
  • UAH : Ukrainian Hryvnia
  • VND : Vietnamese Đồng
  • CAD : Canadian Dollar
  • HKD : Hong Kong Dollar
  • CZK : Czech Koruna
  • GBP : Pound Sterling
  • RON : Romanian Leu
  • BRL : Brazilian Real
  • RUB : Russian Ruble
  • EUR : Euro
  • MYR : Malaysian Ringgit
  • CNY : Chinese Renminbi
  • NZD : New Zealand Dollar
  • SGD : Singapore Dollar
  • ILS : Israeli New Shekel
  • AED : UAE Dirham
  • ARS : Argentine Peso
  • DOP : Dominican Peso
  • PKR : Pakistani Rupee
  • PYG : Paraguayan Guaraní
  • SAR : Saudi Riyal
  • ISK : Icelandic Króna
  • INR : Indian Rupee
  • HRK : Croatian Kuna
  • THB : Thai Baht
  • CHF : Swiss Franc
. 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 fiat_currency and an equivalent amount of Bitcoin invoice will be created.
coin:
Coin full name. E.g. Bitcoin.
coin_symbol:
Symbol of coin. E.g. BTC for Bitcoin.
name:
Name of the invoice.
description:
Description of the invoice. It will display on invoice.
wallet_id:
Unique ID of wallet.
wallet_name:
Name of the wallet.
merchant_id:
Unique ID of merchant.
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 "Over Paid".
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: Under Paid
3: Over Paid
4: Expired
5: Cancelled
payment_history:
Invoice payment history.
- txid:
Transaction ID of blockchain transaction.
- explorer_url:
Third party explorer URL where the transaction status can be cross-checked.
- amount:
The amount of transactions that received.
- date:
UTC date & time of transaction.
- confirmation:
Number of confirmation from the blockchain transaction.
- required_confirmations:
At least this number of confirmations is required to confirm the transaction.
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)
expire_on_timestamp:
Timestamp of expiry time.
invoice_date:
Invoice created date. (UTC time)
invoice_timestamp:
Timestamp of invoice created date.
delete_after:
The invoice is valid for 365 days from the date of creation and will be automatically deleted after this period. Ensure no coins or tokens are sent to the invoice address once it has been deleted.
delete_after_timestamp:
Timestamp of delete_after date.
custom_data1:
Same data will return while creating an invoice.
custom_data2:
Same data will return while creating an invoice.

Response

{
    "id": "674edd35765xxxxxxxxxxxxxx",
    "invoice_id": "FJkJEOx",
    "url": "https://coinremitter.com/invoice/view/674edd35765xxxxxxxxxxxxxx",
    "total_amount": {
        "BTC": "0.03000000",
        "USD": "10.6293"
    },
    "paid_amount": {
        "BTC": "0.01000000",
        "USD": "3.5431"
    },
    "usd_amount": "10.63",
    "amount": "0.03000000",
    "conversion_rate": {
        "USD_BTC": "0.00282239",
        "BTC_USD": "354.31000000"
    },
    "fiat_currency": "",
    "coin": "Bitcoin",
    "coin_symbol": "BTC",
    "name": "BTC-wallet",
    "description": "",
    "wallet_name": "BTC-wallet",
    "wallet_id": "673d6a3fdfxxxxxxxxxxxxxx",
    "merchant_id": "6746c765xxxxxxxxxxxxxx",
    "payment_history": [
        {
            "txid": "1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/1796b1185xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx?from=coinremitter",
            "amount": "0.01000000",
            "date": "2024-11-20 05:34:41",
            "confirmation": 5,
            "required_confirmations": 3
        }
    ],
    "status": "Under Paid",
    "status_code": 2,
    "success_url": "",
    "fail_url": "",
    "notify_url": "",
    "expire_on": "",
    "expire_on_timestamp": "",
    "invoice_date": "2024-11-20 05:33:57",
    "custom_data1": "",
    "custom_data2": "",
    "invoice_timestamp": 1732080837000,
    "delete_after": "2025-05-19 05:33:57",
    "delete_after_timestamp": 1747632837000
}

Get Fiat To Crypto Rate

Get the value of the entered fiat currency in the crypto rate. This can be useful in knowing the price of your product in crypto.

Parameters

Request

fiat *

STRING

Fiat Symbol

fiat_amount *

STRING

Fiat Amount

crypto

STRING

Crypto Symbol

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail.

data

OBJECT

It is data object

price:
Amount of cryptocurrency.
short_name:
Short name of cryptocurrency.
name:
Full name of cryptocurrency.
Post

https://api.coinremitter.com/v1/rate/fiat-to-crypto

curl --request POST \
--url https://api.coinremitter.com/v1/rate/fiat-to-crypto \
--form 'fiat=""' \
--form 'fiat_amount=""' \
--form 'crypto=""'

Response 

{
    "success": true,
    "data": [
        {
            "short_name": "ETH",
            "name": "Ethereum",
            "price": "0.01826164"
        },
        {
            "short_name": "BTC",
            "name": "Bitcoin",
            "price": "0.00078409"
        },
        {
            "short_name": "USDTERC20",
            "name": "Tether USD ERC20",
            "price": "50.00000000"
        }
    ]
}

Get Crypto To Fiat Rate

Get the value of the cryptocurrency entered at the fiat rate. This can be useful in knowing the price of a particular cryptocurrency before making a withdrawal or estimating the price of your product or service.

Parameters

Request

crypto *

STRING

Crypto Symbol

crypto_amount *

STRING

Crypto Amount

fiat

STRING

Fiat Symbol

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail. Read more

data

OBJECT

It is data object

code:
Short name of fiat currency. E.g. USD
currency:
Full name of fiat currency. E.g. United States Dollar
amount:
Crypto price of given fiat amount.
Post

https://api.coinremitter.com/v1/rate/crypto-to-fiat 

curl --request POST \
--url https://api.coinremitter.com/v1/rate/crypto-to-fiat \
--form 'crypto=""' \
--form 'crypto_amount=""' \
--form 'fiat=""'

Response 

{
    "success": true,
    "data": [
        {
            "code": "USD",
            "currency": "United States Dollar",
            "amount": "166.84"
        },
        {
            "code": "EUR",
            "currency": "Euro",
            "amount": "154.16"
        },
        {
            "code": "NZD",
            "currency": "New Zealand Dollar",
            "amount": "273.62"
        },
        {
            "code": "SGD",
            "currency": "Singapore Dollar",
            "amount": "225.23"
        }
    ]
}

Get Supported Currencies

With this API, you will get useful information related to a particular cryptocurrency. This information can help you know how payments with Coinremitter work for a particular cryptocurrency. You can also know the explorer URL of a particular cryptocurrency, where the transaction status can be checked.

Response

success

BOOLEAN

It indicates success or failure. true = success, false = fail. Read more

data

OBJECT

It is data object

coin_symbol:
Short name of coin. E.g. BTC for Bitcoin
coin:
Full name of coin. E.g. Bitcoin
network_name:
Coin network name. E.g. Bitcoin Main Net for Bitcoin
explorer_url:
Third party explorer URL where the transaction status can be cross-checked.
logo:
Coin logo url.
minimum_deposit_amount:
Minimum deposite amount for coin.Below this amount transaction is not accepted.
price_in_usd:
USD price of 1 Coin.
fees:
It is an object.fees contain below keys.
low:
It is an object.low contain below keys.
transaction_fees_type:
Transaction fee type.E.g flat or percentage.
processing_fees_type:
Processing fee type.E.g flat or percentage.
transaction_fee:
Transaction fee charged on wallet Coins/Tokens widhrawal.
processing_fee:
Processing fee charged on wallet Coins/Tokens widhrawal.
transaction_fee_with_gasstation:
Transaction fee charged on wallet Coins/Tokens widhrawal when gas station is enable.
processing_fee_with_gasstation:
Processing fee charged on wallet Coins/Tokens widhrawal when gas station is enable.
medium:
Medium speed type has same key as low speed.
priority:
Priority speed type has same key as low speed.
Post

https://api.coinremitter.com/v1/rate/supported-currency 

curl --request POST \
--url https://api.coinremitter.com/v1/supported/currency

Response 

{
    "success": true,
    "data": [
        {
            "coin": "Bitcoin",
            "coin_symbol": "BTC",
            "network_name": "Bitcoin Network",
            "explorer_url": "https://www.blockchain.com/explorer/transactions/btc/",
            "logo": "https://api.coinremitter.com/assets/images/coins/32x32/BTC.png",
            "minimum_deposit_amount": "0.00001",
            "price_in_usd": "63768",
            "fees": {
                "low": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.23",
                    "processing_fee": "0.23",
                    "transaction_fee_with_gasstation": "0.002",
                    "processing_fee_with_gasstation": "0.002"
                },
                "medium": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.003",
                    "processing_fee": "0.35",
                    "transaction_fee_with_gasstation": "0.002",
                    "processing_fee_with_gasstation": "0.002"
                },
                "priority": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.005",
                    "processing_fee": "0.5",
                    "transaction_fee_with_gasstation": "0.003",
                    "processing_fee_with_gasstation": "0.003"
                }
            }
        },
        {
            "coin": "Tether USD ERC20",
            "coin_symbol": "USDTERC20",
            "network_name": "USDT ERC20 Network",
            "explorer_url": "https://etherscan.io/tx/",
            "logo": "https://api.coinremitter.com/assets/images/coins/32x32/USDTERC20.png",
            "minimum_deposit_amount": "3.1",
            "price_in_usd": "1",
            "fees": {
                "low": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.23",
                    "processing_fee": "0.23",
                    "transaction_fee_with_gasstation": "0.0003",
                    "processing_fee_with_gasstation": "0.22"
                },
                "medium": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.002",
                    "processing_fee": "0.24",
                    "transaction_fee_with_gasstation": "0.0003",
                    "processing_fee_with_gasstation": "0.23"
                },
                "priority": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.003",
                    "processing_fee": "0.2",
                    "transaction_fee_with_gasstation": "0.0004",
                    "processing_fee_with_gasstation": "0.23"
                }
            }
        },
        {
            "coin": "Ethereum",
            "coin_symbol": "ETH",
            "network_name": "Ethereum Coin Network",
            "explorer_url": "https://etherscan.io/tx/",
            "logo": "https://api.coinremitter.com/assets/images/coins/32x32/ETH.png",
            "minimum_deposit_amount": "0.00012",
            "price_in_usd": "2737.98",
            "fees": {
                "low": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.00023",
                    "processing_fee": "0.00023",
                    "transaction_fee_with_gasstation": "0.0003",
                    "processing_fee_with_gasstation": "0.12"
                },
                "medium": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.0001",
                    "processing_fee": "0.0009",
                    "transaction_fee_with_gasstation": "0.0004",
                    "processing_fee_with_gasstation": "0.16"
                },
                "priority": {
                    "transaction_fees_type": "flat",
                    "processing_fees_type": "percentage",
                    "transaction_fee": "0.003",
                    "processing_fee": "0.3",
                    "transaction_fee_with_gasstation": "0.0005",
                    "processing_fee_with_gasstation": "0.2"
                }
            }
        }
    ]
}