Objective-C

PayPal - Get Sale Details

See more PayPal Examples

Shows details for a sale transaction, by ID. Objective-C

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

BOOL success = NO;

//  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;
success = [rest Connect: @"api.sandbox.paypal.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success == NO) {
    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]];

//  The sale ID is added to the path.
//  The sale ID is obtained from payment records as shown here: Find Completed Sales
CkoStringBuilder *sbPath = [[CkoStringBuilder alloc] init];
[sbPath Append: @"/v1/payments/sale/sale_id"];
int numReplaced = [[sbPath Replace: @"sale_id" replacement: @"1XC17935MN507400J"] intValue];

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

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

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;
}

//  Sample JSON response is shown below.
NSLog(@"%@",[json Emit]);
NSLog(@"%@",@"----------------------");

//  Show how to get a timestamp, such as update_time.
CkoDateTime *dateTime = [[CkoDateTime alloc] init];
success = [dateTime SetFromTimestamp: [json StringOf: @"update_time"]];
NSLog(@"%@%@",@"utc update_time: ",[dateTime GetAsTimestamp: NO]);
NSLog(@"%@%@",@"local update_time: ",[dateTime GetAsTimestamp: YES]);
NSLog(@"%@%@",@"utc rfc822: ",[dateTime GetAsRfc822: NO]);
NSLog(@"%@%@",@"local rfc822: ",[dateTime GetAsRfc822: YES]);

CkoDtObj *dtUtc = [[CkoDtObj alloc] init];
[dateTime ToDtObj: NO dtObj: dtUtc];

NSLog(@"%d%@%d%@%d",[dtUtc.Month intValue],@"/",[dtUtc.Day intValue],@"/",[dtUtc.Year intValue]);

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

//  ------------------------------------------------
//  A sample JSON response:

//  	{ 
//  	  "id": "1XC17935MN507400J",
//  	  "create_time": "2016-11-25T15:42:50Z",
//  	  "update_time": "2016-11-25T15:42:56Z",
//  	  "amount": { 
//  	    "total": "289.00",
//  	    "currency": "USD"
//  	  },
//  	  "payment_mode": "INSTANT_TRANSFER",
//  	  "state": "completed",
//  	  "protection_eligibility": "ELIGIBLE",
//  	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
//  	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
//  	  "transaction_fee": { 
//  	    "value": "8.68",
//  	    "currency": "USD"
//  	  },
//  	  "links": [
//  	    { 
//  	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
//  	      "rel": "self",
//  	      "method": "GET"
//  	    },
//  	    { 
//  	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
//  	      "rel": "refund",
//  	      "method": "POST"
//  	    },
//  	    { 
//  	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
//  	      "rel": "parent_payment",
//  	      "method": "GET"
//  	    }
//  	  ]
//  	}