Chilkat Online Tools

Python / GP-API Collection / TRA_1.8 COF Transaction

Back to Collection Items

import sys
import chilkat

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

http = chilkat.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}}",
#   "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"
#     }
#   }
# }

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

http.SetRequestHeader("Content-Type","application/json")
http.SetRequestHeader("X-GP-Version","{{version}}")
# Adds the "Authorization: Bearer {{token}}" header.
http.put_AuthToken("{{token}}")
http.SetRequestHeader("idempotency-key","12345")
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())
    sys.exit()

print(str(resp.get_StatusCode()))
print(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}}"
	-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": [
  ]
}