StripeAPI.Types.BitcoinReceiver

Contains the types generated from the schema BitcoinReceiver

Documentation

data BitcoinReceiver

Defines the data type for the schema bitcoin_receiver

Constructors

BitcoinReceiver

Fields

• bitcoinReceiverActive :: Bool

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

• bitcoinReceiverAmount :: Integer

  amount: The amount of `currency` that you are collecting as payment.

• bitcoinReceiverAmountReceived :: Integer

  amount_received: The amount of `currency` to which `bitcoin_amount_received` has been converted.

• bitcoinReceiverBitcoinAmount :: Integer

  bitcoin_amount: 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.

• bitcoinReceiverBitcoinAmountReceived :: Integer

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

• bitcoinReceiverBitcoinUri :: String

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

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverCreated :: Integer

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• bitcoinReceiverCurrency :: String

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

• bitcoinReceiverCustomer :: Maybe String

  customer: The customer ID of the bitcoin receiver.

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverDescription :: Maybe String

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverEmail :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverFilled :: Bool

  filled: This flag is initially false and updates to true when the customer sends the `bitcoin_amount` to this receiver.

• bitcoinReceiverId :: String

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverInboundAddress :: String

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

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• bitcoinReceiverMetadata :: BitcoinReceiverMetadata'

  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.

• bitcoinReceiverObject :: BitcoinReceiverObject'

  object: String representing the object's type. Objects of the same type share the same value.

• bitcoinReceiverPayment :: Maybe String

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

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverRefundAddress :: Maybe String

  refund_address: The refund address of this bitcoin receiver.

  Constraints:

  • Maximum length of 5000
• bitcoinReceiverTransactions :: Maybe BitcoinReceiverTransactions'

  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.

• bitcoinReceiverUncapturedFunds :: Bool

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

• bitcoinReceiverUsedForPayment :: Maybe Bool

  used_for_payment: Indicate if this source is used for payment.

Instances

Eq BitcoinReceiver

Defined in StripeAPI.Types.BitcoinReceiver

Methods

(==) :: BitcoinReceiver -> BitcoinReceiver -> Bool

(/=) :: BitcoinReceiver -> BitcoinReceiver -> Bool

Show BitcoinReceiver

Defined in StripeAPI.Types.BitcoinReceiver

Methods

showsPrec :: Int -> BitcoinReceiver -> ShowS

show :: BitcoinReceiver -> String

showList :: [BitcoinReceiver] -> ShowS

ToJSON BitcoinReceiver

Defined in StripeAPI.Types.BitcoinReceiver

Methods

toJSON :: BitcoinReceiver -> Value

toEncoding :: BitcoinReceiver -> Encoding

toJSONList :: [BitcoinReceiver] -> Value

toEncodingList :: [BitcoinReceiver] -> Encoding

FromJSON BitcoinReceiver

Defined in StripeAPI.Types.BitcoinReceiver

Methods

parseJSON :: Value -> Parser BitcoinReceiver

parseJSONList :: Value -> Parser [BitcoinReceiver]

data BitcoinReceiverMetadata'

Defines the data type for the schema bitcoin_receiverMetadata'

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.

Constructors

BitcoinReceiverMetadata'

Instances

Eq BitcoinReceiverMetadata'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

(==) :: BitcoinReceiverMetadata' -> BitcoinReceiverMetadata' -> Bool

(/=) :: BitcoinReceiverMetadata' -> BitcoinReceiverMetadata' -> Bool

Show BitcoinReceiverMetadata'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

showsPrec :: Int -> BitcoinReceiverMetadata' -> ShowS

show :: BitcoinReceiverMetadata' -> String

