Skip to main content

malipopaycentralapi_PaymentIntentPayload

Create a payment intent (generic). Used to programmatically initiate a collection, payout, or refund via a specific payment method (MNO push, card, lipa number, etc.).

modestringrequired

Direction/type of the payment.

Possible values: [PAYOUT, CHARGE, REFUND]

Example: CHARGE
amountnumberrequired

Amount in the smallest currency unit (e.g. TZS).

Example: 1000
referencestringnullable

Optional merchant reference. Left empty for server-generated.

Example: ORDER-2026-0091
currencystringnullable

Three-letter currency code. Defaults to TZS.

Possible values: [TZS, USD, NGN]

Example: TZS
paymentMethodDetails objectrequired
typestringrequired

Payment method channel.

Possible values: [TIGOPESA_TZ, MPESA_TZ, HALOPESA_TZ, HALOPESA_TZ_PUSH, AIRTELMONEY_TZ, TIGOPESA_TZ_PUSH, MPESA_TZ_PUSH, AIRTELMONEY_TZ_PUSH, EASYPESA_TZ, EASYPESA_TZ_PUSH, CARD, LIPA_NUMBER, LIPA_NUMBER_PUSH]

Example: MPESA_TZ_PUSH
phoneNumberstringrequired

Customer phone number (255XXXXXXXXX).

Example: 255742200105
cardNumbernumber

Card PAN (CARD only).

expiryMonthnumber

Card expiry month (CARD only).

expiryYearnumber

Card expiry year (CARD only).

holderNamestring

Name on the card (CARD only).

brandstring

Card brand, e.g. VISA, MASTERCARD (CARD only).

cvcnumber

Card CVC (CARD only).

customer object
emailemail
Example: jane@example.com
phoneNumberstring
Example: 255742200105
firstnamestring
Example: JANE
lastnamestring
Example: DOE
billingAddress object
addressstring
Example: Mikocheni, Plot 14
alternativeAddressstring
Example:
citystring
Example: Dar es Salaam
regionstring
Example: Dar es Salaam
postcodestring
Example: 14112
countrystring
Example: TZ
malipopaycentralapi_PaymentIntentPayload
{
  "mode": "CHARGE",
  "amount": 1000,
  "reference": "ORDER-2026-0091",
  "currency": "TZS",
  "paymentMethodDetails": {
    "type": "MPESA_TZ_PUSH",
    "phoneNumber": "255742200105",
    "cardNumber": 0,
    "expiryMonth": 0,
    "expiryYear": 0,
    "holderName": "string",
    "brand": "string",
    "cvc": 0
  },
  "customer": {
    "email": "jane@example.com",
    "phoneNumber": "255742200105",
    "firstname": "JANE",
    "lastname": "DOE",
    "billingAddress": {
      "address": "Mikocheni, Plot 14",
      "alternativeAddress": "",
      "city": "Dar es Salaam",
      "region": "Dar es Salaam",
      "postcode": "14112",
      "country": "TZ"
    }
  }
}