Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Treasury_OutboundTransfer

Contains the types generated from the schema Treasury_OutboundTransfer

6 types
2 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceTreasury_OutboundTransfer.hs

datadata Treasury'outboundTransfer

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

Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.

Simulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects.

Constructors

Treasury'outboundTransfer
- treasury'outboundTransferAmount :: Int
  amount: Amount (in cents) transferred.
- treasury'outboundTransferCancelable :: Bool
  cancelable: Returns `true` if the object can be canceled, and `false` otherwise.
- treasury'outboundTransferCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- treasury'outboundTransferCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- treasury'outboundTransferDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- treasury'outboundTransferDestinationPaymentMethod :: Text
  destination_payment_method: The PaymentMethod used as the payment instrument for an OutboundTransfer.
  Constraints:
  - Maximum length of 5000
- treasury'outboundTransferDestinationPaymentMethodDetails :: OutboundTransfersPaymentMethodDetails
  destination_payment_method_details:
- treasury'outboundTransferExpectedArrivalDate :: Int
  expected_arrival_date: The date when funds are expected to arrive in the destination account.
- treasury'outboundTransferFinancialAccount :: Text
  financial_account: The FinancialAccount that funds were pulled from.
  Constraints:
  - Maximum length of 5000
- treasury'outboundTransferHostedRegulatoryReceiptUrl :: 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'outboundTransferId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- treasury'outboundTransferLivemode :: 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'outboundTransferMetadata :: 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'outboundTransferReturnedDetails :: Maybe (Nullable Treasury'outboundTransferReturnedDetails'NonNullable)
  returned_details: Details about a returned OutboundTransfer. Only set when the status is `returned`.
- treasury'outboundTransferStatementDescriptor :: Text
  statement_descriptor: Information about the OutboundTransfer to be sent to the recipient account.
  Constraints:
  - Maximum length of 5000
- treasury'outboundTransferStatus :: Treasury'outboundTransferStatus'
  status: Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.
- treasury'outboundTransferStatusTransitions :: TreasuryOutboundTransfersResourceStatusTransitions
  status_transitions:
- treasury'outboundTransferTransaction :: Treasury'outboundTransferTransaction'Variants
  transaction: The Transaction associated with this object.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
Show Treasury'outboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
FromJSON Treasury'outboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
ToJSON Treasury'outboundTransferDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer

valuemkTreasury'outboundTransfer

:: Int
treasury'outboundTransferAmount
-> Bool
treasury'outboundTransferCancelable
-> Int
treasury'outboundTransferCreated
-> Text
treasury'outboundTransferCurrency
-> Text
treasury'outboundTransferDestinationPaymentMethod
-> OutboundTransfersPaymentMethodDetails
treasury'outboundTransferDestinationPaymentMethodDetails
-> Int
treasury'outboundTransferExpectedArrivalDate
-> Text
treasury'outboundTransferFinancialAccount
-> Text
treasury'outboundTransferId
-> Bool
treasury'outboundTransferLivemode
-> Object
treasury'outboundTransferMetadata
-> Text
treasury'outboundTransferStatementDescriptor
-> Treasury'outboundTransferStatus'
treasury'outboundTransferStatus
-> TreasuryOutboundTransfersResourceStatusTransitions
treasury'outboundTransferStatusTransitions
-> Treasury'outboundTransferTransaction'Variants
treasury'outboundTransferTransaction
-> Treasury'outboundTransfer

Create a new Treasury'outboundTransfer with all required fields.

datadata Treasury'outboundTransferReturnedDetails'NonNullable

Defines the object schema located at components.schemas.treasury.outbound_transfer.properties.returned_details.anyOf in the specification.

Details about a returned OutboundTransfer. Only set when the status is \`returned\`.

Constructors

Treasury'outboundTransferReturnedDetails'NonNullable
- treasury'outboundTransferReturnedDetails'NonNullableCode :: Maybe Treasury'outboundTransferReturnedDetails'NonNullableCode'
  code: Reason for the return.
- treasury'outboundTransferReturnedDetails'NonNullableTransaction :: Maybe Treasury'outboundTransferReturnedDetails'NonNullableTransaction'Variants
  transaction: The Transaction associated with this object.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundTransferReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
Show Treasury'outboundTransferReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
FromJSON Treasury'outboundTransferReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
ToJSON Treasury'outboundTransferReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer

valuemkTreasury'outboundTransferReturnedDetails'NonNullable :: Treasury'outboundTransferReturnedDetails'NonNullable

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

datadata Treasury'outboundTransferReturnedDetails'NonNullableCode'

Defines the enum schema located at components.schemas.treasury.outbound_transfer.properties.returned_details.anyOf.properties.code in the specification.

Reason for the return.

Constructors

Treasury'outboundTransferReturnedDetails'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'outboundTransferReturnedDetails'NonNullableCode'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumAccountClosed
Represents the JSON value "account_closed"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumAccountFrozen
Represents the JSON value "account_frozen"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumBankAccountRestricted
Represents the JSON value "bank_account_restricted"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumBankOwnershipChanged
Represents the JSON value "bank_ownership_changed"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumDeclined
Represents the JSON value "declined"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumIncorrectAccountHolderName
Represents the JSON value "incorrect_account_holder_name"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumInvalidAccountNumber
Represents the JSON value "invalid_account_number"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumInvalidCurrency
Represents the JSON value "invalid_currency"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumNoAccount
Represents the JSON value "no_account"
Treasury'outboundTransferReturnedDetails'NonNullableCode'EnumOther
Represents the JSON value "other"

Instances4Eq, Show, FromJSON, ToJSON

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

datadata Treasury'outboundTransferReturnedDetails'NonNullableTransaction'Variants

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

The Transaction associated with this object.

Constructors

Treasury'outboundTransferReturnedDetails'NonNullableTransaction'Text Text
Treasury'outboundTransferReturnedDetails'NonNullableTransaction'Treasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundTransferReturnedDetails'NonNullableTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
Show Treasury'outboundTransferReturnedDetails'NonNullableTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
FromJSON Treasury'outboundTransferReturnedDetails'NonNullableTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
ToJSON Treasury'outboundTransferReturnedDetails'NonNullableTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer

datadata Treasury'outboundTransferStatus'

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

Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
Show Treasury'outboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
FromJSON Treasury'outboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
ToJSON Treasury'outboundTransferStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer

datadata Treasury'outboundTransferTransaction'Variants

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

The Transaction associated with this object.

Constructors

Treasury'outboundTransferTransaction'Text Text
Treasury'outboundTransferTransaction'Treasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundTransferTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
Show Treasury'outboundTransferTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
FromJSON Treasury'outboundTransferTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer
ToJSON Treasury'outboundTransferTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundTransfer