Removed deprecated BTC only fields, added multi currency fields

Author: Pieter Poorthuis

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 BITPAY, INC.
+Copyright (c) 2014-2018 BITPAY, INC.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -68,7 +68,7 @@ To contribute to this project, please fork and submit a pull request.
 
 The MIT License (MIT)
 
-Copyright (c) 2014-2015 BitPay, Inc.
+Copyright (c) 2014-2018 BitPay, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

src/controller/BitPay.java

@@ -433,40 +433,58 @@ public List<Invoice> getInvoices(String dateStart, String dateEnd) throws BitPay
 
         return invoices;
     }
+    /**
+     * Checks whether a BitPay invoice has been paid in full.
+     * Returns true if the amountPaid >= paymentTotals, returns false otherwise
+     *
+     * @param Invoice       A Bitpay invoice object
+     * @return true if the amountPaid >= paymentTotals, returns false otherwise
+     */
+
+    public boolean isFullyPaid(Invoice invoice) {
+        long amountPaid = invoice.getAmountPaid();
+        String transactionCurrency = invoice.getTransactionCurrency();
+        // first check if invoice has a transactionCurrency. If not, this means the invoice has not been paid
+        if (transactionCurrency == null){
+            return false;
+        }
+        Hashtable <String, Long> paymentTotals = invoice.getPaymentTotals();
+        if (amountPaid < paymentTotals.get(transactionCurrency)){
+            return false;
+        }
+        return true;
+    }
 
     /**
      * Request a full refund for a BitPay invoice.  The invoice full price and currency type are used in the request.
      *
-     * @param invoiceId      The id of the BitPay invoice for which a refund request should be made.
-     * @param bitcoinAddress The bitcoin address to which the refund should will be made. If left empty ("") and the invoice contains a refund address then the request may success, otherwise it will fail.
+     * @param invoiceId     The id of the BitPay invoice for which a refund request should be made.
+     * @param refundEmail   The email of the buyer to which the refund email will be sent
      * @return A BitPay RefundRequest object with the new Refund object.
      * @throws BitPayException
      */
