Skip to content
AutoPayKe Docs
Get started

Introduction

What the AutoPayKe API does, who it's for, and how workspaces, keys, balances, payouts and webhooks fit together.

AutoPayKe lets your software pay people in Kenya: M-Pesa and Airtel Money wallets, Till (Buy Goods) and PayBill numbers, and accounts at Kenyan banks. You hold a balance in USDC, a dollar stablecoin on the Avalanche C-Chain, and each payout converts it to Kenyan shillings at a locked rate and delivers it, usually within a minute for mobile money.

It suits payroll and rider or driver payouts, marketplace seller settlements, supplier and farmer payments, remittance apps, and anyone whose money arrives in dollars or stablecoins but whose people need shillings.

How it fits together

PieceWhat it is
WorkspaceYour developer account, tied to an AutoPayKe personal, business or organization account. It holds your keys, webhooks, limits and balance.
ConsoleThe dashboard at console.autopayke.com where you create keys, add webhooks, read logs, watch usage and apply for live access.
API keysapk_test_… keys use the sandbox (no real money, instant). apk_live_… keys move real money and work once we approve them.
BalanceLive: USDC in your workspace's smart wallet, which you fund by sending USDC or USDT, or topping up with M-Pesa in the AutoPayKe app. Test: free test USDC from the faucet.
PayoutsA request to send KES somewhere. You get an id at once and the outcome by webhook.
Events and webhooksEvery status change is an event. We POST it, signed, to your webhook URL and keep it readable through the API.

A payout, end to end

  1. Quote

    POST /api/v1/payouts/quote checks the destination and your limits and returns the rate, our fee and the USDC total. Optional, but it lets you show the cost before committing.

  2. Create

    POST /api/v1/payouts with an Idempotency-Key. We take the total from your balance and return the payout with status pending.

  3. Follow

    We send payout.processing, then payout.succeeded or payout.failed to your webhook. A failed payout returns the money to your balance.

  4. Reconcile

    Match payouts to your records by reference and metadata, pull receipts, and list transactions for your books.

Start here

QuickstartA test payout in five minutes.API keysCreate, scope, allowlist, roll and revoke keys.SandboxTest values that force every outcome.PayoutsDestinations, statuses, failures and fees.WebhooksEvents, signatures, retries and ordering.Going liveThe application, approvals and checklist.

Two other APIs on this site

Besides the partner API, these docs cover public endpoints (coverage, published fees, quotes; no key) and the account API, which the AutoPayKe app itself uses with a signed-in person's token (top-ups, payment links, real-time status). Businesses integrating payouts should use API keys.