​
Description

The Settlement Transfer object represents the transfer of funds from the user Wallet to the platform’s Repudiation Wallet in order to settle the negative balance due to a LOST dispute.

Note – Dispute must be closed

Only disputes with the CLOSED Status can be settled.

​
Attributes

​
Id
string

The unique identifier of the object.

​
Tag
string

Max. length: 255 characters

Custom data that you can add to this object.

​
CreationDate
Unix timestamp

The date and time at which the object was created.

​
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.

​
DebitedFunds
object

Information about the debited funds. Please note that:

  • The Currency must be identical to that of the initial transaction.
  • The Amount cannot exceed the initial’s transaction minus the fees.
​
Fees
object

Information about the fees. Please note that:

  • The Currency must be identical to that of the initial transaction.
  • The Amount cannot exceed the initial’s transaction.
​
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.

​
CreditedFunds
object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

​
Status
string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

​
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, PAYOUT

The type of the transaction.

​
Nature
string

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.
​
CreditedWalletId
string

The unique identifier of the wallet. In the specific case of the Client Wallet object, this value is returned by the Mangopay API in the form of the funds type and the currency (e.g., “FEES_EUR”).

​
DebitedWalletId
string

The unique identifier of the debited wallet.

​
RepudiationId
string

The unique identifier of the repudiation.