StripeAPI.Types.SourceReceiverFlow

Contains the types generated from the schema SourceReceiverFlow

Documentation

data SourceReceiverFlow

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

Constructors

SourceReceiverFlow

Fields

• sourceReceiverFlowAddress :: Maybe Text

  address: The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.

  Constraints:

  • Maximum length of 5000
• sourceReceiverFlowAmountCharged :: Int

  amount_charged: The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency.

• sourceReceiverFlowAmountReceived :: Int

  amount_received: The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency.

• sourceReceiverFlowAmountReturned :: Int

  amount_returned: The total amount that was returned to the customer. The amount returned is expressed in the source's currency.

• sourceReceiverFlowRefundAttributesMethod :: Text

  refund_attributes_method: Type of refund attribute method, one of `email`, `manual`, or `none`.

  Constraints:

  • Maximum length of 5000
• sourceReceiverFlowRefundAttributesStatus :: Text

  refund_attributes_status: Type of refund attribute status, one of `missing`, `requested`, or `available`.

  Constraints:

  • Maximum length of 5000

Instances

Eq SourceReceiverFlow

Defined in StripeAPI.Types.SourceReceiverFlow

Methods

(==) :: SourceReceiverFlow -> SourceReceiverFlow -> Bool

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

Show SourceReceiverFlow

Defined in StripeAPI.Types.SourceReceiverFlow

Methods

showsPrec :: Int -> SourceReceiverFlow -> ShowS

show :: SourceReceiverFlow -> String

showList :: [SourceReceiverFlow] -> ShowS

ToJSON SourceReceiverFlow

Defined in StripeAPI.Types.SourceReceiverFlow

Methods

toJSON :: SourceReceiverFlow -> Value

toEncoding :: SourceReceiverFlow -> Encoding

toJSONList :: [SourceReceiverFlow] -> Value

toEncodingList :: [SourceReceiverFlow] -> Encoding

FromJSON SourceReceiverFlow

Defined in StripeAPI.Types.SourceReceiverFlow

Methods

parseJSON :: Value -> Parser SourceReceiverFlow

parseJSONList :: Value -> Parser [SourceReceiverFlow]

mkSourceReceiverFlow

Arguments

:: Int

sourceReceiverFlowAmountCharged

-> Int

sourceReceiverFlowAmountReceived

-> Int

sourceReceiverFlowAmountReturned

-> Text

sourceReceiverFlowRefundAttributesMethod

-> Text

sourceReceiverFlowRefundAttributesStatus

-> SourceReceiverFlow

Create a new SourceReceiverFlow with all required fields.