StripeAPI.Types.Refund

Contains the types generated from the schema Refund

Documentation

data Refund

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.

Constructors

Refund

Fields

• refundAmount :: Int

  amount: Amount, in %s.

• refundBalanceTransaction :: Maybe RefundBalanceTransaction'Variants

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

• refundCharge :: Maybe RefundCharge'Variants

  charge: ID of the charge that was refunded.

• refundCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• refundCurrency :: Text

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

• refundDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)

  Constraints:

  • Maximum length of 5000
• refundFailureBalanceTransaction :: Maybe RefundFailureBalanceTransaction'Variants

  failure_balance_transaction: If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.

• refundFailureReason :: Maybe Text

  failure_reason: If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, or `unknown`.

  Constraints:

  • Maximum length of 5000
• refundId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• refundMetadata :: 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.

• refundPaymentIntent :: Maybe RefundPaymentIntent'Variants

  payment_intent: ID of the PaymentIntent that was refunded.

• refundReason :: Maybe Text

  reason: Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).

  Constraints:

  • Maximum length of 5000
• refundReceiptNumber :: Maybe Text

  receipt_number: This is the transaction number that appears on email receipts sent for this refund.

  Constraints:

  • Maximum length of 5000
• refundSourceTransferReversal :: Maybe RefundSourceTransferReversal'Variants

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

• refundStatus :: Maybe Text

  status: Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our refunds documentation for more details.

  Constraints:

  • Maximum length of 5000
• refundTransferReversal :: Maybe RefundTransferReversal'Variants

  transfer_reversal: If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.

Instances

Eq Refund

Defined in StripeAPI.Types.Refund

Methods

(==) :: Refund -> Refund -> Bool

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

Show Refund

Defined in StripeAPI.Types.Refund

Methods

showsPrec :: Int -> Refund -> ShowS

show :: Refund -> String

showList :: [Refund] -> ShowS

ToJSON Refund

Defined in StripeAPI.Types.Refund

Methods

toJSON :: Refund -> Value

toEncoding :: Refund -> Encoding

toJSONList :: [Refund] -> Value

toEncodingList :: [Refund] -> Encoding

FromJSON Refund

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser Refund

parseJSONList :: Value -> Parser [Refund]

mkRefund

Arguments

:: Int

refundAmount

-> Int

refundCreated

-> Text

refundCurrency

-> Text

refundId

-> Refund

Create a new Refund with all required fields.

data RefundBalanceTransaction'Variants

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.

Constructors

RefundBalanceTransaction'Text Text

RefundBalanceTransaction'BalanceTransaction BalanceTransaction

Instances

Eq RefundBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

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

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

Show RefundBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

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

show :: RefundBalanceTransaction'Variants -> String

