PureBasic
PureBasic
PayPal - Show Payment Details
See more PayPal Examples
Shows details for a payment by ID.Chilkat PureBasic Downloads
IncludeFile "CkDtObj.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkDateTime.pb"
Procedure ChilkatExample()
success.i = 0
; 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)
jsonToken.i = CkJsonObject::ckCreate()
If jsonToken.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/paypal.json")
; Build the Authorization request header field value.
sbAuth.i = CkStringBuilder::ckCreate()
If sbAuth.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
; token_type should be "Bearer"
CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"token_type"))
CkStringBuilder::ckAppend(sbAuth," ")
CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"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.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
bAutoReconnect.i = 1
success = CkRest::ckConnect(rest,"api.sandbox.paypal.com",443,1,bAutoReconnect)
If success = 0
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
ProcedureReturn
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.
CkRest::ckClearAllHeaders(rest)
CkRest::ckClearAllQueryParams(rest)
CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
; The payment ID is added to the path.
sbPath.i = CkStringBuilder::ckCreate()
If sbPath.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbPath,"/v1/payments/payment/payment_id")
numReplaced.i = CkStringBuilder::ckReplace(sbPath,"payment_id","PAY-62106714J93631829LA44NWI")
; Send the GET request and get the JSON response.
sbJsonResponse.i = CkStringBuilder::ckCreate()
If sbJsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestNoBodySb(rest,"GET",CkStringBuilder::ckGetAsString(sbPath),sbJsonResponse)
If success = 0
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckLoadSb(json,sbJsonResponse)
Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))
; Did we get a 200 success response?
If CkRest::ckResponseStatusCode(rest) <> 200
Debug CkJsonObject::ckEmit(json)
Debug "Failed."
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonResponse)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
; Sample JSON response is shown below.
Debug CkJsonObject::ckEmit(json)
Debug "----------------------"
; Show how to get a timestamp, such as update_time.
dateTime.i = CkDateTime::ckCreate()
If dateTime.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkDateTime::ckSetFromTimestamp(dateTime,CkJsonObject::ckStringOf(json,"update_time"))
Debug "utc update_time: " + CkDateTime::ckGetAsTimestamp(dateTime,0)
Debug "local update_time: " + CkDateTime::ckGetAsTimestamp(dateTime,1)
Debug "utc rfc822: " + CkDateTime::ckGetAsRfc822(dateTime,0)
Debug "local rfc822: " + CkDateTime::ckGetAsRfc822(dateTime,1)
dtUtc.i = CkDtObj::ckCreate()
If dtUtc.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkDateTime::ckToDtObj(dateTime,0,dtUtc)
Debug Str(CkDtObj::ckMonth(dtUtc)) + "/" + Str(CkDtObj::ckDay(dtUtc)) + "/" + Str(CkDtObj::ckYear(dtUtc))
Debug "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"
; }
; ]
; }
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonResponse)
CkJsonObject::ckDispose(json)
CkDateTime::ckDispose(dateTime)
CkDtObj::ckDispose(dtUtc)
ProcedureReturn
EndProcedure