Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Treasury_OutboundPayment

Contains the types generated from the schema Treasury_OutboundPayment

9 types
4 values

Packagestripeapi-3.0.0.0
Exports13
LanguageHaskell2010
LicenceMIT
SourceTreasury_OutboundPayment.hs

datadata Treasury'outboundPayment

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

Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.

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

Constructors

Treasury'outboundPayment
- treasury'outboundPaymentAmount :: Int
  amount: Amount (in cents) transferred.
- treasury'outboundPaymentCancelable :: Bool
  cancelable: Returns `true` if the object can be canceled, and `false` otherwise.
- treasury'outboundPaymentCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- treasury'outboundPaymentCurrency :: Text
  currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
- treasury'outboundPaymentCustomer :: Maybe (Nullable Text)
  customer: ID of the customer to whom an OutboundPayment is sent.
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentDestinationPaymentMethod :: Maybe (Nullable Text)
  destination_payment_method: The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`.
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentDestinationPaymentMethodDetails :: Maybe (Nullable Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullable)
  destination_payment_method_details: Details about the PaymentMethod for an OutboundPayment.
- treasury'outboundPaymentEndUserDetails :: Maybe (Nullable Treasury'outboundPaymentEndUserDetails'NonNullable)
  end_user_details: Details about the end user.
- treasury'outboundPaymentExpectedArrivalDate :: Int
  expected_arrival_date: The date when funds are expected to arrive in the destination account.
- treasury'outboundPaymentFinancialAccount :: Text
  financial_account: The FinancialAccount that funds were pulled from.
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentHostedRegulatoryReceiptUrl :: 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'outboundPaymentId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentLivemode :: 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'outboundPaymentMetadata :: 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'outboundPaymentReturnedDetails :: Maybe (Nullable Treasury'outboundPaymentReturnedDetails'NonNullable)
  returned_details: Details about a returned OutboundPayment. Only set when the status is `returned`.
- treasury'outboundPaymentStatementDescriptor :: Text
  statement_descriptor: The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentStatus :: Treasury'outboundPaymentStatus'
  status: Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been "confirmed" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`.
- treasury'outboundPaymentStatusTransitions :: OutboundPaymentsResourceTreasuryOutboundPaymentResourceStatusTransitions
  status_transitions:
- treasury'outboundPaymentTransaction :: Treasury'outboundPaymentTransaction'Variants
  transaction: The Transaction associated with this object.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundPaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
Show Treasury'outboundPaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
FromJSON Treasury'outboundPaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
ToJSON Treasury'outboundPaymentDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment

valuemkTreasury'outboundPayment

Create a new Treasury'outboundPayment with all required fields.

datadata Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullable

Defines the object schema located at components.schemas.treasury.outbound_payment.properties.destination_payment_method_details.anyOf in the specification.

Details about the PaymentMethod for an OutboundPayment.

Constructors

Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullable
- treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableBillingDetails :: Maybe TreasurySharedResourceBillingDetails
  billing_details:
- treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableFinancialAccount :: Maybe OutboundPaymentsPaymentMethodDetailsFinancialAccount
  financial_account:
- treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableType :: Maybe Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableType'
  type: The type of the payment method used in the OutboundPayment.
- treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableUsBankAccount :: Maybe OutboundPaymentsPaymentMethodDetailsUsBankAccount
  us_bank_account:

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
Show Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
FromJSON Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
ToJSON Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment

value

mkTreasury'outboundPaymentDestinationPaymentMethodDetails'NonNullable :: Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullable

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

datadata Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableType'

Defines the enum schema located at components.schemas.treasury.outbound_payment.properties.destination_payment_method_details.anyOf.properties.type in the specification.

The type of the payment method used in the OutboundPayment.

Constructors

Treasury'outboundPaymentDestinationPaymentMethodDetails'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'outboundPaymentDestinationPaymentMethodDetails'NonNullableType'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableType'EnumFinancialAccount
Represents the JSON value "financial_account"
Treasury'outboundPaymentDestinationPaymentMethodDetails'NonNullableType'EnumUsBankAccount
Represents the JSON value "us_bank_account"

Instances4Eq, Show, FromJSON, ToJSON

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

datadata Treasury'outboundPaymentEndUserDetails'NonNullable

Defines the object schema located at components.schemas.treasury.outbound_payment.properties.end_user_details.anyOf in the specification.

Details about the end user.

Constructors

Treasury'outboundPaymentEndUserDetails'NonNullable
- treasury'outboundPaymentEndUserDetails'NonNullableIpAddress :: Maybe (Nullable Text)
  ip_address: IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.
  Constraints:
  - Maximum length of 5000
- treasury'outboundPaymentEndUserDetails'NonNullablePresent :: Maybe Bool
  present: `true`` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundPaymentEndUserDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
Show Treasury'outboundPaymentEndUserDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
FromJSON Treasury'outboundPaymentEndUserDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
ToJSON Treasury'outboundPaymentEndUserDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment

valuemkTreasury'outboundPaymentEndUserDetails'NonNullable :: Treasury'outboundPaymentEndUserDetails'NonNullable

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

datadata Treasury'outboundPaymentReturnedDetails'NonNullable

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

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundPaymentReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
Show Treasury'outboundPaymentReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
FromJSON Treasury'outboundPaymentReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
ToJSON Treasury'outboundPaymentReturnedDetails'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment

valuemkTreasury'outboundPaymentReturnedDetails'NonNullable :: Treasury'outboundPaymentReturnedDetails'NonNullable

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

datadata Treasury'outboundPaymentReturnedDetails'NonNullableCode'

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

Reason for the return.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

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

datadata Treasury'outboundPaymentReturnedDetails'NonNullableTransaction'Variants

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

The Transaction associated with this object.

Constructors

Treasury'outboundPaymentReturnedDetails'NonNullableTransaction'Text Text
Treasury'outboundPaymentReturnedDetails'NonNullableTransaction'Treasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

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

datadata Treasury'outboundPaymentStatus'

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

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundPaymentStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
Show Treasury'outboundPaymentStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
FromJSON Treasury'outboundPaymentStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
ToJSON Treasury'outboundPaymentStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment

datadata Treasury'outboundPaymentTransaction'Variants

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

The Transaction associated with this object.

Constructors

Treasury'outboundPaymentTransaction'Text Text
Treasury'outboundPaymentTransaction'Treasury'transaction Treasury'transaction

Instances4Eq, Show, FromJSON, ToJSON

Eq Treasury'outboundPaymentTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
Show Treasury'outboundPaymentTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
FromJSON Treasury'outboundPaymentTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment
ToJSON Treasury'outboundPaymentTransaction'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Treasury_OutboundPayment