Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.Topup
Description
Contains the types generated from the schema Topup
Synopsis
- data Topup = Topup {
- topupAmount :: Int
- topupBalanceTransaction :: Maybe TopupBalanceTransaction'Variants
- topupCreated :: Int
- topupCurrency :: Text
- topupDescription :: Maybe Text
- topupExpectedAvailabilityDate :: Maybe Int
- topupFailureCode :: Maybe Text
- topupFailureMessage :: Maybe Text
- topupId :: Text
- topupLivemode :: Bool
- topupMetadata :: Object
- topupSource :: Source
- topupStatementDescriptor :: Maybe Text
- topupStatus :: TopupStatus'
- topupTransferGroup :: Maybe Text
- mkTopup :: Int -> Int -> Text -> Text -> Bool -> Object -> Source -> TopupStatus' -> Topup
- data TopupBalanceTransaction'Variants
- data TopupStatus'
Documentation
Defines the object schema located at components.schemas.topup
in the specification.
To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.
Related guide: Topping Up your Platform Account.
Constructors
Topup | |
Fields
|
Create a new Topup
with all required fields.
data TopupBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.topup.properties.balance_transaction.anyOf
in the specification.
ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
Constructors
TopupBalanceTransaction'Text Text | |
TopupBalanceTransaction'BalanceTransaction BalanceTransaction |
Instances
Eq TopupBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Topup | |
Show TopupBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Topup Methods showsPrec :: Int -> TopupBalanceTransaction'Variants -> ShowS # | |
ToJSON TopupBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Topup | |
FromJSON TopupBalanceTransaction'Variants Source # | |
Defined in StripeAPI.Types.Topup Methods parseJSON :: Value -> Parser TopupBalanceTransaction'Variants # parseJSONList :: Value -> Parser [TopupBalanceTransaction'Variants] # |
data TopupStatus' Source #
Defines the enum schema located at components.schemas.topup.properties.status
in the specification.
The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
Constructors
TopupStatus'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
TopupStatus'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
TopupStatus'EnumCanceled | Represents the JSON value |
TopupStatus'EnumFailed | Represents the JSON value |
TopupStatus'EnumPending | Represents the JSON value |
TopupStatus'EnumReversed | Represents the JSON value |
TopupStatus'EnumSucceeded | Represents the JSON value |
Instances
Eq TopupStatus' Source # | |
Defined in StripeAPI.Types.Topup | |
Show TopupStatus' Source # | |
Defined in StripeAPI.Types.Topup Methods showsPrec :: Int -> TopupStatus' -> ShowS # show :: TopupStatus' -> String # showList :: [TopupStatus'] -> ShowS # | |
ToJSON TopupStatus' Source # | |
Defined in StripeAPI.Types.Topup Methods toJSON :: TopupStatus' -> Value # toEncoding :: TopupStatus' -> Encoding # toJSONList :: [TopupStatus'] -> Value # toEncodingList :: [TopupStatus'] -> Encoding # | |
FromJSON TopupStatus' Source # | |
Defined in StripeAPI.Types.Topup |