Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Payout

Contains the types generated from the schema Payout

7 types
1 value

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourcePayout.hs

datadata Payout

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

A `Payout` object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, as well as list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Related guide: Receiving Payouts.

Constructors

Payout
- payoutAmount :: Int
  amount: Amount (in %s) to be transferred to your bank account or debit card.
- payoutArrivalDate :: Int
  arrival_date: Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.
- payoutAutomatic :: Bool
  automatic: Returns `true` if the payout was created by an automated payout schedule, and `false` if it was requested manually.
- payoutBalanceTransaction :: Maybe (Nullable PayoutBalanceTransaction'NonNullableVariants)
  balance_transaction: ID of the balance transaction that describes the impact of this payout on your account balance.
- payoutCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- payoutCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- payoutDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- payoutDestination :: Maybe (Nullable PayoutDestination'NonNullableVariants)
  destination: ID of the bank account or card the payout was sent to.
- payoutFailureBalanceTransaction :: Maybe (Nullable PayoutFailureBalanceTransaction'NonNullableVariants)
  failure_balance_transaction: If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.
- payoutFailureCode :: Maybe (Nullable Text)
  failure_code: Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.
  Constraints:
  - Maximum length of 5000
- payoutFailureMessage :: Maybe (Nullable Text)
  failure_message: Message to user further explaining reason for payout failure if available.
  Constraints:
  - Maximum length of 5000
- payoutId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- payoutLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- payoutMetadata :: Maybe (Nullable 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.
- payoutMethod :: Text
  method: The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)
  Constraints:
  - Maximum length of 5000
- payoutOriginalPayout :: Maybe (Nullable PayoutOriginalPayout'NonNullableVariants)
  original_payout: If the payout reverses another, this is the ID of the original payout.
- payoutReversedBy :: Maybe (Nullable PayoutReversedBy'NonNullableVariants)
  reversed_by: If the payout was reversed, this is the ID of the payout that reverses this payout.
- payoutSourceType :: Text
  source_type: The source balance this payout came from. One of `card`, `fpx`, or `bank_account`.
  Constraints:
  - Maximum length of 5000
- payoutStatementDescriptor :: Maybe (Nullable Text)
  statement_descriptor: Extra information about a payout to be displayed on the user's bank statement.
  Constraints:
  - Maximum length of 5000
- payoutStatus :: Text
  status: Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`.
  Constraints:
  - Maximum length of 5000
- payoutType :: PayoutType'
  type: Can be `bank_account` or `card`.

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout

valuemkPayout

:: Int
payoutAmount
-> Int
payoutArrivalDate
-> Bool
payoutAutomatic
-> Int
payoutCreated
-> Text
payoutCurrency
-> Text
payoutId
-> Bool
payoutLivemode
-> Text
payoutMethod
-> Text
payoutSourceType
-> Text
payoutStatus
-> PayoutType'
payoutType
-> Payout

Create a new Payout with all required fields.

datadata PayoutBalanceTransaction'NonNullableVariants

Defines the oneOf schema located at components.schemas.payout.properties.balance_transaction.anyOf in the specification.

ID of the balance transaction that describes the impact of this payout on your account balance.

Constructors

PayoutBalanceTransaction'NonNullableText Text
PayoutBalanceTransaction'NonNullableBalanceTransaction BalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout

datadata PayoutDestination'NonNullableVariants

Defines the oneOf schema located at components.schemas.payout.properties.destination.anyOf in the specification.

ID of the bank account or card the payout was sent to.

Constructors

PayoutDestination'NonNullableText Text
PayoutDestination'NonNullableBankAccount BankAccount
PayoutDestination'NonNullableCard Card
PayoutDestination'NonNullableDeletedBankAccount DeletedBankAccount
PayoutDestination'NonNullableDeletedCard DeletedCard

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutDestination'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout

datadata PayoutFailureBalanceTransaction'NonNullableVariants

Defines the oneOf schema located at components.schemas.payout.properties.failure_balance_transaction.anyOf in the specification.

If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.

Constructors

PayoutFailureBalanceTransaction'NonNullableText Text
PayoutFailureBalanceTransaction'NonNullableBalanceTransaction BalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutFailureBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutFailureBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutFailureBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutFailureBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout

datadata PayoutOriginalPayout'NonNullableVariants

Defines the oneOf schema located at components.schemas.payout.properties.original_payout.anyOf in the specification.

If the payout reverses another, this is the ID of the original payout.

Constructors

PayoutOriginalPayout'NonNullableText Text
PayoutOriginalPayout'NonNullablePayout Payout

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutOriginalPayout'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutOriginalPayout'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutOriginalPayout'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutOriginalPayout'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout

datadata PayoutReversedBy'NonNullableVariants

Defines the oneOf schema located at components.schemas.payout.properties.reversed_by.anyOf in the specification.

If the payout was reversed, this is the ID of the payout that reverses this payout.

Constructors

PayoutReversedBy'NonNullableText Text
PayoutReversedBy'NonNullablePayout Payout

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutReversedBy'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutReversedBy'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutReversedBy'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutReversedBy'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout

datadata PayoutType'

Defines the enum schema located at components.schemas.payout.properties.type in the specification.

Can be `bank_account` or `card`.

Constructors

PayoutType'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
PayoutType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
PayoutType'EnumBankAccount
Represents the JSON value "bank_account"
PayoutType'EnumCard
Represents the JSON value "card"

Instances4Eq, Show, FromJSON, ToJSON

Eq PayoutType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
Show PayoutType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
FromJSON PayoutType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout
ToJSON PayoutType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Payout