Skip to main content
POST

Authorizations

x-api-key
string
header
required

Merchant API secret.

Headers

environment
enum<string>
default:production

Target environment. Defaults to production when omitted.

Available options:
production,
sandbox

Body

application/json
currency
enum<string>
required
Available options:
UGX,
KES
source
enum<string>
required
Available options:
mobile
amount
number
required
Required range: x <= 1000000000
phone_number
string
required
Required string length: 8 - 20
Pattern: ^\+?[1-9]\d{7,19}$
external_reference
string
required
Required string length: 3 - 120
Pattern: ^[A-Za-z0-9._:-]+$
callback_url
string<uri>
required
Maximum string length: 500
quote
boolean
default:false

Callbacks

POST
{$request.body#/callback_url}collectionPending

Body

application/json
event
enum<string>
required
Available options:
collection.pending
status
enum<string>
required
Available options:
pending
data
object
required

Response

200

Callback accepted.

Response

Quote or collection transaction.

status
enum<string>
required
Available options:
success
data
object
required
Last modified on July 17, 2026