showList :: [RefundBalanceTransaction'Variants] -> ShowS

ToJSON RefundBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

toJSON :: RefundBalanceTransaction'Variants -> Value

toEncoding :: RefundBalanceTransaction'Variants -> Encoding

toJSONList :: [RefundBalanceTransaction'Variants] -> Value

toEncodingList :: [RefundBalanceTransaction'Variants] -> Encoding

FromJSON RefundBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser RefundBalanceTransaction'Variants

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

data RefundCharge'Variants

Defines the oneOf schema located at components.schemas.refund.properties.charge.anyOf in the specification.

ID of the charge that was refunded.

Constructors

RefundCharge'Text Text

RefundCharge'Charge Charge

Instances

Eq RefundCharge'Variants

Defined in StripeAPI.Types.Refund

Methods

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

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

Show RefundCharge'Variants

Defined in StripeAPI.Types.Refund

Methods

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

show :: RefundCharge'Variants -> String

showList :: [RefundCharge'Variants] -> ShowS

ToJSON RefundCharge'Variants

Defined in StripeAPI.Types.Refund

Methods

toJSON :: RefundCharge'Variants -> Value

toEncoding :: RefundCharge'Variants -> Encoding

toJSONList :: [RefundCharge'Variants] -> Value

toEncodingList :: [RefundCharge'Variants] -> Encoding

FromJSON RefundCharge'Variants

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser RefundCharge'Variants

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

data RefundFailureBalanceTransaction'Variants

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.

Constructors

RefundFailureBalanceTransaction'Text Text

RefundFailureBalanceTransaction'BalanceTransaction BalanceTransaction

Instances

Eq RefundFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

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

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

Show RefundFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

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

show :: RefundFailureBalanceTransaction'Variants -> String

showList :: [RefundFailureBalanceTransaction'Variants] -> ShowS

ToJSON RefundFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

toJSON :: RefundFailureBalanceTransaction'Variants -> Value

toEncoding :: RefundFailureBalanceTransaction'Variants -> Encoding

toJSONList :: [RefundFailureBalanceTransaction'Variants] -> Value

toEncodingList :: [RefundFailureBalanceTransaction'Variants] -> Encoding

FromJSON RefundFailureBalanceTransaction'Variants

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser RefundFailureBalanceTransaction'Variants

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

data RefundPaymentIntent'Variants

Defines the oneOf schema located at components.schemas.refund.properties.payment_intent.anyOf in the specification.

ID of the PaymentIntent that was refunded.

Constructors

RefundPaymentIntent'Text Text

RefundPaymentIntent'PaymentIntent PaymentIntent

Instances

Eq RefundPaymentIntent'Variants

Defined in StripeAPI.Types.Refund

Methods

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

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

Show RefundPaymentIntent'Variants

Defined in StripeAPI.Types.Refund

Methods

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

show :: RefundPaymentIntent'Variants -> String

showList :: [RefundPaymentIntent'Variants] -> ShowS

ToJSON RefundPaymentIntent'Variants

Defined in StripeAPI.Types.Refund

Methods

toJSON :: RefundPaymentIntent'Variants -> Value

toEncoding :: RefundPaymentIntent'Variants -> Encoding

toJSONList :: [RefundPaymentIntent'Variants] -> Value

toEncodingList :: [RefundPaymentIntent'Variants] -> Encoding

FromJSON RefundPaymentIntent'Variants

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser RefundPaymentIntent'Variants

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

data RefundSourceTransferReversal'Variants

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.

Constructors

RefundSourceTransferReversal'Text Text

RefundSourceTransferReversal'TransferReversal TransferReversal

Instances

Eq RefundSourceTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

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

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

Show RefundSourceTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

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

show :: RefundSourceTransferReversal'Variants -> String

showList :: [RefundSourceTransferReversal'Variants] -> ShowS

ToJSON RefundSourceTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

toJSON :: RefundSourceTransferReversal'Variants -> Value

toEncoding :: RefundSourceTransferReversal'Variants -> Encoding

toJSONList :: [RefundSourceTransferReversal'Variants] -> Value

toEncodingList :: [RefundSourceTransferReversal'Variants] -> Encoding

FromJSON RefundSourceTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser RefundSourceTransferReversal'Variants

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

data RefundTransferReversal'Variants

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.

Constructors

RefundTransferReversal'Text Text

RefundTransferReversal'TransferReversal TransferReversal

Instances

Eq RefundTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

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

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

Show RefundTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

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

show :: RefundTransferReversal'Variants -> String

showList :: [RefundTransferReversal'Variants] -> ShowS

ToJSON RefundTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

toJSON :: RefundTransferReversal'Variants -> Value

toEncoding :: RefundTransferReversal'Variants -> Encoding

toJSONList :: [RefundTransferReversal'Variants] -> Value

toEncodingList :: [RefundTransferReversal'Variants] -> Encoding

FromJSON RefundTransferReversal'Variants

Defined in StripeAPI.Types.Refund

Methods

parseJSON :: Value -> Parser RefundTransferReversal'Variants

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