-    public RefundHelper requestRefund(String invoiceId, String bitcoinAddress) throws BitPayException {
+    public RefundHelper requestRefund(String invoiceId, String refundEmail) throws BitPayException {
         Invoice invoice = this.getInvoice(invoiceId, this.getAccessToken(FACADE_MERCHANT));
-        return this.requestRefund(invoice, bitcoinAddress, invoice.getPrice(), invoice.getCurrency());
+        return this.requestRefund(invoice, refundEmail, invoice.getPrice(), invoice.getCurrency());
     }
 
     /**
      * Request a refund for a BitPay invoice.
      *
      * @param invoice        A BitPay invoice object for which a refund request should be made.  Must have been obtained using the merchant facade.
-     * @param bitcoinAddress The bitcoin address to which the refund should will be made.  If left empty ("") and the invoice contains a refund address then the request may success, otherwise it will fail.
+     * @param refundEmail   The email of the buyer to which the refund email will be sent
      * @param amount         The amount of money to refund. If zero then a request for 100% of the invoice value is created.
      * @param currency       The three digit currency code specifying the exchange rate to use when calculating the refund bitcoin amount. If this value is "BTC" then no exchange rate calculation is performed.
      * @return A BitPay RefundRequest object with the new Refund object.
      * @throws BitPayException
      */
-    public RefundHelper requestRefund(Invoice invoice, String bitcoinAddress, Double amount, String currency) throws BitPayException {
-        if (bitcoinAddress == null && !invoice.getFlags().getRefundable()) {
-            throw new BitPayException("Error - cannot refund an invoice without a refund address");
-        }
-
+    public RefundHelper requestRefund(Invoice invoice, String refundEmail, Double amount, String currency) throws BitPayException {
+        
         Refund refund = new Refund();
         refund.setToken(invoice.getToken());
         refund.setGuid(this.getGuid());
         refund.setAmount(amount);
-        refund.setBitcoinAddress(bitcoinAddress);
+        refund.setRefundEmail(refundEmail);
         refund.setCurrency(currency);
 
         ObjectMapper mapper = new ObjectMapper();
@@ -489,7 +507,13 @@ public RefundHelper requestRefund(Invoice invoice, String bitcoinAddress, Double
             throw new BitPayException("Error - failed to deserialize BitPay server response (Refund) : " + e.getMessage());
         }
 
-        this.cacheAccessToken(refund.getId(), refund.getToken());
+        try {
+            this.cacheAccessToken(refund.getId(), refund.getToken());
+        } catch (java.lang.NullPointerException e) {
+            // When using the email address to refund, BitPay does not instantly return a request id
+            // Instead BitPay returns 'success':'true'.
+            // BitPay only returns a supportRequestId when the customer has entered his BTC/BCH refund address
+        }
         return new RefundHelper(refund, invoice);
     }
 

src/model/Invoice.java

@@ -39,19 +39,20 @@ public class Invoice {
 	private String _id;
 	private String _url;
 	private String _status;
-	private String _btcPrice;
 	private String _invoiceTime;
 	private long _expirationTime;
 	private long _currentTime;
-	private String _btcPaid;
-	private String _btcDue;
 	private List<InvoiceTransaction> _transactions;
-	private String _rate;
-	private Hashtable<String, String> _exRates;
 	private String _exceptionStatus;
 	private InvoicePaymentUrls _paymentUrls = new InvoicePaymentUrls();
-	private InvoiceFlags _flags = new InvoiceFlags();
 	private boolean _extendedNotifications = false;
+
+	private String _transactionCurrency;
+	private long _amountPaid;
+	private Hashtable<String, Hashtable <String, String> > _exchangeRates;
+	private Hashtable<String, Long> _paymentTotals;
+	private Hashtable<String, Long> _paymentSubtotals;
+
 
     /**
      * Constructor, create an empty Invoice object.
@@ -290,16 +291,6 @@ public void setStatus(String _status) {
 		this._status = _status;
 	}
 
-    @JsonIgnore
-	public String getBtcPrice() {
-		return _btcPrice;
-	}
-	
-    @JsonProperty("btcPrice")
-	public void setBtcPrice(String _btcPrice) {
-		this._btcPrice = _btcPrice;
-	}
-
     @JsonIgnore
 	public String getInvoiceTime() {
 		return _invoiceTime;
@@ -330,26 +321,6 @@ public void setCurrentTime(long _currentTime) {
 		this._currentTime = _currentTime;
 	}
 
-    @JsonIgnore
-	public String getBtcPaid() {
-		return _btcPaid;
-	}
-	
-    @JsonProperty("btcPaid")
-	public void setBtcPaid(String _btcPaid) {
-		this._btcPaid = _btcPaid;
-	}
-
-    @JsonIgnore
-	public String getBtcDue() {
-		return _btcDue;
-	}
-	
-    @JsonProperty("btcDue")
-	public void setBtcDue(String _btcDue) {
-		this._btcDue = _btcDue;
-	}
-
     @JsonIgnore
 	public List<InvoiceTransaction> getTransactions() {
 		return _transactions;
@@ -360,26 +331,6 @@ public void setTransactions(List<InvoiceTransaction> _transactions) {
 		this._transactions = _transactions;
 	}
 
-    @JsonIgnore
-	public String getRate() {
-		return _rate;
-	}
-	
-    @JsonProperty("rate")
-	public void setRate(String _rate) {
-		this._rate = _rate;
-	}
-
-    @JsonIgnore
-	public Hashtable<String, String> getExRates() {
-		return _exRates;
-	}
-	
-    @JsonProperty("exRates")
-	public void setExRates(Hashtable<String, String> _exRates) {
-		this._exRates = _exRates;
-	}
-
     @JsonIgnore
  	public String getExceptionStatus() {
  		return _exceptionStatus;
@@ -399,15 +350,56 @@ public InvoicePaymentUrls getPaymentUrls() {
   	public void setPaymentUrls(InvoicePaymentUrls _paymentUrls) {
   		this._paymentUrls = _paymentUrls;
   	}
-    
-    @JsonIgnore
-  	public InvoiceFlags getFlags() {
-  		return _flags;
+
+	@JsonIgnore
+  	public String getTransactionCurrency() {
+  		return _transactionCurrency;
   	}
 
-    @JsonProperty("flags")
-  	public void setFlags(InvoiceFlags _flags) {
-  		this._flags = _flags;
+    @JsonProperty("transactionCurrency")
+  	public void setTransactionCurrency(String _transactionCurrency) {
+  		this._transactionCurrency = _transactionCurrency;
   	}
+  	
+  	@JsonIgnore
+  	public long getAmountPaid() {
+  		return _amountPaid;
+  	}
+  	
+    @JsonProperty("amountPaid")
+  	public void setAmountPaid(long _amountPaid) {
+  		this._amountPaid = _amountPaid;
+  	}
+
+	@JsonIgnore
+	public Hashtable<String, Hashtable <String, String> > getExchangeRates() {
+		return _exchangeRates;
+	}
+	
+    @JsonProperty("exchangeRates")
+	public void setExchangeRates(Hashtable<String, Hashtable <String, String> > _exchangeRates) {
+		this._exchangeRates = _exchangeRates;
+	}
+
+	@JsonIgnore
+	public Hashtable<String, Long> getPaymentTotals() {
+		return _paymentTotals;
+	}
+	
+    @JsonProperty("paymentTotals")
+	public void setPaymentTotals(Hashtable<String, Long> _paymentTotals) {
+		this._paymentTotals = _paymentTotals;
+	}
+
+	@JsonIgnore
+	public Hashtable<String, Long> getPaymentSubtotals() {
+		return _paymentSubtotals;
+	}
+	
+    @JsonProperty("paymentSubtotals")
+	public void setPaymentSubtotals(Hashtable<String, Long> _paymentSubtotals) {
+		this._paymentSubtotals = _paymentSubtotals;
+	}
+
 
 }

src/model/Refund.java

@@ -13,6 +13,7 @@ public class Refund {
 
 	private Double _amount = 0.0;
 	private String _bitcoinAddress = "";
+	private String _refundEmail = "";
 	private String _currency = "";
 
 	private String _id;
@@ -91,6 +92,18 @@ public void setBitcoinAddress(String bitcoinAddress) {
 		this._bitcoinAddress = bitcoinAddress;
 	}
 
+	@JsonProperty("refundEmail")
+	public String getRefundEmail() {
+		return _refundEmail;
+	}
+    
+    @JsonProperty("refundEmail")
+    @JsonInclude(JsonInclude.Include.NON_DEFAULT)
+	public void setRefundEmail(String refundEmail) {
+		this._refundEmail = refundEmail;
+	}
+
+
     @JsonProperty("currency")
 	public String getCurrency() {
 		return _currency;

src/model/RefundParams.java

@@ -10,6 +10,7 @@ public class RefundParams {
 	private String _currency = "";
 	private Double _amount = 0.0;
 	private String _bitcoinAddress = "";
+	private String _refundEmail = "";
 	private String _invoiceId = "";
 
     public RefundParams() {}
@@ -64,6 +65,16 @@ public void setBitcoinAddress(String bitcoinAddress) {
 		this._bitcoinAddress = bitcoinAddress;
 	}
 
+	@JsonIgnore
+	public String getRefundEmail() {
+		return _refundEmail;
+	}
+        
+    @JsonProperty("refundEmail")
+	public void setRefundEmail(String refundEmail) {
+		this._refundEmail = refundEmail;
+	}
+
     @JsonIgnore
 	public String getInvoiceId() {
 		return _invoiceId;