DisputesDispute settlement

Create a Settlement Transfer

Create a Settlement Transfer

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.
RepudiationIdstringRequired
The unique identifier of the repudiation.

Request

This endpoint expects an object.
AuthorIdstringRequired
The unique identifier of the user at the source of the transaction.
DebitedFundsobjectRequired

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

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.

Response

Success
Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

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

ResultCodestring

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

ResultMessagestring
The explanation of the result code.
DebitedFundsobject

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

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.
AuthorIdstring
The unique identifier of the user at the source of the transaction.
CreditedUserIdstring

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

CreditedFundsobject

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

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.
CreditedWalletIdstring
The unique identifier of the credited wallet.
DebitedWalletIdstring
The unique identifier of the debited wallet.
RepudiationIdstring
The unique identifier of the repudiation.

Errors

400
Bad Request Error