Skip to main content

Create M-PESA Payment

POST /api/payments/mpesa-payment

Initiate M-PESA payment for a balance

Header Parameters
  • api-key string required
  • api-secret string required
Request Body required
  • amount double required

    Amount being sent

  • phoneNumber string required

    Phone number of receiver

  • balanceId int64 required

    Balance Id of the account to send from

  • reference string required

    Reference

  • recipient string required

    Recipient Name

Responses

M-PESA payment was initiated successfully

Schema
  • paymentId uuid required

    Unique identifier for the payment

  • success boolean required

    Was the payment successful?

  • detail string required

    Details of the payment

  • reference string required

    Reference provided for the payment

Loading...