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
-
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
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
True when this bitcoin receiver has received a non-zero amount of bitcoin.The amount ofcurrency
that you are collecting as payment.The amount ofcurrency
to whichbitcoin_amount_received
has been converted.The amount of bitcoin that the customer should send to fill the receiver.The amount of bitcoin that has been sent by the customer to this receiver.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).Time at which the object was created.Three-letter ISO code for the currency to which the bitcoin will be converted.The customer ID of the bitcoin receiver.Always true for a deleted object.An arbitrary string attached to the object.getEmail()
The customer's email address, set by the API call that creates the receiver.This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver.getId()
Unique identifier for the object.A bitcoin address that is specific to this receiver.Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.Set of key-value pairs that you can attach to an object.String representing the object's type.The ID of the payment created from the receiver, if any.The refund address of this bitcoin receiver.A list with one entry for each time that the customer sent bitcoin to the receiver.This receiver contains uncaptured funds that can be used for a payment or refunded.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
Returns a list of your receivers.static BitcoinReceiverCollection
list
(Map<String, Object> params, RequestOptions options) Returns a list of your receivers.static BitcoinReceiver
Retrieves the Bitcoin receiver with the given ID.static BitcoinReceiver
retrieve
(String id, RequestOptions options) Retrieves the Bitcoin receiver with the given ID.static BitcoinReceiver
retrieve
(String id, BitcoinReceiverRetrieveParams params, RequestOptions options) Retrieves the Bitcoin receiver with the given ID.static BitcoinReceiver
Retrieves the Bitcoin receiver with the given ID.void
True when this bitcoin receiver has received a non-zero amount of bitcoin.void
The amount ofcurrency
that you are collecting as payment.void
setAmountReceived
(Long amountReceived) The amount ofcurrency
to whichbitcoin_amount_received
has been converted.void
setBitcoinAmount
(Long bitcoinAmount) The amount of bitcoin that the customer should send to fill the receiver.void
setBitcoinAmountReceived
(Long bitcoinAmountReceived) The amount of bitcoin that has been sent by the customer to this receiver.void
setBitcoinUri
(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
(Long created) Time at which the object was created.void
setCurrency
(String currency) Three-letter ISO code for the currency to which the bitcoin will be converted.void
setCustomer
(String customer) The customer ID of the bitcoin receiver.void
setDeleted
(Boolean deleted) Always true for a deleted object.void
setDescription
(String description) An arbitrary string attached to the object.void
The customer's email address, set by the API call that creates the receiver.void
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver.void
Unique identifier for the object.void
setInboundAddress
(String inboundAddress) A bitcoin address that is specific to this receiver.void
setLivemode
(Boolean livemode) Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode.void
setMetadata
(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.void
String representing the object's type.void
setPayment
(String payment) The ID of the payment created from the receiver, if any.void
setRefundAddress
(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
(Boolean uncapturedFunds) This receiver contains uncaptured funds that can be used for a payment or refunded.void
setUsedForPayment
(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
-
Constructor Details
-
BitcoinReceiver
public BitcoinReceiver()
-
-
Method Details
-
list
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(Map<String, Object> params, RequestOptions options) throws StripeExceptionReturns 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
Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
retrieve
Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
retrieve
public static BitcoinReceiver retrieve(String id, Map<String, Object> params, RequestOptions options) throws StripeExceptionRetrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
retrieve
public static BitcoinReceiver retrieve(String id, BitcoinReceiverRetrieveParams params, RequestOptions options) throws StripeException Retrieves the Bitcoin receiver with the given ID.- Throws:
StripeException
-
getActive
True when this bitcoin receiver has received a non-zero amount of bitcoin. -
getAmount
The amount ofcurrency
that you are collecting as payment. -
getAmountReceived
The amount ofcurrency
to whichbitcoin_amount_received
has been converted. -
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
The amount of bitcoin that has been sent by the customer to this receiver. -
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
Time at which the object was created. Measured in seconds since the Unix epoch. -
getCurrency
Three-letter ISO code for the currency to which the bitcoin will be converted. -
getCustomer
The customer ID of the bitcoin receiver. -
getDeleted
Always true for a deleted object. -
getDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
getEmail
The customer's email address, set by the API call that creates the receiver. -
getFilled
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver. -
getInboundAddress
A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. -
getLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
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
String representing the object's type. Objects of the same type share the same value.Equal to
bitcoin_receiver
. -
getPayment
The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. -
getRefundAddress
The refund address of this bitcoin receiver. -
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
This receiver contains uncaptured funds that can be used for a payment or refunded. -
getUsedForPayment
Indicate if this source is used for payment. -
setActive
True when this bitcoin receiver has received a non-zero amount of bitcoin. -
setAmount
The amount ofcurrency
that you are collecting as payment. -
setAmountReceived
The amount ofcurrency
to whichbitcoin_amount_received
has been converted. -
setBitcoinAmount
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
The amount of bitcoin that has been sent by the customer to this receiver. -
setBitcoinUri
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
Time at which the object was created. Measured in seconds since the Unix epoch. -
setCurrency
Three-letter ISO code for the currency to which the bitcoin will be converted. -
setCustomer
The customer ID of the bitcoin receiver. -
setDeleted
Always true for a deleted object. -
setDescription
An arbitrary string attached to the object. Often useful for displaying to users. -
setEmail
The customer's email address, set by the API call that creates the receiver. -
setFilled
This flag is initially false and updates to true when the customer sends thebitcoin_amount
to this receiver. -
setId
Unique identifier for the object. -
setInboundAddress
A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver. -
setLivemode
Has the valuetrue
if the object exists in live mode or the valuefalse
if the object exists in test mode. -
setMetadata
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
String representing the object's type. Objects of the same type share the same value.Equal to
bitcoin_receiver
. -
setPayment
The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key. -
setRefundAddress
The refund address of this bitcoin receiver. -
setTransactions
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
This receiver contains uncaptured funds that can be used for a payment or refunded. -
setUsedForPayment
Indicate if this source is used for payment. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-