(Perl) Amazon Pay - Create Refund

See more Amazon Pay Examples

Initiate a full or partial refund for a charge.

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#create-refund

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# Implements the following CURL command:

# curl "https://pay-api.amazon.com/:version/refunds/" \
# -X POST
# -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
# -H "x-amz-pay-date:20201012T235046Z"
# -H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"
# -d '{
#     "chargeId": "CHARGE_ID",
#     "refundAmount": {
#         "amount": "14.00",
#         "currencyCode": "USD"
#     },
#     "softDescriptor": "Descriptor"
# }'

# Use the following online tool to generate HTTP code from a CURL command
# Convert a cURL Command to HTTP Source Code

# Use this online tool to generate code from sample JSON:
# Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#     "chargeId": "CHARGE_ID",
#     "refundAmount": {
#         "amount": "14.00",
#         "currencyCode": "USD"
#     },
#     "softDescriptor": "Descriptor"
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("chargeId","CHARGE_ID");
$json->UpdateString("refundAmount.amount","14.00");
$json->UpdateString("refundAmount.currencyCode","USD");
$json->UpdateString("softDescriptor","Descriptor");

# 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 = chilkat::CkPrivateKey->new();
$success = $privKey->LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem");
if ($success == 0) {
    print $privKey->lastErrorText() . "\r\n";
    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 == 0) {
    print $http->lastErrorText() . "\r\n";
    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
# x-amz-pay-idempotency-key
# Authorization

$http->put_Accept("application/json");

# To use the live system, replace "sandbox" with "live" in the URL passed to PostJson3.
# Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
# resp is a HttpResponse
$resp = $http->PostJson3("https://pay-api.amazon.eu/sandbox/v2/refunds/","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

# If the status code is not equal to 201, this will display error information.
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode != 201) {
    print "Failed." . "\r\n";

    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": "RefundInitiated",
#          "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");