Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Objective-C Web API Examples

Primary Categories

ABN AMRO
AWS Secrets Manager
AWS Security Token Service
AWS Translate
Activix CRM
Adyen
Alibaba Cloud OSS
Amazon Cognito
Amazon DynamoDB
Amazon MWS
Amazon Pay
Amazon Rekognition
Amazon SP-API
Amazon Voice ID
Aruba Fatturazione
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Backblaze S3
Banco Inter
Belgian eHealth Platform
Bitfinex v2 REST
Bluzone
BrickLink
Bunny CDN
CallRail
CardConnect
Cerved
ClickBank
Clickatell
Cloudfare
Constant Contact
DocuSign
Duo Auth MFA
ETrade
Ecwid
Egypt ITIDA
Egypt eReceipt
Etsy
Facebook
Faire
Frame.io
GeoOp
GetHarvest
Global Payments
Google People
Google Search Console
Google Translate
Hungary NAV Invoicing
IBM Text to Speech
Ibanity
IntakeQ
Jira
Lightspeed
MYOB
Magento
Mailgun
Mastercard

MedTunnel
MercadoLibre
MessageMedia
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Microsoft Teams
Moody's
Okta OAuth/OIDC
OneLogin OIDC
OneNote
OpenAI ChatGPT
PRODA
PayPal
Paynow.pl
Peoplevox
Populi
QuickBooks
Rabobank
Refinitiv
Royal Mail OBA
SCiS Schools Catalogue
SII Chile
SMSAPI
SOAP finkok.com
SendGrid
Shippo
Shopify
Shopware
Shopware 6
SimpleTexting
Square
Stripe
SugarCRM
TicketBAI
Trello
Twilio
Twitter API v2
Twitter v1
UPS
UniPin
VoiceBase
Vonage
WaTrend
Walmart v3
Wasabi
WhatsApp
WiX
WooCommerce
WordPress
Xero
Yahoo Mail
Yapily
Yousign
ZATCA
Zendesk
Zoom
_Miscellaneous_
eBay
effectconnect
hacienda.go.cr

 

 

 

(Objective-C) PayPal - Refund Sale

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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.64 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..
// ----------------------------------------------------------------------------------------------

// To refund a particular amount, build JSON such as this:
CkoJsonObject *jsonPartial = [[CkoJsonObject alloc] init];
jsonPartial.EmitCompact = NO;
[jsonPartial UpdateString: @"amount.total" value: @"2.34"];
[jsonPartial UpdateString: @"amount.currency" value: @"USD"];
// invoice_number is optional..
[jsonPartial UpdateString: @"invoice_number" value: @"INV-1234567"];
NSLog(@"%@",[jsonPartial Emit]);

// The JSON for a partial refund:

// 	{ 
// 	  "amount": { 
// 	    "total": "2.34",
// 	    "currency": "USD"
// 	  },
// 	  "invoice_number": "INV-1234567"
// 	}

[rest AddHeader: @"Authorization" value: [sbAuth GetAsString]];
[rest AddHeader: @"Content-Type" value: @"application/json"];

// 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/refund"];
int numReplaced = [[sbPath Replace: @"sale_id" replacement: @"1XC17935MN507400J"] intValue];

// Send the POST request containign the JSON in the request body, and get the JSON response.
CkoStringBuilder *sbJsonRequest = [[CkoStringBuilder alloc] init];
jsonPartial.EmitCompact = YES;
[jsonPartial EmitSb: sbJsonRequest];
CkoStringBuilder *sbJsonResponse = [[CkoStringBuilder alloc] init];

BOOL bFullRefund = YES;
// To send a full refund, send an empty request body:
if (bFullRefund == YES) {
    [sbJsonRequest Clear];
    [sbJsonRequest Append: @"{}"];
}

success = [rest FullRequestSb: @"POST" uriPath: [sbPath GetAsString] requestBody: sbJsonRequest responseBody: sbJsonResponse];
if (success != YES) {
    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 201 success response?
if ([rest.ResponseStatusCode intValue] != 201) {
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed.");
    return;
}

NSLog(@"%@",[json Emit]);
NSLog(@"%@",@"Success.");

// A successful JSON response:
// The "id" is the refund_id.

// 	{ 
// 	  "id": "7NE550583A133505U",
// 	  "create_time": "2016-11-26T16:38:27Z",
// 	  "update_time": "2016-11-26T16:38:27Z",
// 	  "state": "completed",
// 	  "amount": { 
// 	    "total": "289.00",
// 	    "currency": "USD"
// 	  },
// 	  "sale_id": "1XC17935MN507400J",
// 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
// 	      "rel": "sale",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}
 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.