StripeAPI.Types.Payout

Contains the types generated from the schema Payout

Documentation

data 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

Fields

• 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 PayoutBalanceTransaction'Variants

  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 Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• payoutDestination :: Maybe PayoutDestination'Variants

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

• payoutFailureBalanceTransaction :: Maybe PayoutFailureBalanceTransaction'Variants

  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 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 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 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 PayoutOriginalPayout'Variants

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

• payoutReversedBy :: Maybe PayoutReversedBy'Variants

  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 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`.

Instances

Eq Payout

Defined in StripeAPI.Types.Payout

Methods

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

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

Show Payout

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> Payout -> ShowS

show :: Payout -> String

showList :: [Payout] -> ShowS

ToJSON Payout

Defined in StripeAPI.Types.Payout

Methods

toJSON :: Payout -> Value

toEncoding :: Payout -> Encoding

toJSONList :: [Payout] -> Value

toEncodingList :: [Payout] -> Encoding

FromJSON Payout

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser Payout

parseJSONList :: Value -> Parser [Payout]

mkPayout

Arguments

:: 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.

data PayoutBalanceTransaction'Variants

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'Text Text

PayoutBalanceTransaction'BalanceTransaction BalanceTransaction

Instances

Eq PayoutBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

(==) :: PayoutBalanceTransaction'Variants -> PayoutBalanceTransaction'Variants -> Bool

(/=) :: PayoutBalanceTransaction'Variants -> PayoutBalanceTransaction'Variants -> Bool

Show PayoutBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> PayoutBalanceTransaction'Variants -> ShowS

show :: PayoutBalanceTransaction'Variants -> String

showList :: [PayoutBalanceTransaction'Variants] -> ShowS

ToJSON PayoutBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

toJSON :: PayoutBalanceTransaction'Variants -> Value

toEncoding :: PayoutBalanceTransaction'Variants -> Encoding

toJSONList :: [PayoutBalanceTransaction'Variants] -> Value

toEncodingList :: [PayoutBalanceTransaction'Variants] -> Encoding

FromJSON PayoutBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser PayoutBalanceTransaction'Variants

parseJSONList :: Value -> Parser [PayoutBalanceTransaction'Variants]

data PayoutDestination'Variants

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'Text Text

PayoutDestination'BankAccount BankAccount

PayoutDestination'Card Card

PayoutDestination'DeletedBankAccount DeletedBankAccount

PayoutDestination'DeletedCard DeletedCard

Instances

Eq PayoutDestination'Variants

Defined in StripeAPI.Types.Payout

Methods

(==) :: PayoutDestination'Variants -> PayoutDestination'Variants -> Bool

(/=) :: PayoutDestination'Variants -> PayoutDestination'Variants -> Bool

Show PayoutDestination'Variants

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> PayoutDestination'Variants -> ShowS

show :: PayoutDestination'Variants -> String

showList :: [PayoutDestination'Variants] -> ShowS

ToJSON PayoutDestination'Variants

Defined in StripeAPI.Types.Payout

Methods

toJSON :: PayoutDestination'Variants -> Value

toEncoding :: PayoutDestination'Variants -> Encoding

toJSONList :: [PayoutDestination'Variants] -> Value

toEncodingList :: [PayoutDestination'Variants] -> Encoding

FromJSON PayoutDestination'Variants

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser PayoutDestination'Variants

parseJSONList :: Value -> Parser [PayoutDestination'Variants]

data PayoutFailureBalanceTransaction'Variants

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'Text Text

PayoutFailureBalanceTransaction'BalanceTransaction BalanceTransaction

Instances

Eq PayoutFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

(==) :: PayoutFailureBalanceTransaction'Variants -> PayoutFailureBalanceTransaction'Variants -> Bool

(/=) :: PayoutFailureBalanceTransaction'Variants -> PayoutFailureBalanceTransaction'Variants -> Bool

Show PayoutFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> PayoutFailureBalanceTransaction'Variants -> ShowS

show :: PayoutFailureBalanceTransaction'Variants -> String

showList :: [PayoutFailureBalanceTransaction'Variants] -> ShowS

ToJSON PayoutFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

toJSON :: PayoutFailureBalanceTransaction'Variants -> Value

toEncoding :: PayoutFailureBalanceTransaction'Variants -> Encoding

toJSONList :: [PayoutFailureBalanceTransaction'Variants] -> Value

toEncodingList :: [PayoutFailureBalanceTransaction'Variants] -> Encoding

FromJSON PayoutFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser PayoutFailureBalanceTransaction'Variants

parseJSONList :: Value -> Parser [PayoutFailureBalanceTransaction'Variants]

data PayoutOriginalPayout'Variants

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'Text Text

PayoutOriginalPayout'Payout Payout

Instances

Eq PayoutOriginalPayout'Variants

Defined in StripeAPI.Types.Payout

Methods

(==) :: PayoutOriginalPayout'Variants -> PayoutOriginalPayout'Variants -> Bool

(/=) :: PayoutOriginalPayout'Variants -> PayoutOriginalPayout'Variants -> Bool

Show PayoutOriginalPayout'Variants

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> PayoutOriginalPayout'Variants -> ShowS

show :: PayoutOriginalPayout'Variants -> String

showList :: [PayoutOriginalPayout'Variants] -> ShowS

ToJSON PayoutOriginalPayout'Variants

Defined in StripeAPI.Types.Payout

Methods

toJSON :: PayoutOriginalPayout'Variants -> Value

toEncoding :: PayoutOriginalPayout'Variants -> Encoding

toJSONList :: [PayoutOriginalPayout'Variants] -> Value

toEncodingList :: [PayoutOriginalPayout'Variants] -> Encoding

FromJSON PayoutOriginalPayout'Variants

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser PayoutOriginalPayout'Variants

parseJSONList :: Value -> Parser [PayoutOriginalPayout'Variants]

data PayoutReversedBy'Variants

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'Text Text

PayoutReversedBy'Payout Payout

Instances

Eq PayoutReversedBy'Variants

Defined in StripeAPI.Types.Payout

Methods

(==) :: PayoutReversedBy'Variants -> PayoutReversedBy'Variants -> Bool

(/=) :: PayoutReversedBy'Variants -> PayoutReversedBy'Variants -> Bool

Show PayoutReversedBy'Variants

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> PayoutReversedBy'Variants -> ShowS

show :: PayoutReversedBy'Variants -> String

showList :: [PayoutReversedBy'Variants] -> ShowS

ToJSON PayoutReversedBy'Variants

Defined in StripeAPI.Types.Payout

Methods

toJSON :: PayoutReversedBy'Variants -> Value

toEncoding :: PayoutReversedBy'Variants -> Encoding

toJSONList :: [PayoutReversedBy'Variants] -> Value

toEncodingList :: [PayoutReversedBy'Variants] -> Encoding

FromJSON PayoutReversedBy'Variants

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser PayoutReversedBy'Variants

parseJSONList :: Value -> Parser [PayoutReversedBy'Variants]

data 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"

Instances

Eq PayoutType'

Defined in StripeAPI.Types.Payout

Methods

(==) :: PayoutType' -> PayoutType' -> Bool

(/=) :: PayoutType' -> PayoutType' -> Bool

Show PayoutType'

Defined in StripeAPI.Types.Payout

Methods

showsPrec :: Int -> PayoutType' -> ShowS

show :: PayoutType' -> String

showList :: [PayoutType'] -> ShowS

ToJSON PayoutType'

Defined in StripeAPI.Types.Payout

Methods

toJSON :: PayoutType' -> Value

toEncoding :: PayoutType' -> Encoding

toJSONList :: [PayoutType'] -> Value

toEncodingList :: [PayoutType'] -> Encoding

FromJSON PayoutType'

Defined in StripeAPI.Types.Payout

Methods

parseJSON :: Value -> Parser PayoutType'

parseJSONList :: Value -> Parser [PayoutType']