PowerBuilder

PayPal - Get Refund Details

See more PayPal Examples

Shows details for a refund, by ID.

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

PowerBuilder

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

li_Success = 0

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

//  Clear the REST object of any headers or query params from previous requests.
loo_Rest.ClearAllHeaders()
loo_Rest.ClearAllQueryParams()

loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())

//  The refund ID is added to the path.
//  To list your refunds, Find Completed Sales. 
//  Refunds in the list have a sale object with a state of "refunded" and a refund object with a state of "completed".
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("/v1/payments/refund/refund_id")
li_NumReplaced = loo_SbPath.Replace("refund_id","7NE550583A133505U")

//  Send the GET request and get the JSON response.
loo_SbJsonResponse = create oleobject
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Rest.FullRequestNoBodySb("GET",loo_SbPath.GetAsString(),loo_SbJsonResponse)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_SbPath
    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 200 success response?
if loo_Rest.ResponseStatusCode <> 200 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_JsonToken
    destroy loo_SbAuth
    destroy loo_Rest
    destroy loo_SbPath
    destroy loo_SbJsonResponse
    destroy loo_Json
    return
end if

//  Sample JSON response is shown below.
Write-Debug loo_Json.Emit()
Write-Debug "----------------------"

Write-Debug "success"

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

//  	{ 
//  	  "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_SbPath
destroy loo_SbJsonResponse
destroy loo_Json