The Settlement Transfer object

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.

Unix timestamp (UTC) of the date and time the object was created.

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

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.

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.

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

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

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.