(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http
Dim success As Boolean

// 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"
// }

Dim json As New Chilkat.JsonObject
success = json.UpdateString("chargeId","CHARGE_ID")
success = json.UpdateString("refundAmount.amount","14.00")
success = json.UpdateString("refundAmount.currencyCode","USD")
success = 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.
Dim privKey As New Chilkat.PrivateKey
success = privKey.LoadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
If (success = False) Then
    System.DebugLog(privKey.LastErrorText)
    Return
End If

// 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
Dim publicKeyId As String
publicKeyId = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
success = http.SetAuthPrivateKey(publicKeyId,privKey)
If (success = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

// 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.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
Dim resp As Chilkat.HttpResponse
resp = http.PostJson3("https://pay-api.amazon.eu/sandbox/v2/refunds/","application/json",json)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

// If the status code is not equal to 201, this will display error information.
System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode <> 201) Then
    System.DebugLog("Failed.")

    Return
End If

// 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

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