StripeAPI.Types.Recipient

Contains the types generated from the schema Recipient

Documentation

data 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

Fields

• recipientActiveAccount :: Maybe RecipientActiveAccount'

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

• recipientCards :: Maybe RecipientCards'

  cards:

• recipientCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• recipientDefaultCard :: Maybe RecipientDefaultCard'Variants

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

• recipientDescription :: Maybe Text

  description: An arbitrary string attached to the object. Often useful for displaying to users.

  Constraints:

  • Maximum length of 5000
• recipientEmail :: Maybe 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 RecipientMigratedTo'Variants

  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 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

Instances

Eq Recipient

Defined in StripeAPI.Types.Recipient

Methods

(==) :: Recipient -> Recipient -> Bool

(/=) :: Recipient -> Recipient -> Bool

Show Recipient

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> Recipient -> ShowS

show :: Recipient -> String

showList :: [Recipient] -> ShowS

ToJSON Recipient

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: Recipient -> Value

toEncoding :: Recipient -> Encoding

toJSONList :: [Recipient] -> Value

toEncodingList :: [Recipient] -> Encoding

FromJSON Recipient

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser Recipient

parseJSONList :: Value -> Parser [Recipient]

mkRecipient

Arguments

:: Int

recipientCreated

-> Text

recipientId

-> Bool

recipientLivemode

-> Object

recipientMetadata

-> Text

recipientType

-> Recipient

Create a new Recipient with all required fields.

data RecipientActiveAccount'

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'

Fields

• recipientActiveAccount'Account :: Maybe RecipientActiveAccount'Account'Variants

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

• recipientActiveAccount'AccountHolderName :: Maybe Text

  account_holder_name: The name of the person or business that owns the bank account.

  Constraints:

  • Maximum length of 5000
• recipientActiveAccount'AccountHolderType :: Maybe 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'AvailablePayoutMethods :: Maybe [RecipientActiveAccount'AvailablePayoutMethods']

  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'BankName :: Maybe Text

  bank_name: Name of the bank associated with the routing number (e.g., `WELLS FARGO`).

  Constraints:

  • Maximum length of 5000
• recipientActiveAccount'Country :: Maybe Text

  country: Two-letter ISO code representing the country the bank account is located in.

  Constraints:

  • Maximum length of 5000
• recipientActiveAccount'Currency :: Maybe Text

  currency: Three-letter ISO code for the currency paid out to the bank account.

• recipientActiveAccount'Customer :: Maybe RecipientActiveAccount'Customer'Variants

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

• recipientActiveAccount'DefaultForCurrency :: Maybe Bool

  default_for_currency: Whether this bank account is the default external account for its currency.

• recipientActiveAccount'Fingerprint :: Maybe 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'Id :: Maybe Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• recipientActiveAccount'Last4 :: Maybe Text

  last4: The last four digits of the bank account number.

  Constraints:

  • Maximum length of 5000
• recipientActiveAccount'Metadata :: Maybe 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'Object :: Maybe RecipientActiveAccount'Object'

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

• recipientActiveAccount'RoutingNumber :: Maybe Text

  routing_number: The routing transit number for the bank account.

  Constraints:

  • Maximum length of 5000
• recipientActiveAccount'Status :: 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

Instances

Eq RecipientActiveAccount'

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientActiveAccount' -> RecipientActiveAccount' -> Bool

(/=) :: RecipientActiveAccount' -> RecipientActiveAccount' -> Bool

Show RecipientActiveAccount'

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientActiveAccount' -> ShowS

show :: RecipientActiveAccount' -> String

