Zig

PayPal - Refund Sale

See more PayPal Examples

Refunds a completed payment. Provide the sale_id in the URI and an empty JSON payload for a full refund. For partial refunds, you can include an amount.

Note: This example requires Chilkat v9.5.0.65 or greater.

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    // Note: Requires Chilkat v9.5.0.64 or greater.

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

    // Load our previously obtained access token. (see PayPal OAuth2 Access Token)
    const json_token = try chilkat.JsonObject.init();
    defer json_token.deinit();
    json_token.loadFile("qa_data/tokens/paypal.json") catch {};

    // Build the Authorization request header field value.
    const sb_auth = try chilkat.StringBuilder.init();
    defer sb_auth.deinit();
    // token_type should be "Bearer"
    sb_auth.append(try json_token.stringOf(alloc, "token_type")) catch {};
    sb_auth.append(" ") catch {};
    sb_auth.append(try json_token.stringOf(alloc, "access_token")) catch {};

    // Make the initial connection.
    // A single REST object, once connected, can be used for many PayPal REST API calls.
    // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    // then it will be automatically re-established as needed.
    const rest = try chilkat.Rest.init();
    defer rest.deinit();
    const b_auto_reconnect = true;
    rest.connect("api.sandbox.paypal.com", 443, true, b_auto_reconnect) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    // ----------------------------------------------------------------------------------------------
    // The code above this comment could be placed inside a function/subroutine within the application
    // because the connection does not need to be made for every request.  Once the connection is made
    // the app may send many requests..
    // ----------------------------------------------------------------------------------------------

    // To refund a particular amount, build JSON such as this:
    const json_partial = try chilkat.JsonObject.init();
    defer json_partial.deinit();
    json_partial.setEmitCompact(false);
    json_partial.updateString("amount.total", "2.34") catch {};
    json_partial.updateString("amount.currency", "USD") catch {};
    // invoice_number is optional..
    json_partial.updateString("invoice_number", "INV-1234567") catch {};
    std.debug.print("{s}\n", .{try json_partial.emit(alloc)});

    // The JSON for a partial refund:

    //     {
    //       "amount": {
    //         "total": "2.34",
    //         "currency": "USD"
    //       },
    //       "invoice_number": "INV-1234567"
    //     }

    rest.addHeader("Authorization", try sb_auth.getAsString(alloc)) catch {};
    rest.addHeader("Content-Type", "application/json") catch {};

    // The sale ID is added to the path.
    // The sale ID is obtained from payment records as shown here: Find Completed Sales
    const sb_path = try chilkat.StringBuilder.init();
    defer sb_path.deinit();
    sb_path.append("/v1/payments/sale/sale_id/refund") catch {};
    _ = sb_path.replace("sale_id", "1XC17935MN507400J");

    // Send the POST request containign the JSON in the request body, and get the JSON response.
    const sb_json_request = try chilkat.StringBuilder.init();
    defer sb_json_request.deinit();
    json_partial.setEmitCompact(true);
    json_partial.emitSb(sb_json_request) catch {};
    const sb_json_response = try chilkat.StringBuilder.init();
    defer sb_json_response.deinit();

    const b_full_refund = true;
    // To send a full refund, send an empty request body:
    if (b_full_refund) {
        sb_json_request.clear();
        sb_json_request.append("{}") catch {};
    }

    rest.fullRequestSb("POST", try sb_path.getAsString(alloc), sb_json_request, sb_json_response) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    json.setEmitCompact(false);
    json.loadSb(sb_json_response) catch {};

    std.debug.print("Response Status Code = {d}\n", .{rest.getResponseStatusCode()});

    // Did we get a 201 success response?
    if (rest.getResponseStatusCode() != 201) {
        std.debug.print("{s}\n", .{try json.emit(alloc)});
        std.debug.print("Failed.\n", .{});
        return;
    }

    std.debug.print("{s}\n", .{try json.emit(alloc)});
    std.debug.print("Success.\n", .{});

    // A successful JSON response:
    // The "id" is the refund_id.

    //     {
    //       "id": "7NE550583A133505U",
    //       "create_time": "2016-11-26T16:38:27Z",
    //       "update_time": "2016-11-26T16:38:27Z",
    //       "state": "completed",
    //       "amount": {
    //         "total": "289.00",
    //         "currency": "USD"
    //       },
    //       "sale_id": "1XC17935MN507400J",
    //       "parent_payment": "PAY-2AA764602T410180HLA4FX6Q",
    //       "links": [
    //         {
    //           "href": "https://api.sandbox.paypal.com/v1/payments/refund/7NE550583A133505U",
    //           "rel": "self",
    //           "method": "GET"
    //         },
    //         {
    //           "href": "https://api.sandbox.paypal.com/v1/payments/payment/PAY-2AA764602T410180HLA4FX6Q",
    //           "rel": "parent_payment",
    //           "method": "GET"
    //         },
    //         {
    //           "href": "https://api.sandbox.paypal.com/v1/payments/sale/1XC17935MN507400J",
    //           "rel": "sale",
    //           "method": "GET"
    //         }
    //       ]
    //     }
}