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

  • Constructor Details

    • BitcoinReceiver

      public BitcoinReceiver()

  • Method Details

    • list

      public static BitcoinReceiverCollection list(Map<String,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(Map<String,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(String id) throws StripeException
      Retrieves the Bitcoin receiver with the given ID.
      Throws:
      StripeException

    • retrieve

      public static BitcoinReceiver retrieve(String id, RequestOptions options) throws StripeException
      Retrieves the Bitcoin receiver with the given ID.
      Throws:
      StripeException

    • retrieve

      public static BitcoinReceiver retrieve(String id, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves 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

      public Boolean getActive()
      True when this bitcoin receiver has received a non-zero amount of bitcoin.

    • getAmount

      public Long getAmount()
      The amount of currency that you are collecting as payment.

    • getAmountReceived

      public Long getAmountReceived()
      The amount of currency to which bitcoin_amount_received has been converted.

    • getBitcoinAmount

      public Long getBitcoinAmount()
      The amount of bitcoin that the customer should send to fill the receiver. The bitcoin_amount is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

    • getBitcoinAmountReceived

      public Long getBitcoinAmountReceived()
      The amount of bitcoin that has been sent by the customer to this receiver.

    • getBitcoinUri

      public 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 Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCurrency

      public String getCurrency()
      Three-letter ISO code for the currency to which the bitcoin will be converted.

    • getCustomer

      public String getCustomer()
      The customer ID of the bitcoin receiver.

    • getDeleted

      public Boolean getDeleted()
      Always true for a deleted object.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.

    • getEmail

      public String getEmail()
      The customer's email address, set by the API call that creates the receiver.

    • getFilled

      public Boolean getFilled()
      This flag is initially false and updates to true when the customer sends the bitcoin_amount to this receiver.

    • getInboundAddress

      public 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 Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,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 String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to bitcoin_receiver.

    • getPayment

      public String getPayment()
      The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

    • getRefundAddress

      public 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 Boolean getUncapturedFunds()
      This receiver contains uncaptured funds that can be used for a payment or refunded.

    • getUsedForPayment

      public Boolean getUsedForPayment()
      Indicate if this source is used for payment.

    • setActive

      public void setActive(Boolean active)
      True when this bitcoin receiver has received a non-zero amount of bitcoin.

    • setAmount

      public void setAmount(Long amount)
      The amount of currency that you are collecting as payment.

    • setAmountReceived

      public void setAmountReceived(Long amountReceived)
      The amount of currency to which bitcoin_amount_received has been converted.

    • setBitcoinAmount

      public void setBitcoinAmount(Long bitcoinAmount)
      The amount of bitcoin that the customer should send to fill the receiver. The bitcoin_amount is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

    • setBitcoinAmountReceived

      public void setBitcoinAmountReceived(Long bitcoinAmountReceived)
      The amount of bitcoin that has been sent by the customer to this receiver.

    • setBitcoinUri

      public 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).

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCurrency

      public void setCurrency(String currency)
      Three-letter ISO code for the currency to which the bitcoin will be converted.

    • setCustomer

      public void setCustomer(String customer)
      The customer ID of the bitcoin receiver.

    • setDeleted

      public void setDeleted(Boolean deleted)
      Always true for a deleted object.

    • setDescription

      public void setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • setEmail

      public void setEmail(String email)
      The customer's email address, set by the API call that creates the receiver.

    • setFilled

      public void setFilled(Boolean filled)
      This flag is initially false and updates to true when the customer sends the bitcoin_amount to this receiver.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setInboundAddress

      public void setInboundAddress(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(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setMetadata

      public void setMetadata(Map<String,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(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(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(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(Boolean uncapturedFunds)
      This receiver contains uncaptured funds that can be used for a payment or refunded.

    • setUsedForPayment

      public void setUsedForPayment(Boolean usedForPayment)
      Indicate if this source is used for payment.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId