Chilkat Online Tools

SQL Server / GP-API Collection / TRA_1.8 COF Transaction

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- 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": "15",
    --   "currency": "GBP",
    --   "reference": "lklkjl-98_()",
    --   "country": "GB",
    --   "capture_mode": "LATER",
    --   "initiator": "MERCHANT",
    --   "stored_credential": {
    --     "model": "RECURRING",
    --     "reason": "RESUBMISSION",
    --     "sequence": "SUBSEQUENT"
    --   },
    --   "payment_method": {
    --     "name": "Jane",
    --     "entry_mode": "ECOM",
    --     "card": {
    --       "number": "4242424242424242",
    --       "expiry_month": "12",
    --       "expiry_year": "24"
    --     }
    --   }
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'account_name', '{{acc_name}}'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'channel', 'CNP'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'type', 'SALE'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'amount', '15'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'currency', 'GBP'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'reference', 'lklkjl-98_()'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'country', 'GB'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'capture_mode', 'LATER'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'initiator', 'MERCHANT'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'stored_credential.model', 'RECURRING'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'stored_credential.reason', 'RESUBMISSION'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'stored_credential.sequence', 'SUBSEQUENT'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.name', 'Jane'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.entry_mode', 'ECOM'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.card.number', '4242424242424242'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.card.expiry_month', '12'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'payment_method.card.expiry_year', '24'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'X-GP-Version', '{{version}}'
    -- Adds the "Authorization: Bearer {{token}}" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '{{token}}'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'idempotency-key', '12345'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://{{url}}/ucp/transactions', 'application/json', @json
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json


END
GO

Curl Command

curl -X POST
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{token}}"
	-H "Accept: application/json"
	-H "X-GP-Version: {{version}}"
	-H "idempotency-key: 12345"
	-d '{
    "account_name": "{{acc_name}}",
    "channel": "CNP",
    "type": "SALE",
    "amount": "15",
    "currency": "GBP",
    "reference": "lklkjl-98_()",
    "country": "GB",
    "capture_mode": "LATER",
    "initiator": "MERCHANT",
    "stored_credential": {
        "model": "RECURRING",
        "reason": "RESUBMISSION",
        "sequence": "SUBSEQUENT"
    },
    "payment_method": {
        "name": "Jane",
        "entry_mode": "ECOM",
        "card": {
            "number": "4242424242424242",
            "expiry_month": "12",
            "expiry_year": "24"
        }
    }
}'
https://{{url}}/ucp/transactions

Postman Collection Item JSON

{
  "name": "TRA_1.8 COF Transaction",
  "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(\"act_id\", jsonData.action.id);\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": "idempotency-key",
        "type": "text",
        "value": "12345",
        "disabled": true
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\r\n    \"account_name\": \"{{acc_name}}\",\r\n    \"channel\": \"CNP\",\r\n    \"type\": \"SALE\",\r\n    \"amount\": \"15\",\r\n    \"currency\": \"GBP\",\r\n    \"reference\": \"lklkjl-98_()\",\r\n    \"country\": \"GB\",\r\n    \"capture_mode\": \"LATER\",\r\n    \"initiator\": \"MERCHANT\",\r\n    \"stored_credential\": {\r\n        \"model\": \"RECURRING\",\r\n        \"reason\": \"RESUBMISSION\",\r\n        \"sequence\": \"SUBSEQUENT\"\r\n    },\r\n    \"payment_method\": {\r\n        \"name\": \"Jane\",\r\n        \"entry_mode\": \"ECOM\",\r\n        \"card\": {\r\n            \"number\": \"4242424242424242\",\r\n            \"expiry_month\": \"12\",\r\n            \"expiry_year\": \"24\"\r\n        }\r\n    }\r\n}"
    },
    "url": {
      "raw": "https://{{url}}/ucp/transactions",
      "protocol": "https",
      "host": [
        "{{url}}"
      ],
      "path": [
        "ucp",
        "transactions"
      ]
    },
    "description": "This CNP transaction includes stored credential info related to the customer in the request. It states what the conditions of the payment under which the stored card details are being used ie.  recurring payment, installment or oneoff. It lists the reason for stored credential and where in the sequence of transactions the payment appears. ie. subsequent or first time card details being used."
  },
  "response": [
  ]
}