PowerBuilder
PowerBuilder
PayPal - Capture Authorization
See more PayPal Examples
Capture and process a previously created authorization. The original payment call must have the intent set to authorize.Note: This example requires Chilkat v9.5.0.65 or greater.
Chilkat PowerBuilder Downloads
integer li_rc
long li_Success
oleobject loo_JsonToken
oleobject loo_SbAuth
oleobject loo_Rest
long li_BAutoReconnect
oleobject loo_Json
oleobject loo_SbPath
long li_NumReplaced
oleobject loo_SbJsonRequest
oleobject loo_SbJsonResponse
li_Success = 0
// Note: Requires Chilkat v9.5.0.64 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..
// ----------------------------------------------------------------------------------------------
// To capture a particular amount, build JSON such as this:
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","6.70")
// is_final_capture is optional and indicates whether to release all remaining funds that the authorization holds in the funding instrument.
loo_Json.UpdateBool("is_final_capture",1)
Write-Debug loo_Json.Emit()
// The JSON created by the above code:
// {
// "amount": {
// "currency": "USD",
// "total": "6.70"
// },
// "is_final_capture": true
// }
// This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
loo_Rest.AddHeader("Authorization",loo_SbAuth.GetAsString())
loo_Rest.AddHeader("Content-Type","application/json")
// The authorization ID is added to the path.
// The authorization ID is obtained from payment records as shown here: Find Authorizations
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")
loo_SbPath.Append("/v1/payments/authorization/authorization_id/capture")
li_NumReplaced = loo_SbPath.Replace("authorization_id","6HG91590AX913463C")
// Send the POST request containing 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)
// 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
Write-Debug loo_Json.Emit()
Write-Debug "Success."
// A successful JSON response:
// {
// "id": "87S70321AE222860G",
// "create_time": "2016-11-26T17:27:46Z",
// "update_time": "2016-11-26T17:27:50Z",
// "amount": {
// "total": "6.70",
// "currency": "USD"
// },
// "is_final_capture": true,
// "state": "completed",
// "reasonCode": "None",
// "parent_payment": "PAY-3SL8976592063093RLA3DMAY",
// "transaction_fee": {
// "value": "0.49",
// "currency": "USD"
// },
// "links": [
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/capture/87S70321AE222860G",
// "rel": "self",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/capture/87S70321AE222860G/refund",
// "rel": "refund",
// "method": "POST"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/authorization/6HG91590AX913463C",
// "rel": "authorization",
// "method": "GET"
// },
// {
// "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-3SL8976592063093RLA3DMAY",
// "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