Create a weblink to view the Pages of a Dispute Document

POST /v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult

Create a weblink to view the Pages of a Dispute Document

cURL

curl --request POST \
  --url https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult

import requests

url = "https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2.01/{ClientId}/dispute-documents/{DisputeDocumentId}/consult")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

200

[
    {
        "Url": "https://api.sandbox.mangopay.com/public/documents/c2a145/consult/L0D3y1QRad0Oos6rYlkG0Q59VG",
        "ExpirationDate": 1673362529
    },
    {
        "Url": "https://api.sandbox.mangopay.com/public/documents/c2a145/consult/DB8MOWLgP21jMIe6VKGGP9EMyA",
        "ExpirationDate": 1673362529
    }
]  

This call returns one link per document page in order to consult them. These links are available for 10 minutes.

Path parameters

DisputeDocumentId · string

The unique identifier of the dispute document.

Responses

200

Array (Dispute Document Pages) · array

The list of Dispute Document Pages created by the platform.

Show properties

Object (Page) · object

The dispute document page created by the platform.

200

[
    {
        "Url": "https://api.sandbox.mangopay.com/public/documents/c2a145/consult/L0D3y1QRad0Oos6rYlkG0Q59VG",
        "ExpirationDate": 1673362529
    },
    {
        "Url": "https://api.sandbox.mangopay.com/public/documents/c2a145/consult/DB8MOWLgP21jMIe6VKGGP9EMyA",
        "ExpirationDate": 1673362529
    }
]