List all Dispute Documents

Query parameters

BeforeDate · Unix timestamp

The date before which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDate · Unix timestamp

The date after which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Responses

200

Array (Dispute documents) · array

The list of dispute documents created by the platform.

Show properties

Object (Dispute document) · object

The dispute document created by the platform.

Show properties

DisputeId · string

The unique identifier of the dispute.

Type · string

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

The type of the dispute document.

Id · string

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

The unique identifier of the object.

Tag · string

Max. length: 255 characters

Custom data that you can add to this object.

CreationDate · Unix timestamp

The date and time at which the object was created.

ProcessedDate · Unix timestamp

The date and time at which the document was processed by Mangopay’s team.

Status · string

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

The status of the dispute document.

RefusedReasonType · string

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.

RefusedReasonMessage · string

Max. length: 255 characters

Default value: null

Additional information about why the KYC Document was refused, provided by Mangopay’s team.

200

[
    {
        "DisputeId": "159102965",
        "Type": "DELIVERY_PROOF",
        "Id": "159188418",
        "Tag": null,
        "CreationDate": 1672655973,
        "ProcessedDate": null,
        "Status": "VALIDATION_ASKED",
        "RefusedReasonType": null,
        "RefusedReasonMessage": null
    }
]  

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $response = $api->DisputeDocuments->GetAll();

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}