v2

latestOpenAPI 3.1.02026-07-262279731.3 MB

disputeDocuments

View a Dispute Document

get/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

DisputeDocumentIdstring required

The unique identifier of the dispute document.

Headers

Authorizationstring required

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.

Response

Success

DisputeIdstring

The unique identifier of the dispute.

Typestring

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

The type of the dispute document.

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.

ProcessedDateinteger

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

Statusstring

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

The status of the dispute document.

RefusedReasonTypestring

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 <inline-code>RefusedReasonMessage</inline-code> for more information.

RefusedReasonMessagestring

Max. length: 255 characters

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