Create a Payout
Body parameters
Max. length: 255 characters
Custom data that you can add to this object.
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.
Information about the debited funds.
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
The unique identifier of the debited wallet.
The unique identifier of the bank account.
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.
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 10 seconds) with a fallback toSTANDARDmode 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 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).
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
200
200
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Max. length: 255 characters
Custom data that you can add to this object.
The date and time at which the object was created.
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.
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.
Information about the debited funds.
Information about the funds being credited to the target of the transaction (CreditedFunds = DebitedFunds - Fees).
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
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.
The unique identifier of the debited wallet.
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIRE
The type of pay-in.
The unique identifier of the bank account.
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.
Returned values: STANDARD, INSTANT_PAYMENT, INSTANT_PAYMENT_ONLY, RTGS_PAYMENT
The value set for the PayoutModeRequested parameter when making the request.
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 10 seconds). IfModeRequestedwasINSTANT_PAYMENT_ONLYand a fallback occurs, theModeAppliedisSTANDARD.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 RTGS modes.
Information regarding the reason for the refusal of the instant payout request.
The unique identifier of a bank wire for tracking purposes only.
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.
400 - Payout not allowed to PAYIN-scope Recipient
400 - Payout not allowed to PAYIN-scope Recipient
400 - Instant payout is deactivated
400 - Instant payout is deactivated
400 - Instant payout is deactivated (INSTANT_PAYMENT_ONLY requested)
400 - Instant payout is deactivated (INSTANT_PAYMENT_ONLY requested)
400 - Destination bank not eligible for instant payout
400 - Destination bank not eligible for instant payout