Skip to main content
POST
Send money to another CloudPay customer (P2P)

Authorizations

Authorization
string
header
required

access_token from register or login. Expires after JWT_TTL (default 15m) or when the session ends.

Body

application/json
to_msisdn
string
required

Kenyan mobile number in local or international format.

Example:

712345678

amount
integer<int64>
required

Cents (KES minor units). 100 = KES 1.00.

Required range: x >= 1
Example:

100000

pin
string
required

4-6 digits; repeated (0000) and sequential (1234, 4321) PINs are refused.

Pattern: ^[0-9]{4,6}$
Example:

"4821"

idempotency_key
string
required

Unique per customer per intended operation; a UUID is ideal.

Required string length: 8 - 100
narrative
string
Maximum string length: 140

Response

Replay of an earlier identical request.

status
object
required
data
object