Chilkat Online Tools

Ruby / CardPointe API Integration / Void by Order ID (Order ID)

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()

# 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}}",
#   "orderid": "{{orderid}}"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("merchid","{{merchid}}")
json.UpdateString("orderid","{{orderid}}")

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/voidByOrderId",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
	-H "Authorization: Basic dGVzdGluZzp0ZXN0aW5nMTIz"
	-H "Content-Type: application/json"
	-d '{
    "merchid": "{{merchid}}",
    "orderid": "{{orderid}}"
}'
https://domain.com/voidByOrderId

Postman Collection Item JSON

{
  "name": "Void by Order ID (Order ID)",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Authorization",
        "value": "Basic dGVzdGluZzp0ZXN0aW5nMTIz"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"merchid\": \"{{merchid}}\",\n    \"orderid\": \"{{orderid}}\"\n}"
    },
    "url": {
      "raw": "{{url}}/voidByOrderId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "voidByOrderId"
      ]
    },
    "description": "[Void by Order ID Documentation](https://developer.cardconnect.com/cardconnect-api#void-by-order-id)"
  },
  "response": [
  ]
}