The Transaction object
Description
A Transaction represents any kind of money movement to and/or from a wallet (pay-ins, payouts, transfers) in the Mangopay ecosystem.
Note – Transaction data retained for 13 months
The API retains all transaction objects for 13 months from CreationDate. This applies to lists of transactions as well as An API call to retrieve an individual pay-in, transfer, conversion, or payout by its Id.
For more information, see the Data availability periods article.
Attributes
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. For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
Unix timestamp (UTC) of the date and time the object was created.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Information about the credited funds (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.
Unix timestamp (UTC) of the date and time 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.