Zig Requires Chilkat v11.0.0+
Zig
Amazon Pay - Close Charge Permission
See more Amazon Pay Examples
Moves the Charge Permission to a Closed state. No future charges can be made and pending charges will be canceled if you set cancelPendingCharges to true.Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
const http = try chilkat.Http.init();
defer http.deinit();
// Implements the following CURL command:
// curl "https://pay-api.amazon.com/:version/chargePermissions/:chargePermissionId/close" \
// -X DELETE
// -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
// -H "x-amz-pay-date:20201012T235046Z"
// -d '{
// "closureReason": "No more charges required",
// "cancelPendingCharges": false
// }'
// Use the following online tool to generate HTTP code from a CURL command
// Convert a cURL Command to HTTP Source Code
// Use this online tool to generate code from sample JSON:
// Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "closureReason": "No more charges required",
// "cancelPendingCharges": false
// }
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.updateString("closureReason", "No more charges required") catch {};
json.updateBool("cancelPendingCharges", false) catch {};
const sb_request_body = try chilkat.StringBuilder.init();
defer sb_request_body.deinit();
json.emitSb(sb_request_body) catch {};
// Load your Amazon Pay private key.
// There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
// or from in-memory strings or bytes.
const priv_key = try chilkat.PrivateKey.init();
defer priv_key.deinit();
priv_key.loadPemFile("C:/someDir/myAmazonPayPrivateKey.pem") catch {
std.debug.print("{s}\n", .{try priv_key.getLastErrorText(alloc)});
return;
};
// Provide your Amazon Pay private key and Public Key ID
// Use your public key ID here. It must be the one associated with the private key.
// Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
const public_key_id = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW";
http.setAuthPrivateKey(public_key_id, priv_key) catch {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
};
// Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
// and will also sign the request. Nothing more is needed.
// Chilkat automatically generates and adds the following headers:
//
// x-amz-pay-date
// x-amz-pay-host
// x-amz-pay-region
// Authorization
http.setAccept("application/json");
// Use the actual chargePermissionId here:
try http.setUrlVar("chargePermissionId", "P21-1111111-1111111");
// To use the live system, replace "sandbox" with "live" in the URL passed to HttpSb.
// Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
const resp = try chilkat.HttpResponse.init();
defer resp.deinit();
http.httpSb("DELETE", "https://pay-api.amazon.eu/sandbox/v2/chargePermissions/{$chargePermissionId}/close", sb_request_body, "utf-8", "application/json", resp) catch {
std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
return;
};
const sb_response_body = try chilkat.StringBuilder.init();
defer sb_response_body.deinit();
resp.getBodySb(sb_response_body) catch {};
const j_resp = try chilkat.JsonObject.init();
defer j_resp.deinit();
j_resp.loadSb(sb_response_body) catch {};
j_resp.setEmitCompact(false);
// If the status code is not equal to 200, this will display error information.
std.debug.print("Response Body:\n", .{});
std.debug.print("{s}\n", .{try j_resp.emit(alloc)});
const resp_status_code = resp.getStatusCode();
std.debug.print("Response Status Code = {d}\n", .{resp_status_code});
if (resp_status_code != 200) {
std.debug.print("Failed.\n", .{});
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "chargePermissionId": "chargePermission-1",
// "chargePermissionReferenceId": null,
// "buyer": {
// "buyerId": "buyerId",
// "name": "name-1",
// "email": "name@amazon.com",
// "phoneNumber": "800-000-0000",
// "primeMembershipTypes": null
// },
// "releaseEnvironment": "Live",
// "shippingAddress": { // Null for PayOnly product type
// "name": "Work",
// "addressLine1": "440 Terry Ave",
// "addressLine2": "",
// "addressLine3": "",
// "city": "Seattle",
// "county": "King",
// "district": "Seattle",
// "stateOrRegion": "WA",
// "postalCode": "98121",
// "countryCode": "US",
// "phoneNumber": "800-000-0000"
// },
// "billingAddress": { // Only available in EU or for PayOnly product type
// "name": "Work",
// "addressLine1": "440 Terry Ave",
// "addressLine2": "",
// "addressLine3": "",
// "city": "Seattle",
// "county": "King",
// "district": "Seattle",
// "stateOrRegion": "WA",
// "postalCode": "98121",
// "countryCode": "US",
// "phoneNumber": "800-000-0000"
// },
// "paymentPreferences": [
// {
// "paymentDescriptor": null
// }],
// "statusDetails": {
// "state": "Closed",
// "reasons":
// [{
// "reasonCode": null,
// "reasonDescription": null
// }],
// "lastUpdatedTimestamp": "20190714T155300Z"
// },
// "creationTimestamp": "20190714T155300Z",
// "expirationTimestamp": "20190715T155300Z",
// "merchantMetadata":{
// "merchantReferenceId": "123-77-876",
// "merchantStoreName": "AmazonTestStoreFront",
// "noteToBuyer": "merchantNoteForBuyer",
// "customInformation": "This is custom information"
// },
// "platformId": "SPId",
// "limits": {
// "amountLimit": {
// "amount": "14.00",
// "currencyCode": "USD"
// },
// "amountBalance": {
// "amount": "14.00",
// "currencyCode": "USD"
// }
// },
// "presentmentCurrency": "USD"
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
var payment_descriptor: [:0]const u8 = "";
var reason_code: [:0]const u8 = "";
var reason_description: [:0]const u8 = "";
_ = try j_resp.stringOf(alloc, "chargePermissionId");
_ = try j_resp.stringOf(alloc, "chargePermissionReferenceId");
_ = try j_resp.stringOf(alloc, "buyer.buyerId");
_ = try j_resp.stringOf(alloc, "buyer.name");
_ = try j_resp.stringOf(alloc, "buyer.email");
_ = try j_resp.stringOf(alloc, "buyer.phoneNumber");
_ = try j_resp.stringOf(alloc, "buyer.primeMembershipTypes");
_ = try j_resp.stringOf(alloc, "releaseEnvironment");
_ = try j_resp.stringOf(alloc, "shippingAddress.name");
_ = try j_resp.stringOf(alloc, "shippingAddress.addressLine1");
_ = try j_resp.stringOf(alloc, "shippingAddress.addressLine2");
_ = try j_resp.stringOf(alloc, "shippingAddress.addressLine3");
_ = try j_resp.stringOf(alloc, "shippingAddress.city");
_ = try j_resp.stringOf(alloc, "shippingAddress.county");
_ = try j_resp.stringOf(alloc, "shippingAddress.district");
_ = try j_resp.stringOf(alloc, "shippingAddress.stateOrRegion");
_ = try j_resp.stringOf(alloc, "shippingAddress.postalCode");
_ = try j_resp.stringOf(alloc, "shippingAddress.countryCode");
_ = try j_resp.stringOf(alloc, "shippingAddress.phoneNumber");
_ = try j_resp.stringOf(alloc, "billingAddress.name");
_ = try j_resp.stringOf(alloc, "billingAddress.addressLine1");
_ = try j_resp.stringOf(alloc, "billingAddress.addressLine2");
_ = try j_resp.stringOf(alloc, "billingAddress.addressLine3");
_ = try j_resp.stringOf(alloc, "billingAddress.city");
_ = try j_resp.stringOf(alloc, "billingAddress.county");
_ = try j_resp.stringOf(alloc, "billingAddress.district");
_ = try j_resp.stringOf(alloc, "billingAddress.stateOrRegion");
_ = try j_resp.stringOf(alloc, "billingAddress.postalCode");
_ = try j_resp.stringOf(alloc, "billingAddress.countryCode");
_ = try j_resp.stringOf(alloc, "billingAddress.phoneNumber");
_ = try j_resp.stringOf(alloc, "statusDetails.state");
_ = try j_resp.stringOf(alloc, "statusDetails.lastUpdatedTimestamp");
_ = try j_resp.stringOf(alloc, "creationTimestamp");
_ = try j_resp.stringOf(alloc, "expirationTimestamp");
_ = try j_resp.stringOf(alloc, "merchantMetadata.merchantReferenceId");
_ = try j_resp.stringOf(alloc, "merchantMetadata.merchantStoreName");
_ = try j_resp.stringOf(alloc, "merchantMetadata.noteToBuyer");
_ = try j_resp.stringOf(alloc, "merchantMetadata.customInformation");
_ = try j_resp.stringOf(alloc, "platformId");
_ = try j_resp.stringOf(alloc, "limits.amountLimit.amount");
_ = try j_resp.stringOf(alloc, "limits.amountLimit.currencyCode");
_ = try j_resp.stringOf(alloc, "limits.amountBalance.amount");
_ = try j_resp.stringOf(alloc, "limits.amountBalance.currencyCode");
_ = try j_resp.stringOf(alloc, "presentmentCurrency");
var i: i32 = 0;
var count_i: i32 = j_resp.sizeOfArray("paymentPreferences");
while (i < count_i) {
j_resp.setI(i);
payment_descriptor = try j_resp.stringOf(alloc, "paymentPreferences[i].paymentDescriptor");
i = i + 1;
}
i = 0;
count_i = j_resp.sizeOfArray("statusDetails.reasons");
while (i < count_i) {
j_resp.setI(i);
reason_code = try j_resp.stringOf(alloc, "statusDetails.reasons[i].reasonCode");
reason_description = try j_resp.stringOf(alloc, "statusDetails.reasons[i].reasonDescription");
i = i + 1;
}
}