Object

org.mdedetrich.stripe.v1

BitcoinReceivers

Related Doc: package v1

Permalink

object BitcoinReceivers extends LazyLogging

Linear Supertypes
LazyLogging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BitcoinReceivers
  2. LazyLogging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    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.

    See also

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

  2. case class BitcoinReceiverInput(amount: BigDecimal, currency: Currency, email: String, description: Option[String], metadata: Option[Map[String, String]], refundMispayments: Option[Boolean]) extends Product with Serializable

    Permalink

    amount

    The amount of currency that you will be paid.

    currency

    The currency to which the bitcoin will be converted. You will be paid out in this currency. Only States Dollar]] is currently supported.

    email

    The email address of the customer.

    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. This will be unset if you POST an empty value.

    refundMispayments

    A flag that indicates whether you would like Stripe to automatically handle refunds for any mispayments to the receiver.

    See also

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

  3. case class BitcoinReceiverList(url: String, hasMore: Boolean, data: List[BitcoinReceiver], totalCount: Option[Long]) extends List[BitcoinReceiver] with Product with Serializable

    Permalink
  4. case class BitcoinReceiverListInput(active: Option[Boolean], endingBefore: Option[String], filled: Option[Boolean], limit: Option[Long], startingAfter: Option[String], uncapturedFunds: Option[Boolean]) extends Product with Serializable

    Permalink

    active

    Filter for active receivers.

    endingBefore

    A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

    filled

    Filter for filled receivers.

    limit

    A limit on the number of objects to be returned. Limit can range between 1 and 100 items.

    startingAfter

    A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next page of the list.

    uncapturedFunds

    Filter for receivers with uncaptured funds.

    See also

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

  5. case class Transaction(id: String, amount: BigDecimal, bitcoinAmount: BigDecimal, created: OffsetDateTime, currency: Currency, receiver: String) extends Product with Serializable

    Permalink

    amount

    The amount of currency that the transaction was converted to in real-time.

    bitcoinAmount

    The amount of bitcoin contained in the transaction.

    currency

    The currency to which this transaction was converted.

    receiver

    The receiver to which this transaction was sent.

    See also

    https://stripe.com/docs/api#bitcoin_receiver_object-transactions-data

  6. case class TransactionList(url: String, hasMore: Boolean, data: List[Transaction], totalCount: Option[Long]) extends List[Transaction] with Product with Serializable

    Permalink

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. object BitcoinReceiver extends Serializable

    Permalink
  5. object BitcoinReceiverInput extends Serializable

    Permalink
  6. object BitcoinReceiverList extends ListJsonMappers[BitcoinReceiver] with Serializable

    Permalink
  7. object BitcoinReceiverListInput extends Serializable

    Permalink
  8. object TransactionList extends ListJsonMappers[Transaction] with Serializable

    Permalink
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. implicit val bitcoinReceiverInputReads: Reads[BitcoinReceiverInput]

    Permalink
  11. implicit val bitcoinReceiverInputWrites: Writes[BitcoinReceiverInput]

    Permalink
  12. implicit val bitcoinReceiverReads: Reads[BitcoinReceiver]

    Permalink
  13. implicit val bitcoinReceiverWrites: Writes[BitcoinReceiver]

    Permalink
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. def create(bitcoinReceiverInput: BitcoinReceiverInput)(idempotencyKey: Option[IdempotencyKey] = None)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[BitcoinReceiver]]

    Permalink
  16. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def get(id: String)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[BitcoinReceiver]]

    Permalink
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def list(bitcoinReceiverListInput: BitcoinReceiverListInput, includeTotalCount: Boolean)(implicit apiKey: ApiKey, endpoint: Endpoint): Future[Try[BitcoinReceiverList]]

    Permalink
  24. lazy val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    LazyLogging
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  30. implicit val transactionReads: Reads[Transaction]

    Permalink
  31. implicit val transactionWrites: Writes[Transaction]

    Permalink
  32. final def wait(): Unit

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

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

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

Inherited from LazyLogging

Inherited from AnyRef

Inherited from Any

Ungrouped