PowerBuilder

PayPal - Refund Sale

See more PayPal Examples

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.

PowerBuilder

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

li_Success = 0

// 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.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.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.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_JsonPartial = create oleobject
li_rc = loo_JsonPartial.ConnectToNewObject("Chilkat.JsonObject")

loo_JsonPartial.EmitCompact = 0
loo_JsonPartial.UpdateString("amount.total","2.34")
loo_JsonPartial.UpdateString("amount.currency","USD")
// invoice_number is optional..
loo_JsonPartial.UpdateString("invoice_number","INV-1234567")
Write-Debug loo_JsonPartial.Emit()

// The JSON for a partial refund:

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

loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Rest.AddHeader("Content-Type","application/json")

// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("/v1/payments/sale/sale_id/refund")
li_NumReplaced = loo_SbPath.Replace("sale_id","1XC17935MN507400J")

// 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.StringBuilder")

loo_JsonPartial.EmitCompact = 1
loo_JsonPartial.EmitSb(loo_SbJsonRequest)
loo_SbJsonResponse = create oleobject
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat.StringBuilder")

li_BFullRefund = 1
// To send a full refund, send an empty request body:
if li_BFullRefund = 1 then
    loo_SbJsonRequest.Clear()
    loo_SbJsonRequest.Append("{}")
end if

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_JsonPartial
    destroy loo_SbPath
    destroy loo_SbJsonRequest
    destroy loo_SbJsonResponse
    return
end if

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

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_JsonPartial
    destroy loo_SbPath
    destroy loo_SbJsonRequest
    destroy loo_SbJsonResponse
    destroy loo_Json
    return
end if

Write-Debug loo_Json.Emit()
Write-Debug "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"
// 	    }
// 	  ]
// 	}


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