StripeAPI.Types.Transfer

Contains the types generated from the schema Transfer

Documentation

data Transfer

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

A `Transfer` object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.

Related guide: Creating Separate Charges and Transfers.

Constructors

Transfer

Fields

• transferAmount :: Int

  amount: Amount in %s to be transferred.

• transferAmountReversed :: Int

  amount_reversed: Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

• transferBalanceTransaction :: Maybe TransferBalanceTransaction'Variants

  balance_transaction: Balance transaction that describes the impact of this transfer on your account balance.

• transferCreated :: Int

  created: Time that this record of the transfer was first created.

• transferCurrency :: Text

  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

• transferDescription :: Maybe Text

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

  Constraints:

  • Maximum length of 5000
• transferDestination :: Maybe TransferDestination'Variants

  destination: ID of the Stripe account the transfer was sent to.

• transferDestinationPayment :: Maybe TransferDestinationPayment'Variants

  destination_payment: If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

• transferId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• transferLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

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

• transferReversals :: TransferReversals'

  reversals: A list of reversals that have been applied to the transfer.

• transferReversed :: Bool

  reversed: Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

• transferSourceTransaction :: Maybe TransferSourceTransaction'Variants

  source_transaction: ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.

• transferSourceType :: Maybe Text

  source_type: The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`.

  Constraints:

  • Maximum length of 5000
• transferTransferGroup :: Maybe Text

  transfer_group: A string that identifies this transaction as part of a group. See the Connect documentation for details.

  Constraints:

  • Maximum length of 5000

Instances

Eq Transfer

Defined in StripeAPI.Types.Transfer

Methods

(==) :: Transfer -> Transfer -> Bool

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

Show Transfer

Defined in StripeAPI.Types.Transfer

Methods

showsPrec :: Int -> Transfer -> ShowS

show :: Transfer -> String

showList :: [Transfer] -> ShowS

ToJSON Transfer

Defined in StripeAPI.Types.Transfer

Methods

toJSON :: Transfer -> Value

toEncoding :: Transfer -> Encoding

toJSONList :: [Transfer] -> Value

toEncodingList :: [Transfer] -> Encoding

FromJSON Transfer

Defined in StripeAPI.Types.Transfer

Methods

parseJSON :: Value -> Parser Transfer

parseJSONList :: Value -> Parser [Transfer]

mkTransfer

Arguments

:: Int

transferAmount

-> Int

transferAmountReversed

-> Int

transferCreated

-> Text

transferCurrency

-> Text

transferId

-> Bool

transferLivemode

-> Object

transferMetadata

-> TransferReversals'

transferReversals

-> Bool

transferReversed

-> Transfer

Create a new Transfer with all required fields.

data TransferBalanceTransaction'Variants

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

Balance transaction that describes the impact of this transfer on your account balance.

Constructors

TransferBalanceTransaction'Text Text

TransferBalanceTransaction'BalanceTransaction BalanceTransaction

Instances

Eq TransferBalanceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

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

Show TransferBalanceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

show :: TransferBalanceTransaction'Variants -> String

showList :: [TransferBalanceTransaction'Variants] -> ShowS

ToJSON TransferBalanceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

toJSON :: TransferBalanceTransaction'Variants -> Value

toEncoding :: TransferBalanceTransaction'Variants -> Encoding

toJSONList :: [TransferBalanceTransaction'Variants] -> Value

toEncodingList :: [TransferBalanceTransaction'Variants] -> Encoding

FromJSON TransferBalanceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

parseJSON :: Value -> Parser TransferBalanceTransaction'Variants

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

data TransferDestination'Variants

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

ID of the Stripe account the transfer was sent to.

Constructors

TransferDestination'Text Text

TransferDestination'Account Account

Instances

Eq TransferDestination'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

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

Show TransferDestination'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

show :: TransferDestination'Variants -> String

showList :: [TransferDestination'Variants] -> ShowS

ToJSON TransferDestination'Variants

Defined in StripeAPI.Types.Transfer

Methods

toJSON :: TransferDestination'Variants -> Value

toEncoding :: TransferDestination'Variants -> Encoding

toJSONList :: [TransferDestination'Variants] -> Value

toEncodingList :: [TransferDestination'Variants] -> Encoding

FromJSON TransferDestination'Variants

Defined in StripeAPI.Types.Transfer

Methods

parseJSON :: Value -> Parser TransferDestination'Variants

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

data TransferDestinationPayment'Variants

Defines the oneOf schema located at components.schemas.transfer.properties.destination_payment.anyOf in the specification.

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

Constructors

TransferDestinationPayment'Text Text

TransferDestinationPayment'Charge Charge

Instances

Eq TransferDestinationPayment'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

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

Show TransferDestinationPayment'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

show :: TransferDestinationPayment'Variants -> String

showList :: [TransferDestinationPayment'Variants] -> ShowS

ToJSON TransferDestinationPayment'Variants

Defined in StripeAPI.Types.Transfer

Methods

toJSON :: TransferDestinationPayment'Variants -> Value

toEncoding :: TransferDestinationPayment'Variants -> Encoding

toJSONList :: [TransferDestinationPayment'Variants] -> Value

toEncodingList :: [TransferDestinationPayment'Variants] -> Encoding

FromJSON TransferDestinationPayment'Variants

Defined in StripeAPI.Types.Transfer

Methods

parseJSON :: Value -> Parser TransferDestinationPayment'Variants

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

data TransferReversals'

Defines the object schema located at components.schemas.transfer.properties.reversals in the specification.

A list of reversals that have been applied to the transfer.

Constructors

TransferReversals'

Fields

• transferReversals'Data :: [TransferReversal]

  data: Details about each object.

• transferReversals'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• transferReversals'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq TransferReversals'

Defined in StripeAPI.Types.Transfer

Methods

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

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

Show TransferReversals'

Defined in StripeAPI.Types.Transfer

Methods

showsPrec :: Int -> TransferReversals' -> ShowS

show :: TransferReversals' -> String

showList :: [TransferReversals'] -> ShowS

ToJSON TransferReversals'

Defined in StripeAPI.Types.Transfer

Methods

toJSON :: TransferReversals' -> Value

toEncoding :: TransferReversals' -> Encoding

toJSONList :: [TransferReversals'] -> Value

toEncodingList :: [TransferReversals'] -> Encoding

FromJSON TransferReversals'

Defined in StripeAPI.Types.Transfer

Methods

parseJSON :: Value -> Parser TransferReversals'

parseJSONList :: Value -> Parser [TransferReversals']

mkTransferReversals'

Arguments

:: [TransferReversal]

transferReversals'Data

-> Bool

transferReversals'HasMore

-> Text

transferReversals'Url

-> TransferReversals'

Create a new TransferReversals' with all required fields.

data TransferSourceTransaction'Variants

Defines the oneOf schema located at components.schemas.transfer.properties.source_transaction.anyOf in the specification.

ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.

Constructors

TransferSourceTransaction'Text Text

TransferSourceTransaction'Charge Charge

Instances

Eq TransferSourceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

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

Show TransferSourceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

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

show :: TransferSourceTransaction'Variants -> String

showList :: [TransferSourceTransaction'Variants] -> ShowS

ToJSON TransferSourceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

toJSON :: TransferSourceTransaction'Variants -> Value

toEncoding :: TransferSourceTransaction'Variants -> Encoding

toJSONList :: [TransferSourceTransaction'Variants] -> Value

toEncodingList :: [TransferSourceTransaction'Variants] -> Encoding

FromJSON TransferSourceTransaction'Variants

Defined in StripeAPI.Types.Transfer

Methods

parseJSON :: Value -> Parser TransferSourceTransaction'Variants

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