Chilkat Online Tools

phpExt / GP-API Collection / TKA_2.7 Tokenize SINGLE USE

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.

// {
//   "usage_mode": "SINGLE",
//   "account_name": "{{token_acc_name}}",
//   "reference": "{{reference}}",
//   "card": {
//     "number": "4242424242424242",
//     "expiry_month": "12",
//     "expiry_year": "23",
//     "cvv": "123"
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('usage_mode','SINGLE');
$json->UpdateString('account_name','{{token_acc_name}}');
$json->UpdateString('reference','{{reference}}');
$json->UpdateString('card.number','4242424242424242');
$json->UpdateString('card.expiry_month','12');
$json->UpdateString('card.expiry_year','23');
$json->UpdateString('card.cvv','123');

$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('X-GP-Idempotency','12345');
$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/payment-methods','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}}"
	-H "X-GP-Idempotency: 12345"
	-d '{
    "usage_mode":"SINGLE",
    "account_name": "{{token_acc_name}}",
    "reference": "{{reference}}",
    "card": {
       "number": "4242424242424242",
        "expiry_month": "12",
        "expiry_year": "23",
        "cvv":"123"
    }
}'
https://{{url}}/ucp/payment-methods

Postman Collection Item JSON

{
  "name": "TKA_2.7 Tokenize SINGLE USE",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.environment.unset(\"pmt_id\");\r",
          "\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "postman.setEnvironmentVariable(\"pmt_id\", jsonData.id);\r",
          "postman.setEnvironmentVariable(\"pmt_reference\", jsonData.reference);\r",
          "postman.setEnvironmentVariable(\"id\", jsonData.id);\r",
          "tests[\"ID \" + pm.environment.get(\"pmt_id\")] = true;\r",
          "\r",
          "tests[\"Response time is acceptable\"] = _.inRange(responseTime, 100, 1500); \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"
      }
    },
    {
      "listen": "prerequest",
      "script": {
        "exec": [
          "var str = String(\"00000000\"+ Math.floor(Math.random()*100000000) + 1).slice(-8);",
          "",
          "pm.environment.set(\"reference\",str);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{token}}"
      },
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "X-GP-Version",
        "value": "{{version}}",
        "type": "text"
      },
      {
        "key": "X-GP-Idempotency",
        "value": "12345",
        "type": "text",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"usage_mode\":\"SINGLE\",\n    \"account_name\": \"{{token_acc_name}}\",\n    \"reference\": \"{{reference}}\",\n    \"card\": {\n       \"number\": \"4242424242424242\",\n        \"expiry_month\": \"12\",\n        \"expiry_year\": \"23\",\n        \"cvv\":\"123\"\n    }\n}"
    },
    "url": {
      "raw": "https://{{url}}/ucp/payment-methods",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "payment-methods"
      ]
    },
    "description": "This request stores a card on GP systems and returns a unique GP token that can be used to create future sale or refund transactions.\r\nIn the body of the request you can see that the card details are inputted into request along with a reference. This is a unique id that the merchant gives in order to identify this tokenization request.\r\nIn the response back, you should receive an id. This is the unique id that global payments has replaced the card details with.\r\n\r\nFor more info on tokenization, visit: https://developer.globalpay.com/api/payment-methods-tokenization#/Create/post_payment_methods"
  },
  "response": [
  ]
}