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
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Payout and check mode applied
This call returns the information about a payout with additional information about the payout mode (ModeRequested, ModeApplied, and FallbackReason parameters).
Note – Payout data retained for 13 months
An API call to retrieve a payout whose CreationDate is older than 13 months may return 404 Not Found.
For more information, see the Data availability periods article.
Path parameters
The unique identifier of the payout.
Responses
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.
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.
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).
Information about the funds being credited to the target of the transaction (CreditedFunds = DebitedFunds - Fees).
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.
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).
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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.
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).
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
The value set for the PayoutModeRequested parameter when making the request.
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 theSTANDARDmode.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).
Information regarding the reason for the refusal of the instant payout request.
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 unique identifier of a bank wire for tracking purposes only.
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.
Allowed values: PAYIN_REFUND
The reason for the reference being provided:
PAYIN_REFUND– The payout serves to reimburse a pay-in.
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– TheReferenceIdvalue provided is the same as theIdof the initial pay-in being refunded.
Was this page helpful?