PureBasic
PureBasic
PayPal - Capture a Previously Authorized Payment
See more PayPal Examples
Captures a previously authorized payment.
Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat PureBasic Downloads
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"
Procedure ChilkatExample()
success.i = 0
; 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)
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 <> 1
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..
; ----------------------------------------------------------------------------------------------
; Build the JSON containing the transaction information.
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckUpdateString(json,"amount.currency","USD")
CkJsonObject::ckUpdateString(json,"amount.total","4.54")
CkJsonObject::ckUpdateBool(json,"is_final_capture",1)
Debug CkJsonObject::ckEmit(json)
; The JSON created by the above code:
; {
; "amount": {
; "currency": "USD",
; "total": "4.54"
; },
; "is_final_capture": true
; }
CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
CkRest::ckAddHeader(rest,"Content-Type","application/json")
; To capture payment, make a call to /v1/payments/authorization/[authorization_id]/capture with the authorization ID in the URI.
; See PayPal Authorize Payment for sample code to create the authorization.
; The "7X8332687A4929542" comes from the "transactions[0].related_resources[0].authorization.id" part of the authorization response.
sbPath.i = CkStringBuilder::ckCreate()
If sbPath.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkStringBuilder::ckAppend(sbPath,"/v1/payments/authorization/[authorization_id]/capture")
numReplacements.i = CkStringBuilder::ckReplace(sbPath,"[authorization_id]","7X8332687A4929542")
; Send the POST request containign the JSON in the request body, and get the JSON response.
sbJsonRequest.i = CkStringBuilder::ckCreate()
If sbJsonRequest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 1)
CkJsonObject::ckEmitSb(json,sbJsonRequest)
sbJsonResponse.i = CkStringBuilder::ckCreate()
If sbJsonResponse.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST",CkStringBuilder::ckGetAsString(sbPath),sbJsonRequest,sbJsonResponse)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
CkJsonObject::setCkEmitCompact(json, 0)
CkJsonObject::ckLoadSb(json,sbJsonResponse)
Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))
; IMPORTANT: In most PayPal examples, the return status code is 201.
; For this particular call, PayPal returns status code 200.
; 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)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndIf
; Sample JSON response is shown below.
Debug CkJsonObject::ckEmit(json)
Debug "success"
; ------------------------------------------------
; A sample JSON response:
; {
; "id": "1LY5310469661362J",
; "create_time": "2016-11-24T00:40:50Z",
; "update_time": "2016-11-24T00:40:54Z",
; "amount": {
; "total": "4.54",
; "currency": "USD"
; },
; "is_final_capture": true,
; "state": "completed",
; "reasonCode": "None",
; "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/authorization/7X8332687A4929542",
; "rel": "authorization",
; "method": "GET"
; },
; {
; "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
; "rel": "parent_payment",
; "method": "GET"
; }
; ]
;
CkJsonObject::ckDispose(jsonToken)
CkStringBuilder::ckDispose(sbAuth)
CkRest::ckDispose(rest)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbPath)
CkStringBuilder::ckDispose(sbJsonRequest)
CkStringBuilder::ckDispose(sbJsonResponse)
ProcedureReturn
EndProcedure