AutoIt

PayPal - Mark Invoice as Refunded

See more PayPal Examples

Mark an invoice as refunded.

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

AutoIt

Local $bSuccess = False

; Note: Requires Chilkat v9.5.0.65 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..
; ----------------------------------------------------------------------------------------------

; Build the JSON request body containing the reminder information:
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oDtNow = ObjCreate("Chilkat.CkDateTime")
$oDtNow.SetFromCurrentSystemTime()
$oSbDt = ObjCreate("Chilkat.StringBuilder")
$oSbDt.Append($oDtNow.GetAsTimestamp(False))
Local $iNumReplaced = $oSbDt.Replace("T"," ")
$iNumReplaced = $oSbDt.Replace("Z"," UTC")
$oJson.UpdateString("date",$oSbDt.GetAsString())
$oJson.UpdateString("note","Refunded by credit card!")
$oJson.UpdateString("amount.currency","USD")
$oJson.UpdateString("amount.value","500.00")
ConsoleWrite($oJson.Emit() & @CRLF)

; The JSON created by the above code:

; 	{ 
; 	  "date": "2016-11-28 21:05:38 UTC",
; 	  "note": "Refunded by credit card!",
; 	  "amount": { 
; 	    "currency": "USD",
; 	    "value": "500.00"
; 	  }
; 	}

; Build a path using a previously-sent invoice ID.
$oSbPath = ObjCreate("Chilkat.StringBuilder")
$oSbPath.Append("/v1/invoicing/invoices/invoice_id/record-refund")
Local $iNumReplacements = $oSbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

$oJson.EmitCompact = True
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")

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

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

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

; Check for a success response.
If ($oRest.ResponseStatusCode <> 204) Then
    ConsoleWrite($oSbResponseBody.GetAsString() & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; For a success response, the response body is empty.
ConsoleWrite("Success." & @CRLF)