Chilkat Online Tools

phpAx / GP-API Collection / TRA_11.0 ACH Auth

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.

// {
//   "account_name": "{{acc_name}}",
//   "channel": "CNP",
//   "type": "SALE",
//   "amount": "12345",
//   "currency": "USD",
//   "reference": "{{reference}}",
//   "country": "US",
//   "payment_method": {
//     "name": "Jane Doe",
//     "entry_mode": "ECOM",
//     "bank_transfer": {
//       "number": "1234567890",
//       "number_type": "SAVING",
//       "check_reference": "123",
//       "sec_code": "WEB",
//       "merchant_notes": "123",
//       "bank": {
//         "code": "083908420",
//         "name": "First Union",
//         "address": {
//           "line_1": "12000 Smoketown Rd",
//           "line_2": "Apt 3B",
//           "line_3": "X",
//           "city": "Mesa",
//           "state": "AZ",
//           "postal_code": "22192",
//           "country": "USA"
//         }
//       }
//     }
//   },
//   "payer": {
//     "name": "ANGELA SMITH",
//     "reference": "123",
//     "date_of_birth": "1967-08-13",
//     "landline_phone": "235555",
//     "mobile_phone": "222222",
//     "billing_address": {
//       "line_1": "Address Line 1",
//       "line_2": "Address Line 2",
//       "city": "PUNE",
//       "state": "AZ",
//       "postal_code": "411015",
//       "country": "USA"
//     }
//   }
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('account_name','{{acc_name}}');
$json->UpdateString('channel','CNP');
$json->UpdateString('type','SALE');
$json->UpdateString('amount','12345');
$json->UpdateString('currency','USD');
$json->UpdateString('reference','{{reference}}');
$json->UpdateString('country','US');
$json->UpdateString('payment_method.name','Jane Doe');
$json->UpdateString('payment_method.entry_mode','ECOM');
$json->UpdateString('payment_method.bank_transfer.number','1234567890');
$json->UpdateString('payment_method.bank_transfer.number_type','SAVING');
$json->UpdateString('payment_method.bank_transfer.check_reference','123');
$json->UpdateString('payment_method.bank_transfer.sec_code','WEB');
$json->UpdateString('payment_method.bank_transfer.merchant_notes','123');
$json->UpdateString('payment_method.bank_transfer.bank.code','083908420');
$json->UpdateString('payment_method.bank_transfer.bank.name','First Union');
$json->UpdateString('payment_method.bank_transfer.bank.address.line_1','12000 Smoketown Rd');
$json->UpdateString('payment_method.bank_transfer.bank.address.line_2','Apt 3B');
$json->UpdateString('payment_method.bank_transfer.bank.address.line_3','X');
$json->UpdateString('payment_method.bank_transfer.bank.address.city','Mesa');
$json->UpdateString('payment_method.bank_transfer.bank.address.state','AZ');
$json->UpdateString('payment_method.bank_transfer.bank.address.postal_code','22192');
$json->UpdateString('payment_method.bank_transfer.bank.address.country','USA');
$json->UpdateString('payer.name','ANGELA SMITH');
$json->UpdateString('payer.reference','123');
$json->UpdateString('payer.date_of_birth','1967-08-13');
$json->UpdateString('payer.landline_phone','235555');
$json->UpdateString('payer.mobile_phone','222222');
$json->UpdateString('payer.billing_address.line_1','Address Line 1');
$json->UpdateString('payer.billing_address.line_2','Address Line 2');
$json->UpdateString('payer.billing_address.city','PUNE');
$json->UpdateString('payer.billing_address.state','AZ');
$json->UpdateString('payer.billing_address.postal_code','411015');
$json->UpdateString('payer.billing_address.country','USA');

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://{{url}}/ucp/transactions','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->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: 12348"
	-d '{
    "account_name": "{{acc_name}}",
    "channel": "CNP",
    "type": "SALE",
    "amount": "12345",
    "currency": "USD",
    "reference": "{{reference}}",
    "country": "US",
    "payment_method": {
        "name": "Jane Doe",
        "entry_mode": "ECOM",
        "bank_transfer": {
            "number": "1234567890",
            "number_type": "SAVING",
            "check_reference": "123",
            "sec_code": "WEB",
            "merchant_notes": "123",
            "bank": {
                "code": "083908420",
                "name": "First Union",
                "address": {
                    "line_1": "12000 Smoketown Rd",
                    "line_2": "Apt 3B",
                    "line_3": "X",
                    "city": "Mesa",
                    "state": "AZ",
                    "postal_code": "22192",
                    "country": "USA"
                }
            }
        }
    },
    "payer": {
        "name": "ANGELA SMITH",
        "reference": "123",
        "date_of_birth": "1967-08-13",
        "landline_phone": "235555",
        "mobile_phone": "222222",
        "billing_address": {
            "line_1": "Address Line 1",
            "line_2": "Address Line 2",
            "city": "PUNE",
            "state": "AZ",
            "postal_code": "411015",
            "country": "USA"
        }
    }
}'
https://{{url}}/ucp/transactions

Postman Collection Item JSON

{
  "name": "TRA_11.0 ACH Auth",
  "event": [
    {
      "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"
      }
    },
    {
      "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",
        "type": "text",
        "value": "{{version}}"
      },
      {
        "key": "X-GP-Idempotency",
        "type": "text",
        "value": "12348",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"account_name\": \"{{acc_name}}\",\n    \"channel\": \"CNP\",\n    \"type\": \"SALE\",\n    \"amount\": \"12345\",\n    \"currency\": \"USD\",\n    \"reference\": \"{{reference}}\",\n    \"country\": \"US\",\n    \"payment_method\": {\n        \"name\": \"Jane Doe\",\n        \"entry_mode\": \"ECOM\",\n        \"bank_transfer\": {\n            \"number\": \"1234567890\",\n            \"number_type\": \"SAVING\",\n            \"check_reference\": \"123\",\n            \"sec_code\": \"WEB\",\n            \"merchant_notes\": \"123\",\n            \"bank\": {\n                \"code\": \"083908420\",\n                \"name\": \"First Union\",\n                \"address\": {\n                    \"line_1\": \"12000 Smoketown Rd\",\n                    \"line_2\": \"Apt 3B\",\n                    \"line_3\": \"X\",\n                    \"city\": \"Mesa\",\n                    \"state\": \"AZ\",\n                    \"postal_code\": \"22192\",\n                    \"country\": \"USA\"\n                }\n            }\n        }\n    },\n    \"payer\": {\n        \"name\": \"ANGELA SMITH\",\n        \"reference\": \"123\",\n        \"date_of_birth\": \"1967-08-13\",\n        \"landline_phone\": \"235555\",\n        \"mobile_phone\": \"222222\",\n        \"billing_address\": {\n            \"line_1\": \"Address Line 1\",\n            \"line_2\": \"Address Line 2\",\n            \"city\": \"PUNE\",\n            \"state\": \"AZ\",\n            \"postal_code\": \"411015\",\n            \"country\": \"USA\"\n        }\n    }\n}\n"
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions"
      ]
    }
  },
  "response": [
  ]
}