The Dispute object

Description

Mangopay relies on the Dispute object to manage chargeback requests from a User. This object is automatically created when the user’s bank orders the reversal of a pay-in.

As a consequence, Mangopay withdraws the required funds from the platform’s Repudiation Wallet. This is called a repudiation and results in the repudiation wallet having a negative balance that the platform will need to settle.

Attributes

InitialTransactionId
string

The unique identifier of the initial pay-in being disputed.

InitialTransactionType
string

Returned values: PAYIN

The type of the initial transaction being disputed.

InitialTransactionNature
string

The nature of the initial transaction being disputed.

DisputeType
string

Allowed values: CONTESTABLE, NOT_CONTESTABLE, RETRIEVAL

The type of the Dispute. You can filter on multiple values by separating them with a comma.

ContestDeadlineDate
Unix timestamp

The date and time until which the platform can contest the dispute (i.e., the Status is set to SUBMITTED). This date is defined by the issuing bank of the initial transaction and may usually vary between 7 to 18 days. Once the deadline passes, the dispute Status is automatically set to CLOSED.

DisputedFunds
string

Information about the disputed funds.
Note: This amount can be lower than the initial transaction amount.

Currency
stringRequired

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount
integerRequired

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

ContestedFunds
objectRequired

Information about the contested funds, in other words, the amount that you wish to contest.
Note: This amount can be lower than the disputed funds amount.

Currency
stringRequired

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount
integerRequired

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status
string

Returned values: CREATED, PENDING_CLIENT_ACTION, SUBMITTED, PENDING_BANK_ACTION, REOPENED_PENDING_CLIENT_ACTION, CLOSED

The status of the dispute:

  • CREATED – The dispute is created.
  • PENDING_CLIENT_ACTION – The dispute was not closed automatically upon its creation, it now requires some actions from the platform (either submission after providing the relevant proofs or closing).
  • SUBMITTED – The dispute is submitted by the platform for the Mangopay team to review the documents.
  • PENDING_BANK_ACTION – Mangopay accepted the documents and passed them on to the bank for them to review the dispute contestation. They will either reject or accept the contestation, or require further documents.
  • REOPENED_PENDING_CLIENT_ACTION – Mangopay didn’t accept the documents and requires more information or documents before sending the documents to the bank.
  • CLOSED – The dispute is closed.
StatusMessage
string

Additional information about the dispute Status communicated by Mangopay teams.

DisputeReason
object

Information about the reasons for the dispute.

properties
DisputeReasonType
string

The reason for the dispute.

DisputeReasonMessage
string

Max. length: 255 characters
Additional information about the reason for the dispute sent by Mangopay teams.

ResultCode
string

Returned values: LOST, WON, VOID

The result of the dispute for the platform, which can be:

  • LOST – The platform lost the dispute and must settle its debt to Mangopay with a Settlement Transfer.
  • WON – The platform won the dispute, the disputed funds will be credited back to the Repudiation Wallet.
  • VOID – The dispute has been canceled.
ResultMessage
string

The explanation of the result code.

Id
string

The unique identifier of the object.

Tag
string

Custom data that can be added to this object.
In the case of the Card Registration, this parameter can be used to facilitate the link between the User object and its equivalent on your platform for instance. This value will be inherited by the Card object Tag parameter and will not be editable.

CreationDate
Unix timestamp

The date and time at which the object was created.

ClosedDate
Unix timestamp

The date and time the dispute was closed (i.e., its Status is set to CLOSED).
Note: This value will be null for any Dispute closed before February 16th, 2023.

RepudiationId
stringRequired

The unique identifier of the repudiation.