Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Types.Recipient
Description
Contains the types generated from the schema Recipient
Synopsis
- data Recipient = Recipient {
- recipientActiveAccount :: Maybe RecipientActiveAccount'
- recipientCards :: Maybe RecipientCards'
- recipientCreated :: Int
- recipientDefaultCard :: Maybe RecipientDefaultCard'Variants
- recipientDescription :: Maybe Text
- recipientEmail :: Maybe Text
- recipientId :: Text
- recipientLivemode :: Bool
- recipientMetadata :: Object
- recipientMigratedTo :: Maybe RecipientMigratedTo'Variants
- recipientName :: Maybe Text
- recipientRolledBackFrom :: Maybe RecipientRolledBackFrom'Variants
- recipientType :: Text
- mkRecipient :: Int -> Text -> Bool -> Object -> Text -> Recipient
- data RecipientActiveAccount' = RecipientActiveAccount' {
- recipientActiveAccount'Account :: Maybe RecipientActiveAccount'Account'Variants
- recipientActiveAccount'AccountHolderName :: Maybe Text
- recipientActiveAccount'AccountHolderType :: Maybe Text
- recipientActiveAccount'AvailablePayoutMethods :: Maybe [RecipientActiveAccount'AvailablePayoutMethods']
- recipientActiveAccount'BankName :: Maybe Text
- recipientActiveAccount'Country :: Maybe Text
- recipientActiveAccount'Currency :: Maybe Text
- recipientActiveAccount'Customer :: Maybe RecipientActiveAccount'Customer'Variants
- recipientActiveAccount'DefaultForCurrency :: Maybe Bool
- recipientActiveAccount'Fingerprint :: Maybe Text
- recipientActiveAccount'Id :: Maybe Text
- recipientActiveAccount'Last4 :: Maybe Text
- recipientActiveAccount'Metadata :: Maybe Object
- recipientActiveAccount'Object :: Maybe RecipientActiveAccount'Object'
- recipientActiveAccount'RoutingNumber :: Maybe Text
- recipientActiveAccount'Status :: Maybe Text
- mkRecipientActiveAccount' :: RecipientActiveAccount'
- data RecipientActiveAccount'Account'Variants
- data RecipientActiveAccount'AvailablePayoutMethods'
- data RecipientActiveAccount'Customer'Variants
- data RecipientActiveAccount'Object'
- data RecipientCards' = RecipientCards' {}
- mkRecipientCards' :: [Card] -> Bool -> Text -> RecipientCards'
- data RecipientDefaultCard'Variants
- data RecipientMigratedTo'Variants
- data RecipientRolledBackFrom'Variants
Documentation
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
|
Create a new Recipient
with all required fields.
data RecipientActiveAccount' Source #
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
|
Instances
Eq RecipientActiveAccount' Source # | |
Defined in StripeAPI.Types.Recipient Methods (==) :: RecipientActiveAccount' -> RecipientActiveAccount' -> Bool # (/=) :: RecipientActiveAccount' -> RecipientActiveAccount' -> Bool # | |
Show RecipientActiveAccount' Source # | |
Defined in StripeAPI.Types.Recipient Methods showsPrec :: Int -> RecipientActiveAccount' -> ShowS # show :: RecipientActiveAccount' -> String # showList :: [RecipientActiveAccount'] -> ShowS # | |
ToJSON RecipientActiveAccount' Source # | |
Defined in StripeAPI.Types.Recipient Methods toJSON :: RecipientActiveAccount' -> Value # toEncoding :: RecipientActiveAccount' -> Encoding # toJSONList :: [RecipientActiveAccount'] -> Value # | |
FromJSON RecipientActiveAccount' Source # | |
Defined in StripeAPI.Types.Recipient Methods parseJSON :: Value -> Parser RecipientActiveAccount' # parseJSONList :: Value -> Parser [RecipientActiveAccount'] # |
mkRecipientActiveAccount' :: RecipientActiveAccount' Source #
Create a new RecipientActiveAccount'
with all required fields.
data RecipientActiveAccount'Account'Variants Source #
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.
Instances
data RecipientActiveAccount'AvailablePayoutMethods' Source #
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 |
RecipientActiveAccount'AvailablePayoutMethods'EnumStandard | Represents the JSON value |
Instances
data RecipientActiveAccount'Customer'Variants Source #
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
data RecipientActiveAccount'Object' Source #
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 |
Instances
Eq RecipientActiveAccount'Object' Source # | |
Defined in StripeAPI.Types.Recipient | |
Show RecipientActiveAccount'Object' Source # | |
Defined in StripeAPI.Types.Recipient Methods showsPrec :: Int -> RecipientActiveAccount'Object' -> ShowS # show :: RecipientActiveAccount'Object' -> String # showList :: [RecipientActiveAccount'Object'] -> ShowS # | |
ToJSON RecipientActiveAccount'Object' Source # | |
Defined in StripeAPI.Types.Recipient | |
FromJSON RecipientActiveAccount'Object' Source # | |
Defined in StripeAPI.Types.Recipient Methods parseJSON :: Value -> Parser RecipientActiveAccount'Object' # parseJSONList :: Value -> Parser [RecipientActiveAccount'Object'] # |
data RecipientCards' Source #
Defines the object schema located at components.schemas.recipient.properties.cards
in the specification.
Constructors
RecipientCards' | |
Fields
|
Instances
Eq RecipientCards' Source # | |
Defined in StripeAPI.Types.Recipient Methods (==) :: RecipientCards' -> RecipientCards' -> Bool # (/=) :: RecipientCards' -> RecipientCards' -> Bool # | |
Show RecipientCards' Source # | |
Defined in StripeAPI.Types.Recipient Methods showsPrec :: Int -> RecipientCards' -> ShowS # show :: RecipientCards' -> String # showList :: [RecipientCards'] -> ShowS # | |
ToJSON RecipientCards' Source # | |
Defined in StripeAPI.Types.Recipient Methods toJSON :: RecipientCards' -> Value # toEncoding :: RecipientCards' -> Encoding # toJSONList :: [RecipientCards'] -> Value # toEncodingList :: [RecipientCards'] -> Encoding # | |
FromJSON RecipientCards' Source # | |
Defined in StripeAPI.Types.Recipient Methods parseJSON :: Value -> Parser RecipientCards' # parseJSONList :: Value -> Parser [RecipientCards'] # |
Arguments
:: [Card] | |
-> Bool | |
-> Text | |
-> RecipientCards' |
Create a new RecipientCards'
with all required fields.
data RecipientDefaultCard'Variants Source #
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 Source # | |
Defined in StripeAPI.Types.Recipient | |
Show RecipientDefaultCard'Variants Source # | |
Defined in StripeAPI.Types.Recipient Methods showsPrec :: Int -> RecipientDefaultCard'Variants -> ShowS # show :: RecipientDefaultCard'Variants -> String # showList :: [RecipientDefaultCard'Variants] -> ShowS # | |
ToJSON RecipientDefaultCard'Variants Source # | |
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 Source # | |
Defined in StripeAPI.Types.Recipient Methods parseJSON :: Value -> Parser RecipientDefaultCard'Variants # parseJSONList :: Value -> Parser [RecipientDefaultCard'Variants] # |
data RecipientMigratedTo'Variants Source #
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.
Instances
data RecipientRolledBackFrom'Variants Source #
Defines the oneOf schema located at components.schemas.recipient.properties.rolled_back_from.anyOf
in the specification.
Instances
Eq RecipientRolledBackFrom'Variants Source # | |
Defined in StripeAPI.Types.Recipient | |
Show RecipientRolledBackFrom'Variants Source # | |
Defined in StripeAPI.Types.Recipient Methods showsPrec :: Int -> RecipientRolledBackFrom'Variants -> ShowS # | |
ToJSON RecipientRolledBackFrom'Variants Source # | |
Defined in StripeAPI.Types.Recipient | |
FromJSON RecipientRolledBackFrom'Variants Source # | |
Defined in StripeAPI.Types.Recipient Methods parseJSON :: Value -> Parser RecipientRolledBackFrom'Variants # parseJSONList :: Value -> Parser [RecipientRolledBackFrom'Variants] # |