A payout is the process of withdrawing funds from a Mangopay wallet in the Mangopay environment to an external bank account opened in the name of the user (the Mangopay Account holder). The user’s external bank account must be registered in advance of the payout request as a Recipient. The country and currency of the Recipient impacts payout routing. The Natural User or Legal User registered with Mangopay must have:Documentation Index
Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
Use this file to discover all available pages before exploring further.
- The
UserCategoryofOWNER(see categories) - The necessary KYC/KYB verification depending on the limits applicable to your platform (for example, they must have
KYCLevelofREGULARfor payment services platforms).
Note – Verification of Payee may impact payoutsIf your platform offers User-Owned Accounts (Virtual Account or Banking Alias) to your end users, Verification of Payee (VOP) may impact their payouts. Read more →There is no impact on payouts for platforms not offering User-Owned Accounts.
Payout rails
Mangopay offers a wide range of payout rails for local and international bank wire transfers. Payout rails, also called routes, refer to the infrastructure and technology that facilitate the transfer of funds between bank accounts. The payout rails available to your platform depend on your contract – contact Mangopay via the Dashboard to discuss activation of a local payout rail for your users.Domestic
Domestic rails rely on local networks used within a country or region. Because both banks are in the same jurisdiction and use the same local networks, the funds can generally be sent much more quickly and cheaply. Sending a domestic payout requires Mangopay to hold and send funds from an account in the same jurisdiction as the user.Non-domestic
Non-domestic rails rely on shared messaging services such as SWIFT to transfer funds. SWIFT processing times depend on a number of factors including cutoff times and correspondent banks. SWIFT payments can arrive same day, they are frequently next day but can also take several days. Mangopay works with partner banks to send the funds to the user’s account. Depending on where the user’s account is registered, Mangopay’s partners may themselves need to rely on additional correspondent banks to enable the connection with the end user’s bank.How Mangopay routes funds
Mangopay attempts to use a given payout rail depending on:- The Payout’s
CurrencyandRecipientId(orBankAccountId) - The Recipient’s
CurrencyandCountry
PayoutModeRequested – see instant schemes and RTGS below.
For example, to use:
- SCT, SCT Inst, or T2, the Recipient
Currencymust beEURand theCountrymust be in the SEPA zone - FPS, the Recipient
Currencymust beGBPand itsCountryGB - ACH, the Recipient
Currencymust beUSDand itsCountryUS
Currency and Country do not match, the payout is attempted via SWIFT but only if the Recipient has the PayoutMethodType of InternationalBankTransfer.
A non-domestic payout attempt to a LocalBankTransfer Recipient returns an HTTP 400 error.
Best practice – Use multi-currency RecipientsIf your users may wish to receive multiple currencies to the same account, register the Recipient with the
InternationalBankTransfer value set for its PayoutMethodType.Mangopay applies a smart routing logic to always use the domestic rail if a local currency is sent, thereby optimizing routing costs and speeds while allowing you to operate one RecipientId for a user.LocalBankTransfer payout method type and accept SWIFT payouts. New account registrations for multi-currency use must use InternationalBankTransfer.
All payout rails by currency
The table below shows all local and international payout rails offered by Mangopay – contact Mangopay via the Dashboard to discuss activation.Delivery times
The delivery times shown in the table above are typical for the rail used. Some payouts are subject to manual review by Mangopay’s teams for reasons of risk management or AML/CFT - these payouts may take longer than shown. Payouts created before the cutoff times outlined below are transferred to the user’s bank account within the corresponding processing times. Payouts created after the cutoff are processed next working day – meaning Monday to Friday excluding weekends and public holidays. Some SWIFT payouts are sent the day after the cutoff, and therefore delivery can take a day longer. These routes are marked +1 in the table above.Note – Timings displayed are indicativeThe delivery times shown on this page are indicative. For all schemes, the actual delivery time of an specific individual payout depends on various factors, many of which are out of Mangopay’s control.
Instant schemes
Mangopay provides a number of instant local schemes:- SEPA Instant Credit Transfer for EUR payouts to EUR Recipients in SEPA countries
- Faster Payments System (FPS) for GBP payouts to local GB Recipients
- RIX-INST for SEK payouts to local SE recipients
Status changes from CREATED to SUCCEEDED) but there can be a delay in some circumstances.
In the SEPA zone, platforms can take advantage of a choice of schemes (SCT, SCT Inst, and T2), and so you need to use the PayoutModeRequested parameter to specify the scheme for each payout request. Mangopay also offers a fallback mechanism for SCT Inst to be processed as SCT if the instant request fails. See initiate an SCT Inst payout for details.
Real-time gross settlement (RTGS)
For high-value EUR payouts in the SEPA zone, Mangopay offers real-time gross settlement (RTGS) via the Eurozone’s T2 scheme (formerly called TARGET2). This functionality was previously known as Express Payouts. To request RTGS, set thePayoutModeRequested to RTGS_PAYMENT in calls to the POST Create a Payout endpoint.
Funds are usually processed the same working day. Payout requests received outside the scheme opening hours are processed the next working day.
The T2 scheme is open 07:00 – 16:15 CET, 5 days a week. The T2 scheme is closed at weekends and on the following days if they fall on a weekday: 1 January (New Year’s Day), Good Friday, Easter Monday, 1 May (Labour Day), 25 December (Christmas Day), 26 December.
Fees for international payouts
International bank wires that rely on the SWIFT network have three options for managing expectations for processing fees:- SHA – The fees are shared between the remitter (sender) and the beneficiary
- BEN – The beneficiary bears all fees
- OUR – The remitter bears all fees
CreditedFunds.Amount of the payout on their recipient account. Mangopay recovers the fees from your platform during the usual billing cycle.
To take advantage of this and activate charge-bearing for your platform, contact our teams via the Dashboard.
Once activated, your platform can set ChargeBearer parameter to OUR in your call to POST Create a Payout to ask Mangopay to use the OUR configuration.
The OUR setting is available:
- On SWIFT non-domestic payouts, not any local scheme
- For any currency and recipient country (if supported)
ChargeBearer is set to OUR, Mangopay checks whether its network of partners is able to fulfill cost-bearing for the given currency and recipient country before requesting the payout.
If OUR is not supported, a 400 HTTP error is returned to allow your platform to decide how to proceed with the user – for example whether to make the request with SHA (default value), register a different recipient, or even convert the funds first thanks to Mangopay’s FX features.
The ChargeBearer parameter is only returned on the GET View a Payout and check mode applied endpoint, not the GET View a Payout endpoint.
Other payout considerations
Country restrictions
Due to AML policy, Mangopay doesn’t allow payouts to some countries – see the country restrictions article for more information.Minimum amount
Mangopay does not impose a minimum amount on payouts. The minimum amount possible is dictated by the rules of the underlying scheme used to send the payout. For example, the SEPA Credit Transfer (SCT) scheme accepts a minimum amount of EUR 0.01 (Amount value 1), and the Faster Payments System (FPS) in the UK allows GBP 0.01 (Amount value 1). Other schemes may impose different minimum amounts.
Migration of legacy bank accounts
The Payout request’sBankAccountId field can contain the Id of a Recipient or a legacy Bank Account.
Active legacy bank accounts, created before the Recipient feature was released, were migrated to recipients.
Obtain Recipient data of an active legacy bank account
To retrieve data of active legacy bank accounts you can use the GET View a Recipient endpoint and specify the legacyBankAccountId as the RecipientId path parameter. For example, if the legacy Bank Account was bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G, call the endpoint with that ID:
GET /v2.01/{ClientId}/recipients/bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G
The API responds with a Recipient object containing the information of the legacy Bank Account:
Recipient API response - Migrated legacy Bank Account
Migration data mapping
Legacy Bank Account objects had no currency property, and so they could be used for payouts in multiple currencies. The Recipients feature has aCurrency for each Recipient to improve payout deliverability, meaning that the same real-life account can be registered multiple times (with different PayoutMethod values).
Note – Legacy local accounts accept SWIFT payoutsA legacy Bank Account accepts non-domestic SWIFT payouts, even though its migrated Recipient object indicates
LocalBankTransfer in the PayoutMethodType.New Recipients must have InternationalBankTransfer to accept non-domestic payouts, otherwise an error is returned – read more.RecipientScope assigned was PAYOUT for all accounts (which can be used for PAYIN use cases).
Bank Account Type | Recipient PayoutMethod | Recipient Currency | Recipient Country |
|---|---|---|---|
IBAN | LocalBankTransfer if IBAN indicates a SEPA country, InternationalBankTransfer if not | Based on the IBAN country (EUR if SEPA country or local non-EUR) | Based on the IBAN |
GB | LocalBankTransfer | GBP | GB |
US | LocalBankTransfer | USD | US |
CA | LocalBankTransfer | CAD | CA |
OTHER | InternationalBankTransfer | Based on the BIC | Based on the BIC |
Migration of non-EUR accounts in SEPA countries
The process that was followed for IBAN type bank accounts was:- Country code extracted from the
IBAN(not theBIC) - If IBAN country is in SEPA and the local currency is EUR, the Recipient was assigned:
PayoutMethodType=LocalBankTransferCurrency=EUR
- If IBAN country is in SEPA and the local currency is not EUR (e.g. Denmark, Poland, etc), the Recipient was assigned:
PayoutMethodType=InternationalBankTransferCurrency= Local currency based on predefined list (e.g.DKK,PLN, etc)