Send Mobile Money

POST /api/pay/sendmobilemoney

This method allows you to transfer money to a mobile money users wallet.

Access to this endpoint requires setup changes on your account. Contact the technical team for this configuration to be completed.

The table below provides information about the properties expected in the payload to be sent to this request:

PropertyDataType (maxSize)RequiredDescription
OrderObjectYesInformation about the operation to be performed
Order.customerFullNameString(180)NoFull Name for customer
Order.customerPhoneNumberString(180)NoPhone Number of the customer
Order.transactionReferenceString(20)YesReference transaction ID from source request to be used in reconciliations
order.customerEmailAddressString(180)NoEmail address of the customer
order.currencyString(3)YesChar 3 ISO currency code
Order.amountDecimal(8,2) YesAmount involved in the transaction
DestinationObjectYesInformation about the payment channel the client should use in completing the transaction
Destination.providerStringYesThe Provider to be used to process the payment (MPESA,AIRTEL,ORANGE,AFRIMONEY)
Destination.walletidString(14)YesPhone number in international format (+243XXXX…)
Request Formats
Sample Request
{
  "order": {
    "customerFullName": "string",
    "customerPhoneNumber": "string",
    "customerEmailAddress": "string",
    "transactionReference": "string",
    "amount": 0,
    "currency": "string”
  },

  "destination": {
    "provider": "string", //MPESA,AIRTEL,ORANGE
    "walletID": "string" //MSISDN
  }
}
Response Information
Sample Response
{
    "transactionId": "string",
    "originatingTransactionId": "string”,
    “statusCode”:”200”,
    “statusDescription”:”SUCCESS”
}