Create a Payout

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

Standard

{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "user_m_01KF3087EDXEAK8VPD9DTMZW8N",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "DebitedWalletId": "wlt_m_01KF30AN0HCMPPCGEEGY4DCBGZ",
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY",
    "BankWireRef": "Example123"
}

Standard

{
    "Id": "po_m_01HQMZSGSQPPXC51TZHDAYFAJF",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1709027672,
    "AuthorId": "204069570",
    "CreditedUserId": null,
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 5213
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYOUT",
    "Nature": "REGULAR",
    "CreditedWalletId": null,
    "DebitedWalletId": "204069727",
    "PaymentType": "BANK_WIRE",
    "BankAccountId": null,
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null,
    "RecipientVerificationOfPayee": null,
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY",
    "ChargeBearer": "OUR"
}  

Note – PayoutModeRequested property only relevant for EUR

The PayoutModeRequested property is only relevant for EUR payouts, where the value determines which of the SEPA schemes (SCT, SCT Inst, or T2) is used.

For other currencies, Mangopay automatically uses the relevant local scheme (e.g. FPS for GBP) if the Recipient’s destination country corresponds, or otherwise uses SWIFT. Read more →

If your platform offers User-Owned Accounts (Virtual Account or Banking Alias) to your end users, Verification of Payee (VOP) may impact their payouts. There is no impact for platforms not offering User-Owned Accounts. Read more →

Body parameters

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.

AuthorId · string · required

The unique identifier of the user at the source of the transaction.
Best practice: When the payout author is different from the bank account owner, the Payout AuthorId value must be different from the Bank Account UserId value as well. Otherwise, Mangopay’s Compliance team will reject the payout.

DebitedFunds · object · required

Information about the debited funds.

Show properties

Currency · string · required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount · integer · required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees · object · required

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency · string · required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount · integer · required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

DebitedWalletId · string · required

The unique identifier of the debited wallet.

RecipientId · string

The unique identifier of the Recipient object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the BankAccountId).

BankAccountId · string

The unique identifier of the Bank Account. This property should not be used by platforms integrating for the first time – send the RecipientId instead.

BankWireRef · string

Max. length: 255 characters (< 12 recommended)

Custom description to appear on the user’s bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank.

For the full structure of the string, see the Customizing bank statement references article.

PayoutModeRequested · string

Possible values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, RTGS_PAYMENT

Default value: STANDARD

The mode defining how the payout request is sent:

• STANDARD – Non-EUR: Sent via the relevant local rail if the Recipient’s destination country corresponds, or otherwise sent via SWIFT. Mangopay automatically routes funds via the available rails, which also determines delivery times. Requests received after the applicable cutoff are processed the next working day. EUR: Sent via the SEPA Credit Transfer scheme or SWIFT (if non-domestic).
• INSTANT_PAYMENT – EUR only: Sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds) with a fallback to STANDARD mode if any of the prerequisites are not met or if another issue occurs. If the payout is above the threshold agreed with Mangopay, the payout fails and there is no fallback.
• INSTANT_PAYMENT_ONLY – EUR only: sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds) without a fallback. If an issue occurs, the wallet automatically refunded.
• RTGS_PAYMENT – EUR only: sent via the Eurozone’s real-time gross settlement (RGTS) scheme T2 (funds processed same working day) without a fallback. If the request is received after the applicable cutoff (16:15 CET), it is processed the next working day (from 07:00 CET).

PaymentRef · object

Information about the payment reference provided for the payout.

This object must be used to provide the reference of a bank wire pay-in or a pay-in to virtual IBAN, if the payout is being used to refund it.

Show properties

ReasonType · string

Allowed values: PAYIN_REFUND

The reason for the reference being provided:

• PAYIN_REFUND – The payout serves to reimburse a pay-in.

ReferenceId · string

Allowed values: The valid Id of a successful pay-in.

The unique identifier associated with the reference, whose value corresponds to the ReasonType:

• PAYIN_REFUND – The ReferenceId value provided is the same as the Id of the initial pay-in being refunded.

ChargeBearer · string | null

Possible values: SHA, OUR

Default value: SHA

The allocation of processing fees for an international SWIFT payout:

• SHA - Fees are shared between the remitter and beneficiary. The beneficiary’s share is deducted from the payout, meaning that the amount arriving on the recipient’s bank account may be less than the Payout’s CreditedFunds.Amount.
• OUR - All fees are paid by the remitter. The recipient receives the full CreditedFunds.Amount of the Payout, and Mangopay recovers the fees from the platform during the billing cycle. A 400 HTTP error is returned if Mangopay’s network of partners does not support OUR fees for the given currency and recipient country, or if this feature is not activated.

