Safe Haskell	None
Language	Haskell2010

StripeAPI.Types.BitcoinReceiver

Description

Contains the types generated from the schema BitcoinReceiver

Synopsis

data BitcoinReceiver = BitcoinReceiver {
}
mkBitcoinReceiver :: Bool -> Int -> Int -> Int -> Int -> Text -> Int -> Text -> Bool -> Text -> Text -> Bool -> Bool -> BitcoinReceiver
data BitcoinReceiverTransactions' = BitcoinReceiverTransactions' {
}
mkBitcoinReceiverTransactions' :: [BitcoinTransaction] -> Bool -> Text -> BitcoinReceiverTransactions'

Documentation

data BitcoinReceiver Source #

Defines the object schema located at components.schemas.bitcoin_receiver in the specification.

Constructors

BitcoinReceiver

Fields

bitcoinReceiverActive :: Bool
active: True when this bitcoin receiver has received a non-zero amount of bitcoin.
bitcoinReceiverAmount :: Int
amount: The amount of `currency` that you are collecting as payment.
bitcoinReceiverAmountReceived :: Int
amount_received: The amount of `currency` to which `bitcoin_amount_received` has been converted.
bitcoinReceiverBitcoinAmount :: Int
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 :: Int
bitcoin_amount_received: The amount of bitcoin that has been sent by the customer to this receiver.
bitcoinReceiverBitcoinUri :: Text
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 :: Int
created: Time at which the object was created. Measured in seconds since the Unix epoch.
bitcoinReceiverCurrency :: Text
currency: Three-letter ISO code for the currency to which the bitcoin will be converted.
bitcoinReceiverCustomer :: Maybe Text
customer: The customer ID of the bitcoin receiver.
Constraints:
- Maximum length of 5000
bitcoinReceiverDescription :: Maybe Text
description: An arbitrary string attached to the object. Often useful for displaying to users.
Constraints:
- Maximum length of 5000
bitcoinReceiverEmail :: Maybe Text
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 :: Text
id: Unique identifier for the object.
Constraints:
- Maximum length of 5000
bitcoinReceiverInboundAddress :: Text
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 :: Maybe Object
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.
bitcoinReceiverPayment :: Maybe Text
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 Text
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

Instances details

Eq BitcoinReceiver Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods (==) :: BitcoinReceiver -> BitcoinReceiver -> Bool # (/=) :: BitcoinReceiver -> BitcoinReceiver -> Bool #
Show BitcoinReceiver Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods showsPrec :: Int -> BitcoinReceiver -> ShowS # show :: BitcoinReceiver -> String # showList :: [BitcoinReceiver] -> ShowS #
ToJSON BitcoinReceiver Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods toJSON :: BitcoinReceiver -> Value # toEncoding :: BitcoinReceiver -> Encoding # toJSONList :: [BitcoinReceiver] -> Value # toEncodingList :: [BitcoinReceiver] -> Encoding #
FromJSON BitcoinReceiver Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods parseJSON :: Value -> Parser BitcoinReceiver # parseJSONList :: Value -> Parser [BitcoinReceiver] #

mkBitcoinReceiver Source #

Arguments

:: Bool	`bitcoinReceiverActive`
-> Int	`bitcoinReceiverAmount`
-> Int	`bitcoinReceiverAmountReceived`
-> Int	`bitcoinReceiverBitcoinAmount`
-> Int	`bitcoinReceiverBitcoinAmountReceived`
-> Text	`bitcoinReceiverBitcoinUri`
-> Int	`bitcoinReceiverCreated`
-> Text	`bitcoinReceiverCurrency`
-> Bool	`bitcoinReceiverFilled`
-> Text	`bitcoinReceiverId`
-> Text	`bitcoinReceiverInboundAddress`
-> Bool	`bitcoinReceiverLivemode`
-> Bool	`bitcoinReceiverUncapturedFunds`
-> BitcoinReceiver

Create a new BitcoinReceiver with all required fields.

data BitcoinReceiverTransactions' Source #

Defines the object schema located at components.schemas.bitcoin_receiver.properties.transactions in the specification.

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'Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000

Instances

Instances details

Eq BitcoinReceiverTransactions' Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods (==) :: BitcoinReceiverTransactions' -> BitcoinReceiverTransactions' -> Bool # (/=) :: BitcoinReceiverTransactions' -> BitcoinReceiverTransactions' -> Bool #
Show BitcoinReceiverTransactions' Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods showsPrec :: Int -> BitcoinReceiverTransactions' -> ShowS # show :: BitcoinReceiverTransactions' -> String # showList :: [BitcoinReceiverTransactions'] -> ShowS #
ToJSON BitcoinReceiverTransactions' Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods toJSON :: BitcoinReceiverTransactions' -> Value # toEncoding :: BitcoinReceiverTransactions' -> Encoding # toJSONList :: [BitcoinReceiverTransactions'] -> Value # toEncodingList :: [BitcoinReceiverTransactions'] -> Encoding #
FromJSON BitcoinReceiverTransactions' Source #
Instance details Defined in StripeAPI.Types.BitcoinReceiver Methods parseJSON :: Value -> Parser BitcoinReceiverTransactions' # parseJSONList :: Value -> Parser [BitcoinReceiverTransactions'] #

mkBitcoinReceiverTransactions' Source #

Arguments

:: [BitcoinTransaction]	`bitcoinReceiverTransactions'Data`
-> Bool	`bitcoinReceiverTransactions'HasMore`
-> Text	`bitcoinReceiverTransactions'Url`
-> BitcoinReceiverTransactions'

Create a new BitcoinReceiverTransactions' with all required fields.