Skip to main content
POST
Collect from a payer on the merchant's collection rail

Authorizations

Authorization
string
header
required

A merchant-scoped API key, issued by CloudPay staff or the merchant's owner. Acts with exactly its scopes.

Path Parameters

merchantID
string<uuid>
required

Body

application/json
amount
integer<int64>
required

Cents; whole shillings on M-Pesa / SasaPay.

idempotency_key
string
required
Required string length: 8 - 100
till_id
string<uuid>

Default the merchant's first active till; a cashier's own till.

msisdn
string

Required except for checkout.

Example:

712345678

email
string

Checkout receipt email (optional).

method
enum<string>
Available options:
stk,
checkout
network
enum<string>

The payer's mobile-money network. Airtel needs a SasaPay or Paystack (charge) collection rail, T-Kash needs SasaPay (400 network_unsupported).

Available options:
mpesa,
airtel,
tkash
reference
string
Maximum string length: 100

Response

Started.

status
object
required
data
object