Skip to main content

malipopaycentralapi_MakeBatchPayoutV3Request

descriptionstringrequired

Description applied to the batch.

Example: March payouts
records object[]required

One entry per beneficiary. Records may mix channels; each one routes independently. At least one record is required.

Possible values: >= 1

  • Array [
    • providerstringrequired

    Channel for this record. Required on every batch record, including mobile ones.

    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
    amountintegerrequired

    Amount in whole TZS.

    Example: 25000
    descriptionstring

    Per-record description. Falls back to the batch description.

    Example: March commission
    beneficiaryNamestring

    Name of the recipient.

    Example: Asha Mwinchumu
  • ]
    • malipopaycentralapi_MakeBatchPayoutV3Request
    {
      "description": "March payouts",
      "records": [
        {
          "provider": "VODACOM",
          "service": "mobile",
          "account": "255712345678",
          "amount": 25000,
          "description": "March commission",
          "beneficiaryName": "Asha Mwinchumu"
        }
      ]
    }