Momo withdraw

Send funds from your ZynlePay wallet to a customer's mobile money wallet (payout).

Flow

1. Call momoWithdraw with the receiver's mobile money number.
2. On a successful API response, the funds are transferred to the receiver's mobile money wallet.
3. ZynlePay delivers the final status to your callback URL. See Handling callbacks.

Example

const result = await client.momoWithdraw({
  receiverId: "260971234567",
  referenceNo: "PAYOUT-1001",
  amount: 250,
});

Parameters

Field	Type	Description
receiverId	string	Receiver's mobile money number (MSISDN, e.g. 260971234567).
referenceNo	string	Your unique transaction reference.
amount	number	Amount to send.

Response

The response preserves all raw API fields. Notable fields:

• response_code — API response code indicating the outcome.
• response_description — human-readable description of the outcome.
• reference_no — echo of your reference number.
• phone — echo of the receiver's phone number.
• udf1–udf5 — user-defined fields echoed back by the API.

Check response_code, not exceptions

This endpoint reports outcome via response_code / response_description, not a status field. A non-success response code arrives as a normal HTTP 200 response, not as an exception — inspect response_code to determine the outcome. Transport-level failures (non-2xx HTTP, network errors, timeouts) still throw ZynlePayError — see Error handling.