(DataFlex) PayPal - Refund Captured Payment

Refunds a captured payment, by ID. Include an amount object in the JSON request body.

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

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

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

    // To refund a particular amount, build JSON such as this:
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Set ComEmitCompact Of hoJson To False
    Get ComUpdateString Of hoJson "amount.total" "4.54" To iSuccess
    Get ComUpdateString Of hoJson "amount.currency" "USD" To iSuccess
    Get ComUpdateString Of hoJson "description" "Athletic socks" To iSuccess
    Get ComUpdateString Of hoJson "reason" "Refunding because color was incorrect" To iSuccess
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1

    // The JSON:

    // 	{ 
    // 	  "amount": { 
    // 	    "total": "4.54",
    // 	    "currency": "USD"
    // 	  },
    // 	  "description": "Athletic socks",
    // 	  "reason": "Refunding because color was incorrect"
    // 	}
    // 
    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 capture ID is added to the path.
    // To list your captures: Find Captures. 
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
    If (Not(IsComObjectCreated(hoSbPath))) Begin
        Send CreateComObject of hoSbPath
    End
    Get ComAppend Of hoSbPath "/v1/payments/capture/capture_id/refund" To iSuccess
    Get ComReplace Of hoSbPath "capture_id" "1LY5310469661362J" To iNumReplaced

    // Send the POST request containign the JSON in the request body, and get the JSON response.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonRequest
    If (Not(IsComObjectCreated(hoSbJsonRequest))) Begin
        Send CreateComObject of hoSbJsonRequest
    End
    Set ComEmitCompact Of hoJson To True
    Get pvComObject of hoSbJsonRequest to vSbJsonRequest
    Get ComEmitSb Of hoJson vSbJsonRequest 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 201 success response?
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 201) 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:
    // The "id" is the refund_id.

    // 	{ 
    // 	  "id": "77B77607RR7243500",
    // 	  "create_time": "2016-11-27T01:38:25Z",
    // 	  "update_time": "2016-11-27T01:38:25Z",
    // 	  "state": "completed",
    // 	  "amount": { 
    // 	    "total": "4.54",
    // 	    "currency": "USD"
    // 	  },
    // 	  "capture_id": "1LY5310469661362J",
    // 	  "parent_payment": "PAY-2CY489250W145633HLA3DK3Y",
    // 	  "links": [
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/77B77607RR7243500",
    // 	      "rel": "self",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2CY489250W145633HLA3DK3Y",
    // 	      "rel": "parent_payment",
    // 	      "method": "GET"
    // 	    },
    // 	    { 
    // 	      "href": "https://api.sandbox.paypal.com/v1/payments/capture/1LY5310469661362J",
    // 	      "rel": "capture",
    // 	      "method": "GET"
    // 	    }
    // 	  ]
    // 	}


End_Procedure