(Swift 3,4,5...) 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 Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

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

    let http = CkoHttp()!
    var success: Bool

    // 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.
    let privKey = CkoPrivateKey()!
    success = privKey.loadPemFile("C:/someDir/myAmazonPayPrivateKey.pem")
    if success == false {
        print("\(privKey.lastErrorText!)")
        return
    }

    // 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
    var publicKeyId: String? = "SANDBOX-AHEGSJCM3L2S637RBGABLAFW"
    success = http.setAuthPrivateKey(publicKeyId, privKey: privKey)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

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

    var respStatusCode: Int = 0

    let sbResponseBody = CkoStringBuilder()!
    success = http.setUrlVar("refundId", value: "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}", sbContent: sbResponseBody)
    if success == false {
        // If the LastStatus is not equal to 0, then we received a response, but it was an error response.
        respStatusCode = http.lastStatus.intValue
        if respStatusCode != 0 {
            print("Response Status Code = \(respStatusCode)")
            print("Response body:")
            print("\(http.lastResponseBody!)")
        }
        else {
            print("\(http.lastErrorText!)")
        }

        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    respStatusCode = http.lastStatus.intValue
    print("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 != 200 {
        print("Failed.")
        return
    }

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

    var refundId: String? = jResp.string(of: "refundId")
    var chargeId: String? = jResp.string(of: "chargeId")
    var refundAmountAmount: String? = jResp.string(of: "refundAmount.amount")
    var refundAmountCurrencyCode: String? = jResp.string(of: "refundAmount.currencyCode")
    var softDescriptor: String? = jResp.string(of: "softDescriptor")
    var creationTimestamp: String? = jResp.string(of: "creationTimestamp")
    var statusDetailsState: String? = jResp.string(of: "statusDetails.state")
    var statusDetailsReasonCode: String? = jResp.string(of: "statusDetails.reasonCode")
    var statusDetailsReasonDescription: String? = jResp.string(of: "statusDetails.reasonDescription")
    var statusDetailsLastUpdatedTimestamp: String? = jResp.string(of: "statusDetails.lastUpdatedTimestamp")
    var releaseEnvironment: String? = jResp.string(of: "releaseEnvironment")

}