Skip to main content

malipopaycentralapi_MakePayoutV3Request

referencestring

Your own reference for this payout. Optional.

Example: PAYOUT-001
descriptionstringrequired

What the payout is for.

Example: Supplier settlement
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: AIRTEL
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
beneficiaryNamestring

Name of the recipient, for your own records.

Example: John Haule
categorystring

SINGLE for one payout. Batch records are created by POST /api/v2/payment/disbursement/batch.

Possible values: [SINGLE, BATCH]

Example: SINGLE
malipopaycentralapi_MakePayoutV3Request
{
  "reference": "PAYOUT-001",
  "description": "Supplier settlement",
  "amount": 50000,
  "provider": "AIRTEL",
  "service": "mobile",
  "account": "255712345678",
  "beneficiaryName": "John Haule",
  "category": "SINGLE"
}