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

Id
string
The unique identifier of the object.
Tag
string
Max. length: 255 charactersCustom 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.
CreationDate
Unix 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.
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
DebitedFunds
object
Information about the debited funds.
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Fees
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe 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
Unix 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, PAYOUTThe type of the transaction.
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
DebitedWalletId
string
The unique identifier of the debited wallet.