(Swift 3,4,5...) Amazon Pay - Cancel Charge

See more Amazon Pay Examples

Moves Charge to Canceled state and releases any authorized payments.

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

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/charges/:chargeId/cancel" \
    // -X DELETE
    // -H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
    // -H "x-amz-pay-date:20201012T235046Z"
    // -d '{
    //     "cancellationReason": "REASON DESCRIPTION"
    // }'

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

    // {
    //   "cancellationReason": "REASON DESCRIPTION"
    // }

    let json = CkoJsonObject()!
    json.update("cancellationReason", value: "REASON DESCRIPTION")

    let sbRequestBody = CkoStringBuilder()!
    json.emitSb(sbRequestBody)

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

    // Use the actual chargeId here:
    success = http.setUrlVar("chargeId", value: "bd504926-f659-4ad7-a1a9-9a747aaf5275")
    // To use the live system, replace "sandbox" with "live" in the URL passed to PTextSb.
    // Also, make sure to use the correct region: pay-api.amazon.com, pay-api.amazon.eu, or pay-api.amazon.jp
    var resp: CkoHttpResponse? = http.pTextSb("DELETE", url: "https://pay-api.amazon.eu/sandbox/v2/charges/{$chargeId}/cancel", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

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

    // If the status code is not equal to 200, this will display error information.
    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode != 200 {
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "chargeId": "P21-1111111-1111111-C111111",
    //   "chargePermissionId": "P21-1111111-1111111",
    //   "chargeAmount": {
    //     "amount": "14.00",
    //     "currencyCode": "USD"
    //   },
    //   "captureAmount": {
    //     "amount": "14.00",
    //     "currencyCode": "USD"
    //   },
    //   "refundedAmount": {
    //     "amount": "0.00",
    //     "currencyCode": "USD"
    //   },
    //   "convertedAmount": "14.00",
    //   "conversionRate": "1.00",
    //   "softDescriptor": "SOFT DESCRIPTOR",
    //   "merchantMetadata": null,
    //   "providerMetadata": {
    //     "providerReferenceId": null
    //   },
    //   "statusDetails": {
    //     "state": "Canceled",
    //     "reasonCode": null,
    //     "reasonDescription": null,
    //     "lastUpdatedTimestamp": "20190714T155300Z"
    //   },
    //   "creationTimestamp": "20190714T155300Z",
    //   "expirationTimestamp": "20190715T155300Z",
    //   "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 chargeId: String? = jResp.string(of: "chargeId")
    var chargePermissionId: String? = jResp.string(of: "chargePermissionId")
    var chargeAmountAmount: String? = jResp.string(of: "chargeAmount.amount")
    var chargeAmountCurrencyCode: String? = jResp.string(of: "chargeAmount.currencyCode")
    var captureAmountAmount: String? = jResp.string(of: "captureAmount.amount")
    var captureAmountCurrencyCode: String? = jResp.string(of: "captureAmount.currencyCode")
    var refundedAmountAmount: String? = jResp.string(of: "refundedAmount.amount")
    var refundedAmountCurrencyCode: String? = jResp.string(of: "refundedAmount.currencyCode")
    var convertedAmount: String? = jResp.string(of: "convertedAmount")
    var conversionRate: String? = jResp.string(of: "conversionRate")
    var softDescriptor: String? = jResp.string(of: "softDescriptor")
    var merchantMetadata: String? = jResp.string(of: "merchantMetadata")
    var providerMetadataProviderReferenceId: String? = jResp.string(of: "providerMetadata.providerReferenceId")
    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 creationTimestamp: String? = jResp.string(of: "creationTimestamp")
    var expirationTimestamp: String? = jResp.string(of: "expirationTimestamp")
    var releaseEnvironment: String? = jResp.string(of: "releaseEnvironment")

}