PowerShell

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.

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $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)
$jsonToken = New-Object Chilkat.JsonObject
$jsonToken.LoadFile("qa_data/tokens/paypal.json")

# Build the Authorization request header field value.
$sbAuth = New-Object Chilkat.StringBuilder
# token_type should be "Bearer"
$sbAuth.Append($jsonToken.StringOf("token_type"))
$sbAuth.Append(" ")
$sbAuth.Append($jsonToken.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.
$rest = New-Object Chilkat.Rest
$bAutoReconnect = $true
$success = $rest.Connect("api.sandbox.paypal.com",443,$true,$bAutoReconnect)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# ----------------------------------------------------------------------------------------------
# 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:
$json = New-Object Chilkat.JsonObject
$json.EmitCompact = $false
$dtNow = New-Object Chilkat.CkDateTime
$dtNow.SetFromCurrentSystemTime()
$sbDt = New-Object Chilkat.StringBuilder
$sbDt.Append($dtNow.GetAsTimestamp($false))
$numReplaced = $sbDt.Replace("T"," ")
$numReplaced = $sbDt.Replace("Z"," UTC")
$json.UpdateString("date",$sbDt.GetAsString())
$json.UpdateString("note","Refunded by credit card!")
$json.UpdateString("amount.currency","USD")
$json.UpdateString("amount.value","500.00")
$($json.Emit())

# 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.
$sbPath = New-Object Chilkat.StringBuilder
$sbPath.Append("/v1/invoicing/invoices/invoice_id/record-refund")
$numReplacements = $sbPath.Replace("invoice_id","INV2-QCHR-QHSD-M2VU-AVXC")

$json.EmitCompact = $true
$sbRequestBody = New-Object Chilkat.StringBuilder
$sbResponseBody = New-Object Chilkat.StringBuilder

$rest.AddHeader("Content-Type","application/json")
$rest.AddHeader("Authorization",$sbAuth.GetAsString())
$json.EmitSb($sbRequestBody)

$success = $rest.FullRequestSb("POST",$sbPath.GetAsString(),$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$("Response Status Code = " + $rest.ResponseStatusCode)

# Check for a success response.
if ($rest.ResponseStatusCode -ne 204) {
    $($sbResponseBody.GetAsString())
    $("Failed.")
    exit
}

# For a success response, the response body is empty.
$("Success.")