Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.TransferReversal

Contains the types generated from the schema TransferReversal

5 types
1 value

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceTransferReversal.hs

datadata TransferReversal

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

Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance.

Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.

Related guide: Reversing Transfers.

Constructors

TransferReversal
- transferReversalAmount :: Int
  amount: Amount, in %s.
- transferReversalBalanceTransaction :: Maybe (Nullable TransferReversalBalanceTransaction'NonNullableVariants)
  balance_transaction: Balance transaction that describes the impact on your account balance.
- transferReversalCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- transferReversalCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- transferReversalDestinationPaymentRefund :: Maybe (Nullable TransferReversalDestinationPaymentRefund'NonNullableVariants)
  destination_payment_refund: Linked payment refund for the transfer reversal.
- transferReversalId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- transferReversalMetadata :: 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.
- transferReversalSourceRefund :: Maybe (Nullable TransferReversalSourceRefund'NonNullableVariants)
  source_refund: ID of the refund responsible for the transfer reversal.
- transferReversalTransfer :: TransferReversalTransfer'Variants
  transfer: ID of the transfer that was reversed.

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
Show TransferReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
FromJSON TransferReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
ToJSON TransferReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal

valuemkTransferReversal

:: Int
transferReversalAmount
-> Int
transferReversalCreated
-> Text
transferReversalCurrency
-> Text
transferReversalId
-> TransferReversalTransfer'Variants
transferReversalTransfer
-> TransferReversal

Create a new TransferReversal with all required fields.

datadata TransferReversalBalanceTransaction'NonNullableVariants

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

Balance transaction that describes the impact on your account balance.

Constructors

TransferReversalBalanceTransaction'NonNullableText Text
TransferReversalBalanceTransaction'NonNullableBalanceTransaction BalanceTransaction

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferReversalBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
Show TransferReversalBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
FromJSON TransferReversalBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
ToJSON TransferReversalBalanceTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal

datadata TransferReversalDestinationPaymentRefund'NonNullableVariants

Defines the oneOf schema located at components.schemas.transfer_reversal.properties.destination_payment_refund.anyOf in the specification.

Linked payment refund for the transfer reversal.

Constructors

TransferReversalDestinationPaymentRefund'NonNullableText Text
TransferReversalDestinationPaymentRefund'NonNullableRefund Refund

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferReversalDestinationPaymentRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
Show TransferReversalDestinationPaymentRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
FromJSON TransferReversalDestinationPaymentRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
ToJSON TransferReversalDestinationPaymentRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal

datadata TransferReversalSourceRefund'NonNullableVariants

Defines the oneOf schema located at components.schemas.transfer_reversal.properties.source_refund.anyOf in the specification.

ID of the refund responsible for the transfer reversal.

Constructors

TransferReversalSourceRefund'NonNullableText Text
TransferReversalSourceRefund'NonNullableRefund Refund

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferReversalSourceRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
Show TransferReversalSourceRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
FromJSON TransferReversalSourceRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
ToJSON TransferReversalSourceRefund'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal

datadata TransferReversalTransfer'Variants

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

ID of the transfer that was reversed.

Constructors

TransferReversalTransfer'Text Text
TransferReversalTransfer'Transfer Transfer

Instances4Eq, Show, FromJSON, ToJSON

Eq TransferReversalTransfer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
Show TransferReversalTransfer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
FromJSON TransferReversalTransfer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal
ToJSON TransferReversalTransfer'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.TransferReversal