PowerShell

PayPal - Refund Captured Payment

See more PayPal Examples

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.

PowerShell

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

$success = $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)
$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..
# ----------------------------------------------------------------------------------------------

# To refund a particular amount, build JSON such as this:
$json = New-Object Chilkat.JsonObject
$json.EmitCompact = $false
$json.UpdateString("amount.total","4.54")
$json.UpdateString("amount.currency","USD")
$json.UpdateString("description","Athletic socks")
$json.UpdateString("reason","Refunding because color was incorrect")
$($json.Emit())

# The JSON:

# 	{ 
# 	  "amount": { 
# 	    "total": "4.54",
# 	    "currency": "USD"
# 	  },
# 	  "description": "Athletic socks",
# 	  "reason": "Refunding because color was incorrect"
# 	}
# 
$rest.AddHeader("Authorization",$sbAuth.GetAsString())
$rest.AddHeader("Content-Type","application/json")

# The capture ID is added to the path.
# To list your captures: Find Captures. 
$sbPath = New-Object Chilkat.StringBuilder
$sbPath.Append("/v1/payments/capture/capture_id/refund")
$numReplaced = $sbPath.Replace("capture_id","1LY5310469661362J")

# Send the POST request containign the JSON in the request body, and get the JSON response.
$sbJsonRequest = New-Object Chilkat.StringBuilder
$json.EmitCompact = $true
$json.EmitSb($sbJsonRequest)
$sbJsonResponse = New-Object Chilkat.StringBuilder

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

$json.EmitCompact = $false
$json.LoadSb($sbJsonResponse)

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

# Did we get a 201 success response?
if ($rest.ResponseStatusCode -ne 201) {
    $($json.Emit())
    $("Failed.")
    exit
}

$($json.Emit())
$("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"
# 	    }
# 	  ]
# 	}