Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Treasury_ReceivedCredit

Contains the types generated from the schema Treasury_ReceivedCredit

7 types
2 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceTreasury_ReceivedCredit.hs

datadata Treasury'receivedCredit

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

ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.

Constructors

Treasury'receivedCredit
- treasury'receivedCreditAmount :: Int
  amount: Amount (in cents) transferred.
- treasury'receivedCreditCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- treasury'receivedCreditCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- treasury'receivedCreditDescription :: Text
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- treasury'receivedCreditFailureCode :: Maybe (Nullable Treasury'receivedCreditFailureCode'NonNullable)
  failure_code: Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.
- treasury'receivedCreditFinancialAccount :: Maybe (Nullable Text)
  financial_account: The FinancialAccount that received the funds.
  Constraints:
  - Maximum length of 5000
- treasury'receivedCreditId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- treasury'receivedCreditInitiatingPaymentMethodDetails :: TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails
  initiating_payment_method_details:
- treasury'receivedCreditLinkedFlows :: ReceivedCreditsResourceTreasuryLinkedFlows
  linked_flows:
- treasury'receivedCreditLivemode :: 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'receivedCreditNetwork :: Treasury'receivedCreditNetwork'
  network: The rails used to send the funds.
- treasury'receivedCreditReversalDetails :: Maybe (Nullable Treasury'receivedCreditReversalDetails'NonNullable)
  reversal_details: Details describing when a ReceivedCredit may be reversed.
- treasury'receivedCreditStatus :: Treasury'receivedCreditStatus'
  status: Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.
- treasury'receivedCreditTransaction :: Maybe (Nullable Treasury'receivedCreditTransaction'NonNullableVariants)
  transaction: The Transaction associated with this object.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit

datadata Treasury'receivedCreditFailureCode'NonNullable

Defines the enum schema located at components.schemas.treasury.received_credit.properties.failure_code in the specification.

Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen.

Constructors

Treasury'receivedCreditFailureCode'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'receivedCreditFailureCode'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'receivedCreditFailureCode'NonNullableEnumAccountClosed
Represents the JSON value "account_closed"
Treasury'receivedCreditFailureCode'NonNullableEnumAccountFrozen
Represents the JSON value "account_frozen"
Treasury'receivedCreditFailureCode'NonNullableEnumOther
Represents the JSON value "other"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditFailureCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditFailureCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditFailureCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditFailureCode'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit

datadata Treasury'receivedCreditNetwork'

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

The rails used to send the funds.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditNetwork'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit

datadata Treasury'receivedCreditReversalDetails'NonNullable

Defines the object schema located at components.schemas.treasury.received_credit.properties.reversal_details.anyOf in the specification.

Details describing when a ReceivedCredit may be reversed.

Constructors

Treasury'receivedCreditReversalDetails'NonNullable
- treasury'receivedCreditReversalDetails'NonNullableDeadline :: Maybe (Nullable Int)
  deadline: Time before which a ReceivedCredit can be reversed.
- treasury'receivedCreditReversalDetails'NonNullableRestrictedReason :: Maybe (Nullable Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullable)
  restricted_reason: Set if a ReceivedCredit cannot be reversed.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditReversalDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditReversalDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditReversalDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditReversalDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit

valuemkTreasury'receivedCreditReversalDetails'NonNullable :: Treasury'receivedCreditReversalDetails'NonNullable

Create a new Treasury'receivedCreditReversalDetails'NonNullable with all required fields.

datadata Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullable

Defines the enum schema located at components.schemas.treasury.received_credit.properties.reversal_details.anyOf.properties.restricted_reason in the specification.

Set if a ReceivedCredit cannot be reversed.

Constructors

Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableEnumAlreadyReversed
Represents the JSON value "already_reversed"
Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableEnumDeadlinePassed
Represents the JSON value "deadline_passed"
Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableEnumNetworkRestricted
Represents the JSON value "network_restricted"
Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableEnumOther
Represents the JSON value "other"
Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableEnumSourceFlowRestricted
Represents the JSON value "source_flow_restricted"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditReversalDetails'NonNullableRestrictedReason'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit

datadata Treasury'receivedCreditStatus'

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

Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit

datadata Treasury'receivedCreditTransaction'NonNullableVariants

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

The Transaction associated with this object.

Constructors

Treasury'receivedCreditTransaction'NonNullableText Text
Treasury'receivedCreditTransaction'NonNullableTreasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'receivedCreditTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
Show Treasury'receivedCreditTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
FromJSON Treasury'receivedCreditTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit
ToJSON Treasury'receivedCreditTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_ReceivedCredit