Lianja

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.

Lianja

llSuccess = .F.

// 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)
loJsonToken = createobject("CkJsonObject")
loJsonToken.LoadFile("qa_data/tokens/paypal.json")

// Build the Authorization request header field value.
loSbAuth = createobject("CkStringBuilder")
// token_type should be "Bearer"
loSbAuth.Append(loJsonToken.StringOf("token_type"))
loSbAuth.Append(" ")
loSbAuth.Append(loJsonToken.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.
loRest = createobject("CkRest")
llBAutoReconnect = .T.
llSuccess = loRest.Connect("api.sandbox.paypal.com",443,.T.,llBAutoReconnect)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    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..
// ----------------------------------------------------------------------------------------------

loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.

// This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
loRest.AddHeader("Authorization",loSbAuth.GetAsString())
loRest.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
loSbPath = createobject("CkStringBuilder")
loSbPath.Append("/v1/payments/authorization/authorization_id/void")
lnNumReplaced = loSbPath.Replace("authorization_id","0SU72290A8399291G")

// Send the POST request containing an empty JSON body, and get the JSON response.
loSbJsonRequest = createobject("CkStringBuilder")
loSbJsonRequest.Append("{}")

loSbJsonResponse = createobject("CkStringBuilder")

llSuccess = loRest.FullRequestSb("POST",loSbPath.GetAsString(),loSbJsonRequest,loSbJsonResponse)
if (llSuccess <> .T.) then
    ? loRest.LastErrorText
    release loJsonToken
    release loSbAuth
    release loRest
    release loJson
    release loSbPath
    release loSbJsonRequest
    release loSbJsonResponse
    return
endif

loJson.EmitCompact = .F.
loJson.LoadSb(loSbJsonResponse)

? "Response Status Code = " + str(loRest.ResponseStatusCode)

// Did we get a 200 success response?
if (loRest.ResponseStatusCode <> 200) then
    ? loJson.Emit()
    ? "Failed."
    release loJsonToken
    release loSbAuth
    release loRest
    release loJson
    release loSbPath
    release loSbJsonRequest
    release loSbJsonResponse
    return
endif

? loJson.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"
// 	    }
// 	  ]
// 	}


release loJsonToken
release loSbAuth
release loRest
release loJson
release loSbPath
release loSbJsonRequest
release loSbJsonResponse