Refund a payment
Return all or part of a successful payment from your disbursement account. Needs the refund permission.
/payments/{reference}/refundCreates a pending refund (type: refund) of the collection in the path. The money goes back to the number that paid. See Refund payments.
Refunds can never add up to more than the original; pending refunds count towards that.
referencepathstringrequiredThe external_reference of the collection to refund.
external_referencebodystringrequiredA new reference for the refund itself. Retrying with it returns the original refund.
amountbodynumberHow much to refund. Leave it out to refund everything that’s left.
descriptionbodystringShown in both parties’ transaction history. Defaults to Refund <reference>.
metadatabodyobjectYour own data.
Response
A transaction with type: refund, status: pending and refund_of set to the original’s reference.
Other 400 messages: only successful collections can be refunded, only payments collected with a payment request can be refunded, and the momo disbursement account is not connected, so payouts and refunds are unavailable.
