KiviPAY API: connect payment infrastructure to your own product

Use virtual POS charges, payment links, instalment and commission queries, transaction status and refund endpoints over REST/JSON. On the Kivi side, each collection also posts to ledgers and accounting automatically.

• REST / JSONJSON request and response over HTTPS
• Key-based authPer-environment API key
• 3-D SecureCard verification flow supported
• SandboxTest environment and test cards
• WebhooksEvent-driven real-time notifications
• Kivi integrationCollections, ledgers and accounting entries created automatically

What the API covers

Endpoint paths, request and response fields are documented with examples in the Swagger reference.

• Payments Card charges Start single or instalment payments, run the 3-D Secure flow and receive the result.
• Payment links Link creation Create links with amount, description and expiry; share over SMS or WhatsApp.
• Queries Instalments & commission Calculate instalment options and commission rates per card before the charge.
• Status Transaction lookup Transaction status, receipt and reconciliation data by reference number.
• Refunds Refund & void Same-day void and partial or full refunds, reflected in ledgers and accounting.
• Events Webhooks Real-time notifications for payment results, refunds and settlement events.

Integration in three steps

1. 1Get your keysSeparate API keys are issued for the sandbox and production environments after contracting.
2. 2Test in the sandboxValidate charge, link and refund flows with test cards before going live.
3. 3Go liveRegister your webhook endpoint and switch to the production key; typical go-live is one to two weeks.