B4X Requires Chilkat v11.0.0+
B4X
PayPal - Get Sale Details
See more PayPal Examples
Shows details for a sale transaction, by ID.Chilkat B4X Downloads
Dim success As Boolean = 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 ChilkatJsonObject
jsonToken.Initialize
jsonToken.LoadFile("qa_data/tokens/paypal.json")
' Build the Authorization request header field value.
Dim sbAuth As ChilkatStringBuilder
sbAuth.Initialize
' token_type should be "Bearer"
sbAuth.Append(jsonToken.StringOf("token_type"))
sbAuth.Append(" ")
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 ChilkatRest
rest.Initialize("rest")
Dim bAutoReconnect As Boolean = True
success = rest.Connect("api.sandbox.paypal.com", 443, True, bAutoReconnect)
If success = False Then
Log(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.
rest.ClearAllHeaders
rest.ClearAllQueryParams
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 ChilkatStringBuilder
sbPath.Initialize
sbPath.Append("/v1/payments/sale/sale_id")
Dim numReplaced As Int = sbPath.Replace("sale_id", "1XC17935MN507400J")
' Send the GET request and get the JSON response.
Dim sbJsonResponse As ChilkatStringBuilder
sbJsonResponse.Initialize
success = rest.FullRequestNoBodySb("GET", sbPath.GetAsString, sbJsonResponse)
If success = False Then
Log(rest.LastErrorText)
Return
End If
Dim json As ChilkatJsonObject
json.Initialize
json.EmitCompact = False
json.LoadSb(sbJsonResponse)
Log("Response Status Code = " & rest.ResponseStatusCode)
' Did we get a 200 success response?
If rest.ResponseStatusCode <> 200 Then
Log(json.Emit)
Log("Failed.")
Return
End If
' Sample JSON response is shown below.
Log(json.Emit)
Log("----------------------")
' Show how to get a timestamp, such as update_time.
Dim dateTime As ChilkatDateTime
dateTime.Initialize
success = dateTime.SetFromTimestamp(json.StringOf("update_time"))
Log("utc update_time: " & dateTime.GetAsTimestamp(False))
Log("local update_time: " & dateTime.GetAsTimestamp(True))
Log("utc rfc822: " & dateTime.GetAsRfc822(False))
Log("local rfc822: " & dateTime.GetAsRfc822(True))
Dim dtUtc As ChilkatDtObj
dtUtc.Initialize
dateTime.ToDtObj(False, dtUtc)
Log(dtUtc.Month & "/" & dtUtc.Day & "/" & dtUtc.Year)
Log("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"
' }
' ]
' }