Documentation

Developer documentation

Everything you need to integrate Diginummi into your app, website, or POS system.

Get started

Quickstart

1

Get your API key

Create a free account and grab your API key from the dashboard. Use your test key during development — no real transactions.

2

Install the SDK

Install the official Node.js SDK with npm, or use our REST API directly from any language.

3

Create a payment

Generate a payment link or QR code with a single API call. Redirect your customer or display the QR at checkout.

4

Listen for webhooks

Register a webhook endpoint to receive real-time payment confirmations, refunds, and settlement events.

SDKs & libraries

Official SDKs

Node.js

npm install @diginummi/node

Recommended

Python

pip install diginummi

PHP

composer require diginummi/diginummi-php

Ruby

gem install diginummi

Go

go get github.com/diginummi/diginummi-go

REST API

https://api.diginummi.com/v1

No SDK needed
quickstart.ts
import Diginummi from '@diginummi/node';

const client = new Diginummi({
  apiKey: process.env.DIGINUMMI_API_KEY,
});

// Create a payment link for any order
const link = await client.paymentLinks.create({
  amount: 3200,        // $32.00
  currency: 'USD',
  description: 'Table 7 — Dinner order',
  acceptedCurrencies: ['BTC', 'ETH', 'USDC'],
  expiresIn: 900,      // 15 minutes
});

console.log(link.url);
// → https://pay.diginummi.com/l/xyz789

// Listen for confirmation via webhook
// POST /webhooks/diginummi
// { event: 'payment.confirmed', data: { ... } }
REST API

Core API endpoints

Base URL: https://api.diginummi.com

POST

/v1/payment-links

Create a hosted payment link for a specific amount and currency.

GET

/v1/payment-links/:id

Retrieve the status and details of a payment link.

POST

/v1/charges

Create a direct charge and get a hosted checkout URL.

GET

/v1/charges/:id

Retrieve a charge and its current payment status.

GET

/v1/settlements

List all settlements and payout records for your account.

POST

/v1/webhooks

Register a webhook endpoint to receive real-time event notifications.

Real-time events

Webhook events

payment.confirmed

Fired when a payment is confirmed on-chain and funds are credited to your account.

payment.failed

Fired when a payment attempt fails or expires before confirmation.

settlement.completed

Fired when a settlement payout is sent to your bank account.

refund.created

Fired when a refund is initiated for a previously confirmed payment.

Guides

Integration guides

In-store

In-store QR code payments

Display a dynamic QR code at your counter. Customers scan and pay from their wallet — confirmation appears on your screen in seconds.

Read guide
Remote

Payment links via SMS or email

Generate a payment link for any order and send it to your customer. Works for remote orders, deposits, and invoices.

Read guide
E-commerce

Shopify plugin

Add crypto as a payment option to your Shopify store in minutes. No coding required — install from the Shopify App Store.

Read guide
E-commerce

WooCommerce plugin

Install the Diginummi WooCommerce plugin and enable crypto checkout alongside your existing payment methods.

Read guide
API

Custom checkout integration

Use the REST API or SDK to build a fully custom crypto checkout flow into your website or app.

Read guide
Security

Webhook verification

Verify webhook signatures to ensure events are genuinely from Diginummi before processing them in your backend.

Read guide

Ready to integrate?

Create a free account and start testing in the sandbox — no KYB required.