Send a payout
Send money from your disbursement account to a MoMo wallet. Needs the payout permission.
/payoutsChecks the project’s limits and the recipient’s wallet, looks up the owner’s name, then creates a pending payout. See Send payouts.
Retrying with the same external_reference returns the original payout and never pays twice.
external_referencebodystringrequiredYour unique reference for this payout, within the project.
providerbodystringrequiredmomoProvider to pay through. Must be enabled for the project, with its disbursement account connected.
amountbodynumberrequiredAmount in major units. Greater than 0, and within the project’s payout limits.
currencybodystringrequiredSZLISO 4217 code of your provider environment.
phone_numberbodystringrequiredThe recipient’s MoMo number.
descriptionbodystringShown in both parties’ transaction history. Up to 160 characters.
methodbodystringtransfer or deposit. Defaults to the method configured for your account.
metadatabodyobjectYour own data.
Response
A transaction with type: payout, status: pending and, when MTN returned it, party_name.
Other 400 messages: payout exceeds this project's daily payout limit of …, phone_number is not registered for mobile money, or the account is not active, and the momo disbursement account is not connected, so payouts and refunds are unavailable.
