Chilkat Online Tools

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

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

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

    CkJsonObject::ckUpdateString(json,"merchid","{{merchid}}")
    CkJsonObject::ckUpdateString(json,"orderid","{{orderid}}")

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