Package com.stripe.model
Class BitcoinReceiver
- java.lang.Object
-
- com.stripe.model.StripeObject
-
- com.stripe.net.ApiResource
-
- com.stripe.model.BitcoinReceiver
-
- All Implemented Interfaces:
HasId
,PaymentSource
,StripeObjectInterface
public class BitcoinReceiver extends ApiResource implements PaymentSource
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.stripe.net.ApiResource
ApiResource.RequestMethod
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiResource
CHARSET, GSON
-
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
-
Constructor Summary
Constructors Constructor Description BitcoinReceiver()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(java.lang.Object other)
boolean
equals(java.lang.Object o)
java.lang.Boolean
getActive()
True when this bitcoin receiver has received a non-zero amount of bitcoin.java.lang.Long
getAmount()
The amount ofcurrency
that you are collecting as payment.java.lang.Long
getAmountReceived()
The amount ofcurrency
to whichbitcoin_amount_received
has been converted.java.lang.Long
getBitcoinAmount()
The amount of bitcoin that the customer should send to fill the receiver.java.lang.Long
getBitcoinAmountReceived()
The amount of bitcoin that has been sent by the customer to this receiver.java.lang.String
getBitcoinUri()
This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).java.lang.Long
getCreated()
Time at which the object was created.java.lang.String
getCurrency()
Three-letter ISO code for the currency to which the bitcoin will be converted.java.lang.String
getCustomer()
The customer ID of the bitcoin receiver.java.lang.Boolean
getDeleted()
Always true for a deleted object.java.lang.String
getDescription()
An arbitrary string attached to the object.java.lang.String
getEmail()
The customer's email address, set by the API call that creates the receiver.java.lang.Boolean
getFilled()
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver.java.lang.String
getId()
Unique identifier for the object.java.lang.String
getInboundAddress()
A bitcoin address that is specific to this receiver.java.lang.Boolean
getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.java.util.Map<java.lang.String,java.lang.String>
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.String
getObject()
String representing the object's type.java.lang.String
getPayment()
The ID of the payment created from the receiver, if any.java.lang.String
getRefundAddress()
The refund address of this bitcoin receiver.BitcoinTransactionCollection
getTransactions()
A list with one entry for each time that the customer sent bitcoin to the receiver.java.lang.Boolean
getUncapturedFunds()
This receiver contains uncaptured funds that can be used for a payment or refunded.java.lang.Boolean
getUsedForPayment()
Indicate if this source is used for payment.int
hashCode()
static BitcoinReceiverCollection
list(BitcoinReceiverListParams params)
Returns a list of your receivers.static BitcoinReceiverCollection
list(BitcoinReceiverListParams params, RequestOptions options)
Returns a list of your receivers.static BitcoinReceiverCollection
list(java.util.Map<java.lang.String,java.lang.Object> params)
Returns a list of your receivers.static BitcoinReceiverCollection
list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Returns a list of your receivers.static BitcoinReceiver
retrieve(java.lang.String id)
Retrieves the Bitcoin receiver with the given ID.static BitcoinReceiver
retrieve(java.lang.String id, RequestOptions options)
Retrieves the Bitcoin receiver with the given ID.static BitcoinReceiver
retrieve(java.lang.String id, BitcoinReceiverRetrieveParams params, RequestOptions options)
Retrieves the Bitcoin receiver with the given ID.static BitcoinReceiver
retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options)
Retrieves the Bitcoin receiver with the given ID.void
setActive(java.lang.Boolean active)
True when this bitcoin receiver has received a non-zero amount of bitcoin.void
setAmount(java.lang.Long amount)
The amount ofcurrency
that you are collecting as payment.void
setAmountReceived(java.lang.Long amountReceived)
The amount ofcurrency
to whichbitcoin_amount_received
has been converted.void
setBitcoinAmount(java.lang.Long bitcoinAmount)
The amount of bitcoin that the customer should send to fill the receiver.void
setBitcoinAmountReceived(java.lang.Long bitcoinAmountReceived)
The amount of bitcoin that has been sent by the customer to this receiver.void
setBitcoinUri(java.lang.String bitcoinUri)
This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).void
setCreated(java.lang.Long created)
Time at which the object was created.void
setCurrency(java.lang.String currency)
Three-letter ISO code for the currency to which the bitcoin will be converted.void
setCustomer(java.lang.String customer)
The customer ID of the bitcoin receiver.void
setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.void
setDescription(java.lang.String description)
An arbitrary string attached to the object.void
setEmail(java.lang.String email)
The customer's email address, set by the API call that creates the receiver.void
setFilled(java.lang.Boolean filled)
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver.void
setId(java.lang.String id)
Unique identifier for the object.void
setInboundAddress(java.lang.String inboundAddress)
A bitcoin address that is specific to this receiver.void
setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object.void
setObject(java.lang.String object)
String representing the object's type.void
setPayment(java.lang.String payment)
The ID of the payment created from the receiver, if any.void
setRefundAddress(java.lang.String refundAddress)
The refund address of this bitcoin receiver.void
setTransactions(BitcoinTransactionCollection transactions)
A list with one entry for each time that the customer sent bitcoin to the receiver.void
setUncapturedFunds(java.lang.Boolean uncapturedFunds)
This receiver contains uncaptured funds that can be used for a payment or refunded.void
setUsedForPayment(java.lang.Boolean usedForPayment)
Indicate if this source is used for payment.-
Methods inherited from class com.stripe.net.ApiResource
checkNullTypedParams, classUrl, classUrl, instanceUrl, instanceUrl, request, request, requestCollection, requestCollection, requestSearchResult, requestSearchResult, requestStream, requestStream, setExpandableFieldId, setStripeResponseGetter, singleClassUrl, singleClassUrl, subresourceUrl, urlEncode, urlEncodeId
-
Methods inherited from class com.stripe.model.StripeObject
equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.stripe.model.StripeObjectInterface
getLastResponse, setLastResponse
-
-
-
-
Method Detail
-
list
public static BitcoinReceiverCollection list(java.util.Map<java.lang.String,java.lang.Object> params) throws StripeException
Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.- Throws:
StripeException
-
list
public static BitcoinReceiverCollection list(java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.- Throws:
StripeException
-
list
public static BitcoinReceiverCollection list(BitcoinReceiverListParams params) throws StripeException
Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.- Throws:
StripeException
-
list
public static BitcoinReceiverCollection list(BitcoinReceiverListParams params, RequestOptions options) throws StripeException
Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.- Throws:
StripeException
-
retrieve
public static BitcoinReceiver retrieve(java.lang.String id) throws StripeException
Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
retrieve
public static BitcoinReceiver retrieve(java.lang.String id, RequestOptions options) throws StripeException
Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
retrieve
public static BitcoinReceiver retrieve(java.lang.String id, java.util.Map<java.lang.String,java.lang.Object> params, RequestOptions options) throws StripeException
Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
retrieve
public static BitcoinReceiver retrieve(java.lang.String id, BitcoinReceiverRetrieveParams params, RequestOptions options) throws StripeException
Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
getActive
public java.lang.Boolean getActive()
True when this bitcoin receiver has received a non-zero amount of bitcoin.
-
getAmount
public java.lang.Long getAmount()
The amount ofcurrency
that you are collecting as payment.
-
getAmountReceived
public java.lang.Long getAmountReceived()
The amount ofcurrency
to whichbitcoin_amount_received
has been converted.
-
getBitcoinAmount
public java.lang.Long getBitcoinAmount()
The amount of bitcoin that the customer should send to fill the receiver. Thebitcoin_amount
is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.
-
getBitcoinAmountReceived
public java.lang.Long getBitcoinAmountReceived()
The amount of bitcoin that has been sent by the customer to this receiver.
-
getBitcoinUri
public java.lang.String getBitcoinUri()
This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).
-
getCreated
public java.lang.Long getCreated()
Time at which the object was created. Measured in seconds since the Unix epoch.
-
getCurrency
public java.lang.String getCurrency()
Three-letter ISO code for the currency to which the bitcoin will be converted.
-
getCustomer
public java.lang.String getCustomer()
The customer ID of the bitcoin receiver.
-
getDeleted
public java.lang.Boolean getDeleted()
Always true for a deleted object.
-
getDescription
public java.lang.String getDescription()
An arbitrary string attached to the object. Often useful for displaying to users.
-
getEmail
public java.lang.String getEmail()
The customer's email address, set by the API call that creates the receiver.
-
getFilled
public java.lang.Boolean getFilled()
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver.
-
getInboundAddress
public java.lang.String getInboundAddress()
A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.
-
getLivemode
public java.lang.Boolean getLivemode()
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
getMetadata
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-
getObject
public java.lang.String getObject()
String representing the object's type. Objects of the same type share the same value.Equal to
bitcoin_receiver
.
-
getPayment
public java.lang.String getPayment()
The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.
-
getRefundAddress
public java.lang.String getRefundAddress()
The refund address of this bitcoin receiver.
-
getTransactions
public BitcoinTransactionCollection getTransactions()
A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.
-
getUncapturedFunds
public java.lang.Boolean getUncapturedFunds()
This receiver contains uncaptured funds that can be used for a payment or refunded.
-
getUsedForPayment
public java.lang.Boolean getUsedForPayment()
Indicate if this source is used for payment.
-
setActive
public void setActive(java.lang.Boolean active)
True when this bitcoin receiver has received a non-zero amount of bitcoin.
-
setAmount
public void setAmount(java.lang.Long amount)
The amount ofcurrency
that you are collecting as payment.
-
setAmountReceived
public void setAmountReceived(java.lang.Long amountReceived)
The amount ofcurrency
to whichbitcoin_amount_received
has been converted.
-
setBitcoinAmount
public void setBitcoinAmount(java.lang.Long bitcoinAmount)
The amount of bitcoin that the customer should send to fill the receiver. Thebitcoin_amount
is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.
-
setBitcoinAmountReceived
public void setBitcoinAmountReceived(java.lang.Long bitcoinAmountReceived)
The amount of bitcoin that has been sent by the customer to this receiver.
-
setBitcoinUri
public void setBitcoinUri(java.lang.String bitcoinUri)
This URI can be displayed to the customer as a clickable link (to activate their bitcoin client) or as a QR code (for mobile wallets).
-
setCreated
public void setCreated(java.lang.Long created)
Time at which the object was created. Measured in seconds since the Unix epoch.
-
setCurrency
public void setCurrency(java.lang.String currency)
Three-letter ISO code for the currency to which the bitcoin will be converted.
-
setCustomer
public void setCustomer(java.lang.String customer)
The customer ID of the bitcoin receiver.
-
setDeleted
public void setDeleted(java.lang.Boolean deleted)
Always true for a deleted object.
-
setDescription
public void setDescription(java.lang.String description)
An arbitrary string attached to the object. Often useful for displaying to users.
-
setEmail
public void setEmail(java.lang.String email)
The customer's email address, set by the API call that creates the receiver.
-
setFilled
public void setFilled(java.lang.Boolean filled)
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver.
-
setId
public void setId(java.lang.String id)
Unique identifier for the object.
-
setInboundAddress
public void setInboundAddress(java.lang.String inboundAddress)
A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.
-
setLivemode
public void setLivemode(java.lang.Boolean livemode)
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.
-
setMetadata
public void setMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
-
setObject
public void setObject(java.lang.String object)
String representing the object's type. Objects of the same type share the same value.Equal to
bitcoin_receiver
.
-
setPayment
public void setPayment(java.lang.String payment)
The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.
-
setRefundAddress
public void setRefundAddress(java.lang.String refundAddress)
The refund address of this bitcoin receiver.
-
setTransactions
public void setTransactions(BitcoinTransactionCollection transactions)
A list with one entry for each time that the customer sent bitcoin to the receiver. Hidden when viewing the receiver with a publishable key.
-
setUncapturedFunds
public void setUncapturedFunds(java.lang.Boolean uncapturedFunds)
This receiver contains uncaptured funds that can be used for a payment or refunded.
-
setUsedForPayment
public void setUsedForPayment(java.lang.Boolean usedForPayment)
Indicate if this source is used for payment.
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
canEqual
protected boolean canEqual(java.lang.Object other)
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-