---
title: "Create a Payout"
method: POST
path: "/v2.01/{ClientId}/payouts/bankwire"
tags: ["Payouts"]
---

# Create a Payout

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

Initiate a payout request from a user's wallet to a Recipient

<Note icon="fa-regular fa-circle-info">
**Note – Local Recipients can only receive local currencies**

Attempting a payout to a newly created local Recipient (with the `PayoutMethodType` of `LocalBankTransfer`) in a non-local currency may return an HTTP 400 error because the Recipient's Country doesn't correspond to the currency sent (for example, 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](/guides/payouts#how-mangopay-routes-funds) **→**
</Note>

<Note icon="fa-regular fa-circle-info">
**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](/guides/payouts#how-mangopay-routes-funds) **&rarr;**
</Note>

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](/guides/vop) **&rarr;**

## Path parameters

- `ClientId` string, required

## Headers

- `Authorization` string, required

## Request body

- CreateAPayoutRequest
  - `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 Recipient `UserId` value as well. Otherwise, Mangopay's Compliance team will reject the payout.
  - `DebitedFunds` CreateAPayoutRequestDebitedFunds, required — Information about the debited funds.
    - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer, required — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
  - `Fees` CreateAPayoutRequestFees, required — Information about the fees.
    - `Currency` string, required — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer, required — The amount of the currency in its minor unit. For example, 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](/api-reference/recipients/recipient-object) 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.
  - `Tag` string — Max. length: 255 characters Custom data that you can add to this object.
  - `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 <a href="/bank-statements">Customizing bank statement references</a> 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](/guides/payouts#all-rails-by-currency), which also determines [delivery times](/guides/payouts#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)](/guides/payouts#real-time-gross-settlement-rtgs) 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` CreateAPayoutRequestPaymentRef — Information about the payment reference provided for the payout. This object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.
    - `ReasonType` string, required — **Allowed values:** `PAYIN_REFUND` The reason for the reference being provided: - `PAYIN_REFUND` – The payout serves to reimburse a pay-in.
    - `ReferenceId` string, required — **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 — Possible values: `SHA`, `OUR` Default value: `SHA` The allocation of [processing fees](/guides/payouts#fees-for-international-payouts) 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.

## Response `200`

Success

- CreatePayoutResponse
  - `Id` string — Max length: 128 characters (see [data formats](/api-reference/overview/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` integer — Unix timestamp (UTC) of the date and time 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` unknown
  - `DebitedFunds` CreatePayoutResponseDebitedFunds — Information about the debited funds.
    - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
  - `CreditedFunds` CreatePayoutResponseCreditedFunds — Information about the credited funds (`CreditedFunds` = `DebitedFunds` - `Fees`).
    - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer — The amount of the currency in its minor unit. For example, EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`.
  - `Fees` CreatePayoutResponseFees — Information about the fees.
    - `Currency` string — **Allowed values:** The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings). The currency of the amount.
    - `Amount` integer — The amount of the currency in its minor unit. For example, 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 <a href="/errors/codes">handle errors</a> or for filtering purposes.
  - `ResultMessage` string — The explanation of the result code.
  - `ExecutionDate` integer — Unix timestamp (UTC) of the date and time 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:** `BANK_WIRE` The payment type of the payout.
  - `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 <a href="/bank-statements">Customizing bank statement references</a> 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](/guides/payouts#all-rails-by-currency), which also determines [delivery times](/guides/payouts#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)](/guides/payouts#real-time-gross-settlement-rtgs) 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` CreatePayoutResponseFallbackReason — Information regarding the reason for the refusal of the instant payout request.
    - `ResultCode` string — The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> 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` CreatePayoutResponsePaymentRef — Information about the payment reference provided for the payout. This object must be used to provide the reference of a [bank wire pay-in](/api-reference/bank-wire-payins/bank-wire-payin-object) or a [pay-in to virtual IBAN](/api-reference/virtual-accounts/external-instruction-bank-wire-payin-object), if the payout is being used to refund it.
    - `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.
  - `RecipientVerificationOfPayee` RecipientVerificationOfPayeePayout — Information about the [Verification of Payee (VOP)](/guides/vop) check performed on the Recipient as part of a Payout request. Because VOP only applies to SEPA local schemes, this object is returned `null` if the Recipient's `Currency` is not `EUR` or its `PayoutMethodType` is not `LocalBankTransfer`. Unlike [Recipient](/api-reference/recipients/recipient-object) endpoints, `RecipientVerificationPayeeSuggestedName` is not returned on Payout responses, even if the result is `CLOSE_MATCH`.
    - `RecipientVerificationId` string, nullable — The unique identifier of the VOP check. This value may be `null` if the check could not be performed.
    - `RecipientVerificationCheck` string, nullable — **Possible values:** `MATCH`, `CLOSE_MATCH`, `NO_MATCH`, `MATCH_NOT_POSSIBLE` The result of the VOP check: - `MATCH` – The account is valid and the account name matches the IBAN. - `CLOSE_MATCH` – The account is valid but the name doesn't match exactly. - `NO_MATCH` – This account likely belongs to a different owner. - `MATCH_NOT_POSSIBLE` – The check could not be completed.
    - `RecipientVerificationMessage` string, nullable — A human-readable message describing the result of the `RecipientVerificationCheck`: - If `MATCH`, then `Account name fully matches account identifier.` - If `CLOSE_MATCH`, then `Account name partially matches account identifier. Name returned by check: {Name}. Payment made to this account may not reach its intended counterparty.` - If `NO_MATCH`, then `Account name does not matches account identifier. Payment made to this account may not reach its intended counterparty.` - If `MATCH_NOT_POSSIBLE`, then `Account name does not matches account identifier. Payment made to this account may not reach its intended counterparty.`
  - `RecipientId` string — The unique identifier of the [Recipient](/api-reference/recipients/recipient-object) 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 — Possible values: `SHA`, `OUR` Default value: `SHA` The allocation of [processing fees](/guides/payouts#fees-for-international-payouts) 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.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.dev/mangopay/apis/api-reference.md) · [All operations](https://skmtc.dev/mangopay/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mangopay/api-reference/revisions/fafbd0c69654/schema)