Skip to main content

malipopaycentralapi_MakeCollectionV3Request

referencestring

Your own reference for this payment. Reusing a reference returns the existing payment instead of charging again. Optional; Malipopay generates one when omitted.

Example: ORDER-001
descriptionstringrequired

What the customer is paying for. Shown on the payment record.

Example: Payment for Order #001
amountintegerrequired

Amount in whole TZS.

Example: 50000
providerstring

Channel the payment runs on, e.g. VODACOM, AIRTEL, TIGO, HALOPESA, TTCL, CRDB, NMB. Optional when service is mobile - the MNO is detected from the number. Required for every other service.

Example: VODACOM
servicestringrequired

How the counterparty is identified. mobile = mobile money wallet, account = bank account, tanqr = TANQR, merchant = till / Lipa Number.

Possible values: [mobile, account, tanqr, merchant]

Example: mobile
accountstringrequired

The counterparty identifier for the chosen service: a phone number (mobile), a bank account number (account), or a till / merchant id. Mobile numbers may be sent as 0XXXXXXXXX or 255XXXXXXXXX; both are normalised to 255XXXXXXXXX.

Example: 255712345678
amountTypestringrequired

FULL requires the exact amount, FIXED accepts one payment of a set amount, FLEXIBLE accepts part payments until the total is met.

Possible values: [FULL, FIXED, FLEXIBLE]

Example: FULL
pushboolean

Send the USSD push prompt to the customer immediately. Set false to create the payment and collect it later (for example via a payment link or paybill).

Default value: true
malipopaycentralapi_MakeCollectionV3Request
{
  "reference": "ORDER-001",
  "description": "Payment for Order #001",
  "amount": 50000,
  "provider": "VODACOM",
  "service": "mobile",
  "account": "255712345678",
  "amountType": "FULL",
  "push": true
}