showList :: [BitcoinReceiverMetadata'] -> ShowS

ToJSON BitcoinReceiverMetadata'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

toJSON :: BitcoinReceiverMetadata' -> Value

toEncoding :: BitcoinReceiverMetadata' -> Encoding

toJSONList :: [BitcoinReceiverMetadata'] -> Value

toEncodingList :: [BitcoinReceiverMetadata'] -> Encoding

FromJSON BitcoinReceiverMetadata'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

parseJSON :: Value -> Parser BitcoinReceiverMetadata'

parseJSONList :: Value -> Parser [BitcoinReceiverMetadata']

data BitcoinReceiverObject'

Defines the enum schema bitcoin_receiverObject'

String representing the object's type. Objects of the same type share the same value.

Constructors

BitcoinReceiverObject'EnumOther Value

BitcoinReceiverObject'EnumTyped String

BitcoinReceiverObject'EnumStringBitcoinReceiver

Instances

Eq BitcoinReceiverObject'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

(==) :: BitcoinReceiverObject' -> BitcoinReceiverObject' -> Bool

(/=) :: BitcoinReceiverObject' -> BitcoinReceiverObject' -> Bool

Show BitcoinReceiverObject'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

showsPrec :: Int -> BitcoinReceiverObject' -> ShowS

show :: BitcoinReceiverObject' -> String

showList :: [BitcoinReceiverObject'] -> ShowS

ToJSON BitcoinReceiverObject'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

toJSON :: BitcoinReceiverObject' -> Value

toEncoding :: BitcoinReceiverObject' -> Encoding

toJSONList :: [BitcoinReceiverObject'] -> Value

toEncodingList :: [BitcoinReceiverObject'] -> Encoding

FromJSON BitcoinReceiverObject'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

parseJSON :: Value -> Parser BitcoinReceiverObject'

parseJSONList :: Value -> Parser [BitcoinReceiverObject']

data BitcoinReceiverTransactions'

Defines the data type for the schema bitcoin_receiverTransactions'

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.

Constructors

BitcoinReceiverTransactions'

Fields

• bitcoinReceiverTransactions'Data :: [] BitcoinTransaction

  data: Details about each object.

• bitcoinReceiverTransactions'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• bitcoinReceiverTransactions'Object :: BitcoinReceiverTransactions'Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• bitcoinReceiverTransactions'Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq BitcoinReceiverTransactions'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

(==) :: BitcoinReceiverTransactions' -> BitcoinReceiverTransactions' -> Bool

(/=) :: BitcoinReceiverTransactions' -> BitcoinReceiverTransactions' -> Bool

Show BitcoinReceiverTransactions'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

showsPrec :: Int -> BitcoinReceiverTransactions' -> ShowS

show :: BitcoinReceiverTransactions' -> String

showList :: [BitcoinReceiverTransactions'] -> ShowS

ToJSON BitcoinReceiverTransactions'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

toJSON :: BitcoinReceiverTransactions' -> Value

toEncoding :: BitcoinReceiverTransactions' -> Encoding

toJSONList :: [BitcoinReceiverTransactions'] -> Value

toEncodingList :: [BitcoinReceiverTransactions'] -> Encoding

FromJSON BitcoinReceiverTransactions'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

parseJSON :: Value -> Parser BitcoinReceiverTransactions'

parseJSONList :: Value -> Parser [BitcoinReceiverTransactions']

data BitcoinReceiverTransactions'Object'

Defines the enum schema bitcoin_receiverTransactions'Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

BitcoinReceiverTransactions'Object'EnumOther Value

BitcoinReceiverTransactions'Object'EnumTyped String

BitcoinReceiverTransactions'Object'EnumStringList

Instances

Eq BitcoinReceiverTransactions'Object'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

(==) :: BitcoinReceiverTransactions'Object' -> BitcoinReceiverTransactions'Object' -> Bool

(/=) :: BitcoinReceiverTransactions'Object' -> BitcoinReceiverTransactions'Object' -> Bool

Show BitcoinReceiverTransactions'Object'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

showsPrec :: Int -> BitcoinReceiverTransactions'Object' -> ShowS

show :: BitcoinReceiverTransactions'Object' -> String

showList :: [BitcoinReceiverTransactions'Object'] -> ShowS

ToJSON BitcoinReceiverTransactions'Object'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

toJSON :: BitcoinReceiverTransactions'Object' -> Value

toEncoding :: BitcoinReceiverTransactions'Object' -> Encoding

toJSONList :: [BitcoinReceiverTransactions'Object'] -> Value

toEncodingList :: [BitcoinReceiverTransactions'Object'] -> Encoding

FromJSON BitcoinReceiverTransactions'Object'

Defined in StripeAPI.Types.BitcoinReceiver

Methods

parseJSON :: Value -> Parser BitcoinReceiverTransactions'Object'

parseJSONList :: Value -> Parser [BitcoinReceiverTransactions'Object']