Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the types generated from the schema Refund
Synopsis
- data Refund = Refund {
- refundAmount :: Int
- refundBalanceTransaction :: Maybe RefundBalanceTransaction'Variants
- refundCharge :: Maybe RefundCharge'Variants
- refundCreated :: Int
- refundCurrency :: Text
- refundDescription :: Maybe Text
- refundFailureBalanceTransaction :: Maybe RefundFailureBalanceTransaction'Variants
- refundFailureReason :: Maybe Text
- refundId :: Text
- refundMetadata :: Maybe Object
- refundPaymentIntent :: Maybe RefundPaymentIntent'Variants
- refundReason :: Maybe Text
- refundReceiptNumber :: Maybe Text
- refundSourceTransferReversal :: Maybe RefundSourceTransferReversal'Variants
- refundStatus :: Maybe Text
- refundTransferReversal :: Maybe RefundTransferReversal'Variants
- mkRefund :: Int -> Int -> Text -> Text -> Refund
- data RefundBalanceTransaction'Variants
- data RefundCharge'Variants
- data RefundFailureBalanceTransaction'Variants
- data RefundPaymentIntent'Variants
- data RefundSourceTransferReversal'Variants
- data RefundTransferReversal'Variants
Documentation
Defines the object schema located at components.schemas.refund
in the specification.
`Refund` objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.
Related guide: Refunds.
Refund | |
|
Create a new Refund
with all required fields.
data RefundBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.refund.properties.balance_transaction.anyOf
in the specification.
Balance transaction that describes the impact on your account balance.
data RefundCharge'Variants Source #
Defines the oneOf schema located at components.schemas.refund.properties.charge.anyOf
in the specification.
ID of the charge that was refunded.
Instances
Eq RefundCharge'Variants Source # | |
Defined in StripeAPI.Types.Refund (==) :: RefundCharge'Variants -> RefundCharge'Variants -> Bool # (/=) :: RefundCharge'Variants -> RefundCharge'Variants -> Bool # | |
Show RefundCharge'Variants Source # | |
Defined in StripeAPI.Types.Refund showsPrec :: Int -> RefundCharge'Variants -> ShowS # show :: RefundCharge'Variants -> String # showList :: [RefundCharge'Variants] -> ShowS # | |
ToJSON RefundCharge'Variants Source # | |
Defined in StripeAPI.Types.Refund toJSON :: RefundCharge'Variants -> Value # toEncoding :: RefundCharge'Variants -> Encoding # toJSONList :: [RefundCharge'Variants] -> Value # toEncodingList :: [RefundCharge'Variants] -> Encoding # | |
FromJSON RefundCharge'Variants Source # | |
Defined in StripeAPI.Types.Refund parseJSON :: Value -> Parser RefundCharge'Variants # parseJSONList :: Value -> Parser [RefundCharge'Variants] # |
data RefundFailureBalanceTransaction'Variants Source #
Defines the oneOf schema located at components.schemas.refund.properties.failure_balance_transaction.anyOf
in the specification.
If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
RefundFailureBalanceTransaction'Text Text | |
RefundFailureBalanceTransaction'BalanceTransaction BalanceTransaction |
data RefundPaymentIntent'Variants Source #
Defines the oneOf schema located at components.schemas.refund.properties.payment_intent.anyOf
in the specification.
ID of the PaymentIntent that was refunded.
Instances
Eq RefundPaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Refund | |
Show RefundPaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Refund showsPrec :: Int -> RefundPaymentIntent'Variants -> ShowS # show :: RefundPaymentIntent'Variants -> String # showList :: [RefundPaymentIntent'Variants] -> ShowS # | |
ToJSON RefundPaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Refund | |
FromJSON RefundPaymentIntent'Variants Source # | |
Defined in StripeAPI.Types.Refund |
data RefundSourceTransferReversal'Variants Source #
Defines the oneOf schema located at components.schemas.refund.properties.source_transfer_reversal.anyOf
in the specification.
The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.
RefundSourceTransferReversal'Text Text | |
RefundSourceTransferReversal'TransferReversal TransferReversal |
data RefundTransferReversal'Variants Source #
Defines the oneOf schema located at components.schemas.refund.properties.transfer_reversal.anyOf
in the specification.
If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.