Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Treasury_CreditReversal

Contains the types generated from the schema Treasury_CreditReversal

4 types
1 value

Packagestripeapi-3.0.0.0
Exports5
LanguageHaskell2010
LicenceMIT
SourceTreasury_CreditReversal.hs

datadata Treasury'creditReversal

Defines the object schema located at components.schemas.treasury.credit_reversal in the specification.

You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

Constructors

Treasury'creditReversal
- treasury'creditReversalAmount :: Int
  amount: Amount (in cents) transferred.
- treasury'creditReversalCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- treasury'creditReversalFinancialAccount :: Text
  financial_account: The FinancialAccount to reverse funds from.
  Constraints:
  - Maximum length of 5000
- treasury'creditReversalHostedRegulatoryReceiptUrl :: Maybe (Nullable Text)
  hosted_regulatory_receipt_url: A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.
  Constraints:
  - Maximum length of 5000
- treasury'creditReversalId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- treasury'creditReversalLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- treasury'creditReversalMetadata :: 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.
- treasury'creditReversalNetwork :: Treasury'creditReversalNetwork'
  network: The rails used to reverse the funds.
- treasury'creditReversalReceivedCredit :: Text
  received_credit: The ReceivedCredit being reversed.
  Constraints:
  - Maximum length of 5000
- treasury'creditReversalStatus :: Treasury'creditReversalStatus'
  status: Status of the CreditReversal
- treasury'creditReversalStatusTransitions :: ReceivedCreditsResourceStatusTransitions
  status_transitions:
- treasury'creditReversalTransaction :: Maybe (Nullable Treasury'creditReversalTransaction'NonNullableVariants)
  transaction: The Transaction associated with this object.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'creditReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
Show Treasury'creditReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
FromJSON Treasury'creditReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
ToJSON Treasury'creditReversalDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal

valuemkTreasury'creditReversal

Create a new Treasury'creditReversal with all required fields.

datadata Treasury'creditReversalNetwork'

Defines the enum schema located at components.schemas.treasury.credit_reversal.properties.network in the specification.

The rails used to reverse the funds.

Constructors

Treasury'creditReversalNetwork'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'creditReversalNetwork'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'creditReversalNetwork'EnumAch
Represents the JSON value "ach"
Treasury'creditReversalNetwork'EnumStripe
Represents the JSON value "stripe"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'creditReversalNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
Show Treasury'creditReversalNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
FromJSON Treasury'creditReversalNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
ToJSON Treasury'creditReversalNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal

datadata Treasury'creditReversalStatus'

Defines the enum schema located at components.schemas.treasury.credit_reversal.properties.status in the specification.

Status of the CreditReversal

Constructors

Treasury'creditReversalStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'creditReversalStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'creditReversalStatus'EnumCanceled
Represents the JSON value "canceled"
Treasury'creditReversalStatus'EnumPosted
Represents the JSON value "posted"
Treasury'creditReversalStatus'EnumProcessing
Represents the JSON value "processing"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'creditReversalStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
Show Treasury'creditReversalStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
FromJSON Treasury'creditReversalStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
ToJSON Treasury'creditReversalStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal

datadata Treasury'creditReversalTransaction'NonNullableVariants

Defines the oneOf schema located at components.schemas.treasury.credit_reversal.properties.transaction.anyOf in the specification.

The Transaction associated with this object.

Constructors

Treasury'creditReversalTransaction'NonNullableText Text
Treasury'creditReversalTransaction'NonNullableTreasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'creditReversalTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
Show Treasury'creditReversalTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
FromJSON Treasury'creditReversalTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal
ToJSON Treasury'creditReversalTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_CreditReversal