(Objective-C) PayPal - Find Completed Sales

List payments and find completed payments (sales transactions). Get the sales id, state, and total amount for each.

Note: This example requires Chilkat v9.5.0.65 or greater.

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <CkoRest.h>

// 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)
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
[jsonToken LoadFile: @"qa_data/tokens/paypal.json"];

// Build the Authorization request header field value.
CkoStringBuilder *sbAuth = [[CkoStringBuilder alloc] init];
// token_type should be "Bearer"
[sbAuth Append: [jsonToken StringOf: @"token_type"]];
[sbAuth Append: @" "];
[sbAuth Append: [jsonToken StringOf: @"access_token"]];

// 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.
CkoRest *rest = [[CkoRest alloc] init];
BOOL bAutoReconnect = YES;
BOOL success = [rest Connect: @"api.sandbox.paypal.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    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];
[rest ClearAllQueryParams];

[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];

// To find sales transactions, we list payments and look for those
// containing "sale" transactions
[rest AddQueryParam: @"count" value: @"100"];
[rest AddQueryParam: @"start_index" value: @"0"];
[rest AddQueryParam: @"sort_by" value: @"update_time"];
[rest AddQueryParam: @"sort_order" value: @"asc"];

// Send the GET request and get the JSON response.
CkoStringBuilder *sbJsonResponse = [[CkoStringBuilder alloc] init];
success = [rest FullRequestNoBodySb: @"GET" uriPath: @"/v1/payments/payment" sb: sbJsonResponse];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[json LoadSb: sbJsonResponse];

// (optional) Save the entire JSON response to a file to examine if desired..
CkoStringBuilder *sbTemp = [[CkoStringBuilder alloc] init];
[json EmitSb: sbTemp];
[sbTemp WriteFile: @"qa_output/paypal_payments.json" charset: @"utf-8" emitBom: NO];

NSLog(@"%@%d",@"Response Status Code = ",[rest.ResponseStatusCode intValue]);

// Did we get a 200 success response?
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
    return;
}

// We are looking for sales transactions .
// As shown below, we are looking in the "transactions" for "related_resources"
// containing "sale" JSON objects. 

// 	{ 
// 	  "payments": [
// 	    { 
// 	      "id": "PAY-66A12106PU3254228LA3BYKI",
// 	      "create_time": "2016-11-23T22:46:01Z",
// 	      "update_time": "2016-11-23T22:46:07Z",
// 	      "state": "approved",
// 	      "intent": "sale",
// 	      "payer": { 
// 	          ...
// 	          }
// 	        ]
// 	      },
// 	      "transactions": [
// 	        { 
// 	          ...
// 	          "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",

// Iterate over the payments and show each sale transaction.
int numPayments = [[json SizeOfArray: @"payments"] intValue];
int i = 0;
while (i < numPayments) {

    json.I = [NSNumber numberWithInt: i];
    int j = 0;
    int numTransactions = [[json SizeOfArray: @"payments[i].transactions"] intValue];
    while (j < numTransactions) {
        json.J = [NSNumber numberWithInt: j];
        int numRelatedResources = [[json SizeOfArray: @"payments[i].transactions[j].related_resources"] intValue];
        int k = 0;
        while (k < numRelatedResources) {
            json.K = [NSNumber numberWithInt: k];
            if ([json HasMember: @"payments[i].transactions[j].related_resources[k].sale"] == YES) {
                CkoJsonObject *jsonSale = [json ObjectOf: @"payments[i].transactions[j].related_resources[k].sale"];
                NSLog(@"%@%@",@"sale id: ",[jsonSale StringOf: @"id"]);
                NSLog(@"%@%@",@"state: ",[jsonSale StringOf: @"state"]);
                NSLog(@"%@%@",@"total: ",[jsonSale StringOf: @"amount.total"]);
                NSLog(@"%@",@"----");

            }

            k = k + 1;
        }

        j = j + 1;
    }

    i = i + 1;
}

NSLog(@"%@",@"success");