Chilkat Online Tools

Ruby / CardPointe API Integration / Capture (Partial Amount)

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("username")
http.put_Password("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 = Chilkat::CkJsonObject.new()
json.UpdateString("retref","{{retref}}")
json.UpdateString("merchid","{{merchid}}")
json.UpdateString("amount","2.00")

http.SetRequestHeader("Authorization","Basic dGVzdGluZzp0ZXN0aW5nMTIz")
http.SetRequestHeader("Content-Type","application/json")

sbRequestBody = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequestBody)

# resp is a CkHttpResponse
resp = http.PTextSb("PUT","https://domain.com/capture",sbRequestBody,"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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