Chilkat Online Tools

phpExt / GP-API Collection / TRA_12.1 EBT CP Manual

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

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

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

// {
//   "account_name": "{{acc_name}}",
//   "type": "SALE",
//   "channel": "CP",
//   "amount": "156",
//   "currency": "CAD",
//   "country": "CA",
//   "capture_mode": "AUTO",
//   "reference": "{{reference}}",
//   "payment_method": {
//     "name": "Jane Doe",
//     "entry_mode": "MANUAL",
//     "card": {
//       "funding": "FOOD_STAMP",
//       "pin_block": "57E7B46D0E374C333D010000144000C2",
//       "number": "4003000123456781",
//       "expiry_month": "12",
//       "expiry_year": "20"
//     }
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('account_name','{{acc_name}}');
$json->UpdateString('type','SALE');
$json->UpdateString('channel','CP');
$json->UpdateString('amount','156');
$json->UpdateString('currency','CAD');
$json->UpdateString('country','CA');
$json->UpdateString('capture_mode','AUTO');
$json->UpdateString('reference','{{reference}}');
$json->UpdateString('payment_method.name','Jane Doe');
$json->UpdateString('payment_method.entry_mode','MANUAL');
$json->UpdateString('payment_method.card.funding','FOOD_STAMP');
$json->UpdateString('payment_method.card.pin_block','57E7B46D0E374C333D010000144000C2');
$json->UpdateString('payment_method.card.number','4003000123456781');
$json->UpdateString('payment_method.card.expiry_month','12');
$json->UpdateString('payment_method.card.expiry_year','20');

$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->PostJson3('https://{{url}}/ucp/transactions','application/json',$json);
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}}"
	-d '{
  "account_name": "{{acc_name}}",
  "type": "SALE",
  "channel": "CP",
  "amount": "156",
  "currency": "CAD",
  "country": "CA",
  "capture_mode": "AUTO",
  "reference": "{{reference}}",
  "payment_method": {
    "name": "Jane Doe",
    "entry_mode": "MANUAL",
    "card": {
      "funding": "FOOD_STAMP",
      "pin_block": "57E7B46D0E374C333D010000144000C2",
      "number": "4003000123456781",
      "expiry_month": "12",
      "expiry_year": "20"
    }
  }
}'
https://{{url}}/ucp/transactions

Postman Collection Item JSON

{
  "name": "TRA_12.1 EBT CP Manual",
  "event": [
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "var str = String(\"00000000\"+ Math.floor(Math.random()*100000000) + 1).slice(-8);\r",
          "\r",
          "pm.environment.set(\"reference\",str);"
        ],
        "type": "text/javascript"
      }
    },
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.environment.unset(\"trn_id\");\r",
          "\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "postman.setEnvironmentVariable(\"trn_id\", jsonData.id);\r",
          "postman.setEnvironmentVariable(\"reference\", jsonData.reference);\r",
          "postman.setEnvironmentVariable(\"batch_id\", jsonData.batch_id);\r",
          "postman.setEnvironmentVariable(\"act_id\", jsonData.action.id);\r",
          "\r",
          "tests[\"Transaction ID \" + pm.environment.get(\"trn_id\")] = true;\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \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": {
    "auth": {
      "type": "noauth"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{token}}",
        "type": "text"
      },
      {
        "key": "Accept",
        "value": "application/json",
        "type": "text"
      },
      {
        "key": "X-GP-Version",
        "value": "{{version}}",
        "type": "text"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": " {\r\n  \"account_name\": \"{{acc_name}}\",\r\n  \"type\": \"SALE\",\r\n  \"channel\": \"CP\",\r\n  \"amount\": \"156\",\r\n  \"currency\": \"CAD\",\r\n  \"country\": \"CA\",\r\n  \"capture_mode\": \"AUTO\",\r\n  \"reference\": \"{{reference}}\",\r\n  \"payment_method\": {\r\n    \"name\": \"Jane Doe\",\r\n    \"entry_mode\": \"MANUAL\",\r\n    \"card\": {\r\n      \"funding\": \"FOOD_STAMP\",\r\n      \"pin_block\": \"57E7B46D0E374C333D010000144000C2\",\r\n      \"number\": \"4003000123456781\",\r\n      \"expiry_month\": \"12\",\r\n      \"expiry_year\": \"20\"\r\n    }\r\n  }\r\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions"
      ]
    }
  },
  "response": [
  ]
}