Chilkat Online Tools

Node.js / GP-API Collection / DAA_1.1 Get Disputes

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateString("from_deposit_time_created","2020-10-04");
    queryParams.UpdateString("account_name","{{settlement_acc_name}}");
    queryParams.UpdateString("order_by","arn");

    // Adds the "Authorization: Bearer {{token}}" header.
    http.AuthToken = "{{token}}";
    http.SetRequestHeader("X-GP-Version","{{version}}");

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://{{url}}/ucp/settlement/disputes",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

Curl Command

curl -G -d "from_deposit_time_created=2020-10-04"
	-d "account_name=%7B%7Bsettlement_acc_name%7D%7D"
	-d "order_by=arn"
	-H "Authorization: Bearer {{token}}"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/settlement/disputes

Postman Collection Item JSON

{
  "name": "DAA_1.1 Get Disputes",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "\r",
          "pm.environment.unset(\"trn_id\");\r",
          "\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "postman.setEnvironmentVariable(\"dis_id\", jsonData.disputes[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": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "X-GP-Version",
        "value": "{{version}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "https://{{url}}/ucp/settlement/disputes?from_deposit_time_created=2020-10-04&account_name={{settlement_acc_name}}&order_by=arn",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "settlement",
        "disputes"
      ],
      "query": [
        {
          "key": "from_deposit_time_created",
          "value": "2020-10-04"
        },
        {
          "key": "account_name",
          "value": "{{settlement_acc_name}}"
        },
        {
          "key": "order_by",
          "value": "arn"
        }
      ]
    },
    "description": "This request returns a list of all disputes initiated by a Payer/Payer's Bank to the Merchant from a specific date. To change the date of how far back in time the report goes to, edit the from_deposit_time_created variable in the Params tab to whatever date you would like. It is recommended to go at least 10 days back in time.\r\n\r\nFor more info on getting dispute list, visit: https://developer.globalpay.com/api/disputes#/Disputes/get_disputes"
  },
  "response": [
  ]
}