Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Refund

Contains the types generated from the schema Refund

8 types
1 value

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceRefund.hs

datadata 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
- refundAmount :: Int
  amount: Amount, in %s.
- refundBalanceTransaction :: Maybe (Nullable RefundBalanceTransaction'NonNullableVariants)
  balance_transaction: Balance transaction that describes the impact on your account balance.
- refundCharge :: Maybe (Nullable RefundCharge'NonNullableVariants)
  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
- refundInstructionsEmail :: Maybe Text
  instructions_email: Email to which refund instructions, if required, are sent to.
  Constraints:
  - Maximum length of 5000
- refundMetadata :: Maybe (Nullable 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.
- refundNextAction :: Maybe RefundNextAction
  next_action:
- refundPaymentIntent :: Maybe (Nullable RefundPaymentIntent'NonNullableVariants)
  payment_intent: ID of the PaymentIntent that was refunded.
- refundReason :: Maybe (Nullable RefundReason'NonNullable)
  reason: Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
- refundReceiptNumber :: Maybe (Nullable Text)
  receipt_number: This is the transaction number that appears on email receipts sent for this refund.
  Constraints:
  - Maximum length of 5000
- refundSourceTransferReversal :: Maybe (Nullable RefundSourceTransferReversal'NonNullableVariants)
  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 (Nullable 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`, `requires_action`, `succeeded`, `failed`, or `canceled`. Refer to our refunds documentation for more details.
  Constraints:
  - Maximum length of 5000
- refundTransferReversal :: Maybe (Nullable RefundTransferReversal'NonNullableVariants)
  transfer_reversal: If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

valuemkRefund

:: Int
refundAmount
-> Int
refundCreated
-> Text
refundCurrency
-> Text
refundId
-> Refund

Create a new Refund with all required fields.

datadata RefundBalanceTransaction'NonNullableVariants

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'NonNullableText Text
RefundBalanceTransaction'NonNullableBalanceTransaction BalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

datadata RefundCharge'NonNullableVariants

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

ID of the charge that was refunded.

Constructors

RefundCharge'NonNullableText Text
RefundCharge'NonNullableCharge Charge

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundCharge'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

datadata 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

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundFailureBalanceTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundFailureBalanceTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundFailureBalanceTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundFailureBalanceTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

datadata RefundPaymentIntent'NonNullableVariants

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'NonNullableText Text
RefundPaymentIntent'NonNullablePaymentIntent PaymentIntent

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundPaymentIntent'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

datadata RefundReason'NonNullable

Defines the enum schema located at components.schemas.refund.properties.reason in the specification.

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

Constructors

RefundReason'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
RefundReason'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
RefundReason'NonNullableEnumDuplicate
Represents the JSON value "duplicate"
RefundReason'NonNullableEnumExpiredUncapturedCharge
Represents the JSON value "expired_uncaptured_charge"
RefundReason'NonNullableEnumFraudulent
Represents the JSON value "fraudulent"
RefundReason'NonNullableEnumRequestedByCustomer
Represents the JSON value "requested_by_customer"

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

datadata RefundSourceTransferReversal'NonNullableVariants

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'NonNullableText Text
RefundSourceTransferReversal'NonNullableTransferReversal TransferReversal

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundSourceTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundSourceTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundSourceTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundSourceTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund

datadata RefundTransferReversal'NonNullableVariants

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'NonNullableText Text
RefundTransferReversal'NonNullableTransferReversal TransferReversal

Instances4Eq, Show, FromJSON, ToJSON

Eq RefundTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
Show RefundTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
FromJSON RefundTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund
ToJSON RefundTransferReversal'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Refund