Chilkat Online Tools

phpExt / GP-API Collection / TRA_4.0 Refund for prev sale auth

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

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

// resp is a CkHttpResponse
$resp = $http->QuickRequest('POST','https://{{url}}/ucp/transactions/{{sale_trn_id}}/refund');
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{token}}"
	-H "Accept: application/json"
	-H "X-GP-Version: {{version}}"
https://{{url}}/ucp/transactions/{{sale_trn_id}}/refund

Postman Collection Item JSON

{
  "name": "TRA_4.0 Refund for prev sale auth",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);\r",
          "postman.setEnvironmentVariable(\"refund_trn_id\", jsonData.id);\r",
          "\r",
          "pm.test(\"Successful POST request\", function () {\r",
          "    pm.expect(pm.response.code).to.be.oneOf([400]);\r",
          "});\r",
          "\r",
          "pm.test(\"Status code name has string\", function () {\r",
          "    pm.response.to.have.status(\"Bad Request\");\r",
          "});\r",
          "\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \r",
          "\r",
          "pm.test(\"Body matches string\", function () {\r",
          "    pm.expect(pm.response.text()).to.include(\"40010\");\r",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "disabled": true
      },
      {
        "key": "Authorization",
        "value": "Bearer {{token}}"
      },
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "X-GP-Version",
        "type": "text",
        "value": "{{version}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions/{{sale_trn_id}}/refund",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions",
        "{{sale_trn_id}}",
        "refund"
      ]
    },
    "description": "This request is for refunding a previous sale transaction. It uses the sale_trn_id from most recent sale transaction. You can only refund a transaction that has the status 'CAPTURED' ie. you can not process a refund for a transaction that is being captured at a later stage.\r\n\r\nFor more details on a refund request, visit: https://developer.globalpay.com/api/transactions#/Refund/post_transactions__id__refund"
  },
  "response": [
  ]
}