902 lines
40 KiB
HTML
902 lines
40 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_65) on Fri Oct 23 16:37:04 EDT 2015 -->
|
|
<TITLE>
|
|
BitPay
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2015-10-23">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="BitPay";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BitPay.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
PREV CLASS
|
|
<A HREF="../controller/BitPayException.html" title="class in controller"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../index.html?controller/BitPay.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="BitPay.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
controller</FONT>
|
|
<BR>
|
|
Class BitPay</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>controller.BitPay</B>
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>BitPay</B><DT>extends java.lang.Object</DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#FACADE_MERCHANT">FACADE_MERCHANT</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#FACADE_PAYROLL">FACADE_PAYROLL</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#FACADE_POS">FACADE_POS</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#FACADE_USER">FACADE_USER</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#PUBLIC_NO_TOKEN">PUBLIC_NO_TOKEN</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#BitPay()">BitPay</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Constructor for use if the keys and SIN are managed by this library.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#BitPay(com.google.bitcoin.core.ECKey)">BitPay</A></B>(com.google.bitcoin.core.ECKey ecKey)</CODE>
|
|
|
|
<BR>
|
|
Constructor for use if the keys and SIN were derived external to this library.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#BitPay(com.google.bitcoin.core.ECKey, java.lang.String)">BitPay</A></B>(com.google.bitcoin.core.ECKey ecKey,
|
|
java.lang.String clientName)</CODE>
|
|
|
|
<BR>
|
|
Constructor for use if the keys and SIN were derived external to this library.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#BitPay(com.google.bitcoin.core.ECKey, java.lang.String, java.lang.String)">BitPay</A></B>(com.google.bitcoin.core.ECKey ecKey,
|
|
java.lang.String clientName,
|
|
java.lang.String envUrl)</CODE>
|
|
|
|
<BR>
|
|
Constructor for use if the keys and SIN were derived external to this library.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#BitPay(java.lang.String)">BitPay</A></B>(java.lang.String clientName)</CODE>
|
|
|
|
<BR>
|
|
Constructor for use if the keys and SIN are managed by this library.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#BitPay(java.lang.String, java.lang.String)">BitPay</A></B>(java.lang.String clientName,
|
|
java.lang.String envUrl)</CODE>
|
|
|
|
<BR>
|
|
Constructor for use if the keys and SIN are managed by this library.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#authorizeClient(java.lang.String)">authorizeClient</A></B>(java.lang.String pairingCode)</CODE>
|
|
|
|
<BR>
|
|
Authorize this client for use with the BitPay server.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#cancelRefundRequest(model.Invoice, java.lang.String)">cancelRefundRequest</A></B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String refundId)</CODE>
|
|
|
|
<BR>
|
|
Cancel a previously submitted refund request on a BitPay invoice.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#cancelRefundRequest(java.lang.String, java.lang.String)">cancelRefundRequest</A></B>(java.lang.String invoiceId,
|
|
java.lang.String refundId)</CODE>
|
|
|
|
<BR>
|
|
Cancel a previously submitted refund request on a BitPay invoice.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#clientIsAuthorized(java.lang.String)">clientIsAuthorized</A></B>(java.lang.String facade)</CODE>
|
|
|
|
<BR>
|
|
Test whether this client is authorized for a specified level of API access.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/Invoice.html" title="class in model">Invoice</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#createInvoice(model.Invoice)">createInvoice</A></B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice)</CODE>
|
|
|
|
<BR>
|
|
Create a BitPay invoice using the POS facade.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/Invoice.html" title="class in model">Invoice</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#createInvoice(model.Invoice, java.lang.String)">createInvoice</A></B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String token)</CODE>
|
|
|
|
<BR>
|
|
Create a BitPay invoice.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getAccessToken(java.lang.String)">getAccessToken</A></B>(java.lang.String id)</CODE>
|
|
|
|
<BR>
|
|
Retrieve a token associated with a known resource.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List<<A HREF="../model/Refund.html" title="class in model">Refund</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getAllRefunds(model.Invoice)">getAllRefunds</A></B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice)</CODE>
|
|
|
|
<BR>
|
|
Retrieve all refund requests on a BitPay invoice.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getIdentity()">getIdentity</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Get the generated client identity.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/Invoice.html" title="class in model">Invoice</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getInvoice(java.lang.String)">getInvoice</A></B>(java.lang.String invoiceId)</CODE>
|
|
|
|
<BR>
|
|
Retrieve a BitPay invoice by invoice id using the public facade.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/Invoice.html" title="class in model">Invoice</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getInvoice(java.lang.String, java.lang.String)">getInvoice</A></B>(java.lang.String invoiceId,
|
|
java.lang.String token)</CODE>
|
|
|
|
<BR>
|
|
Retrieve a BitPay invoice by invoice id using the specified facade.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.util.List<<A HREF="../model/Invoice.html" title="class in model">Invoice</A>></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getInvoices(java.lang.String, java.lang.String)">getInvoices</A></B>(java.lang.String dateStart,
|
|
java.lang.String dateEnd)</CODE>
|
|
|
|
<BR>
|
|
Retrieve a collection of BitPay invoices.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/Rates.html" title="class in model">Rates</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getRates()">getRates</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Retrieve the exchange rate table maintained by BitPay.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/Refund.html" title="class in model">Refund</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#getRefund(model.Invoice, java.lang.String)">getRefund</A></B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String refundId)</CODE>
|
|
|
|
<BR>
|
|
Retrieve a previously made refund request on a BitPay invoice.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#requestClientAuthorization(java.lang.String)">requestClientAuthorization</A></B>(java.lang.String facade)</CODE>
|
|
|
|
<BR>
|
|
Request a pairing code from the BitPay server.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/RefundHelper.html" title="class in model">RefundHelper</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#requestRefund(model.Invoice, java.lang.String, java.lang.Double, java.lang.String)">requestRefund</A></B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String bitcoinAddress,
|
|
java.lang.Double amount,
|
|
java.lang.String currency)</CODE>
|
|
|
|
<BR>
|
|
Request a refund for a BitPay invoice.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../model/RefundHelper.html" title="class in model">RefundHelper</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../controller/BitPay.html#requestRefund(java.lang.String, java.lang.String)">requestRefund</A></B>(java.lang.String invoiceId,
|
|
java.lang.String bitcoinAddress)</CODE>
|
|
|
|
<BR>
|
|
Request a full refund for a BitPay invoice.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="FACADE_MERCHANT"><!-- --></A><H3>
|
|
FACADE_MERCHANT</H3>
|
|
<PRE>
|
|
public static final java.lang.String <B>FACADE_MERCHANT</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#controller.BitPay.FACADE_MERCHANT">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="FACADE_PAYROLL"><!-- --></A><H3>
|
|
FACADE_PAYROLL</H3>
|
|
<PRE>
|
|
public static final java.lang.String <B>FACADE_PAYROLL</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#controller.BitPay.FACADE_PAYROLL">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="FACADE_POS"><!-- --></A><H3>
|
|
FACADE_POS</H3>
|
|
<PRE>
|
|
public static final java.lang.String <B>FACADE_POS</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#controller.BitPay.FACADE_POS">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="FACADE_USER"><!-- --></A><H3>
|
|
FACADE_USER</H3>
|
|
<PRE>
|
|
public static final java.lang.String <B>FACADE_USER</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#controller.BitPay.FACADE_USER">Constant Field Values</A></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="PUBLIC_NO_TOKEN"><!-- --></A><H3>
|
|
PUBLIC_NO_TOKEN</H3>
|
|
<PRE>
|
|
public static final java.lang.String <B>PUBLIC_NO_TOKEN</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="../constant-values.html#controller.BitPay.PUBLIC_NO_TOKEN">Constant Field Values</A></DL>
|
|
</DL>
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="BitPay(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
BitPay</H3>
|
|
<PRE>
|
|
public <B>BitPay</B>(java.lang.String clientName,
|
|
java.lang.String envUrl)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Constructor for use if the keys and SIN are managed by this library.
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>clientName</CODE> - The label for this client.<DD><CODE>envUrl</CODE> - The target server URL.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BitPay(java.lang.String)"><!-- --></A><H3>
|
|
BitPay</H3>
|
|
<PRE>
|
|
public <B>BitPay</B>(java.lang.String clientName)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Constructor for use if the keys and SIN are managed by this library. Use BitPay production server.
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>clientName</CODE> - The label for this client.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BitPay()"><!-- --></A><H3>
|
|
BitPay</H3>
|
|
<PRE>
|
|
public <B>BitPay</B>()
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Constructor for use if the keys and SIN are managed by this library. Use BitPay production server. Default client name.
|
|
<P>
|
|
<DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BitPay(com.google.bitcoin.core.ECKey, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
BitPay</H3>
|
|
<PRE>
|
|
public <B>BitPay</B>(com.google.bitcoin.core.ECKey ecKey,
|
|
java.lang.String clientName,
|
|
java.lang.String envUrl)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Constructor for use if the keys and SIN were derived external to this library.
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>ecKey</CODE> - An elliptical curve key.<DD><CODE>clientName</CODE> - The label for this client.<DD><CODE>envUrl</CODE> - The target server URL.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BitPay(com.google.bitcoin.core.ECKey, java.lang.String)"><!-- --></A><H3>
|
|
BitPay</H3>
|
|
<PRE>
|
|
public <B>BitPay</B>(com.google.bitcoin.core.ECKey ecKey,
|
|
java.lang.String clientName)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Constructor for use if the keys and SIN were derived external to this library. Use BitPay production server.
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>ecKey</CODE> - An elliptical curve key.<DD><CODE>clientName</CODE> - The label for this client.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BitPay(com.google.bitcoin.core.ECKey)"><!-- --></A><H3>
|
|
BitPay</H3>
|
|
<PRE>
|
|
public <B>BitPay</B>(com.google.bitcoin.core.ECKey ecKey)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Constructor for use if the keys and SIN were derived external to this library. Use BitPay production server. Default client name.
|
|
<P>
|
|
<DL>
|
|
<DT><B>Parameters:</B><DD><CODE>ecKey</CODE> - An elliptical curve key.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="getIdentity()"><!-- --></A><H3>
|
|
getIdentity</H3>
|
|
<PRE>
|
|
public java.lang.String <B>getIdentity</B>()</PRE>
|
|
<DL>
|
|
<DD>Get the generated client identity.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>Client identify as a string</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="authorizeClient(java.lang.String)"><!-- --></A><H3>
|
|
authorizeClient</H3>
|
|
<PRE>
|
|
public void <B>authorizeClient</B>(java.lang.String pairingCode)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Authorize this client for use with the BitPay server.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>pairingCode</CODE> - A pairing code generated at https://bitpay.com/dashboard/merchant/api-tokens.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="requestClientAuthorization(java.lang.String)"><!-- --></A><H3>
|
|
requestClientAuthorization</H3>
|
|
<PRE>
|
|
public java.lang.String <B>requestClientAuthorization</B>(java.lang.String facade)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Request a pairing code from the BitPay server.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>facade</CODE> - Defines the level of API access being requested
|
|
<DT><B>Returns:</B><DD>A pairing code for claim at https://bitpay.com/dashboard/merchant/api-tokens.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="clientIsAuthorized(java.lang.String)"><!-- --></A><H3>
|
|
clientIsAuthorized</H3>
|
|
<PRE>
|
|
public boolean <B>clientIsAuthorized</B>(java.lang.String facade)</PRE>
|
|
<DL>
|
|
<DD>Test whether this client is authorized for a specified level of API access.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>facade</CODE> - Defines the level of API access being requested.
|
|
<DT><B>Returns:</B><DD>True if this client is authorized, false otherwise.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAccessToken(java.lang.String)"><!-- --></A><H3>
|
|
getAccessToken</H3>
|
|
<PRE>
|
|
public java.lang.String <B>getAccessToken</B>(java.lang.String id)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve a token associated with a known resource. The token is used to access other related resources.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>id</CODE> - The identifier for the desired resource.
|
|
<DT><B>Returns:</B><DD>The token associated with resource.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="createInvoice(model.Invoice, java.lang.String)"><!-- --></A><H3>
|
|
createInvoice</H3>
|
|
<PRE>
|
|
public <A HREF="../model/Invoice.html" title="class in model">Invoice</A> <B>createInvoice</B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String token)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Create a BitPay invoice.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoice</CODE> - An Invoice object with request parameters defined.<DD><CODE>token</CODE> - The resource access token for the request.
|
|
<DT><B>Returns:</B><DD>A BitPay generated Invoice object.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="createInvoice(model.Invoice)"><!-- --></A><H3>
|
|
createInvoice</H3>
|
|
<PRE>
|
|
public <A HREF="../model/Invoice.html" title="class in model">Invoice</A> <B>createInvoice</B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Create a BitPay invoice using the POS facade.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoice</CODE> - An Invoice object with request parameters defined.
|
|
<DT><B>Returns:</B><DD>A BitPay generated Invoice object.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInvoice(java.lang.String)"><!-- --></A><H3>
|
|
getInvoice</H3>
|
|
<PRE>
|
|
public <A HREF="../model/Invoice.html" title="class in model">Invoice</A> <B>getInvoice</B>(java.lang.String invoiceId)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve a BitPay invoice by invoice id using the public facade.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoiceId</CODE> - The id of the invoice to retrieve.
|
|
<DT><B>Returns:</B><DD>A BitPay Invoice object.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInvoice(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
getInvoice</H3>
|
|
<PRE>
|
|
public <A HREF="../model/Invoice.html" title="class in model">Invoice</A> <B>getInvoice</B>(java.lang.String invoiceId,
|
|
java.lang.String token)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve a BitPay invoice by invoice id using the specified facade. The client must have been previously authorized for the specified facade (the public facade requires no authorization).
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoiceId</CODE> - The id of the invoice to retrieve.<DD><CODE>token</CODE> - The facade/invoice token (e.g., pos/invoice) for the invoice.
|
|
<DT><B>Returns:</B><DD>A BitPay Invoice object.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getInvoices(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
getInvoices</H3>
|
|
<PRE>
|
|
public java.util.List<<A HREF="../model/Invoice.html" title="class in model">Invoice</A>> <B>getInvoices</B>(java.lang.String dateStart,
|
|
java.lang.String dateEnd)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve a collection of BitPay invoices.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>dateStart</CODE> - The first date for the query filter.<DD><CODE>dateEnd</CODE> - The last date for the query filter.
|
|
<DT><B>Returns:</B><DD>A list of BitPay Invoice objects.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="requestRefund(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
requestRefund</H3>
|
|
<PRE>
|
|
public <A HREF="../model/RefundHelper.html" title="class in model">RefundHelper</A> <B>requestRefund</B>(java.lang.String invoiceId,
|
|
java.lang.String bitcoinAddress)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Request a full refund for a BitPay invoice. The invoice full price and currency type are used in the request.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoiceId</CODE> - The id of the BitPay invoice for which a refund request should be made.<DD><CODE>bitcoinAddress</CODE> - 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.
|
|
<DT><B>Returns:</B><DD>A BitPay RefundRequest object with the new Refund object.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="requestRefund(model.Invoice, java.lang.String, java.lang.Double, java.lang.String)"><!-- --></A><H3>
|
|
requestRefund</H3>
|
|
<PRE>
|
|
public <A HREF="../model/RefundHelper.html" title="class in model">RefundHelper</A> <B>requestRefund</B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String bitcoinAddress,
|
|
java.lang.Double amount,
|
|
java.lang.String currency)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Request a refund for a BitPay invoice.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoice</CODE> - A BitPay invoice object for which a refund request should be made. Must have been obtained using the merchant facade.<DD><CODE>bitcoinAddress</CODE> - 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.<DD><CODE>amount</CODE> - The amount of money to refund. If zero then a request for 100% of the invoice value is created.<DD><CODE>currency</CODE> - 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.
|
|
<DT><B>Returns:</B><DD>A BitPay RefundRequest object with the new Refund object.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="cancelRefundRequest(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
|
cancelRefundRequest</H3>
|
|
<PRE>
|
|
public boolean <B>cancelRefundRequest</B>(java.lang.String invoiceId,
|
|
java.lang.String refundId)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Cancel a previously submitted refund request on a BitPay invoice.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoiceId</CODE> - The BitPay invoiceId having the associated refund to be canceled.<DD><CODE>refundId</CODE> - The refund id for the refund to be canceled.
|
|
<DT><B>Returns:</B><DD>True if the refund was successfully canceled, false otherwise.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="cancelRefundRequest(model.Invoice, java.lang.String)"><!-- --></A><H3>
|
|
cancelRefundRequest</H3>
|
|
<PRE>
|
|
public boolean <B>cancelRefundRequest</B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String refundId)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Cancel a previously submitted refund request on a BitPay invoice.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoice</CODE> - The BitPay invoice having the associated refund to be canceled. Must have been obtained using the merchant facade.<DD><CODE>refundId</CODE> - The refund id for the refund to be canceled.
|
|
<DT><B>Returns:</B><DD>True if the refund was successfully canceled, false otherwise.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRefund(model.Invoice, java.lang.String)"><!-- --></A><H3>
|
|
getRefund</H3>
|
|
<PRE>
|
|
public <A HREF="../model/Refund.html" title="class in model">Refund</A> <B>getRefund</B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice,
|
|
java.lang.String refundId)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve a previously made refund request on a BitPay invoice.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoice</CODE> - The BitPay invoice having the associated refund.<DD><CODE>refundId</CODE> - The refund id for the refund to be updated with new status.
|
|
<DT><B>Returns:</B><DD>A BitPay invoice object with the associated Refund object updated.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getAllRefunds(model.Invoice)"><!-- --></A><H3>
|
|
getAllRefunds</H3>
|
|
<PRE>
|
|
public java.util.List<<A HREF="../model/Refund.html" title="class in model">Refund</A>> <B>getAllRefunds</B>(<A HREF="../model/Invoice.html" title="class in model">Invoice</A> invoice)
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve all refund requests on a BitPay invoice.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>invoice</CODE> - The BitPay invoice object having the associated refunds.
|
|
<DT><B>Returns:</B><DD>A BitPay invoice object with the associated Refund objects updated.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getRates()"><!-- --></A><H3>
|
|
getRates</H3>
|
|
<PRE>
|
|
public <A HREF="../model/Rates.html" title="class in model">Rates</A> <B>getRates</B>()
|
|
throws <A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></PRE>
|
|
<DL>
|
|
<DD>Retrieve the exchange rate table maintained by BitPay. See https://bitpay.com/bitcoin-exchange-rates.
|
|
<P>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>A Rates object populated with the BitPay exchange rate table.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../controller/BitPayException.html" title="class in controller">BitPayException</A></CODE></DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BitPay.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
PREV CLASS
|
|
<A HREF="../controller/BitPayException.html" title="class in controller"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../index.html?controller/BitPay.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="BitPay.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|