The Payout object

Description

Mangopay relies on the Payout object to transfer funds from a Wallet to an external bank account, which must be registered as a Recipient for the User. Legacy active Bank Account objects can continue to be used for payouts, as they were migrated to Recipients.

Read payouts guide

Note – Verification of Payee may impact payouts

If your platform offers User-Owned Accounts (Virtual Account or Banking Alias) to your end users, Verification of Payee (VOP) may impact their payouts. Read more

There is no impact for platforms not offering User-Owned Accounts.

Attributes

IdstringOptional
TagstringOptional
CreationDateintegerOptional
AuthorIdstringOptional
CreditedUserIdanyOptional
DebitedFundsobjectOptional
Information about the debited funds.
CreditedFundsobjectOptional
FeesobjectOptional
Information about the fees.
StatusstringOptional
ResultCodestringOptional
ResultMessagestringOptional
The explanation of the result code.
ExecutionDateintegerOptional
TypestringOptional
NaturestringOptional
CreditedWalletIdstringOptional
DebitedWalletIdstringOptional
The unique identifier of the debited wallet.
PaymentTypestringOptional
BankAccountIdstringOptional
The unique identifier of the bank account.
BankWireRefstringOptional
ModeRequestedstringOptional
ModeAppliedstringOptional
FallbackReasonobject or nullOptional
Information regarding the reason for the refusal of the instant payout request.
EndToEndIdstringOptional
The unique identifier of a bank wire for tracking purposes only.
PaymentRefobject or nullOptional
RecipientVerificationOfPayeeobject or nullOptional
RecipientIdstringOptional
ChargeBearerstringOptional