stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Types.Payout

Description

Contains the types generated from the schema Payout

Synopsis

Documentation

data Payout Source #

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 

Fields

Instances

Instances details
Eq Payout Source # 
Instance details

Defined in StripeAPI.Types.Payout

Methods

(==) :: Payout -> Payout -> Bool #

(/=) :: Payout -> Payout -> Bool #

Show Payout Source # 
Instance details

Defined in StripeAPI.Types.Payout

ToJSON Payout Source # 
Instance details

Defined in StripeAPI.Types.Payout

FromJSON Payout Source # 
Instance details

Defined in StripeAPI.Types.Payout

data PayoutBalanceTransaction'Variants Source #

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.

data PayoutFailureBalanceTransaction'Variants Source #

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.

data PayoutType' Source #

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"