For non-SWIFT requests, the ChargeBearer is ignored and SHA or null is displayed by default in the response.

Responses

200

Id · string

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.

CreationDate · Unix timestamp

The date and time at which the object was created.

AuthorId · string

The unique identifier of the user at the source of the transaction.
Best practice: When the payout author is different from the bank account owner, the Payout AuthorId value must be different from the Bank Account UserId value as well. Otherwise, Mangopay’s Compliance team will reject the payout.

CreditedUserId · string

The unique identifier of the user whose wallet is credited.
In the specific case of the Payout object, this value is always null since there is no credited wallet.

DebitedFunds · object

Information about the debited funds.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds · object

Information about the funds being credited to the target of the transaction (CreditedFunds = DebitedFunds - Fees).

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees · object

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode · string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage · string

The explanation of the result code.

ExecutionDate · Unix timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Type · string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature · string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

• REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
• REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
• REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
• SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

CreditedWalletId · string

The unique identifier of the credited wallet.
In the specific case of the Payout object, this value is always null since there is no credited wallet.

DebitedWalletId · string

The unique identifier of the debited wallet.

PaymentType · string

Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE

The type of pay-in.

BankAccountId · string

The unique identifier of the bank account.

BankWireRef · string

Max. length: 255 characters (< 12 recommended)

Custom description to appear on the user’s bank statement along with the platform name. The recommended length is 12 characters – strings longer than this may be truncated depending on the bank.

For the full structure of the string, see the Customizing bank statement references article.

ModeRequested · string

Returned values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, RTGS_PAYMENT

The value set for the PayoutModeRequested parameter when making the request.

ModeApplied · string

Returned values: STANDARD, INSTANT_PAYMENT, RTGS_PAYMENT, PENDING_RESPONSE

The mode defining how the payout request is sent:

• STANDARD – Non-EUR: Sent via the relevant local rail if the Recipient’s destination country corresponds, or otherwise sent via SWIFT. Mangopay automatically routes funds via the available rails, which also determines delivery times. Requests received after the applicable cutoff are processed the next working day. EUR: Sent via the SEPA Credit Transfer scheme or SWIFT (if non-domestic).
• INSTANT_PAYMENT – EUR only: Sent via the SEPA Instant Credit Transfer scheme (funds processed within 10 seconds).
• RTGS_PAYMENT – EUR only: Sent via the Eurozone’s real-time gross settlement (RGTS) scheme T2 (funds processed same working day) without a fallback. If the request is received after the applicable cutoff (16:15 CET), it is processed the next working day (from 07:00 CET).
• PENDING_RESPONSE – Temporary state to accommodate the possible latency between the creation of the request and the mode being applied in the case of instant payment and RGTS modes.

FallbackReason · object

Information regarding the reason for the refusal of the instant payout request.

Show properties

ResultCode · string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage · string

The explanation of the result code.

EndToEndId · string

The unique identifier of a bank wire for tracking purposes only.

PaymentRef · object

Information about the payment reference provided for the payout. This object is returned null if not provided.

This object must be used to provide the reference of a bank wire pay-in or a pay-in to virtual IBAN, if the payout is being used to refund it.

Show properties

ReasonType · string

Allowed values: PAYIN_REFUND

The reason for the reference being provided:

• PAYIN_REFUND – The payout serves to reimburse a pay-in.

ReferenceId · string

Allowed values: The valid Id of a successful pay-in

The unique identifier associated with the reference, whose value corresponds to the ReasonType:

• PAYIN_REFUND – The ReferenceId value provided is the same as the Id of the initial pay-in being refunded.

RecipientId · string

The unique identifier of the Recipient object to which the payout is being requested. This property should be used by platforms integrating for the first time (and not the BankAccountId).

ChargeBearer · string | null

Possible values: SHA, OUR

Default value: SHA

The allocation of processing fees for an international SWIFT payout:

• SHA - SWIFT fees are shared between the remitter and beneficiary. The beneficiary’s share is deducted from the payout, meaning that the amount arriving on the recipient’s bank account may be less than the Payout’s CreditedFunds.Amount.
• OUR - All SWIFT fees are paid by the remitter. The recipient receives the full CreditedFunds.Amount of the Payout, and Mangopay recovers the fees from the platform during the billing cycle. A 400 HTTP error is returned if Mangopay’s network of partners does not support OUR fees for the given currency and recipient country, or if this feature is not activated.

