Chilkat Online Tools

PureBasic / CardPointe API Integration / Capture (Partial Amount)

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

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "username")
    CkHttp::setCkPassword(http, "password")

    ; Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    ; The following JSON is sent in the request body.

    ; {
    ;   "retref": "{{retref}}",
    ;   "merchid": "{{merchid}}",
    ;   "amount": "2.00"
    ; }

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

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

    CkHttp::ckSetRequestHeader(http,"Authorization","Basic dGVzdGluZzp0ZXN0aW5nMTIz")
    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/capture",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

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



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


    ProcedureReturn
EndProcedure

Curl Command

curl -X PUT
	-u 'username:password'
	-H "Authorization: Basic dGVzdGluZzp0ZXN0aW5nMTIz"
	-H "Content-Type: application/json"
	-d '{
    "retref": "{{retref}}",
    "merchid": "{{merchid}}",
    "amount": "2.00"
}'
https://domain.com/capture

Postman Collection Item JSON

{
  "name": "Capture (Partial Amount)",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"profileid\", jsonData.profileid);",
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"acctid\", jsonData.acctid);",
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"retref\", jsonData.retref);",
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"token\", jsonData.token);",
          "var jsonData = JSON.parse(responseBody);",
          "postman.setEnvironmentVariable(\"batchid\", jsonData.batchid);"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "basic",
      "basic": [
        {
          "key": "password",
          "value": "testing123",
          "type": "string"
        },
        {
          "key": "username",
          "value": "testing",
          "type": "string"
        },
        {
          "key": "showPassword",
          "value": false,
          "type": "boolean"
        }
      ]
    },
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "Basic dGVzdGluZzp0ZXN0aW5nMTIz"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"retref\": \"{{retref}}\",\n    \"merchid\": \"{{merchid}}\",\n    \"amount\": \"2.00\"\n}"
    },
    "url": {
      "raw": "{{url}}/capture",
      "host": [
        "{{url}}"
      ],
      "path": [
        "capture"
      ]
    },
    "description": "[Capture Documentation](https://developer.cardconnect.com/cardconnect-api#capture)\n\n**Note:** If \"amount\" is omitted, the transaction is voided for the full amount."
  },
  "response": [
  ]
}