Java

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.

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Rest;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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)
        JsonObject jsonToken = new JsonObject();
        jsonToken.loadFile("qa_data/tokens/paypal.json");

        // Build the Authorization request header field value.
        StringBuilder sbAuth = new StringBuilder();
        // token_type should be "Bearer"
        sbAuth.append(jsonToken.stringOf("token_type"));
        sbAuth.append(" ");
        sbAuth.append(jsonToken.stringOf("access_token"));

        // 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.
        Rest rest = new Rest();
        boolean bAutoReconnect = true;
        try {
            rest.connect("api.sandbox.paypal.com", 443, true, bAutoReconnect);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            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:
        JsonObject jsonPartial = new JsonObject();
        jsonPartial.setEmitCompact(false);
        jsonPartial.updateString("amount.total", "2.34");
        jsonPartial.updateString("amount.currency", "USD");
        // invoice_number is optional..
        jsonPartial.updateString("invoice_number", "INV-1234567");
        System.out.println(jsonPartial.emit());

        // The JSON for a partial refund:

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

        rest.addHeader("Authorization", sbAuth.getAsString());
        rest.addHeader("Content-Type", "application/json");

        // The sale ID is added to the path.
        // The sale ID is obtained from payment records as shown here: Find Completed Sales
        StringBuilder sbPath = new StringBuilder();
        sbPath.append("/v1/payments/sale/sale_id/refund");
        int numReplaced = sbPath.replace("sale_id", "1XC17935MN507400J");

        // Send the POST request containign the JSON in the request body, and get the JSON response.
        StringBuilder sbJsonRequest = new StringBuilder();
        jsonPartial.setEmitCompact(true);
        jsonPartial.emitSb(sbJsonRequest);
        StringBuilder sbJsonResponse = new StringBuilder();

        boolean bFullRefund = true;
        // To send a full refund, send an empty request body:
        if (bFullRefund) {
            sbJsonRequest.clear();
            sbJsonRequest.append("{}");
        }

        try {
            rest.fullRequestSb("POST", sbPath.getAsString(), sbJsonRequest, sbJsonResponse);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        JsonObject json = new JsonObject();
        json.setEmitCompact(false);
        json.loadSb(sbJsonResponse);

        System.out.println("Response Status Code = " + rest.getResponseStatusCode());

        // Did we get a 201 success response?
        if (rest.getResponseStatusCode() != 201) {
            System.out.println(json.emit());
            System.out.println("Failed.");
            return;
        }

        System.out.println(json.emit());
        System.out.println("Success.");

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