Chilkat Online Tools

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

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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}}"
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"merchid","{{merchid}}")
    CkJsonObject::ckUpdateString(json,"retref","{{retref}}")
    CkJsonObject::ckUpdateString(json,"signature","{{signature}}")

    CkHttp::ckSetRequestHeader(http,"Authorization","{{Authorization}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/sigcap",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttpResponse::ckHeader(resp)
        Debug "Failed."
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(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

    resptext.s = CkJsonObject::ckStringOf(jResp,"resptext")
    retref.s = CkJsonObject::ckStringOf(jResp,"retref")
    respcode.s = CkJsonObject::ckStringOf(jResp,"respcode")
    merchid.s = CkJsonObject::ckStringOf(jResp,"merchid")


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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}"
    }
  ]
}