Skip to content

Overview

Every endpoint at a glance, grouped by what it does.

Base URL

https://api.autopayke.com

Every response is JSON shaped as { ok: true, data }, or { ok: false, error, code } when something is wrong. Amounts in responses are minor units as decimal strings. See Requests and responses.

Endpoints

Who the key belongs to, its limits and today's usage, the balance payouts are paid from, and the bank codes payouts accept.

Payouts API key

Send KES to M-Pesa, Airtel Money, Till (Buy Goods), PayBill and Kenyan bank accounts, paid from your USDC balance. Quote first, then create, then follow the status.

Recipients API key

Check who owns a phone number or bank account before you pay it.

Everything that moved money in the workspace (API payouts and anything else on the account), with receipts you can send to recipients or auditors.

Events API key

A record of everything that happened to your objects. The same events your webhooks receive; read them here to catch up after downtime.

Sandbox API key

Test-only helpers: top up your test balance and force a test payout into any status. They answer NOT_FOUND to live keys.

Where money can come from and go to right now: countries, methods, mobile money operators and per-transaction limits.

Fees Public

The prices AutoPayKe publishes, and an itemised quote for any amount, the same figures the app charges against.

The public side of a payment link: what the payer sees, paying it, and following the payment. No account is needed to pay.

Balance Bearer token

What the account holds, what it can send and withdraw, and anything on hold.

Saved cards Bearer token

References to cards used for top-ups: brand and last four digits only. Cards are saved by the hosted checkout, never by posting card details.

Payment requests Bearer token

Ask anyone to pay you: create a link, share it, and see when it's paid. The payer side is under Payment links (payer).

OpenAPI

The same endpoints as an OpenAPI 3.1 file, for generating a client in any language or importing into Postman or Insomnia: /openapi.json.