Chilkat Online Tools

phpAx / GP-API Collection / DIA_1.1 Get Dispute

Back to Collection Items

<?php

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-GP-Version','{{version}}');
// Adds the "Authorization: Bearer {{token}}" header.
$http->AuthToken = '{{token}}';
$http->SetRequestHeader('Accept','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://{{url}}/ucp/disputes/DIS_SAND_abcd1235',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print 'Response status code = ' . $http->LastStatus . "\n";
print $sbResponseBody->getAsString() . "\n";

?>

Curl Command

curl -X GET
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{token}}"
	-H "Accept: application/json"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/disputes/DIS_SAND_abcd1235

Postman Collection Item JSON

{
  "name": "DIA_1.1 Get Dispute",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "//pm.environment.unset(\"doc_id\");\r",
          "\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "postman.setEnvironmentVariable(\"dis_id\", jsonData.id);\r",
          "\r",
          "pm.test(\"Document available\", function () {\r",
          "   pm.expect(jsonData.documents[0]).to.have.any.keys('id');\r",
          "postman.setEnvironmentVariable(\"doc_id\", jsonData.documents[0].id);\r",
          "});\r",
          "\r",
          "pm.test(\"Successful POST request\", function () {\r",
          "    pm.expect(pm.response.code).to.be.oneOf([200,201,202]);\r",
          "});\r",
          "\r",
          "pm.test(\"Status code name has string\", function () {\r",
          "    pm.response.to.have.status(\"OK\");\r",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "value": "application/json",
        "type": "text",
        "disabled": true
      },
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "Accept",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "X-GP-Version",
        "value": "{{version}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/disputes/DIS_SAND_abcd1235",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "disputes",
        "DIS_SAND_abcd1235"
      ]
    },
    "description": "This request returns details about a specific dispute. User must include dispute id in query string.\r\n\r\nThe status of the specific dispute is returned along with what stage the dispute is in and reason for dispute and any documentation the issuer has provided regarding dispute.\r\n\r\nFor more info on getting specific dispute from GP-API, visit https://developer.globalpay.com/api/disputes#/Dispute/get_disputes__id_"
  },
  "response": [
  ]
}