Chilkat Online Tools

phpAx / CardPointe API Integration / Void by Order ID (Order ID)

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");

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "merchid": "{{merchid}}",
//   "orderid": "{{orderid}}"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('merchid','{{merchid}}');
$json->UpdateString('orderid','{{orderid}}');

$http->SetRequestHeader('Authorization','Basic dGVzdGluZzp0ZXN0aW5nMTIz');
$http->SetRequestHeader('Content-Type','application/json');

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('PUT','https://domain.com/voidByOrderId',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X PUT
	-H "Authorization: Basic dGVzdGluZzp0ZXN0aW5nMTIz"
	-H "Content-Type: application/json"
	-d '{
    "merchid": "{{merchid}}",
    "orderid": "{{orderid}}"
}'
https://domain.com/voidByOrderId

Postman Collection Item JSON

{
  "name": "Void by Order ID (Order ID)",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "Basic dGVzdGluZzp0ZXN0aW5nMTIz"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"merchid\": \"{{merchid}}\",\n    \"orderid\": \"{{orderid}}\"\n}"
    },
    "url": {
      "raw": "{{url}}/voidByOrderId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "voidByOrderId"
      ]
    },
    "description": "[Void by Order ID Documentation](https://developer.cardconnect.com/cardconnect-api#void-by-order-id)"
  },
  "response": [
  ]
}