Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Types.Recipient

Contains the types generated from the schema Recipient

10 types
3 values

Packagestripeapi-3.0.0.0
Exports13
LanguageHaskell2010
LicenceMIT
SourceRecipient.hs

datadata Recipient

Defines the object schema located at components.schemas.recipient in the specification.

With `Recipient` objects, you can transfer money from your Stripe account to a third-party bank account or debit card. The API allows you to create, delete, and update your recipients. You can retrieve individual recipients as well as a list of all your recipients.

*`Recipient` objects have been deprecated in favor of Connect, specifically Connect's much more powerful Account objects. Stripe accounts that don't already use recipients can no longer begin doing so. Please use `Account` objects instead.**

Constructors

Recipient
- recipientActiveAccount :: Maybe (Nullable RecipientActiveAccount'NonNullable)
  active_account: Hash describing the current account on the recipient, if there is one.
- recipientCards :: Maybe (Nullable RecipientCards'NonNullable)
  cards:
- recipientCreated :: Int
  created: Time at which the object was created. Measured in seconds since the Unix epoch.
- recipientDefaultCard :: Maybe (Nullable RecipientDefaultCard'NonNullableVariants)
  default_card: The default card to use for creating transfers to this recipient.
- recipientDescription :: Maybe (Nullable Text)
  description: An arbitrary string attached to the object. Often useful for displaying to users.
  Constraints:
  - Maximum length of 5000
- recipientEmail :: Maybe (Nullable Text)
  email
  Constraints:
  - Maximum length of 5000
- recipientId :: Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- recipientLivemode :: Bool
  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
- recipientMetadata :: 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.
- recipientMigratedTo :: Maybe (Nullable RecipientMigratedTo'NonNullableVariants)
  migrated_to: The ID of the Custom account this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.
- recipientName :: Maybe (Nullable Text)
  name: Full, legal name of the recipient.
  Constraints:
  - Maximum length of 5000
- recipientRolledBackFrom :: Maybe RecipientRolledBackFrom'Variants
  rolled_back_from
- recipientType :: Text
  type: Type of the recipient, one of `individual` or `corporation`.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

valuemkRecipient

:: Int
recipientCreated
-> Text
recipientId
-> Bool
recipientLivemode
-> Object
recipientMetadata
-> Text
recipientType
-> Recipient

Create a new Recipient with all required fields.

datadata RecipientActiveAccount'NonNullable

Defines the object schema located at components.schemas.recipient.properties.active_account.anyOf in the specification.

Hash describing the current account on the recipient, if there is one.

Constructors

RecipientActiveAccount'NonNullable
- recipientActiveAccount'NonNullableAccount :: Maybe (Nullable RecipientActiveAccount'NonNullableAccount'NonNullableVariants)
  account: The ID of the account that the bank account is associated with.
- recipientActiveAccount'NonNullableAccountHolderName :: Maybe (Nullable Text)
  account_holder_name: The name of the person or business that owns the bank account.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableAccountHolderType :: Maybe (Nullable Text)
  account_holder_type: The type of entity that holds the account. This can be either `individual` or `company`.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableAccountType :: Maybe (Nullable Text)
  account_type: The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableAvailablePayoutMethods :: Maybe (Nullable [RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullable])
  available_payout_methods: A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
- recipientActiveAccount'NonNullableBankName :: Maybe (Nullable Text)
  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableCountry :: Maybe Text
  country: Two-letter ISO code representing the country the bank account is located in.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableCurrency :: Maybe Text
  currency: Three-letter ISO code for the currency paid out to the bank account.
- recipientActiveAccount'NonNullableCustomer :: Maybe (Nullable RecipientActiveAccount'NonNullableCustomer'NonNullableVariants)
  customer: The ID of the customer that the bank account is associated with.
- recipientActiveAccount'NonNullableDefaultForCurrency :: Maybe (Nullable Bool)
  default_for_currency: Whether this bank account is the default external account for its currency.
- recipientActiveAccount'NonNullableFingerprint :: Maybe (Nullable Text)
  fingerprint: Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableId :: Maybe Text
  id: Unique identifier for the object.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableLast4 :: Maybe Text
  last4: The last four digits of the bank account number.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableMetadata :: Maybe (Nullable 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.
- recipientActiveAccount'NonNullableObject :: Maybe RecipientActiveAccount'NonNullableObject'
  object: String representing the object's type. Objects of the same type share the same value.
- recipientActiveAccount'NonNullableRoutingNumber :: Maybe (Nullable Text)
  routing_number: The routing transit number for the bank account.
  Constraints:
  - Maximum length of 5000
- recipientActiveAccount'NonNullableStatus :: Maybe Text
  status: For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.
  For external accounts, possible values are `new` and `errored`. Validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientActiveAccount'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientActiveAccount'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientActiveAccount'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientActiveAccount'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

valuemkRecipientActiveAccount'NonNullable :: RecipientActiveAccount'NonNullable

Create a new RecipientActiveAccount'NonNullable with all required fields.

datadata RecipientActiveAccount'NonNullableAccount'NonNullableVariants

Defines the oneOf schema located at components.schemas.recipient.properties.active_account.anyOf.properties.account.anyOf in the specification.

The ID of the account that the bank account is associated with.

Constructors

RecipientActiveAccount'NonNullableAccount'NonNullableText Text
RecipientActiveAccount'NonNullableAccount'NonNullableAccount Account

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientActiveAccount'NonNullableAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientActiveAccount'NonNullableAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientActiveAccount'NonNullableAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientActiveAccount'NonNullableAccount'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

datadata RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullable

Defines the enum schema located at components.schemas.recipient.properties.active_account.anyOf.properties.available_payout_methods.items in the specification.

Constructors

RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableOther Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableTyped Text
This constructor can be used to send values to the server which are not present in the specification yet.
RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableEnumInstant
Represents the JSON value "instant"
RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableEnumStandard
Represents the JSON value "standard"

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientActiveAccount'NonNullableAvailablePayoutMethods'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

datadata RecipientActiveAccount'NonNullableCustomer'NonNullableVariants

Defines the oneOf schema located at components.schemas.recipient.properties.active_account.anyOf.properties.customer.anyOf in the specification.

The ID of the customer that the bank account is associated with.

Constructors

RecipientActiveAccount'NonNullableCustomer'NonNullableText Text
RecipientActiveAccount'NonNullableCustomer'NonNullableCustomer Customer
RecipientActiveAccount'NonNullableCustomer'NonNullableDeletedCustomer DeletedCustomer

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientActiveAccount'NonNullableCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientActiveAccount'NonNullableCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientActiveAccount'NonNullableCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientActiveAccount'NonNullableCustomer'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

datadata RecipientActiveAccount'NonNullableObject'

Defines the enum schema located at components.schemas.recipient.properties.active_account.anyOf.properties.object in the specification.

String representing the object's type. Objects of the same type share the same value.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientActiveAccount'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientActiveAccount'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientActiveAccount'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientActiveAccount'NonNullableObject'Defined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

datadata RecipientCards'NonNullable

Defines the object schema located at components.schemas.recipient.properties.cards in the specification.

Constructors

RecipientCards'NonNullable
- recipientCards'NonNullableData :: [Card]
  data
- recipientCards'NonNullableHasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- recipientCards'NonNullableUrl :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientCards'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientCards'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientCards'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientCards'NonNullableDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

valuemkRecipientCards'NonNullable

:: [Card]
recipientCards'NonNullableData
-> Bool
recipientCards'NonNullableHasMore
-> Text
recipientCards'NonNullableUrl
-> RecipientCards'NonNullable

Create a new RecipientCards'NonNullable with all required fields.

datadata RecipientDefaultCard'NonNullableVariants

Defines the oneOf schema located at components.schemas.recipient.properties.default_card.anyOf in the specification.

The default card to use for creating transfers to this recipient.

Constructors

RecipientDefaultCard'NonNullableText Text
RecipientDefaultCard'NonNullableCard Card

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientDefaultCard'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientDefaultCard'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientDefaultCard'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientDefaultCard'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

datadata RecipientMigratedTo'NonNullableVariants

Defines the oneOf schema located at components.schemas.recipient.properties.migrated_to.anyOf in the specification.

The ID of the Custom account this recipient was migrated to. If set, the recipient can no longer be updated, nor can transfers be made to it: use the Custom account instead.

Constructors

RecipientMigratedTo'NonNullableText Text
RecipientMigratedTo'NonNullableAccount Account

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientMigratedTo'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientMigratedTo'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientMigratedTo'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientMigratedTo'NonNullableVariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient

datadata RecipientRolledBackFrom'Variants

Defines the oneOf schema located at components.schemas.recipient.properties.rolled_back_from.anyOf in the specification.

Constructors

RecipientRolledBackFrom'Text Text
RecipientRolledBackFrom'Account Account

Instances4Eq, Show, FromJSON, ToJSON

Eq RecipientRolledBackFrom'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
Show RecipientRolledBackFrom'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
FromJSON RecipientRolledBackFrom'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient
ToJSON RecipientRolledBackFrom'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Types.Recipient