(Xojo Plugin) PayPal - Show Payment Details

Shows details for a payment by ID.

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

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// 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
Dim success As Boolean
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 payment ID is added to the path.
Dim sbPath As New Chilkat.StringBuilder
success = sbPath.Append("/v1/payments/payment/payment_id")
Dim numReplaced As Int32
numReplaced = sbPath.Replace("payment_id","PAY-2CY489250W145633HLA3DK3Y")

// 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("----------------------")

// 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 Chilkat.DtObj
dtUtc = dateTime.GetDtObj(False)
System.DebugLog(Str(dtUtc.Month) + "/" + Str(dtUtc.Day) + "/" + Str(dtUtc.Year))

System.DebugLog("success")

// ------------------------------------------------
// A sample JSON response:

// 	{ 
// 	  "id": "PAY-2CY489250W145633HLA3DK3Y",
// 	  "create_time": "2016-11-24T00:33:51Z",
// 	  "update_time": "2016-11-24T00:40:54Z",
// 	  "state": "approved",
// 	  "intent": "authorize",
// 	  "payer": { 
// 	    "payment_method": "credit_card",
// 	    "funding_instruments": [
// 	      { 
// 	        "credit_card_token": { 
// 	          "credit_card_id": "CARD-52W84623JH8043102LA3CLGA",
// 	          "payer_id": "user12345",
// 	          "last4": "9974",
// 	          "type": "visa",
// 	          "expire_month": "9",
// 	          "expire_year": "2021"
// 	        }
// 	      }
// 	    ]
// 	  },
// 	  "transactions": [
// 	    { 
// 	      "amount": { 
// 	        "total": "6.70",
// 	        "currency": "USD",
// 	        "details": { 
// 	          "subtotal": "6.70"
// 	        }
// 	      },
// 	      "description": "This is the payment transaction description.",
// 	      "related_resources": [
// 	        { 
// 	          "authorization": { 
// 	            "id": "7X8332687A4929542",
// 	            "create_time": "2016-11-24T00:33:51Z",
// 	            "update_time": "2016-11-24T00:33:58Z",
// 	            "amount": { 
// 	              "total": "6.70",
// 	              "currency": "USD",
// 	              "details": { 
// 	                "subtotal": "6.70"
// 	              }
// 	            },
// 	            "state": "captured",
// 	            "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	            "valid_until": "2016-12-23T00:33:51Z",
// 	            "links": [
// 	              { 
// 	                "href": "https://api.sandbox.paypal.com/v1/payments/authorization/7X8332687A4929542",
// 	                "rel": "self",
// 	                "method": "GET"
// 	              },
// 	              { 
// 	                "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	                "rel": "parent_payment",
// 	                "method": "GET"
// 	              }
// 	            ]
// 	          }
// 	        },
// 	        { 
// 	          "capture": { 
// 	            "id": "1LY5310469661362J",
// 	            "create_time": "2016-11-24T00:40:50Z",
// 	            "update_time": "2016-11-24T00:40:54Z",
// 	            "amount": { 
// 	              "total": "4.54",
// 	              "currency": "USD"
// 	            },
// 	            "state": "completed",
// 	            "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
// 	            "transaction_fee": { 
// 	              "value": "0.43",
// 	              "currency": "USD"
// 	            },
// 	            "links": [
// 	              { 
// 	                "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
// 	                "rel": "self",
// 	                "method": "GET"
// 	              },
// 	              { 
// 	                "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J/refund",
// 	                "rel": "refund",
// 	                "method": "POST"
// 	              },
// 	              { 
// 	                "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	                "rel": "parent_payment",
// 	                "method": "GET"
// 	              }
// 	            ]
// 	          }
// 	        }
// 	      ]
// 	    }
// 	  ],
// 	  "links": [
// 	    { 
// 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
// 	      "rel": "self",
// 	      "method": "GET"
// 	    }
// 	  ]
// 	}