(Excel) PayPal - Get Sale Details

Shows details for a sale transaction, by ID.

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

Download Excel Class Modules Chilkat Excel Class Modules

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

' Build the Authorization request header field value.
Dim sbAuth As Chilkat.StringBuilder
Set sbAuth = Chilkat.NewStringBuilder
' 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 Chilkat.Rest
Set rest = Chilkat.NewRest

bAutoReconnect = True

success = rest.Connect("api.sandbox.paypal.com",443,True,bAutoReconnect)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
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 sale ID is added to the path.
' The sale ID is obtained from payment records as shown here: Find Completed Sales
Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/v1/payments/sale/sale_id")

numReplaced = sbPath.Replace("sale_id","1XC17935MN507400J")

' Send the GET request and get the JSON response.
Dim sbJsonResponse As Chilkat.StringBuilder
Set sbJsonResponse = Chilkat.NewStringBuilder
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse)
If (success <> True) Then
    Debug.Print rest.LastErrorText
    Exit Sub
End If

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

Debug.Print "Response Status Code = "; rest.ResponseStatusCode

' Did we get a 200 success response?
If (rest.ResponseStatusCode <> 200) Then
    Debug.Print json.Emit()
    Debug.Print "Failed."
    Exit Sub
End If

' Sample JSON response is shown below.
Debug.Print json.Emit()
Debug.Print "----------------------"

' Show how to get a timestamp, such as update_time.
Dim dateTime As Chilkat.CkDateTime
Set dateTime = Chilkat.NewCkDateTime
success = dateTime.SetFromTimestamp(json.StringOf("update_time"))
Debug.Print "utc update_time: "; dateTime.GetAsTimestamp(False)
Debug.Print "local update_time: "; dateTime.GetAsTimestamp(True)
Debug.Print "utc rfc822: "; dateTime.GetAsRfc822(False)
Debug.Print "local rfc822: "; dateTime.GetAsRfc822(True)


Set dtUtc = dateTime.GetDtObj(False)
Debug.Print dtUtc.Month; "/"; dtUtc.Day; "/"; dtUtc.Year

Debug.Print "success"

' ------------------------------------------------
' A sample JSON response:

' 	{ 
' 	  "id": "1XC17935MN507400J",
' 	  "create_time": "2016-11-25T15:42:50Z",
' 	  "update_time": "2016-11-25T15:42:56Z",
' 	  "amount": { 
' 	    "total": "289.00",
' 	    "currency": "USD"
' 	  },
' 	  "payment_mode": "INSTANT_TRANSFER",
' 	  "state": "completed",
' 	  "protection_eligibility": "ELIGIBLE",
' 	  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE,UNAUTHORIZED_PAYMENT_ELIGIBLE",
' 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
' 	  "transaction_fee": { 
' 	    "value": "8.68",
' 	    "currency": "USD"
' 	  },
' 	  "links": [
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
' 	      "rel": "self",
' 	      "method": "GET"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J/refund",
' 	      "rel": "refund",
' 	      "method": "POST"
' 	    },
' 	    { 
' 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
' 	      "rel": "parent_payment",
' 	      "method": "GET"
' 	    }
' 	  ]
' 	}