API docs

Take payments, pay out and move money with one REST API. JSON in, JSON out, Bearer tokens.

https://pesa-bridge.com/api/bridgepay/v1openapi.json

Every reply is {"status":"ok","data":…} or {"status":"error","message","code"}. Start with Getting started.

Discover APIs

Payments
Prompt-to-pay

Send a payment prompt to the customer's phone.

Payments
Pay Bill and Till payments

Receive payments customers make to your number.

Payments
Dynamic QR

A QR code the customer scans to pay you.

Online payments
Online payments (gateway)

One hosted page: wallet, mobile money, card or bank.

Online payments
Hosted page and pesabridge.js

Pay buttons with a publishable key.

Online payments
Payment links

Reusable links you share by message, email or QR.

Online payments
Refunds

Full and partial refunds of online payments.

Online payments
Payouts to your bank

When online sales are paid out to you.

Online payments
Disputes

Held amounts and dispute events.

Online payments
E-commerce plugin

The store plugin for your online shop.

Pay out
Pay out to customers (B2C)

From your settlement account to a customer's wallet.

Pay out
Pay businesses (B2B)

Pay another business by short code.

Pay out
Biz Pocket payout

Pay out to a Biz Pocket number.

Pay out
Tax and government bills

Pay tax with the payment reference.

Pay out
Reversals

Reverse a transaction after an officer approves.

Payments
Invoices

Create, send and follow invoices.

Payments
Payment request to a business

Till to till; the paying business approves.

Payments
Standing orders

Recurring payments.

On the live platform the customer sets it up in the app: test platform only.

Payments
Pay with loyalty points

Take points as payment.

On the live platform customers pay with points in the app: test platform only.

Partners
Transfers from abroad

For licensed remittance partners.

Account
Transactions and reconciliation

Read and list your transactions.

Account
Business and customer checks

Look up a short code; check a customer number.

Account
Keys and tokens

Test and live keys, rotation, ending tokens.

Account
Webhooks

Signed events, retries and test deliveries.

API reference

Loading…