Skip to main content

Create M-PESA Payment

POST /api/payments/mpesa-payment

Initiate M-PESA payment for a balance

Query Parameters
  • is-virtual boolean

    virtual transactions ?

    Example: false
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

    Wallet Id of the account to send from

  • balanceIdCharge int64

    Wallet Id to charge, if left empty the balance that is being debited from will be charged

  • reference string required

    Reference

  • recipient string required

    Recipient Name

  • recipientIdNumber string

    Recipient ID number

  • tagId int64

    Tag ID

Responses

M-PESA payment was initiated successfully

Response Headers
  • x-request-id any

    Request Id for traceability

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...