Submit a Dispute

PUT

/v2.01/:ClientId/disputes/:DisputeId/submit

PUT

/v2.01/:ClientId/disputes/:DisputeId/submit

$ curl -X PUT https://api.sandbox.mangopay.com/v2.01/ClientId/disputes/DisputeId/submit \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "ContestedFunds": {
>       "Currency": "EUR",
>       "Amount": 1200
>     }
>   }
> }'

1 {
2   "InitialTransactionId": "158596153",
3   "InitialTransactionType": "PAYIN",
4   "InitialTransactionNature": "REGULAR",
5   "DisputeType": "CONTESTABLE",
6   "ContestDeadlineDate": 1673049599,
7   "DisputedFunds": {
8     "Currency": "EUR",
9     "Amount": 1200
10   },
11   "ContestedFunds": {
12     "Currency": "EUR",
13     "Amount": 1200
14   },
15   "Status": "SUBMITTED",
16   "StatusMessage": null,
17   "DisputeReason": {
18     "DisputeReasonType": "UNKNOWN",
19     "DisputeReasonMessage": "This is a test dispute"
20   },
21   "ResultCode": "",
22   "ResultMessage": null,
23   "Id": "159102965",
24   "Tag": null,
25   "CreationDate": 1672411848,
26   "ClosedDate": null,
27   "RepudiationId": "159102966"
28 }

Submit a Dispute

This call is used both for the initial submission of the dispute and any resubmission made afterwards (in case more documents are required for instance).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

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.

DisputeIdstringRequired

The unique identifier of the dispute.

Request

This endpoint expects an object.

ContestedFundsobjectRequired

Information about the debited funds.

Response

Success

InitialTransactionIdstring

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

InitialTransactionTypestring

Returned values: PAYIN

The type of the initial transaction being disputed.

InitialTransactionNaturestring

Returned values: REGULAR

The nature of the initial transaction being disputed.

DisputeTypestring

Returned values: CONTESTABLE, NOT_CONTESTABLE, RETRIEVAL

The type of dispute:

CONTESTABLE – Dispute for which the chargeback can be contested by providing proof (i.e., Dispute Documents) justifying the original transaction.
NOT_CONTESTABLE – Dispute that is automatically closed after its creation, without any action possible for the platform.
RETRIEVAL – Dispute that is actually a chargeback warning issued by the bank. The platform is required to provide documents, but no funds will be taken from the Repudiation Wallet.

ContestDeadlineDateinteger

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.

DisputedFundsobject

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

ContestedFundsobject

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

Statusstring

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.

StatusMessagestring

Additional information about the dispute Status communicated by Mangopay teams.

DisputeReasonobject

Information about the reasons for the dispute.

ResultCodestring

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.

ResultMessagestring

The explanation of the result code.

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.

ClosedDateinteger

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.

RepudiationIdstring

The unique identifier of the repudiation.

Errors

400

Bad Request Error