Refund a PayMongo Wallet payment

Called by refunds-api. The payment is the debit Transfers knows as transfer_id; it is refunded in full back to the payer from the refund wallet the payee's parent organization names in paymongo_wallet_refund_wallet_id. Each reference_id is transferred at most once: a repeat returns the first refund. The outcome is asynchronous: the response says processing, and paymongo_wallet.refund.succeeded or .failed follows on the event bus. A failure before or at the transfer (no usable refund wallet, no payer wallet, or Transfers refusing it) is answered as status failed and not published. In test mode no money moves and success is published.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Transfers id of the payment's debit (core-api's source.provider_id)

Body Params

Refund parameters

Full refund of a PayMongo Wallet payment, from the merchant's wallet back to the payer's.

integer
required
string
enum
required
Allowed:
metadata
object
string
enum
required
Allowed:
string
required
length ≤ 100
Headers
string
enum
required

Mode of the refund: true or false

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json