Chilkat Online Tools

Objective-C / GP-API Collection / TRA_2.4 CP Gratuity

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

// 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": "CP",
//   "type": "SALE",
//   "capture_mode": "AUTO",
//   "amount": "10000",
//   "gratuity_amount": "100",
//   "currency": "USD",
//   "reference": "{{reference}}",
//   "country": "US",
//   "payment_method": {
//     "first_name": "Jane",
//     "last_name": "Doe",
//     "entry_mode": "MANUAL",
//     "card": {
//       "number": "4242424242424242",
//       "expiry_month": "09",
//       "expiry_year": "22"
//     }
//   }
// }

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"account_name" value: @"{{acc_name}}"];
[json UpdateString: @"channel" value: @"CP"];
[json UpdateString: @"type" value: @"SALE"];
[json UpdateString: @"capture_mode" value: @"AUTO"];
[json UpdateString: @"amount" value: @"10000"];
[json UpdateString: @"gratuity_amount" value: @"100"];
[json UpdateString: @"currency" value: @"USD"];
[json UpdateString: @"reference" value: @"{{reference}}"];
[json UpdateString: @"country" value: @"US"];
[json UpdateString: @"payment_method.first_name" value: @"Jane"];
[json UpdateString: @"payment_method.last_name" value: @"Doe"];
[json UpdateString: @"payment_method.entry_mode" value: @"MANUAL"];
[json UpdateString: @"payment_method.card.number" value: @"4242424242424242"];
[json UpdateString: @"payment_method.card.expiry_month" value: @"09"];
[json UpdateString: @"payment_method.card.expiry_year" value: @"22"];

[http SetRequestHeader: @"Content-Type" value: @"application/json"];
[http SetRequestHeader: @"X-GP-Version" value: @"{{version}}"];
// Adds the "Authorization: Bearer {{token}}" header.
http.AuthToken = @"{{token}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http PostJson3: @"https://{{url}}/ucp/transactions" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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}}",
    "channel": "CP",
    "type": "SALE",
    "capture_mode": "AUTO",
    "amount": "10000",
    "gratuity_amount": "100",
    "currency": "USD",
    "reference": "{{reference}}",
    "country": "US",
    "payment_method": {
        "first_name": "Jane",
        "last_name": "Doe",
        "entry_mode": "MANUAL",
        "card": {
            "number": "4242424242424242",
            "expiry_month": "09",
            "expiry_year": "22"
        }
    }
}'
https://{{url}}/ucp/transactions

Postman Collection Item JSON

{
  "name": "TRA_2.4 CP Gratuity",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "pm.environment.unset(\"trn_id\");\r",
          "var jsonData = JSON.parse(responseBody);\r",
          "postman.setEnvironmentVariable(\"trn_id\", jsonData.id);\r",
          "postman.setEnvironmentVariable(\"batch_id\", jsonData.batch_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}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"account_name\": \"{{acc_name}}\",\n    \"channel\": \"CP\",\n    \"type\": \"SALE\",\n    \"capture_mode\": \"AUTO\",\n    \"amount\": \"10000\",\n    \"gratuity_amount\": \"100\",\n    \"currency\": \"USD\",\n    \"reference\": \"{{reference}}\",\n    \"country\": \"US\",\n    \"payment_method\": {\n        \"first_name\": \"Jane\",\n        \"last_name\": \"Doe\",\n        \"entry_mode\": \"MANUAL\",\n        \"card\": {\n            \"number\": \"4242424242424242\",\n            \"expiry_month\": \"09\",\n            \"expiry_year\": \"22\"\n        }\n    }\n}"
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions"
      ]
    },
    "description": "This request allows the merchant to specify what part of the original transaction amount is gratuity e.g For a $50 transaction, $5 of this transaction amount is gratuity. Insert gratuity amount in the gratuity_amount field in the body of the request."
  },
  "response": [
  ]
}