Xbase++

PayPal - Void an Authorization

See more PayPal Examples

Voids a previously authorized payment.

Note: A fully captured authorization cannot be voided.

Note: This example requires Chilkat v9.5.0.65 or greater.

Xbase++

LOCAL nSuccess
LOCAL oJsonToken
LOCAL oSbAuth
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oJson
LOCAL oSbPath
LOCAL nNumReplaced
LOCAL oSbJsonRequest
LOCAL oSbJsonResponse

nSuccess := 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)
oJsonToken := CreateObject("Chilkat.JsonObject")
oJsonToken:LoadFile("qa_data/tokens/paypal.json")

//  Build the Authorization request header field value.
oSbAuth := CreateObject("Chilkat.StringBuilder")
//  token_type should be "Bearer"
oSbAuth:Append(oJsonToken:StringOf("token_type"))
oSbAuth:Append(" ")
oSbAuth:Append(oJsonToken: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.
oRest := CreateObject("Chilkat.Rest")
nBAutoReconnect := 1
nSuccess := oRest:Connect("api.sandbox.paypal.com", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    RETURN
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..
//  ----------------------------------------------------------------------------------------------

oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0

//  This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
oRest:AddHeader("Authorization", oSbAuth:GetAsString())
oRest: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
oSbPath := CreateObject("Chilkat.StringBuilder")
oSbPath:Append("/v1/payments/authorization/authorization_id/void")
nNumReplaced := oSbPath:Replace("authorization_id", "0SU72290A8399291G")

//  Send the POST request containing an empty JSON body, and get the JSON response.
oSbJsonRequest := CreateObject("Chilkat.StringBuilder")
oSbJsonRequest:Append("{}")

oSbJsonResponse := CreateObject("Chilkat.StringBuilder")

nSuccess := oRest:FullRequestSb("POST", oSbPath:GetAsString(), oSbJsonRequest, oSbJsonResponse)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJson:destroy()
    oSbPath:destroy()
    oSbJsonRequest:destroy()
    oSbJsonResponse:destroy()
    RETURN
ENDIF

oJson:EmitCompact := 0
oJson:LoadSb(oSbJsonResponse)

? "Response Status Code = " + Str(oRest:ResponseStatusCode)

//  Did we get a 200 success response?
IF (oRest:ResponseStatusCode != 200)
    ? oJson:Emit()
    ? "Failed."
    oJsonToken:destroy()
    oSbAuth:destroy()
    oRest:destroy()
    oJson:destroy()
    oSbPath:destroy()
    oSbJsonRequest:destroy()
    oSbJsonResponse:destroy()
    RETURN
ENDIF

? oJson:Emit()
? "Success."

//  A successful JSON response:

//  	{ 
//  	  "id": "0SU72290A8399291G",
//  	  "create_time": "2016-11-26T17:31:05Z",
//  	  "update_time": "2016-11-26T17:31:10Z",
//  	  "amount": { 
//  	    "total": "6.70",
//  	    "currency": "USD",
//  	    "details": { 
//  	      "subtotal": "6.70"
//  	    }
//  	  },
//  	  "state": "voided",
//  	  "parent_payment": "PAY-62106714J93631829LA44NWI",
//  	  "links": [
//  	    { 
//  	      "href": "https://api.sandbox.paypal.com/v1/payments/authorization/0SU72290A8399291G",
//  	      "rel": "self",
//  	      "method": "GET"
//  	    },
//  	    { 
//  	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-62106714J93631829LA44NWI",
//  	      "rel": "parent_payment",
//  	      "method": "GET"
//  	    }
//  	  ]
//  	}

oJsonToken:destroy()
oSbAuth:destroy()
oRest:destroy()
oJson:destroy()
oSbPath:destroy()
oSbJsonRequest:destroy()
oSbJsonResponse:destroy()