Rejects, returns, and recalls
Successful payouts (i.e. with Status value SUCCEEDED) can be rejected by the acquiring bank, for example if the bank account is closed or not compatible (e.g. a savings account). In some cases, Mangopay is able to request the recall on behalf of a platform or user.
In this scenario, Mangopay creates a Refund object for the payout so that the funds can be returned to the wallet.
Set up hook notifications for the following event types to be notified of this:
PAYOUT_REFUND_CREATEDPAYOUT_REFUND_SUCCEEDEDPAYOUT_REFUND_FAILED
You can use the GET View a Refund endpoint to see details of the payout return.
Additional information regarding the return can be found in the RefundReason object returned by the API.
Possible RefundReasonType are:
BANKACCOUNT_INCORRECTBANKACCOUNT_HAS_BEEN_CLOSEDOWNER_DOT_NOT_MATCH_BANKACCOUNTWITHDRAWAL_IMPOSSIBLE_ON_SAVINGS_ACCOUNTS
The refund reason type may be accompanied by a custom message in the RefundReasonMessage parameter.