Create a Payout - Mangopay docs

Overview

User management

Users
User regulatory status
User e-money

User verification

User data format
KYC documents
UBO declarations

Wallets

User wallets
Client wallets

Cards

Card registrations
Cards
Metadata
Card validations

Card pay-ins

Direct card pay-ins
Recurring card pay-ins
Preauthorizations
Deposit preauthorizations
Web card pay-ins

Banking pay-ins

Bank wires
Virtual IBAN
Direct debits
Web direct debits

APM pay-ins

Apple Pay
Bancontact
BLIK
Giropay
Google Pay
iDEAL
Klarna
MB WAY
Multibanco
Payconiq
PayPal
Satispay
Swish
TWINT

Transfers

Transfers

Refunds

Refunds

Disputes

Disputes
Dispute documents
Repudiations
Dispute settlement

Payouts

Bank accounts
Payouts

FX conversions

Conversion rates
Quotes
Conversions

Transactions

Transactions

Helpers

API responses
Country authorizations
Webhooks
Events
Reports

Platform account

Client
Dashboard permissions

POST

v2.01

{ClientId}

payouts

bankwire

{
    "AuthorId": "204069570",
    "Tag": "Created using Mangopay API Postman Collection",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "BankAccountId": "204070675",
    "DebitedWalletId": "204069727",
    "BankWireRef": "ExampleInvoice1234"
}  

{
    "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": "204070675",
    "BankWireRef": "ExampleInvoice1234",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null
}  

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.

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_PAYMENT

Default value: STANDARD

The 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 25 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 25 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 usually processed within 5 minutes) 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

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.

CreationDate

timestamp

The date and time at which the object was created.

AuthorId

string

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.

CreditedFunds

object

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

Fees

object

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

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

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 – 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 25 seconds). If ModeRequested was INSTANT_PAYMENT_ONLY and a fallback occurs, the ModeApplied is STANDARD.
RTGS_PAYMENT – Sent via the Eurozone’s real-time gross settlement (RGTS) scheme T2 (funds usually processed within 5 minutes) 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.

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.

{
    "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"
    }
}  

{
    "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"
    }
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "c2a051f4-b4d2-4097-9a03-b4b3a67bb9e1#1676883693",
    "Date": 1676883694.0,
    "errors": {
        "PayoutModeRequested": "The request for instant payment cannot be successful due to ineligibility "
    }
}  

{
    "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": "204070675",
    "BankWireRef": "ExampleInvoice1234",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null
}  

{
    "AuthorId": "204069570",
    "Tag": "Created using Mangopay API Postman Collection",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "BankAccountId": "204070675",
    "DebitedWalletId": "204069727",
    "BankWireRef": "ExampleInvoice1234"
}  

{
  "AuthorId": "user_m_01JCQYJNHFPENP1SKTCBYER0F8",
"Tag": "Created using Mangopay API Postman Collection",
"DebitedFunds": {
    "Currency": "EUR",
    "Amount": 24581
},
"Fees": {
    "Currency": "EUR",
    "Amount": 0
},
"BankAccountId": "bankacc_m_01JCN1X2EHWG0JNJNPNQ21CW5G",
"DebitedWalletId": "wlt_m_01J9KR4A7BH8KVE4PG6DTNS817",
"BankWireRef": "Example123",
  "PaymentRef": {
  "ReasonType": "PAYIN_REFUND",
  "ReferenceId": "payin_m_01JCR21X56KVHF7F5TVGYNT9G7"
  }
}

Was this page helpful?

The Payout object Check Instant Payout eligibility

{
    "AuthorId": "204069570",
    "Tag": "Created using Mangopay API Postman Collection",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5792
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 579
    },
    "BankAccountId": "204070675",
    "DebitedWalletId": "204069727",
    "BankWireRef": "ExampleInvoice1234"
}  

{
    "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": "204070675",
    "BankWireRef": "ExampleInvoice1234",
    "ModeRequested": null,
    "ModeApplied": "PENDING_RESPONSE",
    "FallbackReason": null,
    "EndToEndId": "2c2184396eef4e5da90ab48a2feeb51d",
    "PaymentRef": null
}  

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses