Merchant API will provide you with a way to sell your products without the need of a messy code implementation. With our API, the only thing you need to do is to create your invoice. After the invoice has been paid, you will be notified by email and/or callback.
Your payments are forwarded according to your vendor settings to prevent any unwanted scenarios.
Crypto rates are valid for 30 minutes.
A small fee is taken automatically before system forwards the payment, we use those fees to keep the services up and running.
The minimum supported transaction size is
1 "your fiat currency here". Forwarding transactions will include a network fee paid from the amount you received.
In high fee times for Bitcoin, please try to generate transactions larger than the fee itself. :)
- Download the plugin from our plugins page for your CMS version.
- If you haven’t done so already, head over and sign up and create a merchant account.
- if you need help installing the plugin, you can read our integration guide for Wordpress, Opencart, WHMCS
Our rates are updated every 5 minutes.
Please use the following link to register for a Litepay Merchant account.
Once you registered, go to
Vendor page, and create your
VendorID. Fill in all the required fields and double check. At the moment we provide checkout plugins only for
OPENCART but we are currently working on adding more plugins.
If you want to create your own plugin, you can send a POST request to our API servers, with the following information:
vendor = vendor id #(required) invoice = invoice number you generated #(required) secret = SecretKey needed to confirm that you are said vendor #(required) price = price of the invoice #(required) currency = currency of the invoice. #(optional, defaults to USD) email = Buyers email. #(optional) callbackUrl = a callback url where you can receive callbacks from our system. (urlencoded) #(required) returnUrl = a returnUrl for us to send the client to after the payment. (urlencoded) #(required)
A correct input of data will return a JSON response with the status of the POST REQUEST. If the status of the request is
success, you will get a second variable named
url, which contains the url of the invoice. Your code must redirect the user to the url received.
A request that is incomplete will result in the status being
error and the next variable being
message, which will contain the error message.
An example successful invoice:
status : success url : https://litepay.ch/v2/i/a101432f-5f33-5f37-9537-a7b69992dae2
An example of a error returned by the API
status: error message: You did not send the vendor / invoice / secret / price / callbackUrl / returnUrl , try again.
The API is still under development. Information can and will change.
For automated shops, using our plugins listed above, the POST will be done automatically and the client will be redirected to our payment system. If the invoice is already in our system, the buyer will be redirected to the existing invoice.
If you want to use the VENDOR ID on more than one website, make sure that your invoice # is not duplicated.
Invoices are permanent, once created they can't be modified or deleted. That being said, when using your vendor id on multiple website, make sure the invoice numbers don't match the already created ones. If you have more questions about this, you can contact us.
Already created invoices won't change, if you are testing our plugins make sure you always test with a new invoice.
Once the invoice has been paid, our system will send you an email confirming that.
This is how the email might look like:
Subject: LitePay.ch Merchant | Invoice Example-818 has been paid! Body: Hello, Coffee Shop Invoice number #Example-818 has been paid. Payment information: Used BTC address : 3LNUEC3cCMqXCr5yhLDxjv1BhYrnhzGmXP Amount: 0.004546 BTC / ~32 USD TxID: a781b7bccbee0c1ea5b2f4c3ddca4c7396b4508f3067e0a4bf644a19e68db8ce TxTime: 2017-11-01 22:35:45 Status: Payment has 0 confirmations Best Regards, LitePay.ch Team Thank you for using www.LitePay.ch Support is available at: email@example.com
Callback is sent once the payment has been received and has the necesary number of confirmations.
If you are using Cloudflare service, make sure you are allowing our GET request, if you do not receive callbacks from us, check your cloudflare rules first.
Make sure our ip 220.127.116.11 is whitelisted
Crypto Addresses will expire once the invoice has been paid. Unpaid/Paid invoices expire after 30 days since their creation.
In the event of a incomplete payment (a user sends less than the required amount and doesn't follow up with the rest of the payment), we are required to refund your transaction in 30 days since that payment was made.
If 30 days have passed, we will consider that payment a donation.
Please contact us at firstname.lastname@example.org with your payment information if you are in such a pickle.