Chilkat Online Tools

Objective-C / CardPointe API Integration / Void by Order ID (Order ID)

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"merchid" value: @"{{merchid}}"];
[json UpdateString: @"orderid" value: @"{{orderid}}"];

[http SetRequestHeader: @"Authorization" value: @"Basic dGVzdGluZzp0ZXN0aW5nMTIz"];
[http SetRequestHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbRequestBody = [[CkoStringBuilder alloc] init];
[json EmitSb: sbRequestBody];

CkoHttpResponse *resp = [http PTextSb: @"PUT" url: @"https://domain.com/voidByOrderId" textData: sbRequestBody charset: @"utf-8" contentType: @"application/json" md5: NO gzip: NO];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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