Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Treasury_InboundTransfer

Contains the types generated from the schema Treasury_InboundTransfer

7 types
3 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceTreasury_InboundTransfer.hs

datadata Treasury'inboundTransfer

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

Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

Constructors

Treasury'inboundTransfer
- treasury'inboundTransferAmount :: Int
  amount: Amount (in cents) transferred.
- treasury'inboundTransferCancelable :: Bool
  cancelable: Returns `true` if the InboundTransfer is able to be canceled.
- treasury'inboundTransferCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- treasury'inboundTransferCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- treasury'inboundTransferDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- treasury'inboundTransferFailureDetails :: Maybe (Nullable Treasury'inboundTransferFailureDetails'NonNullable)
  failure_details: Details about this InboundTransfer's failure. Only set when status is `failed`.
- treasury'inboundTransferFinancialAccount :: Text
  financial_account: The FinancialAccount that received the funds.
  Constraints:
  - Maximum length of 5000
- treasury'inboundTransferHostedRegulatoryReceiptUrl :: 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'inboundTransferId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- treasury'inboundTransferLinkedFlows :: TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows
  linked_flows:
- treasury'inboundTransferLivemode :: 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'inboundTransferMetadata :: 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'inboundTransferOriginPaymentMethod :: Text
  origin_payment_method: The origin payment method to be debited for an InboundTransfer.
  Constraints:
  - Maximum length of 5000
- treasury'inboundTransferOriginPaymentMethodDetails :: Maybe (Nullable Treasury'inboundTransferOriginPaymentMethodDetails'NonNullable)
  origin_payment_method_details: Details about the PaymentMethod for an InboundTransfer.
- treasury'inboundTransferReturned :: Maybe (Nullable Bool)
  returned: Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state.
- treasury'inboundTransferStatementDescriptor :: Text
  statement_descriptor: Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`.
  Constraints:
  - Maximum length of 5000
- treasury'inboundTransferStatus :: Treasury'inboundTransferStatus'
  status: Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.
- treasury'inboundTransferStatusTransitions :: TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions
  status_transitions:
- treasury'inboundTransferTransaction :: Maybe (Nullable Treasury'inboundTransferTransaction'NonNullableVariants)
  transaction: The Transaction associated with this object.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer

valuemkTreasury'inboundTransfer

Create a new Treasury'inboundTransfer with all required fields.

datadata Treasury'inboundTransferFailureDetails'NonNullable

Defines the object schema located at components.schemas.treasury.inbound_transfer.properties.failure_details.anyOf in the specification.

Details about this InboundTransfer\'s failure. Only set when status is \`failed\`.

Constructors

Treasury'inboundTransferFailureDetails'NonNullable
- treasury'inboundTransferFailureDetails'NonNullableCode :: Maybe Treasury'inboundTransferFailureDetails'NonNullableCode'
  code: Reason for the failure.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferFailureDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferFailureDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferFailureDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferFailureDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer

valuemkTreasury'inboundTransferFailureDetails'NonNullable :: Treasury'inboundTransferFailureDetails'NonNullable

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

datadata Treasury'inboundTransferFailureDetails'NonNullableCode'

Defines the enum schema located at components.schemas.treasury.inbound_transfer.properties.failure_details.anyOf.properties.code in the specification.

Reason for the failure.

Constructors

Treasury'inboundTransferFailureDetails'NonNullableCode'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
Treasury'inboundTransferFailureDetails'NonNullableCode'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumAccountClosed
Represents the JSON value "account_closed"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumAccountFrozen
Represents the JSON value "account_frozen"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumBankAccountRestricted
Represents the JSON value "bank_account_restricted"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumBankOwnershipChanged
Represents the JSON value "bank_ownership_changed"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumDebitNotAuthorized
Represents the JSON value "debit_not_authorized"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumIncorrectAccountHolderAddress
Represents the JSON value "incorrect_account_holder_address"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumIncorrectAccountHolderName
Represents the JSON value "incorrect_account_holder_name"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumIncorrectAccountHolderTaxId
Represents the JSON value "incorrect_account_holder_tax_id"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumInsufficientFunds
Represents the JSON value "insufficient_funds"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumInvalidAccountNumber
Represents the JSON value "invalid_account_number"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumInvalidCurrency
Represents the JSON value "invalid_currency"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumNoAccount
Represents the JSON value "no_account"
Treasury'inboundTransferFailureDetails'NonNullableCode'EnumOther
Represents the JSON value "other"

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferFailureDetails'NonNullableCode'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferFailureDetails'NonNullableCode'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferFailureDetails'NonNullableCode'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferFailureDetails'NonNullableCode'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer

datadata Treasury'inboundTransferOriginPaymentMethodDetails'NonNullable

Defines the object schema located at components.schemas.treasury.inbound_transfer.properties.origin_payment_method_details.anyOf in the specification.

Details about the PaymentMethod for an InboundTransfer.

Constructors

Treasury'inboundTransferOriginPaymentMethodDetails'NonNullable
- treasury'inboundTransferOriginPaymentMethodDetails'NonNullableBillingDetails :: Maybe TreasurySharedResourceBillingDetails
  billing_details:
- treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType :: Maybe Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType'
  type: The type of the payment method used in the InboundTransfer.
- treasury'inboundTransferOriginPaymentMethodDetails'NonNullableUsBankAccount :: Maybe InboundTransfersPaymentMethodDetailsUsBankAccount
  us_bank_account:

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer

value

mkTreasury'inboundTransferOriginPaymentMethodDetails'NonNullable :: Treasury'inboundTransferOriginPaymentMethodDetails'NonNullable

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

datadata Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType'

Defines the enum schema located at components.schemas.treasury.inbound_transfer.properties.origin_payment_method_details.anyOf.properties.type in the specification.

The type of the payment method used in the InboundTransfer.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferOriginPaymentMethodDetails'NonNullableType'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer

datadata Treasury'inboundTransferStatus'

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

Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been "confirmed" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer

datadata Treasury'inboundTransferTransaction'NonNullableVariants

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

The Transaction associated with this object.

Constructors

Treasury'inboundTransferTransaction'NonNullableText Text
Treasury'inboundTransferTransaction'NonNullableTreasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'inboundTransferTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
Show Treasury'inboundTransferTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
FromJSON Treasury'inboundTransferTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer
ToJSON Treasury'inboundTransferTransaction'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_InboundTransfer