Skip to main content

Django implementation of CryptAPI's payment gateway

Project description


CryptAPI's Django Library

Django's implementation of CryptAPI's payment gateway


Python >= 3.0
Django >= 2.0
Requests >= 2.20


pip install django-cryptapi

on pypi or on GitHub



Run migrations:

python3 migrate cryptapi

Add CryptAPI's URLs to your project's file:

urlpatterns = [
    path('cryptapi/', include('cryptapi.urls')),


After the installation you need to set up Providers for each coin you wish to accept.

You need to go into your Django Admin and create a new CryptAPI Provider for each coin with your cold wallet address where the funds will be forwarded to.


Creating an Invoice

In your order creation view, assuming user_order is your order object:

from cryptapi import Invoice
def order_creation_view(request):
    invoice = Invoice(

    payment_address = invoice.address()

    if payment_address is not None:
        # Show the payment address to the user
        # Handle request error, check RequestLogs on Admin


request is Django's view HttpRequest object
order_id is just your order id
coin is the coin you wish to use, can be one of: ['btc', 'eth', 'bch', 'ltc', 'xmr', 'iota'] and you need to have a Provider set up for that coin.
value is an integer of the value of your order, either in satoshi, litoshi, wei, piconero or IOTA

Getting notified when the user pays

from django.dispatch import receiver
from cryptapi.signals import payment_complete

def payment_received(order_id, payment, value):
    # Implement your logic to mark the order as paid and release the goods to the user


order_id is the id of the order that you provided earlier, used to fetch your order
payment is an cryptapi.models.Payment object with the payment details, such as TXID, number of confirmations, etc.
value is the value the user paid, either in satoshi, litoshi, wei or IOTA


This library has a couple of helpers to help you get started

cryptapi.valid_providers() is a method that returns a list of tuples of the active providers that you can just feed into the choices of a form.ChoiceField

cryptapi.get_order_invoices(order_id) returns a list of cryptapi.models.Request objects of your order (you can have multiple objects for the same order if the user mistakenly initiated the payment with another coin)

There's also some template tags which you can import to help you with conversions and the protocols. You just need to load cryptapi_helper on your template and use the following tags / filters:

{% convert_value coin value %} where the coin is one of ['btc', 'eth', 'bch', 'ltc', 'xmr', 'iota'] and the value is the value in satoshi, litoshi, wei or IOTA, will convert to the main coin denomination.

{{ coin|coin_name }} will output the properly formatted cryptocurrency name

If you want to build a full payment URI for your clients, you can use our build_payment_uri tag, like so:

{% build_payment_uri btc 1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3 0.001 %}

# will output: bitcoin:1PE5U4temq1rFzseHHGE2L8smwHCyRbkx3?amount=0.001

It takes 3 arguments: the coin, the payment address and the value in the main denomination of the coin, and it will output a payment URI ready for you to feed into a QR Code generator


Need help?
Contact us @

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-cryptapi-0.1.8.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

django_cryptapi-0.1.8-py3-none-any.whl (18.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page