Zig
Zig
PayPal - List Payments
See more PayPal Examples
Lists payments that were created by the create payment call and are in any state. The list shows the payments that are made to the merchant who makes the call.Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat Zig Downloads
const std = @import("std");
const chilkat = @import("chilkat");
pub fn main(init: std.process.Init) !void {
const alloc = init.arena.allocator();
// Note: Requires Chilkat v9.5.0.65 or greater.
// 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 {};
// Add query parameters.
rest.addQueryParam("count", "3") catch {};
rest.addQueryParam("start_index", "0") catch {};
rest.addQueryParam("sort_by", "create_time") catch {};
rest.addQueryParam("sort_order", "desc") 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 {};
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;
}
// Sample JSON response is shown below.
std.debug.print("{s}\n", .{try json.emit(alloc)});
std.debug.print("----------------------\n", .{});
// Iterate over the payments and show some information from each..
const num_payments = json.sizeOfArray("payments");
var i: i32 = 0;
while (i < num_payments) {
json.setI(i);
std.debug.print("id: {s}\n", .{try json.stringOf(alloc, "payments[i].id")});
std.debug.print("state: {s}\n", .{try json.stringOf(alloc, "payments[i].state")});
std.debug.print("intent: {s}\n", .{try json.stringOf(alloc, "payments[i].intent")});
var j: i32 = 0;
const num_transactions = json.sizeOfArray("payments[i].transactions");
while (j < num_transactions) {
json.setJ(j);
std.debug.print("amount: {s}\n", .{try json.stringOf(alloc, "payments[i].transactions[j].amount.total")});
std.debug.print("description: {s}\n", .{try json.stringOf(alloc, "payments[i].transactions[j].description")});
j = j + 1;
}
std.debug.print("----\n", .{});
i = i + 1;
}
std.debug.print("success\n", .{});
// ------------------------------------------------
// A sample JSON response:
// {
// "payments": [
// {
// "id": "PAY-66A12106PU3254228LA3BYKI",
// "create_time": "2016-11-23T22:46:01Z",
// "update_time": "2016-11-23T22:46:07Z",
// "state": "approved",
// "intent": "sale",
// "payer": {
// "payment_method": "credit_card",
// "funding_instruments": [
// {
// "credit_card": {
// "type": "visa",
// "number": "xxxxxxxxxxxx9974",
// "expire_month": "9",
// "expire_year": "2021",
// "first_name": "Joe",
// "last_name": "Buyer"
// }
// }
// ]
// },
// "transactions": [
// {
// "amount": {
// "total": "7.47",
// "currency": "USD",
// "details": {
// "subtotal": "7.47"
// }
// },
// "description": "This is the payment transaction description.",
// "related_resources": [
// {
// "sale": {
// "id": "70L88278E6781074B",
// "create_time": "2016-11-23T22:46:01Z",
// "update_time": "2016-11-23T22:46:07Z",
// "amount": {
// "total": "7.47",
// "currency": "USD"
// },
// "state": "completed",
// "parent_payment": "PAY-66A12106PU3254228LA3BYKI",
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B",
// "rel": "self",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/70L88278E6781074B/refund",
// "rel": "refund",
// "method": "POST"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
// "rel": "parent_payment",
// "method": "GET"
// }
// ]
// }
// }
// ]
// }
// ],
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-66A12106PU3254228LA3BYKI",
// "rel": "self",
// "method": "GET"
// }
// ]
// },
// {
// "id": "PAY-65M1278399433341ALA3B4JY",
// "create_time": "2016-11-23T22:54:31Z",
// "update_time": "2016-11-23T22:54:35Z",
// "state": "approved",
// "intent": "sale",
// "payer": {
// "payment_method": "credit_card",
// "funding_instruments": [
// {
// "credit_card": {
// "type": "visa",
// "number": "xxxxxxxxxxxx9974",
// "expire_month": "9",
// "expire_year": "2021",
// "first_name": "Joe",
// "last_name": "Buyer"
// }
// }
// ]
// },
// "transactions": [
// {
// "amount": {
// "total": "7.47",
// "currency": "USD",
// "details": {
// "subtotal": "7.47"
// }
// },
// "description": "This is the payment transaction description.",
// "related_resources": [
// {
// "sale": {
// "id": "1CP21441CY030683B",
// "create_time": "2016-11-23T22:54:31Z",
// "update_time": "2016-11-23T22:54:35Z",
// "amount": {
// "total": "7.47",
// "currency": "USD"
// },
// "state": "completed",
// "parent_payment": "PAY-65M1278399433341ALA3B4JY",
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B",
// "rel": "self",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/1CP21441CY030683B/refund",
// "rel": "refund",
// "method": "POST"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
// "rel": "parent_payment",
// "method": "GET"
// }
// ]
// }
// }
// ]
// }
// ],
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-65M1278399433341ALA3B4JY",
// "rel": "self",
// "method": "GET"
// }
// ]
// },
// {
// "id": "PAY-12T35751GS725073SLA3CQNQ",
// "create_time": "2016-11-23T23:37:26Z",
// "update_time": "2016-11-23T23:37:31Z",
// "state": "approved",
// "intent": "sale",
// "payer": {
// "payment_method": "credit_card",
// "funding_instruments": [
// {
// "credit_card_token": {
// "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
// "payer_id": "user12345",
// "last4": "9974",
// "type": "visa",
// "expire_month": "9",
// "expire_year": "2021"
// }
// }
// ]
// },
// "transactions": [
// {
// "amount": {
// "total": "6.70",
// "currency": "USD",
// "details": {
// "subtotal": "6.70"
// }
// },
// "description": "This is the payment transaction description.",
// "related_resources": [
// {
// "sale": {
// "id": "4F194018A1618453G",
// "create_time": "2016-11-23T23:37:26Z",
// "update_time": "2016-11-23T23:37:31Z",
// "amount": {
// "total": "6.70",
// "currency": "USD"
// },
// "state": "completed",
// "parent_payment": "PAY-12T35751GS725073SLA3CQNQ",
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G",
// "rel": "self",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/sale/4F194018A1618453G/refund",
// "rel": "refund",
// "method": "POST"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
// "rel": "parent_payment",
// "method": "GET"
// }
// ]
// }
// }
// ]
// }
// ],
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-12T35751GS725073SLA3CQNQ",
// "rel": "self",
// "method": "GET"
// }
// ]
// }
// ],
// "count": 3,
// "next_id": "PAY-2005552565085590VLA3CR5Q"
// }
}