DataFlex

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.

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJsonToken
    Handle hoSbAuth
    Handle hoRest
    Boolean iBAutoReconnect
    Handle hoJson
    Handle hoSbPath
    Integer iNumReplaced
    Variant vSbJsonRequest
    Handle hoSbJsonRequest
    Variant vSbJsonResponse
    Handle hoSbJsonResponse
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

    // 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)
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/paypal.json" To iSuccess

    // Build the Authorization request header field value.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
    If (Not(IsComObjectCreated(hoSbAuth))) Begin
        Send CreateComObject of hoSbAuth
    End
    // token_type should be "Bearer"
    Get ComStringOf Of hoJsonToken "token_type" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess
    Get ComAppend Of hoSbAuth " " To iSuccess
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess

    // 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.
    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "api.sandbox.paypal.com" 443 True iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // ----------------------------------------------------------------------------------------------
    // 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..
    // ----------------------------------------------------------------------------------------------

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Set ComEmitCompact Of hoJson To False

    // This is the OAuth2 Authorization header, not to be confused with a PayPal credit card authorization...
    Get ComGetAsString Of hoSbAuth To sTemp1
    Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess
    Get ComAddHeader Of hoRest "Content-Type" "application/json" To iSuccess

    // The authorization ID is added to the path.
    // The authorization ID is obtained from payment records as shown here: Find Authorizations
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
    If (Not(IsComObjectCreated(hoSbPath))) Begin
        Send CreateComObject of hoSbPath
    End
    Get ComAppend Of hoSbPath "/v1/payments/authorization/authorization_id/void" To iSuccess
    Get ComReplace Of hoSbPath "authorization_id" "0SU72290A8399291G" To iNumReplaced

    // Send the POST request containing an empty JSON body, and get the JSON response.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonRequest
    If (Not(IsComObjectCreated(hoSbJsonRequest))) Begin
        Send CreateComObject of hoSbJsonRequest
    End
    Get ComAppend Of hoSbJsonRequest "{}" To iSuccess

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonResponse
    If (Not(IsComObjectCreated(hoSbJsonResponse))) Begin
        Send CreateComObject of hoSbJsonResponse
    End

    Get ComGetAsString Of hoSbPath To sTemp1
    Get pvComObject of hoSbJsonRequest to vSbJsonRequest
    Get pvComObject of hoSbJsonResponse to vSbJsonResponse
    Get ComFullRequestSb Of hoRest "POST" sTemp1 vSbJsonRequest vSbJsonResponse To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Set ComEmitCompact Of hoJson To False
    Get pvComObject of hoSbJsonResponse to vSbJsonResponse
    Get ComLoadSb Of hoJson vSbJsonResponse To iSuccess

    Get ComResponseStatusCode Of hoRest To iTemp1
    Showln "Response Status Code = " iTemp1

    // Did we get a 200 success response?
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        Get ComEmit Of hoJson To sTemp1
        Showln sTemp1
        Showln "Failed."
        Procedure_Return
    End

    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1
    Showln "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"
    // 	    }
    // 	  ]
    // 	}


End_Procedure