showList :: [RecipientActiveAccount'] -> ShowS

ToJSON RecipientActiveAccount'

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientActiveAccount' -> Value

toEncoding :: RecipientActiveAccount' -> Encoding

toJSONList :: [RecipientActiveAccount'] -> Value

toEncodingList :: [RecipientActiveAccount'] -> Encoding

FromJSON RecipientActiveAccount'

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientActiveAccount'

parseJSONList :: Value -> Parser [RecipientActiveAccount']

mkRecipientActiveAccount' :: RecipientActiveAccount'

Create a new RecipientActiveAccount' with all required fields.

data RecipientActiveAccount'Account'Variants

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'Account'Text Text

RecipientActiveAccount'Account'Account Account

Instances

Eq RecipientActiveAccount'Account'Variants

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientActiveAccount'Account'Variants -> RecipientActiveAccount'Account'Variants -> Bool

(/=) :: RecipientActiveAccount'Account'Variants -> RecipientActiveAccount'Account'Variants -> Bool

Show RecipientActiveAccount'Account'Variants

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientActiveAccount'Account'Variants -> ShowS

show :: RecipientActiveAccount'Account'Variants -> String

showList :: [RecipientActiveAccount'Account'Variants] -> ShowS

ToJSON RecipientActiveAccount'Account'Variants

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientActiveAccount'Account'Variants -> Value

toEncoding :: RecipientActiveAccount'Account'Variants -> Encoding

toJSONList :: [RecipientActiveAccount'Account'Variants] -> Value

toEncodingList :: [RecipientActiveAccount'Account'Variants] -> Encoding

FromJSON RecipientActiveAccount'Account'Variants

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientActiveAccount'Account'Variants

parseJSONList :: Value -> Parser [RecipientActiveAccount'Account'Variants]

data RecipientActiveAccount'AvailablePayoutMethods'

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

Constructors

RecipientActiveAccount'AvailablePayoutMethods'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

RecipientActiveAccount'AvailablePayoutMethods'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

RecipientActiveAccount'AvailablePayoutMethods'EnumInstant

Represents the JSON value "instant"

RecipientActiveAccount'AvailablePayoutMethods'EnumStandard

Represents the JSON value "standard"

Instances

Eq RecipientActiveAccount'AvailablePayoutMethods'

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientActiveAccount'AvailablePayoutMethods' -> RecipientActiveAccount'AvailablePayoutMethods' -> Bool

(/=) :: RecipientActiveAccount'AvailablePayoutMethods' -> RecipientActiveAccount'AvailablePayoutMethods' -> Bool

Show RecipientActiveAccount'AvailablePayoutMethods'

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientActiveAccount'AvailablePayoutMethods' -> ShowS

show :: RecipientActiveAccount'AvailablePayoutMethods' -> String

showList :: [RecipientActiveAccount'AvailablePayoutMethods'] -> ShowS

ToJSON RecipientActiveAccount'AvailablePayoutMethods'

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientActiveAccount'AvailablePayoutMethods' -> Value

toEncoding :: RecipientActiveAccount'AvailablePayoutMethods' -> Encoding

toJSONList :: [RecipientActiveAccount'AvailablePayoutMethods'] -> Value

toEncodingList :: [RecipientActiveAccount'AvailablePayoutMethods'] -> Encoding

FromJSON RecipientActiveAccount'AvailablePayoutMethods'

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientActiveAccount'AvailablePayoutMethods'

parseJSONList :: Value -> Parser [RecipientActiveAccount'AvailablePayoutMethods']

data RecipientActiveAccount'Customer'Variants

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'Customer'Text Text

RecipientActiveAccount'Customer'Customer Customer

RecipientActiveAccount'Customer'DeletedCustomer DeletedCustomer

Instances

Eq RecipientActiveAccount'Customer'Variants

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientActiveAccount'Customer'Variants -> RecipientActiveAccount'Customer'Variants -> Bool

(/=) :: RecipientActiveAccount'Customer'Variants -> RecipientActiveAccount'Customer'Variants -> Bool

Show RecipientActiveAccount'Customer'Variants

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientActiveAccount'Customer'Variants -> ShowS

show :: RecipientActiveAccount'Customer'Variants -> String

showList :: [RecipientActiveAccount'Customer'Variants] -> ShowS

ToJSON RecipientActiveAccount'Customer'Variants

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientActiveAccount'Customer'Variants -> Value

toEncoding :: RecipientActiveAccount'Customer'Variants -> Encoding

toJSONList :: [RecipientActiveAccount'Customer'Variants] -> Value

toEncodingList :: [RecipientActiveAccount'Customer'Variants] -> Encoding

FromJSON RecipientActiveAccount'Customer'Variants

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientActiveAccount'Customer'Variants

parseJSONList :: Value -> Parser [RecipientActiveAccount'Customer'Variants]

data RecipientActiveAccount'Object'

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'Object'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

RecipientActiveAccount'Object'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

RecipientActiveAccount'Object'EnumBankAccount

Represents the JSON value "bank_account"

Instances

Eq RecipientActiveAccount'Object'

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientActiveAccount'Object' -> RecipientActiveAccount'Object' -> Bool

(/=) :: RecipientActiveAccount'Object' -> RecipientActiveAccount'Object' -> Bool

Show RecipientActiveAccount'Object'

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientActiveAccount'Object' -> ShowS

show :: RecipientActiveAccount'Object' -> String

showList :: [RecipientActiveAccount'Object'] -> ShowS

ToJSON RecipientActiveAccount'Object'

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientActiveAccount'Object' -> Value

toEncoding :: RecipientActiveAccount'Object' -> Encoding

toJSONList :: [RecipientActiveAccount'Object'] -> Value

toEncodingList :: [RecipientActiveAccount'Object'] -> Encoding

FromJSON RecipientActiveAccount'Object'

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientActiveAccount'Object'

parseJSONList :: Value -> Parser [RecipientActiveAccount'Object']

data RecipientCards'

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

Constructors

RecipientCards'

Fields

• recipientCards'Data :: [Card]

  data

• recipientCards'HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• recipientCards'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq RecipientCards'

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientCards' -> RecipientCards' -> Bool

(/=) :: RecipientCards' -> RecipientCards' -> Bool

Show RecipientCards'

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientCards' -> ShowS

show :: RecipientCards' -> String

showList :: [RecipientCards'] -> ShowS

ToJSON RecipientCards'

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientCards' -> Value

toEncoding :: RecipientCards' -> Encoding

toJSONList :: [RecipientCards'] -> Value

toEncodingList :: [RecipientCards'] -> Encoding

FromJSON RecipientCards'

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientCards'

parseJSONList :: Value -> Parser [RecipientCards']

mkRecipientCards'

Arguments

:: [Card]

recipientCards'Data

-> Bool

recipientCards'HasMore

-> Text

recipientCards'Url

-> RecipientCards'

Create a new RecipientCards' with all required fields.

data RecipientDefaultCard'Variants

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'Text Text

RecipientDefaultCard'Card Card

Instances

Eq RecipientDefaultCard'Variants

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientDefaultCard'Variants -> RecipientDefaultCard'Variants -> Bool

(/=) :: RecipientDefaultCard'Variants -> RecipientDefaultCard'Variants -> Bool

Show RecipientDefaultCard'Variants

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientDefaultCard'Variants -> ShowS

show :: RecipientDefaultCard'Variants -> String

showList :: [RecipientDefaultCard'Variants] -> ShowS

ToJSON RecipientDefaultCard'Variants

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientDefaultCard'Variants -> Value

toEncoding :: RecipientDefaultCard'Variants -> Encoding

toJSONList :: [RecipientDefaultCard'Variants] -> Value

toEncodingList :: [RecipientDefaultCard'Variants] -> Encoding

FromJSON RecipientDefaultCard'Variants

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientDefaultCard'Variants

parseJSONList :: Value -> Parser [RecipientDefaultCard'Variants]

data RecipientMigratedTo'Variants

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'Text Text

RecipientMigratedTo'Account Account

Instances

Eq RecipientMigratedTo'Variants

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientMigratedTo'Variants -> RecipientMigratedTo'Variants -> Bool

(/=) :: RecipientMigratedTo'Variants -> RecipientMigratedTo'Variants -> Bool

Show RecipientMigratedTo'Variants

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientMigratedTo'Variants -> ShowS

show :: RecipientMigratedTo'Variants -> String

showList :: [RecipientMigratedTo'Variants] -> ShowS

ToJSON RecipientMigratedTo'Variants

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientMigratedTo'Variants -> Value

toEncoding :: RecipientMigratedTo'Variants -> Encoding

toJSONList :: [RecipientMigratedTo'Variants] -> Value

toEncodingList :: [RecipientMigratedTo'Variants] -> Encoding

FromJSON RecipientMigratedTo'Variants

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientMigratedTo'Variants

parseJSONList :: Value -> Parser [RecipientMigratedTo'Variants]

data 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

Instances

Eq RecipientRolledBackFrom'Variants

Defined in StripeAPI.Types.Recipient

Methods

(==) :: RecipientRolledBackFrom'Variants -> RecipientRolledBackFrom'Variants -> Bool

(/=) :: RecipientRolledBackFrom'Variants -> RecipientRolledBackFrom'Variants -> Bool

Show RecipientRolledBackFrom'Variants

Defined in StripeAPI.Types.Recipient

Methods

showsPrec :: Int -> RecipientRolledBackFrom'Variants -> ShowS

show :: RecipientRolledBackFrom'Variants -> String

showList :: [RecipientRolledBackFrom'Variants] -> ShowS

ToJSON RecipientRolledBackFrom'Variants

Defined in StripeAPI.Types.Recipient

Methods

toJSON :: RecipientRolledBackFrom'Variants -> Value

toEncoding :: RecipientRolledBackFrom'Variants -> Encoding

toJSONList :: [RecipientRolledBackFrom'Variants] -> Value

toEncodingList :: [RecipientRolledBackFrom'Variants] -> Encoding

FromJSON RecipientRolledBackFrom'Variants

Defined in StripeAPI.Types.Recipient

Methods

parseJSON :: Value -> Parser RecipientRolledBackFrom'Variants

parseJSONList :: Value -> Parser [RecipientRolledBackFrom'Variants]