Create a Payout

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.

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

Allowed values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY

Default value: STANDARD

The mode of the payout:

• STANDARD – A standard bank wire is requested and the processing time of the funds is up to 48 hours.
• INSTANT_PAYMENT – An instant payment bank wire is requested and the processing time is within 25 seconds. The payment will fall back to the STANDARD mode if any of the prerequisites are not met or if another problem occurs.
• INSTANT_PAYMENT_ONLY – An instant payment bank wire is requested and the processing time is within 25 seconds. There is no fallback if the prerequisites are not met or another problem occurs: the wallet is automatically refunded and the payout is not completed.

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.

For more details, see the payouts guide.

Hide 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. The expected value differs according to the ReasonType:

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

Responses

200

Id

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

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

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

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

ModeApplied

string

Returned values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, PENDING_RESPONSE

The payout mode actually applied for the transaction. The payout mode can revert to standard if some of the prerequisites for an instant payment are not met.

• STANDARD – A standard bank wire is requested and the processing time of the funds is about 48 hours.
• INSTANT_PAYMENT – An instant payment bank wire is requested and the processing time is within 25 seconds (subject to prerequisites); if the prerequisites are not met, then the payment will fall back to the STANDARD mode.
• INSTANT_PAYMENT_ONLY – An instant payment bank wire is requested and the processing time is within 25 seconds, but if any prerequisite is not met or another problem occurs, there is no fallback: the wallet is automatically refunded and the payout is not completed.
• PENDING_RESPONSE – Temporary state to accommodate the short latency between the moment the request is sent and the moment the mode is applied (or a fallback occurs).

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 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.

For more details, see the payouts guide.

Hide 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. The expected value differs according to the ReasonType:

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

400 - Instant payout 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": "e1606a91-e563-45f3-a337-acdd933ab80b#1673533663",
    "Date": 1673533664.0,
    "errors": {
        "PayoutModeRequested": "InstantPayment is disabled"
    }
}  

400 - Instant payout is deactivated (INSTANT_PAYMENT_ONLY requested)

{
    "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 - Destination bank not eligible for instant payout

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