PowerBuilder
PowerBuilder
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 PowerBuilder Downloads
integer li_rc
integer li_Success
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbPath
integer li_NumReplacements
oleobject loo_SbJsonRequest
oleobject loo_SbJsonResponse
li_Success = 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)
loo_JsonToken = create oleobject
li_rc = loo_JsonToken.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
destroy loo_JsonToken
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_JsonToken.LoadFile("qa_data/tokens/paypal.json")
// Build the Authorization request header field value.
loo_SbAuth = create oleobject
li_rc = loo_SbAuth.ConnectToNewObject("Chilkat.StringBuilder")
// token_type should be "Bearer"
loo_SbAuth.Append(loo_JsonToken.StringOf("token_type"))
loo_SbAuth.Append(" ")
loo_SbAuth.Append(loo_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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("api.sandbox.paypal.com",443,1,li_BAutoReconnect)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
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..
// ----------------------------------------------------------------------------------------------
// Build the JSON containing the transaction information.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
loo_Json.EmitCompact = 0
loo_Json.UpdateString("amount.currency","USD")
loo_Json.UpdateString("amount.total","4.54")
loo_Json.UpdateBool("is_final_capture",1)
Write-Debug loo_Json.Emit()
// The JSON created by the above code:
// {
// "amount": {
// "currency": "USD",
// "total": "4.54"
// },
// "is_final_capture": true
// }
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Rest.AddHeader("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.
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")
loo_SbPath.Append("/v1/payments/authorization/[authorization_id]/capture")
li_NumReplacements = loo_SbPath.Replace("[authorization_id]","7X8332687A4929542")
// Send the POST request containign the JSON in the request body, and get the JSON response.
loo_SbJsonRequest = create oleobject
li_rc = loo_SbJsonRequest.ConnectToNewObject("Chilkat.StringBuilder")
loo_Json.EmitCompact = 1
loo_Json.EmitSb(loo_SbJsonRequest)
loo_SbJsonResponse = create oleobject
li_rc = loo_SbJsonResponse.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Rest.FullRequestSb("POST",loo_SbPath.GetAsString(),loo_SbJsonRequest,loo_SbJsonResponse)
if li_Success <> 1 then
Write-Debug loo_Rest.LastErrorText
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbPath
destroy loo_SbJsonRequest
destroy loo_SbJsonResponse
return
end if
loo_Json.EmitCompact = 0
loo_Json.LoadSb(loo_SbJsonResponse)
Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)
// 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 loo_Rest.ResponseStatusCode <> 200 then
Write-Debug loo_Json.Emit()
Write-Debug "Failed."
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbPath
destroy loo_SbJsonRequest
destroy loo_SbJsonResponse
return
end if
// Sample JSON response is shown below.
Write-Debug loo_Json.Emit()
Write-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"
// }
// ]
//
destroy loo_JsonToken
destroy loo_SbAuth
destroy loo_Rest
destroy loo_Json
destroy loo_SbPath
destroy loo_SbJsonRequest
destroy loo_SbJsonResponse