(Excel) PayPal - Show Payment Details

Shows details for a payment 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 payment ID is added to the path.
Dim sbPath As Chilkat.StringBuilder
Set sbPath = Chilkat.NewStringBuilder
success = sbPath.Append("/v1/payments/payment/payment_id")

numReplaced = sbPath.Replace("payment_id","PAY-2CY489250W145633HLA3DK3Y")

' 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": "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"
' 	    }
' 	  ]
' 	}