Xojo Plugin Requires Chilkat v11.0.0+

PayPal - Get Sale Details

See more PayPal Examples

Shows details for a sale transaction, by ID. Xojo Plugin

Dim success As Boolean
success = False

//  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 = False) 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 sale ID is added to the path.
//  The sale ID is obtained from payment records as shown here: Find Completed Sales
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/payments/sale/sale_id")
Dim numReplaced As Int32
numReplaced = sbPath.Replace("sale_id","1XC17935MN507400J")

//  Send the GET request and get the JSON response.
Dim sbJsonResponse As New Chilkat.StringBuilder
success = rest.FullRequestNoBodySb("GET",sbPath.GetAsString(),sbJsonResponse)
If (success = False) 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("----------------------")

//  Show how to get a timestamp, such as update_time.
Dim dateTime As New Chilkat.CkDateTime
success = dateTime.SetFromTimestamp(json.StringOf("update_time"))
System.DebugLog("utc update_time: " + dateTime.GetAsTimestamp(False))
System.DebugLog("local update_time: " + dateTime.GetAsTimestamp(True))
System.DebugLog("utc rfc822: " + dateTime.GetAsRfc822(False))
System.DebugLog("local rfc822: " + dateTime.GetAsRfc822(True))

Dim dtUtc As New Chilkat.DtObj
dateTime.ToDtObj False,dtUtc

System.DebugLog(Str(dtUtc.Month) + "/" + Str(dtUtc.Day) + "/" + Str(dtUtc.Year))

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