| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetRecipientsId
Description
Contains the different functions to run the operation getRecipientsId
Synopsis
- getRecipientsId :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> m (Either HttpException (Response GetRecipientsIdResponse))
- getRecipientsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> m (Either HttpException (Response ByteString))
- getRecipientsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRecipientsIdResponse))
- getRecipientsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetRecipientsIdRequestBody = GetRecipientsIdRequestBody {
- data GetRecipientsIdResponse
- data GetRecipientsIdResponseBody200 = GetRecipientsIdResponseBody200 {
- getRecipientsIdResponseBody200ActiveAccount :: Maybe GetRecipientsIdResponseBody200ActiveAccount'
- getRecipientsIdResponseBody200Cards :: Maybe GetRecipientsIdResponseBody200Cards'
- getRecipientsIdResponseBody200Created :: Maybe Integer
- getRecipientsIdResponseBody200DefaultCard :: Maybe GetRecipientsIdResponseBody200DefaultCard'Variants
- getRecipientsIdResponseBody200Deleted :: Maybe GetRecipientsIdResponseBody200Deleted'
- getRecipientsIdResponseBody200Description :: Maybe Text
- getRecipientsIdResponseBody200Email :: Maybe Text
- getRecipientsIdResponseBody200Id :: Maybe Text
- getRecipientsIdResponseBody200Livemode :: Maybe Bool
- getRecipientsIdResponseBody200Metadata :: Maybe GetRecipientsIdResponseBody200Metadata'
- getRecipientsIdResponseBody200MigratedTo :: Maybe GetRecipientsIdResponseBody200MigratedTo'Variants
- getRecipientsIdResponseBody200Name :: Maybe Text
- getRecipientsIdResponseBody200Object :: Maybe GetRecipientsIdResponseBody200Object'
- getRecipientsIdResponseBody200RolledBackFrom :: Maybe GetRecipientsIdResponseBody200RolledBackFrom'Variants
- getRecipientsIdResponseBody200Type :: Maybe Text
- data GetRecipientsIdResponseBody200ActiveAccount' = GetRecipientsIdResponseBody200ActiveAccount' {
- getRecipientsIdResponseBody200ActiveAccount'Account :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Account'Variants
- getRecipientsIdResponseBody200ActiveAccount'AccountHolderName :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'AccountHolderType :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'BankName :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Country :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Currency :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Customer :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants
- getRecipientsIdResponseBody200ActiveAccount'DefaultForCurrency :: Maybe Bool
- getRecipientsIdResponseBody200ActiveAccount'Fingerprint :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Id :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Last4 :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Metadata :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Metadata'
- getRecipientsIdResponseBody200ActiveAccount'Object :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Object'
- getRecipientsIdResponseBody200ActiveAccount'RoutingNumber :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Status :: Maybe Text
- data GetRecipientsIdResponseBody200ActiveAccount'Account'Variants
- data GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants
- data GetRecipientsIdResponseBody200ActiveAccount'Metadata' = GetRecipientsIdResponseBody200ActiveAccount'Metadata' {
- data GetRecipientsIdResponseBody200ActiveAccount'Object'
- data GetRecipientsIdResponseBody200Cards' = GetRecipientsIdResponseBody200Cards' {}
- data GetRecipientsIdResponseBody200Cards'Object'
- data GetRecipientsIdResponseBody200DefaultCard'Variants
- data GetRecipientsIdResponseBody200Deleted'
- data GetRecipientsIdResponseBody200Metadata' = GetRecipientsIdResponseBody200Metadata' {
- data GetRecipientsIdResponseBody200MigratedTo'Variants
- data GetRecipientsIdResponseBody200Object'
- data GetRecipientsIdResponseBody200RolledBackFrom'Variants
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe Text | expand: Specifies which fields in the response should be expanded. |
| -> Text | id | Constraints: Maximum length of 5000 |
| -> Maybe GetRecipientsIdRequestBody | The request body to send |
| -> m (Either HttpException (Response GetRecipientsIdResponse)) | Monad containing the result of the operation |
GET /v1/recipients/{id}<p>Retrieves the details of an existing recipient. You need only supply the unique recipient identifier that was returned upon recipient creation.</p>
getRecipientsIdRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/recipients/{id}The same as getRecipientsId but returns the raw ByteString
getRecipientsIdM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetRecipientsIdResponse)) Source #
GET /v1/recipients/{id}Monadic version of getRecipientsId (use with runWithConfiguration)
getRecipientsIdRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Text -> Maybe GetRecipientsIdRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/recipients/{id}Monadic version of getRecipientsIdRaw (use with runWithConfiguration)
data GetRecipientsIdRequestBody Source #
Defines the data type for the schema getRecipientsIdRequestBody
Constructors
| GetRecipientsIdRequestBody | |
Instances
data GetRecipientsIdResponse Source #
Represents a response of the operation getRecipientsId.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetRecipientsIdResponseError is used.
Constructors
| GetRecipientsIdResponseError String | Means either no matching case available or a parse error |
| GetRecipientsIdResponse200 GetRecipientsIdResponseBody200 | Successful response. |
| GetRecipientsIdResponseDefault Error | Error response. |
Instances
| Eq GetRecipientsIdResponse Source # | |
Defined in StripeAPI.Operations.GetRecipientsId Methods (==) :: GetRecipientsIdResponse -> GetRecipientsIdResponse -> Bool # (/=) :: GetRecipientsIdResponse -> GetRecipientsIdResponse -> Bool # | |
| Show GetRecipientsIdResponse Source # | |
Defined in StripeAPI.Operations.GetRecipientsId Methods showsPrec :: Int -> GetRecipientsIdResponse -> ShowS # show :: GetRecipientsIdResponse -> String # showList :: [GetRecipientsIdResponse] -> ShowS # | |
data GetRecipientsIdResponseBody200 Source #
Defines the data type for the schema GetRecipientsIdResponseBody200
Constructors
| GetRecipientsIdResponseBody200 | |
Fields
| |
Instances
data GetRecipientsIdResponseBody200ActiveAccount' Source #
Defines the data type for the schema GetRecipientsIdResponseBody200Active_account'
Hash describing the current account on the recipient, if there is one.
Constructors
| GetRecipientsIdResponseBody200ActiveAccount' | |
Fields
| |
data GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source #
Define the one-of schema GetRecipientsIdResponseBody200Active_account'Account'
The ID of the account that the bank account is associated with.
Constructors
| GetRecipientsIdResponseBody200ActiveAccount'Account'Account Account | |
| GetRecipientsIdResponseBody200ActiveAccount'Account'Text Text |
Instances
data GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source #
Define the one-of schema GetRecipientsIdResponseBody200Active_account'Customer'
The ID of the customer that the bank account is associated with.
Constructors
Instances
data GetRecipientsIdResponseBody200ActiveAccount'Metadata' Source #
Defines the data type for the schema GetRecipientsIdResponseBody200Active_account'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.
Instances
data GetRecipientsIdResponseBody200ActiveAccount'Object' Source #
Defines the enum schema GetRecipientsIdResponseBody200Active_account'Object'
String representing the object's type. Objects of the same type share the same value.
Constructors
Instances
data GetRecipientsIdResponseBody200Cards' Source #
Defines the data type for the schema GetRecipientsIdResponseBody200Cards'
Constructors
| GetRecipientsIdResponseBody200Cards' | |
Fields
| |
Instances
data GetRecipientsIdResponseBody200Cards'Object' Source #
Defines the enum schema GetRecipientsIdResponseBody200Cards'Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetRecipientsIdResponseBody200Cards'Object'EnumOther Value | |
| GetRecipientsIdResponseBody200Cards'Object'EnumTyped Text | |
| GetRecipientsIdResponseBody200Cards'Object'EnumStringList |
Instances
data GetRecipientsIdResponseBody200DefaultCard'Variants Source #
Define the one-of schema GetRecipientsIdResponseBody200Default_card'
The default card to use for creating transfers to this recipient.
Constructors
| GetRecipientsIdResponseBody200DefaultCard'Card Card | |
| GetRecipientsIdResponseBody200DefaultCard'Text Text |
Instances
data GetRecipientsIdResponseBody200Deleted' Source #
Defines the enum schema GetRecipientsIdResponseBody200Deleted'
Always true for a deleted object
Constructors
| GetRecipientsIdResponseBody200Deleted'EnumOther Value | |
| GetRecipientsIdResponseBody200Deleted'EnumTyped Bool | |
| GetRecipientsIdResponseBody200Deleted'EnumBoolTrue |
Instances
data GetRecipientsIdResponseBody200Metadata' Source #
Defines the data type for the schema GetRecipientsIdResponseBody200Metadata'
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.
Constructors
| GetRecipientsIdResponseBody200Metadata' | |
Instances
data GetRecipientsIdResponseBody200MigratedTo'Variants Source #
Define the one-of schema GetRecipientsIdResponseBody200Migrated_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.
Constructors
| GetRecipientsIdResponseBody200MigratedTo'Account Account | |
| GetRecipientsIdResponseBody200MigratedTo'Text Text |
Instances
data GetRecipientsIdResponseBody200Object' Source #
Defines the enum schema GetRecipientsIdResponseBody200Object'
String representing the object's type. Objects of the same type share the same value.
Constructors
| GetRecipientsIdResponseBody200Object'EnumOther Value | |
| GetRecipientsIdResponseBody200Object'EnumTyped Text | |
| GetRecipientsIdResponseBody200Object'EnumStringRecipient |
Instances
data GetRecipientsIdResponseBody200RolledBackFrom'Variants Source #
Define the one-of schema GetRecipientsIdResponseBody200Rolled_back_from'
Constructors
| GetRecipientsIdResponseBody200RolledBackFrom'Account Account | |
| GetRecipientsIdResponseBody200RolledBackFrom'Text Text |