DisputesDispute documents

Create a Dispute Document

Create a Dispute Document

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.
DisputeIdstringRequired
The unique identifier of the dispute.

Request

This endpoint expects an object.
TypestringRequired

Allowed values: DELIVERY_PROOF, INVOICE, REFUND_PROOF, USER_CORRESPONDANCE, USER_ACCEPTANCE_PROOF, PRODUCT_REPLACEMENT_PROOF, OTHER

The type of the dispute document.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

Response

Success
DisputeIdstringOptional
The unique identifier of the dispute.
TypestringOptional

Returned values: DELIVERY_PROOF, INVOICE, REFUND_PROOF, USER_CORRESPONDANCE, USER_ACCEPTANCE_PROOF, PRODUCT_REPLACEMENT_PROOF, OTHER

The type of the dispute document.

IdstringOptional

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

The unique identifier of the object.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

CreationDateintegerOptional

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

ProcessedDateintegerOptional

Unix timestamp (UTC) of the date and time the document was processed by Mangopay’s team.

StatusstringOptional

Returned values: CREATED, VALIDATION_ASKED, VALIDATED, REFUSED, OUT_OF_DATE

The status of the dispute document.

RefusedReasonTypestringOptional

Returned values: DOCUMENT_DO_NOT_MATCH_USER_DATA, DOCUMENT_FALSIFIED, DOCUMENT_HAS_EXPIRED, DOCUMENT_INCOMPLETE, DOCUMENT_MISSING, DOCUMENT_NOT_ACCEPTED, DOCUMENT_UNREADABLE, SPECIFIC_CASE, UNDERAGE_PERSON

The reason for the dispute document refusal. See the RefusedReasonMessage for more information.

RefusedReasonMessagestringOptional

Max. length: 255 characters

Default value: null Additional information about why the dispute document was refused, provided by Mangopay’s team.