Chilkat Online Tools

TCL / CardPointe API Integration / Signature Capture (Retref + Signature)

Back to Collection Items

load ./chilkat.dll

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

set 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.

# {
#   "merchid": "{{merchid}}",
#   "retref": "{{retref}}",
#   "signature": "{{signature}}"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "merchid" "{{merchid}}"
CkJsonObject_UpdateString $json "retref" "{{retref}}"
CkJsonObject_UpdateString $json "signature" "{{signature}}"

CkHttp_SetRequestHeader $http "Authorization" "{{Authorization}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "PUT" "https://domain.com/sigcap" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody

set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

delete_CkHttpResponse $resp

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "resptext": "signature stored",
#   "retref": "010787260965",
#   "respcode": "02",
#   "merchid": "496082673999"
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

set resptext [CkJsonObject_stringOf $jResp "resptext"]
set retref [CkJsonObject_stringOf $jResp "retref"]
set respcode [CkJsonObject_stringOf $jResp "respcode"]
set merchid [CkJsonObject_stringOf $jResp "merchid"]

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp

Curl Command

curl -X PUT
	-H "Authorization: {{Authorization}}"
	-H "Content-Type: application/json"
	-d '{
	"merchid": "{{merchid}}",
	"retref": "{{retref}}",
	"signature": "{{signature}}"
}'
https://domain.com/sigcap

Postman Collection Item JSON

{
  "name": "Signature Capture (Retref + Signature)",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "type": "text",
        "value": "{{Authorization}}"
      },
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n\t\"merchid\": \"{{merchid}}\",\n\t\"retref\": \"{{retref}}\",\n\t\"signature\": \"{{signature}}\"\n}"
    },
    "url": {
      "raw": "{{url}}/sigcap",
      "host": [
        "{{url}}"
      ],
      "path": [
        "sigcap"
      ]
    },
    "description": "[Signature Capture Documentation](https://developer.cardconnect.com/cardconnect-api#signature-capture)"
  },
  "response": [
    {
      "name": "Signature Capture Example",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Authorization",
            "type": "text",
            "value": "{{Authorization}}"
          },
          {
            "key": "Content-Type",
            "name": "Content-Type",
            "type": "text",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n\t\"merchid\": \"{{merchid}}\",\n\t\"retref\": \"{{retref}}\",\n\t\"signature\": \"{{signature}}\"\n}"
        },
        "url": {
          "raw": "{{url}}/sigcap",
          "host": [
            "{{url}}"
          ],
          "path": [
            "sigcap"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "X-FRAME-OPTIONS",
          "value": "DENY"
        },
        {
          "key": "Content-Type",
          "value": "application/json"
        },
        {
          "key": "Content-Length",
          "value": "96"
        },
        {
          "key": "Date",
          "value": "Thu, 10 Jan 2019 22:48:14 GMT"
        },
        {
          "key": "Server",
          "value": "CardConnect"
        },
        {
          "key": "Set-Cookie",
          "value": "BIGipServerphu-smb-vip_8080=!LjWLHiB9n9NWwsA7l1uxw4rK+VEmEdwIthKC4TazuLPJh6E1ejLYwbozqYcrk8OdOnAt3b319/yBPZ4=; path=/; Httponly; Secure"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"resptext\": \"signature stored\",\n    \"retref\": \"010787260965\",\n    \"respcode\": \"02\",\n    \"merchid\": \"496082673999\"\n}"
    }
  ]
}