API Documentation
Cari Finance takes card payments for your business. You call the HTTP API from your server with a secret key, and customers pay either on a payment link or in a checkout your own page shows with our script.
What is here today
- A REST API over HTTPS, called from your server with a secret key (
sk_test_...orsk_live_...). There are no server libraries: usefetch,curlor your language's HTTP client. - Payment sessions: your server opens a session for an exact amount; a page completes it with a publishable key.
- A checkout script (version 2) that you load from
js/v2/and that completes a payment session in the browser. - Payment links, customers, charges, refunds, balance, payouts and disputes (read only).
What is not here yet
- Outbound webhooks. Cari Finance does not send webhooks to your server. See Webhooks for how to find out about payments in the meantime.
- Server libraries for Node.js, Python, Ruby, PHP or Go. None has been published.
- Card terminals and tap to pay, mobile money, QR payments and subscription billing. The API has some endpoints for subscriptions, transfers, merchants and QR codes, but they keep records only: they do not bill a customer or move money, and they are not documented here.
Resources
Charges
List and read charges, update their descriptive fields, or take a payment with a card token.
Payment sessions
Open a session for an exact amount on your server and let the checkout widget complete it.
Customers
Create, read, update, delete and list customer records.
Refunds
Refund a charge in full or in part and list the refunds of a charge.