Xojo Plugin

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.

Xojo Plugin

Dim success As Boolean
success = False

// 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)
Dim jsonToken As New Chilkat.JsonObject
success = jsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
Dim sbAuth As New Chilkat.StringBuilder
// token_type should be "Bearer"
success = sbAuth.Append(jsonToken.StringOf("token_type"))
success = sbAuth.Append(" ")
success = 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.
Dim rest As New Chilkat.Rest
Dim bAutoReconnect As Boolean
bAutoReconnect = True
success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    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.
success = rest.ClearAllHeaders()
success = rest.ClearAllQueryParams()

success = rest.AddHeader("Authorization",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".
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/payments/refund/refund_id")
Dim numReplaced As Int32
numReplaced = sbPath.Replace("refund_id","7NE550583A133505U")

// Send the GET request and get the JSON response.
Dim sbJsonResponse As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse)
If (success <> True) Then
    System.DebugLog(rest.LastErrorText)
    Return
End If

Dim json As New Chilkat.JsonObject
json.EmitCompact = False
success = json.LoadSb(sbJsonResponse)

System.DebugLog("Response Status Code = " + Str(rest.ResponseStatusCode))

// Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

// Sample JSON response is shown below.
System.DebugLog(json.Emit())
System.DebugLog("----------------------")

System.DebugLog("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"
// 	    }
// 	  ]
// 	}