neoliqpay
- Version: 3.0.0
- Web: https://www.liqpay.ua/
- Download: https://pypi.org/project/neoliqpay
- Source: https://github.com/MiloLug/neoliqpay
- Documentation: https://www.liqpay.ua/documentation/en/
- Keywords: neoliqpay, aioliqpay, liqpay, privat24, privatbank, python, internet acquiring, P2P payments, two-step payments, asyncio
What python version is supported?
- Python 3.6, 3.7, 3.8, 3.9, 3.10
Get Started
- Sign up in https://www.liqpay.ua/en/authorization.
- Create a company.
- In company settings, on API tab, get Public key and Private key.
- Done.
Installation
With pip:
pip install neoliqpay[sync] # for sync variant
pip install neoliqpay[async] # for async variant
pip install neoliqpay[async,sync] # for bothWorking with LiqPay Callback locally
If you need debugging API Callback on local environment use https://github.com/inconshreveable/ngrok
Using
Example 1: Basic
Backend
Get payment button (html response)
liqpay = LiqPay(public_key, private_key)
html = liqpay.cnb_form(
action='pay',
amount=1,
currency='UAH',
description='description text',
order_id='order_id_1',
language='ua'
)Get plain checkout url:
liqpay = LiqPay(public_key, private_key)
html = liqpay.checkout_url({
action='auth',
amount=1,
currency='UAH',
description='description text',
order_id='order_id_1',
language='ua',
recurringbytoken=1'
})
# Response:
str: https://www.liqpay.ua/api/3/checkout/?data=<decoded data>&signature=<decoded signature>Frontend
Variable html will contain next html form
<form method="POST" action="https://www.liqpay.ua/api/3/checkout" accept-charset="utf-8">
<input type="hidden" name="data" value="eyAidmVyc2lvbiIgOiAzLCAicHVibGljX2tleSIgOiAieW91cl9wdWJsaWNfa2V5IiwgImFjdGlv
biIgOiAicGF5IiwgImFtb3VudCIgOiAxLCAiY3VycmVuY3kiIDogIlVTRCIsICJkZXNjcmlwdGlv
biIgOiAiZGVzY3JpcHRpb24gdGV4dCIsICJvcmRlcl9pZCIgOiAib3JkZXJfaWRfMSIgfQ=="/>
<input type="hidden" name="signature" value="QvJD5u9Fg55PCx/Hdz6lzWtYwcI="/>
<input type="image"
src="//static.liqpay.ua/buttons/p1ru.radius.png"/>
</form>Example 2: Integrate Payment widget with Django
Payment widget documentation
https://www.liqpay.ua/documentation/en/api/aquiring/widget/
Backend
views.py
from neoliqpay import LiqPay
from django.views.generic import TemplateView
from django.shortcuts import render
from django.http import HttpResponse
liqpay = LiqPay(settings.LIQPAY_PUBLIC_KEY, settings.LIQPAY_PRIVATE_KEY)
class PayView(TemplateView):
template_name = 'billing/pay.html'
def get(self, request, *args, **kwargs):
params = {
'action': 'pay',
'amount': 100,
'currency': 'USD',
'description': 'Payment for clothes',
'order_id': 'order_id_1',
'server_url': 'https://test.com/billing/pay-callback/', # url to callback view
}
signature, data = liqpay.cnb_signature_data_pair(params)
return render(
request,
self.template_name,
{
'signature': signature,
'data': data
}
)
class PayCallbackView(View):
def post(self, request, *args, **kwargs):
data = request.POST.get('data')
signature = request.POST.get('signature')
if liqpay.callback_is_valid(signature, data):
print('callback is valid')
response = liqpay.decode_data(data)
print('callback data', response)
return HttpResponse()urls.py
from django.conf.urls import path
from billing.views import PayView, PayCallbackView
urlpatterns = [
path('pay/', PayView.as_view(), name='pay_view'),
path('pay-callback/', PayCallbackView.as_view(), name='pay_callback'),
]billing/pay.html
<div id="liqpay_checkout"></div>
<script>
window.LiqPayCheckoutCallback = function() {
LiqPayCheckout.init({
data: "{{ data }}",
signature: "{{ signature }}",
embedTo: "#liqpay_checkout",
mode: "embed" // embed || popup,
}).on("liqpay.callback", function(data){
console.log(data.status);
console.log(data);
}).on("liqpay.ready", function(data){
// ready
}).on("liqpay.close", function(data){
// close
});
};
</script>
<script src="//static.liqpay.ua/libjs/checkout.js" async></script>