Class/Object

org.mdedetrich.stripe.v1.BitcoinReceivers

BitcoinReceiver

Related Docs: object BitcoinReceiver | package BitcoinReceivers

Permalink

case class BitcoinReceiver(id: String, active: Boolean, amount: BigDecimal, amountReceived: BigDecimal, bitcoinAmount: BigDecimal, bitcoinAmountReceived: BigDecimal, bitcoinUri: String, created: OffsetDateTime, currency: Currency, customer: String, description: String, email: String, filled: Boolean, inboundAddress: String, livemode: Boolean, metadata: Option[Map[String, String]], payment: Option[String], refundAddress: Option[String], transactions: Option[TransactionList], uncapturedFunds: Boolean, usedForPayment: Boolean) extends StripeObject with PaymentSource with Product with Serializable

active

True when this bitcoin receiver has received a non-zero amount of bitcoin.

amount

The amount of currency that you are collecting as payment.

amountReceived

The amount of currency to which bitcoinAmountReceived has been converted.

bitcoinAmount

The amount of bitcoin that the customer should send to fill the receiver. The bitcoinAmount is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

bitcoinAmountReceived

The amount of bitcoin that has been sent by the customer to this receiver.

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

currency

Three-letter ISO currency code representing the currency to which the bitcoin will be converted.

email

The customer’s email address, set by the API call that creates the receiver.

filled

This flag is initially false and updates to true when the customer sends the bitcoinAmount to this receiver.

inboundAddress

A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

metadata

A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

payment

The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

refundAddress

The refund address for these bitcoin, if communicated by the customer.

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.

uncapturedFunds

This receiver contains uncaptured funds that can be used for a payment or refunded.

See also

https://stripe.com/docs/api#bitcoin_receiver_object

Linear Supertypes
Serializable, Serializable, Product, Equals, PaymentSource, StripeObject, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitcoinReceiver
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PaymentSource
  7. StripeObject
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BitcoinReceiver(id: String, active: Boolean, amount: BigDecimal, amountReceived: BigDecimal, bitcoinAmount: BigDecimal, bitcoinAmountReceived: BigDecimal, bitcoinUri: String, created: OffsetDateTime, currency: Currency, customer: String, description: String, email: String, filled: Boolean, inboundAddress: String, livemode: Boolean, metadata: Option[Map[String, String]], payment: Option[String], refundAddress: Option[String], transactions: Option[TransactionList], uncapturedFunds: Boolean, usedForPayment: Boolean)

    Permalink

    active

    True when this bitcoin receiver has received a non-zero amount of bitcoin.

    amount

    The amount of currency that you are collecting as payment.

    amountReceived

    The amount of currency to which bitcoinAmountReceived has been converted.

    bitcoinAmount

    The amount of bitcoin that the customer should send to fill the receiver. The bitcoinAmount is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

    bitcoinAmountReceived

    The amount of bitcoin that has been sent by the customer to this receiver.

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

    currency

    Three-letter ISO currency code representing the currency to which the bitcoin will be converted.

    email

    The customer’s email address, set by the API call that creates the receiver.

    filled

    This flag is initially false and updates to true when the customer sends the bitcoinAmount to this receiver.

    inboundAddress

    A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

    metadata

    A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

    payment

    The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

    refundAddress

    The refund address for these bitcoin, if communicated by the customer.

    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.

    uncapturedFunds

    This receiver contains uncaptured funds that can be used for a payment or refunded.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val active: Boolean

    Permalink

    True when this bitcoin receiver has received a non-zero amount of bitcoin.

  5. val amount: BigDecimal

    Permalink

    The amount of currency that you are collecting as payment.

  6. val amountReceived: BigDecimal

    Permalink

    The amount of currency to which bitcoinAmountReceived has been converted.

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. val bitcoinAmount: BigDecimal

    Permalink

    The amount of bitcoin that the customer should send to fill the receiver.

    The amount of bitcoin that the customer should send to fill the receiver. The bitcoinAmount is denominated in Satoshi: there are 10^8 Satoshi in one bitcoin.

  9. val bitcoinAmountReceived: BigDecimal

    Permalink

    The amount of bitcoin that has been sent by the customer to this receiver.

  10. val bitcoinUri: String

    Permalink

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

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. val created: OffsetDateTime

    Permalink
  13. val currency: Currency

    Permalink

    Three-letter ISO currency code representing the currency to which the bitcoin will be converted.

  14. val customer: String

    Permalink
  15. val description: String

    Permalink
  16. val email: String

    Permalink

    The customer’s email address, set by the API call that creates the receiver.

  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. val filled: Boolean

    Permalink

    This flag is initially false and updates to true when the customer sends the bitcoinAmount to this receiver.

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. val id: String

    Permalink
  22. val inboundAddress: String

    Permalink

    A bitcoin address that is specific to this receiver.

    A bitcoin address that is specific to this receiver. The customer can send bitcoin to this address to fill the receiver.

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. val livemode: Boolean

    Permalink
  25. val metadata: Option[Map[String, String]]

    Permalink

    A set of key/value pairs that you can attach to a customer object.

    A set of key/value pairs that you can attach to a customer object. It can be useful for storing additional information about the customer in a structured format.

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. val payment: Option[String]

    Permalink

    The ID of the payment created from the receiver, if any.

    The ID of the payment created from the receiver, if any. Hidden when viewing the receiver with a publishable key.

  30. val refundAddress: Option[String]

    Permalink

    The refund address for these bitcoin, if communicated by the customer.

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. val transactions: Option[TransactionList]

    Permalink

    A list with one entry for each time that the customer sent bitcoin to the receiver.

    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.

  33. val uncapturedFunds: Boolean

    Permalink

    This receiver contains uncaptured funds that can be used for a payment or refunded.

  34. val usedForPayment: Boolean

    Permalink
  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from PaymentSource

Inherited from StripeObject

Inherited from AnyRef

Inherited from Any

Ungrouped