Skip to main content

malipopaycentralapi_BatchPayoutResponse

successboolean
Example: true
codeinteger

1111 when the batch was accepted.

Example: 1111
messagestring

Human-readable outcome.

Example: Disbursement request sent successfully
data object
records object[]

One payment per record, each in AWAITING_APPROVAL. Approve them individually by reference.

  • Array [
  • idstring

    Malipopay id for the payment.

    Example: 6890f1c2a4b19e3f2c7d5a10
    referencestring

    Malipopay reference. Use it to poll status and to match webhooks.

    Example: ML008985
    merchantAccountIdstring

    Your merchant account name.

    Example: Lockwood Technology
    modestring

    CHARGE for collections, PAYOUT for disbursements.

    Example: CHARGE
    statusstring

    Current status. See the Payment Statuses guide.

    Example: PROCESSING
    amountinteger

    Amount requested, in whole TZS.

    Example: 50000
    paidAmountinteger

    Amount received so far. Below amount on a part payment.

    Example: 0
    transactionFeeinteger

    Fee recorded against this transaction, in TZS.

    Example: 1250
    amountTypestring

    Amount rule the payment was created with.

    Example: FULL
    descriptionstring

    Description you supplied.

    Example: Payment for Order #001
    currencystring

    ISO currency code.

    Example: TZS
    linkstring

    Shareable link for this payment.

    Example: https://app.malipopay.co.tz/ref?ML008985
    customer object
    phoneNumberstring

    Normalised MSISDN.

    Example: 255712345678
    firstnamestring

    Resolved first name, when the channel returns one.

    Example: JOHN
    lastnamestring

    Resolved last name.

    Example: HAULE
    mnostring

    Resolved network.

    Example: Vodacom
    feeAmountinteger

    What Malipopay charged on this collection, in TZS. Present only on collections posted under the upfront fee model - a payment that predates it has no per-payment fee to report, which is a different statement from having been charged nothing.

    Example: 1250
    feePercentnumber

    Rate applied to produce feeAmount.

    Example: 2.5
    netAmountinteger

    What was credited to your wallet after the fee.

    Example: 48750
    failureboolean

    Present only when a payout failed its balance precheck.

    failureReasonstring

    Why the payment failed. Present only on failures.

    Example: Insufficient balance
    createdAtstring

    ISO 8601 creation timestamp.

    Example: 2026-08-18T08:15:32.000Z
    updatedAtstring

    ISO 8601 last-update timestamp.

    Example: 2026-08-18T08:15:32.000Z
  • ]
  • malipopaycentralapi_BatchPayoutResponse
    {
    "success": true,
    "code": 1111,
    "message": "Disbursement request sent successfully",
    "data": {
    "records": [
    {
    "id": "6890f1c2a4b19e3f2c7d5a10",
    "reference": "ML008985",
    "merchantAccountId": "Lockwood Technology",
    "mode": "CHARGE",
    "status": "PROCESSING",
    "amount": 50000,
    "paidAmount": 0,
    "transactionFee": 1250,
    "amountType": "FULL",
    "description": "Payment for Order #001",
    "currency": "TZS",
    "link": "https://app.malipopay.co.tz/ref?ML008985",
    "customer": {
    "phoneNumber": "255712345678",
    "firstname": "JOHN",
    "lastname": "HAULE",
    "mno": "Vodacom"
    },
    "feeAmount": 1250,
    "feePercent": 2.5,
    "netAmount": 48750,
    "failure": true,
    "failureReason": "Insufficient balance",
    "createdAt": "2026-08-18T08:15:32.000Z",
    "updatedAt": "2026-08-18T08:15:32.000Z"
    }
    ]
    }
    }