POST
/
v2.01
/
{ClientId}
/
payouts
/
bankwire
{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "204069570",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "DebitedWalletId": "204069727",
    "BankAccountId": "204070675",
    "BankWireRef": "Example123"
}
{
    "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": "rec_01K09BK0T804BEGVP6GPKQXR3N",
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null
}  

Body parameters

Tag
string
Max. length: 255 charactersCustom 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.
Fees
object
required
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
DebitedWalletId
string
required
The unique identifier of the debited wallet.
BankAccountId
string
required
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.
PayoutModeRequested
string
Possible values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, RTGS_PAYMENTDefault value: STANDARDThe mode defining how the payout request is sent:
  • STANDARD – Sent via the relevant route for the currency and destination account (which determine the typical funds processing times). If a request is received after the applicable cutoff, it is processed the next working day.
  • INSTANT_PAYMENT – 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.
  • INSTANT_PAYMENT_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 – 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.

Responses

{
    "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": "rec_01K09BK0T804BEGVP6GPKQXR3N",
    "BankWireRef": "Example123",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null
}  
{
    "Tag": "Created using Mangopay API Postman Collection",
    "AuthorId": "204069570",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "DebitedWalletId": "204069727",
    "BankAccountId": "204070675",
    "BankWireRef": "Example123"
}