Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Topup

Contains the types generated from the schema Topup

Synopsis

data Topup
value mkTopup
data TopupBalanceTransaction'NonNullableVariants
data TopupStatus'

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourceTopup.hs

datadata Topup

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
- topupAmount :: Int
  amount: Amount transferred.
- topupBalanceTransaction :: Maybe (Nullable TopupBalanceTransaction'NonNullableVariants)
  balance_transaction: 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.
- topupCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- topupCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
  Constraints:
  - Maximum length of 5000
- topupDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- topupExpectedAvailabilityDate :: Maybe (Nullable Int)
  expected_availability_date: Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
- topupFailureCode :: Maybe (Nullable Text)
  failure_code: Error code explaining reason for top-up failure if available (see the errors section for a list of codes).
  Constraints:
  - Maximum length of 5000
- topupFailureMessage :: Maybe (Nullable Text)
  failure_message: Message to user further explaining reason for top-up failure if available.
  Constraints:
  - Maximum length of 5000
- topupId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- topupLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- topupMetadata :: 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.
- topupSource :: Source
  source: `Source` objects allow you to accept a variety of payment methods. They represent a customer's payment instrument, and can be used with the Stripe API just like a `Card` object: once chargeable, they can be charged, or can be attached to customers.
  Related guides: Sources API and Sources & Customers.
- topupStatementDescriptor :: Maybe (Nullable Text)
  statement_descriptor: Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
  Constraints:
  - Maximum length of 5000
- topupStatus :: TopupStatus'
  status: The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
- topupTransferGroup :: Maybe (Nullable Text)
  transfer_group: A string that identifies this top-up as part of a group.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq TopupDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
Show TopupDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
FromJSON TopupDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
ToJSON TopupDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup

valuemkTopup

:: Int
topupAmount
-> Int
topupCreated
-> Text
topupCurrency
-> Text
topupId
-> Bool
topupLivemode
-> Object
topupMetadata
-> Source
topupSource
-> TopupStatus'
topupStatus
-> Topup

Source#

Create a new Topup with all required fields.

datadata TopupBalanceTransaction'NonNullableVariants

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'NonNullableText Text
TopupBalanceTransaction'NonNullableBalanceTransaction BalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq TopupBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
Show TopupBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
FromJSON TopupBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
ToJSON TopupBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup

datadata 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 "canceled"
TopupStatus'EnumFailed
Represents the JSON value "failed"
TopupStatus'EnumPending
Represents the JSON value "pending"
TopupStatus'EnumReversed
Represents the JSON value "reversed"
TopupStatus'EnumSucceeded
Represents the JSON value "succeeded"

Instances4Eq, Show, FromJSON, ToJSON

Eq TopupStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
Show TopupStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
FromJSON TopupStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup
ToJSON TopupStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Topup