Sample code for 30+ languages & platforms
CkJava Requires Chilkat v11.0.0+

PayPal: Record an external refund against an invoice

See more PayPal Examples

Record USD 5 already returned by bank transfer for a paid invoice. This call does not move money. To refund a PayPal capture, use the Payments v2 capture refund example instead.

PayPal documentation

Chilkat CkJava Downloads

CkJava
import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    //  See Unlock Chilkat before making requests.
    //  For the merchant's internal backoffice application. Load the sandbox token
    //  from the merchant's credential store. Keep it out of publicly distributed apps.
    //  See Get a PayPal access token.
    CkHttp http = new CkHttp();
    http.put_AuthToken("SANDBOX_ACCESS_TOKEN");
    CkHttpResponse resp = new CkHttpResponse();

    //  Record only money already returned outside PayPal. Reconcile first if a previous
    //  attempt timed out.

    http.SetUrlVar("id","INVOICE_ID");
    CkJsonObject body = new CkJsonObject();
    body.UpdateString("method","BANK_TRANSFER");
    body.UpdateString("amount.currency_code","USD");
    body.UpdateString("amount.value","5.00");

    //  Use the actual date of the transfer; this example records one made today.
    CkDateTime date = new CkDateTime();
    date.SetFromCurrentSystemTime();
    body.UpdateString("refund_date",date.getAsIso8601("YYYY-MM-DD",false));

    success = http.HttpJson("POST","https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{$id}/refunds",body,"application/json",resp);
    if (success != true) {
        System.out.println("No HTTP response: " + http.lastErrorText());
        return;
        }

    if ((resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
        CkJsonObject errorInfo = new CkJsonObject();
        errorInfo.Load(resp.bodyStr());
        System.out.println("HTTP " + resp.get_StatusCode() + " " + errorInfo.stringOf("name") + " " + errorInfo.stringOf("details[0].issue"));
        System.out.println("PayPal debug ID: " + errorInfo.stringOf("debug_id"));
        return;
        }

    CkJsonObject result = new CkJsonObject();
    boolean parsed = result.Load(resp.bodyStr());
    if (parsed != true) {
        System.out.println("Expected a JSON response; HTTP " + resp.get_StatusCode());
        return;
        }

    System.out.println("Record ID: " + result.stringOf("refund_id"));
  }
}