Lianja Requires Chilkat v11.0.0+
Lianja
PayPal - Get Sale Details
See more PayPal Examples
Shows details for a sale transaction, by ID.Chilkat Lianja Downloads
llSuccess = .F.
// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess = .F.) then
? loRest.LastErrorText
release loJsonToken
release loSbAuth
release loRest
return
endif
// ----------------------------------------------------------------------------------------------
// 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.
loRest.ClearAllHeaders()
loRest.ClearAllQueryParams()
loRest.AddHeader("Authorization",loSbAuth.GetAsString())
// The sale ID is added to the path.
// The sale ID is obtained from payment records as shown here: Find Completed Sales
loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/v1/payments/sale/sale_id")
lnNumReplaced = loSbPath.Replace("sale_id","1XC17935MN507400J")
// Send the GET request and get the JSON response.
loSbJsonResponse = createobject("CkStringBuilder")
llSuccess = loRest.FullRequestNoBodySb("GET",loSbPath.GetAsString(),loSbJsonResponse)
if (llSuccess = .F.) then
? loRest.LastErrorText
release loJsonToken
release loSbAuth
release loRest
release loSbPath
release loSbJsonResponse
return
endif
loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.
loJson.LoadSb(loSbJsonResponse)
? "Response Status Code = " + str(loRest.ResponseStatusCode)
// Did we get a 200 success response?
if (loRest.ResponseStatusCode <> 200) then
? loJson.Emit()
? "Failed."
release loJsonToken
release loSbAuth
release loRest
release loSbPath
release loSbJsonResponse
release loJson
return
endif
// Sample JSON response is shown below.
? loJson.Emit()
? "----------------------"
// Show how to get a timestamp, such as update_time.
loDateTime = createobject("CkDateTime")
llSuccess = loDateTime.SetFromTimestamp(loJson.StringOf("update_time"))
? "utc update_time: " + loDateTime.GetAsTimestamp(.F.)
? "local update_time: " + loDateTime.GetAsTimestamp(.T.)
? "utc rfc822: " + loDateTime.GetAsRfc822(.F.)
? "local rfc822: " + loDateTime.GetAsRfc822(.T.)
loDtUtc = createobject("CkDtObj")
loDateTime.ToDtObj(.F.,loDtUtc)
? str(loDtUtc.Month) + "/" + str(loDtUtc.Day) + "/" + str(loDtUtc.Year)
? "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"
// }
// ]
// }
release loJsonToken
release loSbAuth
release loRest
release loSbPath
release loSbJsonResponse
release loJson
release loDateTime
release loDtUtc