How to process an Instant Payout

​

Introduction

This how-to guide will show you how to successfully process an instant payout.

Mangopay provides two modes to wire funds outside the Mangopay environment:

• Standard - A bank wire with a processing time of about 48 hours.
• Instant Payout - A bank wire with a processing time of about 25 seconds (subject to prerequisites).

​

1. Create the user’s Bank Account

Create the Bank Account object to which the funds are going to be credited with the Instant Payout.

Note that:

• You need to use the UserId of a verified user as a path parameter for the next steps to be successful.
• You can use Mangopay’s IBAN bank account available in the Testing payouts article.

POST /v2.01/{ClientId}/users/{UserId}/bankaccounts/iban

Keep the resulting BankAccountId that will be necessary to make the payout.

​

2. Check if the Bank Account is reachable for an Instant Payout (recommended)

Call the dedicated endpoint to check whether or not the destination bank is eligible for instant payout. Eligible banks participate in the SEPA Instant Credit Transfer scheme of the European Payments Council (EPC).

POST /v2.01/{ClientId}/payouts/reachability

If the IsReachable parameter value is true in the response, you can go ahead with the instant payout.

{
    "InstantPayout": {
        "IsReachable": true,
        "UnreachableReason": null
    }
}

​

3. Create the Instant Payout

In order to make an instant payment, the PayoutModeRequested parameter must be set to either:

• INSTANT_PAYMENT - The payment will fall back to the STANDARD mode if any of the prerequisites are not met or if another problem occurs.
• INSTANT_PAYMENT_ONLY - There is no fallback if the prerequisites are not met or another problem occurs: the wallet is automatically refunded and the payout is not completed.

POST /v2.01/{ClientId}/payouts/bankwire

​

4. Indicate if the Payout has fallbacked (recommended)

It may happen that due to unmet prerequisites or processing issues the instant payout falls back to a regular payout.

To communicate to your end user whether the payout was instantaneous or reverted to standard, you may take advantage of:

• The View a Payout and check mode applied endpoint
• The INSTANT_PAYOUT_FALLBACKED event type for webhooks

​

Related resources