AutoIt

PayPal - Refund Sale

See more PayPal Examples

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

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

AutoIt

Local $bSuccess = False

; 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 = ObjCreate("Chilkat.JsonObject")
$oJsonToken.LoadFile("qa_data/tokens/paypal.json")

; Build the Authorization request header field value.
$oSbAuth = ObjCreate("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 = ObjCreate("Chilkat.Rest")
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("api.sandbox.paypal.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
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..
; ----------------------------------------------------------------------------------------------

; To refund a particular amount, build JSON such as this:
$oJsonPartial = ObjCreate("Chilkat.JsonObject")
$oJsonPartial.EmitCompact = False
$oJsonPartial.UpdateString("amount.total","2.34")
$oJsonPartial.UpdateString("amount.currency","USD")
; invoice_number is optional..
$oJsonPartial.UpdateString("invoice_number","INV-1234567")
ConsoleWrite($oJsonPartial.Emit() & @CRLF)

; The JSON for a partial refund:

; 	{ 
; 	  "amount": { 
; 	    "total": "2.34",
; 	    "currency": "USD"
; 	  },
; 	  "invoice_number": "INV-1234567"
; 	}

$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())
$oRest.AddHeader("Content-Type","application/json")

; The sale ID is added to the path.
; The sale ID is obtained from payment records as shown here: Find Completed Sales
$oSbPath = ObjCreate("Chilkat.StringBuilder")
$oSbPath.Append("/v1/payments/sale/sale_id/refund")
Local $iNumReplaced = $oSbPath.Replace("sale_id","1XC17935MN507400J")

; Send the POST request containign the JSON in the request body, and get the JSON response.
$oSbJsonRequest = ObjCreate("Chilkat.StringBuilder")
$oJsonPartial.EmitCompact = True
$oJsonPartial.EmitSb($oSbJsonRequest)
$oSbJsonResponse = ObjCreate("Chilkat.StringBuilder")

Local $bFullRefund = True
; To send a full refund, send an empty request body:
If ($bFullRefund = True) Then
    $oSbJsonRequest.Clear 
    $oSbJsonRequest.Append("{}")
EndIf

$bSuccess = $oRest.FullRequestSb("POST",$oSbPath.GetAsString(),$oSbJsonRequest,$oSbJsonResponse)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.LoadSb($oSbJsonResponse)

ConsoleWrite("Response Status Code = " & $oRest.ResponseStatusCode & @CRLF)

; Did we get a 201 success response?
If ($oRest.ResponseStatusCode <> 201) Then
    ConsoleWrite($oJson.Emit() & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

ConsoleWrite($oJson.Emit() & @CRLF)
ConsoleWrite("Success." & @CRLF)

; A successful JSON response:
; The "id" is the refund_id.

; 	{ 
; 	  "id": "7NE550583A133505U",
; 	  "create_time": "2016-11-26T16:38:27Z",
; 	  "update_time": "2016-11-26T16:38:27Z",
; 	  "state": "completed",
; 	  "amount": { 
; 	    "total": "289.00",
; 	    "currency": "USD"
; 	  },
; 	  "sale_id": "1XC17935MN507400J",
; 	  "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
; 	  "links": [
; 	    { 
; 	      "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
; 	      "rel": "self",
; 	      "method": "GET"
; 	    },
; 	    { 
; 	      "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
; 	      "rel": "parent_payment",
; 	      "method": "GET"
; 	    },
; 	    { 
; 	      "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
; 	      "rel": "sale",
; 	      "method": "GET"
; 	    }
; 	  ]
; 	}