(PowerShell) Amazon Pay - Get Refund

See more Amazon Pay Examples

Get refund details.

Note: This example requires Chilkat v9.5.0.89 or later. Contact support@chilkatsoft.com to get a v9.5.0.89 pre-release for testing.

For more information, see https://developer.amazon.com/docs/amazon-pay-api-v2/refund.html#get-refund

Chilkat .NET Downloads Chilkat .NET Assemblies

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

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

# Implements the following CURL command:

# curl "https://pay-api.amazon.com/:version/refunds/:refundId" \
# -X GET
# -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
# -H "x-amz-pay-date:20201012T235046Z"

# Load your Amazon Pay private key.  
# There are many other ways to load private keys into the Chilkat private key object, such as from different formats,
# or from in-memory strings or bytes.
$privKey = New-Object Chilkat.PrivateKey
$success = $privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
if ($success -eq $false) {
    $($privKey.LastErrorText)
    exit
}

# Provide your Amazon Pay private key and Public Key ID 
# Use your public key ID here.  It must be the one associated with the private key.
# Note: The SetAuthPrivateKey method was added in Chilkat v9.5.0.89
$publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
$success = $http.SetAuthPrivateKey($publicKeyId,$privKey)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

# Note: When the private key is provided as shown above, Chilkat will automatically add the required x-amz-pay-* headers to the HTTP request,
# and will also sign the request.  Nothing more is needed.
# Chilkat automatically generates and adds the following headers:
# 
# x-amz-pay-date
# x-amz-pay-host
# x-amz-pay-region
# Authorization

$http.Accept = "application/json"

$respStatusCode = 0

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.SetUrlVar("refundId","S01-5105180-3221187-R022311")
# To use the live system, replace "sandbox" with "live" in the URL passed to QuickGetSb.
# Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
$success = $http.QuickGetSb("https://pay-api.amazon.eu/sandbox/v2/refunds/{$refundId}",$sbResponseBody)
if ($success -eq $false) {
    # If the LastStatus is not equal to 0, then we received a response, but it was an error response.
    $respStatusCode = $http.LastStatus
    if ($respStatusCode -ne 0) {
        $("Response Status Code = " + $respStatusCode)
        $("Response body:")
        $($http.LastResponseBody)
    }
    else {
        $($http.LastErrorText)
    }

    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
# We expect a 200 status code for success.
# Note: Some Amazon Pay API calls return 200 for success, others return 201.
if ($respStatusCode -ne 200) {
    $("Failed.")
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#      "refundId": "S01-5105180-3221187-R022311",
#      "chargeId": "S01-5105180-3221187-C056351",
#      "refundAmount": {
#          "amount": "14.00",
#          "currencyCode": "USD"
#      },
#      "softDescriptor": "Descriptor",
#      "creationTimestamp": "20190714T155300Z",
#      "statusDetails": {
#          "state": "Refunded",
#          "reasonCode": null,
#          "reasonDescription": null,
#          "lastUpdatedTimestamp": "20190714T155300Z"
#      },
#      "releaseEnvironment": "Sandbox"
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

$refundId = $jResp.StringOf("refundId")
$chargeId = $jResp.StringOf("chargeId")
$refundAmountAmount = $jResp.StringOf("refundAmount.amount")
$refundAmountCurrencyCode = $jResp.StringOf("refundAmount.currencyCode")
$softDescriptor = $jResp.StringOf("softDescriptor")
$creationTimestamp = $jResp.StringOf("creationTimestamp")
$statusDetailsState = $jResp.StringOf("statusDetails.state")
$statusDetailsReasonCode = $jResp.StringOf("statusDetails.reasonCode")
$statusDetailsReasonDescription = $jResp.StringOf("statusDetails.reasonDescription")
$statusDetailsLastUpdatedTimestamp = $jResp.StringOf("statusDetails.lastUpdatedTimestamp")
$releaseEnvironment = $jResp.StringOf("releaseEnvironment")