Zig Requires Chilkat v11.0.0+
Zig
PayPal - Find Captures
See more PayPal Examples
Finds captures for previous authorizations. (A capture is when the funds from an authorization are captured. There can be more than one capture, where the sum adds to the full authorization amount or an amount lower than the authorized amount.)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 requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
// Load our previously obtained access token. (see PayPal OAuth2 Access Token)
const json_token = try chilkat.JsonObject.init();
defer json_token.deinit();
json_token.loadFile("qa_data/tokens/paypal.json") catch {};
// Build the Authorization request header field value.
const sb_auth = try chilkat.StringBuilder.init();
defer sb_auth.deinit();
// token_type should be "Bearer"
sb_auth.append(try json_token.stringOf(alloc, "token_type")) catch {};
sb_auth.append(" ") catch {};
sb_auth.append(try json_token.stringOf(alloc, "access_token")) catch {};
// Make the initial connection.
// A single REST object, once connected, can be used for many PayPal REST API calls.
// The auto-reconnect indicates that if the already-established HTTPS connection is closed,
// then it will be automatically re-established as needed.
const rest = try chilkat.Rest.init();
defer rest.deinit();
const b_auto_reconnect = true;
rest.connect("api.sandbox.paypal.com", 443, true, b_auto_reconnect) catch {
std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
return;
};
// ----------------------------------------------------------------------------------------------
// The code above this comment could be placed inside a function/subroutine within the application
// because the connection does not need to be made for every request. Once the connection is made
// the app may send many requests..
// ----------------------------------------------------------------------------------------------
// Clear the REST object of any headers or query params from previous requests.
rest.clearAllHeaders() catch {};
rest.clearAllQueryParams() catch {};
rest.addHeader("Authorization", try sb_auth.getAsString(alloc)) catch {};
// To find captured payments, we list payments and look for those
// containing a "capture" resource.
rest.addQueryParam("count", "100") catch {};
rest.addQueryParam("start_index", "0") catch {};
rest.addQueryParam("sort_by", "update_time") catch {};
rest.addQueryParam("sort_order", "asc") catch {};
// Send the GET request and get the JSON response.
const sb_json_response = try chilkat.StringBuilder.init();
defer sb_json_response.deinit();
rest.fullRequestNoBodySb("GET", "/v1/payments/payment", sb_json_response) catch {
std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
return;
};
const json = try chilkat.JsonObject.init();
defer json.deinit();
json.setEmitCompact(false);
json.loadSb(sb_json_response) catch {};
// (optional) Save the entire JSON response to a file to examine if desired..
const sb_temp = try chilkat.StringBuilder.init();
defer sb_temp.deinit();
json.emitSb(sb_temp) catch {};
sb_temp.writeFile("qa_output/paypal_payments.json", "utf-8", false) catch {};
std.debug.print("Response Status Code = {d}\n", .{rest.getResponseStatusCode()});
// Did we get a 200 success response?
if (rest.getResponseStatusCode() != 200) {
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("Failed.\n", .{});
return;
}
// We are looking for "capture" resources .
// As shown below, we are looking in the "transactions" for "related_resources"
// containing "capture" JSON objects.
// {
// "payments": [
// {
// "id": "PAY-2CY489250W145633HLA3DK3Y",
// "create_time": "2016-11-24T00:33:51Z",
// "update_time": "2016-11-24T00:40:54Z",
// "state": "approved",
// "intent": "authorize",
// "payer": {
// "payment_method": "credit_card",
// "funding_instruments": [
// {
// ...
// }
// ]
// },
// "transactions": [
// {
// "amount": {
// ...
// },
// "description": "This is the payment transaction description.",
// "related_resources": [
// {
// "authorization": {
// ...
// }
// },
// {
// "capture": {
// "id": "1LY5310469661362J",
// "create_time": "2016-11-24T00:40:50Z",
// "update_time": "2016-11-24T00:40:54Z",
// "amount": {
// "total": "4.54",
// "currency": "USD"
// },
// "state": "completed",
// "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// "transaction_fee": {
// "value": "0.43",
// "currency": "USD"
// },
// ...
//
// Iterate over the payments and show each capture
const json_capture = try chilkat.JsonObject.init();
defer json_capture.deinit();
const num_payments = json.sizeOfArray("payments");
var i: i32 = 0;
while (i < num_payments) {
json.setI(i);
var j: i32 = 0;
const num_transactions = json.sizeOfArray("payments[i].transactions");
while (j < num_transactions) {
json.setJ(j);
const num_related_resources = json.sizeOfArray("payments[i].transactions[j].related_resources");
var k: i32 = 0;
while (k < num_related_resources) {
json.setK(k);
if (json.hasMember("payments[i].transactions[j].related_resources[k].capture")) {
json.objectOf2("payments[i].transactions[j].related_resources[k].capture", json_capture) catch {};
std.debug.print("capture id: {s}\n", .{try json_capture.stringOf(alloc, "id")});
std.debug.print("state: {s}\n", .{try json_capture.stringOf(alloc, "state")});
std.debug.print("total: {s}\n", .{try json_capture.stringOf(alloc, "amount.total")});
std.debug.print("----\n", .{});
}
k = k + 1;
}
j = j + 1;
}
i = i + 1;
}
std.debug.print("success\n", .{});
}