For non-SWIFT requests, the ChargeBearer is ignored and SHA or null is displayed by default in the response.

400 - LocalBankTransfer recipient not compatible with currency

The error below occurs when an attempt was made to send a non-local currency to a newly created local Recipient (with the PayoutMethodType of LocalBankTransfer), but the Recipient’s Country doesn’t correspond to the currency sent (e.g. a USD payout sent to local SEPA Recipient).

To receive non-local currencies, create a new Recipient with PayoutMethodType of InternationalBankTransfer and retry the payout. Mangopay automatically optimizes the payout route, so if a local currency is sent to an international Recipient, the domestic rail is used.

Read more about how Mangopay routes funds →

{
    "Id": "f601ee1c-2d77-48f5-a64e-11068f85ae84",
    "Message": "Currency PLN not supported for given local DE recipient rec_01KN1HP4HVT54097B3DRWB0HM8. Create or use international recipient.",
    "Type": "invalid_action",
    "Date": 1774941060.0,
    "errors": null
}

400 - Payout not allowed to PAYIN-scope Recipient

{
    "Id": "44312c27-c681-4240-8df9-a2507bcf30d6",
    "Message": "Payout not allowed for RecipientScope PAYIN",
    "Type": "invalid_action",
    "Date": 1747666655.0,
    "errors": null
}

400 - One of RecipientId or BankAccountId required

Platforms integrating for the first time should send the RecipientId.

{
    "Id": "c0a55d23-84d7-4fd4-ad44-6729e76b3a08",
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Date": 1769519160.0,
    "errors": {
        "BankAccountId_RecipientId": "Only one of 'BankAccountId' or 'RecipientId' can be provided."
    }
}

{
    "Id": "8c21222f-9741-40ae-94cf-7d5b3e0b6d40",
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Date": 1769519089.0,
    "errors": {
        "BankAccountId_RecipientId": "Either BankAccountId or RecipientId must be provided."
    }
}

400 - INSTANT_PAYMENT used for non-EUR

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "e1606a91-e563-45f3-a337-acdd933ab80b#1673533663",
    "Date": 1673533664.0,
    "errors": {
        "PayoutModeRequested": "InstantPayment is disabled"
    }
}  

400 - INSTANT_PAYMENT is deactivated

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "b5a1b347-9b21-4077-bd41-d41ea4b07be4#1676883139",
    "Date": 1676883140.0,
    "errors": {
        "PayoutModeRequested": "InstantPayment was explicitly requested but this feature is not activated on your configuration"
    }
}  

400 - Bank not reachable for SCT Inst (including non-EUR if INSTANT_PAYMENT requested)

{
    "Id": "6587fb28-4df8-40bc-80b4-782632bd4f16",
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Date": 1779269064.0,
    "errors": {
        "PayoutModeRequested": "The request for instant payment cannot be successful due to ineligibility"
    }
}

400 - SWIFT OUR charge bearing not supported for currency and recipient country

{
    "Id": "098c7654-3210-4892-b062-876543210abc",
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "payout_error",
    "Date": 1737041130,
    "errors": {
        "Chargebearer": "Chargebearer = OUR is not supported"
    }
}

400 - SWIFT OUR charge bearing not activated for your platform

{
    "Id": "f8b52b3a-ce2b-4755-a5bd-c07122fc5b17",
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Date": 1771262195.0,
    "errors": {
        "ChargeBearer": "ChargeBearer type not enabled"
    }
}

Standard

{
    "Id": "po_m_01HQMZSGSQPPXC51TZHDAYFAJF",
    "Tag": "Created using Mangopay API Postman Collection",
    "CreationDate": 1709027672,
    "AuthorId": "204069570",
    "CreditedUserId": null,
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 5213
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "Status": "CREATED",
    "ResultCode": null,
    "ResultMessage": null,
    "ExecutionDate": null,
    "Type": "PAYOUT",
    "Nature": "REGULAR",
    "CreditedWalletId": null,
    "DebitedWalletId": "204069727",
    "PaymentType": "BANK_WIRE",
    "BankAccountId": null,
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null,
    "RecipientVerificationOfPayee": null,
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY",
    "ChargeBearer": "OUR"
}  

Standard

{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "user_m_01KF3087EDXEAK8VPD9DTMZW8N",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "DebitedWalletId": "wlt_m_01KF30AN0HCMPPCGEEGY4DCBGZ",
    "RecipientId": "rec_01KF0MPAA8X9C80Q394TSF7MEY",
    "BankWireRef": "Example123"
}