TukuPay Docs

Take payments

Payment links, invoices and paypoints

Requests for payment people pay by M-Pesa on a hosted TukuPay page, so you build no payment screen.

Payment links

POST/v1/payment-linksSigned · collect

SeeSigning requestsKeys and scopesWebhooks for the resultErrors

FieldMeaning
titleWhat it is for
wallet_idWhere payments land
amountKES; 0 or left out: the payer types any amount
link_typee.g. SERVICE_PAYMENT, PRODUCT_PURCHASE, DONATION, CUSTOM (default WALLET_TOPUP)
description, min_amount, max_amountOptional
single_payment, max_uses, expires_atOptional limits (ISO 8601 for the date)

The answer (201) includes id, link_code, status, checkout_link_url, short_url and can_be_used. Share the URL by SMS, WhatsApp or email; the payer pays on TukuPay's page.

GET/v1/payment-linksSigned · collect

SeeSigning requestsKeys and scopesWebhooks for the resultErrors

GET/v1/payment-links/{id}Signed · collect

SeeSigning requestsKeys and scopesWebhooks for the resultErrors

The list takes limit, offset and link_type, and answers { links, total, size, page, has_more }.

Invoices

As invoices in TukuPay, each with its own pay link: customer (name, optional phone and email), wallet_id, lines (description, quantity, unit_price), and optional issue_date, due_date, vat_rate, vat_inclusive, notes, terms.

GET/v1/invoices/{id}Signed · collect

SeeSigning requestsKeys and scopesWebhooks for the resultErrors

Paypoints

A named place to pay into a wallet: name, wallet_id, description, amount_mode (any, fixed or min) and amount. Each has a share_url for a QR code or a message, and can be put on your website with the embed script.

GET/v1/paypoints/{id}Signed · collect

SeeSigning requestsKeys and scopesWebhooks for the resultErrors

In the sandbox, making a link, invoice or paypoint is simulated ({ simulated: true, … }); the lists show your real ones.