Sign in

v1

latestOpenAPI 3.0.12026-07-2679100267.2 KB

Trigger a mobile money collection request from a customer.

post/v1/global-collection/inflow/initiate

Headers

Authorizationstring required
Example:Bearer <token>

Bearer token for authentication.

accountIdstring required
Example:890022ce-bae0-45c1-9b9d-ee7872e6ca27

The parent accountId of the business.

Request body

phoneNumberstring required
callbackUrlstring required
amountnumber required
currencystring required
topupVendorstring required

Mobile money network provider (e.g. AIRTEL, MPESA).

idempotencyKeystring

A client-generated key used to safely retry the request without risk of duplicate charges. If not provided, the server generates one automatically and returns it in the response.

Example request

{
  "phoneNumber": "0980802xxx",
  "callbackUrl": "https://your-server.com/webhook/collection",
  "amount": 10,
  "currency": "CDF",
  "topupVendor": "AIRTEL",
  "idempotencyKey": "a8f3d2c1-5b9e-4f7a-b2d6-1c8e3f5a9d0b"
}

Response

Inflow initiated successfully.

codestring
descriptionstring

Example response

{
  "code": "00",
  "description": "Successful",
  "data": {
    "transactionReference": "a822e327-4bcd-40ec-ac61-ed3622eac000",
    "status": "PENDING",
    "message": "success",
    "idempotencyKey": "a8f3d2c1-5b9e-4f7a-b2d6-1c8e3f5a9d0b"
  }
}