Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PowerBuilder Web API Examples

Primary Categories

AWS Translate
Activix CRM
Adyen
Amazon MWS
Azure Maps
Azure Monitor
Azure OAuth2
Azure Storage Accounts
Bluzone
CardConnect
ClickBank
Clickatell
Cloudfare
DocuSign
ETrade
Etsy
Facebook
GeoOp
GetHarvest
Jira
MYOB

Magento
Microsoft Calendar
Microsoft Group
Microsoft Tasks and Plans
Okta OAuth/OIDC
OneLogin OIDC
PayPal
Peoplevox
Populi
QuickBooks
SOAP finkok.com
Shippo
Shopify
Stripe
SugarCRM
Trello
Twitter
VoiceBase
Vonage
Walmart
Walmart v3
Xero
eBay
effectconnect

 

 

 

(PowerBuilder) PayPal - Refund Captured Payment

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

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

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
integer li_Success
oleobject loo_Json
oleobject loo_SbPath
integer li_NumReplaced
oleobject loo_SbJsonRequest
oleobject loo_SbJsonResponse

// 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)
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
if li_rc < 0 then
    destroy loo_JsonToken
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat_9_5_0.Rest")

li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    return
end if

// ----------------------------------------------------------------------------------------------
// 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:
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_Json.EmitCompact = 0
loo_Json.UpdateString("amount.total","4.54")
loo_Json.UpdateString("amount.currency","USD")
loo_Json.UpdateString("description","Athletic socks")
loo_Json.UpdateString("reason","Refunding because color was incorrect")
Write-Debug loo_Json.Emit()

// The JSON:

// 	{ 
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "description": "Athletic socks",
// 	  "reason": "Refunding because color was incorrect"
// 	}
// 
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Rest.AddHeader("Content-Type","application/json")

// The capture ID is added to the path.
// To list your captures: Find Captures. 
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_SbPath.Append("/v1/payments/capture/capture_id/refund")
li_NumReplaced = loo_SbPath.Replace("capture_id","1LY5310469661362J")

// Send the POST request containign the JSON in the request body, and get the JSON response.
loo_SbJsonRequest = create oleobject
li_rc = loo_SbJsonRequest.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_Json.EmitCompact = 1
loo_Json.EmitSb(loo_SbJsonRequest)
loo_SbJsonResponse = create oleobject
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

li_Success = loo_Rest.FullRequestSb("POST",loo_SbPath.GetAsString(),loo_SbJsonRequest,loo_SbJsonResponse)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_SbJsonRequest
    destroy loo_SbJsonResponse
    return
end if

loo_Json.EmitCompact = 0
loo_Json.LoadSb(loo_SbJsonResponse)

Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)

// Did we get a 201 success response?
if loo_Rest.ResponseStatusCode <> 201 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_SbJsonRequest
    destroy loo_SbJsonResponse
    return
end if

Write-Debug loo_Json.Emit()
Write-Debug "Success."

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

// 	{ 
// 	  "id": "77B77607RR7243500",
// 	  "create_time": "2016-11-27T01:38:25Z",
// 	  "update_time": "2016-11-27T01:38:25Z",
// 	  "state": "completed",
// 	  "amount": { 
// 	    "total": "4.54",
// 	    "currency": "USD"
// 	  },
// 	  "capture_id": "1LY5310469661362J",
// 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	      "rel": "parent_payment",
// 	      "method": "GET"
// 	    },
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
// 	      "rel": "capture",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}


destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbPath
destroy loo_SbJsonRequest
destroy loo_SbJsonResponse

 

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