| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetRecipientsId
Description
Contains the different functions to run the operation getRecipientsId
Synopsis
- getRecipientsId :: forall m. MonadHTTP m => GetRecipientsIdParameters -> ClientT m (Response GetRecipientsIdResponse)
- data GetRecipientsIdParameters = GetRecipientsIdParameters {}
- mkGetRecipientsIdParameters :: Text -> GetRecipientsIdParameters
- data GetRecipientsIdResponse
- data GetRecipientsIdResponseBody200 = GetRecipientsIdResponseBody200 {
- getRecipientsIdResponseBody200ActiveAccount :: Maybe GetRecipientsIdResponseBody200ActiveAccount'
- getRecipientsIdResponseBody200Cards :: Maybe GetRecipientsIdResponseBody200Cards'
- getRecipientsIdResponseBody200Created :: Maybe Int
- getRecipientsIdResponseBody200DefaultCard :: Maybe GetRecipientsIdResponseBody200DefaultCard'Variants
- getRecipientsIdResponseBody200Deleted :: Maybe GetRecipientsIdResponseBody200Deleted'
- getRecipientsIdResponseBody200Description :: Maybe Text
- getRecipientsIdResponseBody200Email :: Maybe Text
- getRecipientsIdResponseBody200Id :: Maybe Text
- getRecipientsIdResponseBody200Livemode :: Maybe Bool
- getRecipientsIdResponseBody200Metadata :: Maybe Object
- getRecipientsIdResponseBody200MigratedTo :: Maybe GetRecipientsIdResponseBody200MigratedTo'Variants
- getRecipientsIdResponseBody200Name :: Maybe Text
- getRecipientsIdResponseBody200Object :: Maybe GetRecipientsIdResponseBody200Object'
- getRecipientsIdResponseBody200RolledBackFrom :: Maybe GetRecipientsIdResponseBody200RolledBackFrom'Variants
- getRecipientsIdResponseBody200Type :: Maybe Text
- mkGetRecipientsIdResponseBody200 :: GetRecipientsIdResponseBody200
- data GetRecipientsIdResponseBody200ActiveAccount' = GetRecipientsIdResponseBody200ActiveAccount' {
- getRecipientsIdResponseBody200ActiveAccount'Account :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Account'Variants
- getRecipientsIdResponseBody200ActiveAccount'AccountHolderName :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'AccountHolderType :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods :: Maybe [GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods']
- 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 Object
- getRecipientsIdResponseBody200ActiveAccount'Object :: Maybe GetRecipientsIdResponseBody200ActiveAccount'Object'
- getRecipientsIdResponseBody200ActiveAccount'RoutingNumber :: Maybe Text
- getRecipientsIdResponseBody200ActiveAccount'Status :: Maybe Text
- mkGetRecipientsIdResponseBody200ActiveAccount' :: GetRecipientsIdResponseBody200ActiveAccount'
- data GetRecipientsIdResponseBody200ActiveAccount'Account'Variants
- data GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'
- = GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'Other Value
- | GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'Typed Text
- | GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'EnumInstant
- | GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'EnumStandard
- data GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants
- data GetRecipientsIdResponseBody200ActiveAccount'Object'
- data GetRecipientsIdResponseBody200Cards' = GetRecipientsIdResponseBody200Cards' {}
- mkGetRecipientsIdResponseBody200Cards' :: [Card] -> Bool -> Text -> GetRecipientsIdResponseBody200Cards'
- data GetRecipientsIdResponseBody200DefaultCard'Variants
- data GetRecipientsIdResponseBody200Deleted'
- data GetRecipientsIdResponseBody200MigratedTo'Variants
- data GetRecipientsIdResponseBody200Object'
- data GetRecipientsIdResponseBody200RolledBackFrom'Variants
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => GetRecipientsIdParameters | Contains all available parameters of this operation (query and path parameters) |
| -> ClientT m (Response GetRecipientsIdResponse) | Monadic computation which returns 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>
data GetRecipientsIdParameters Source #
Defines the object schema located at paths./v1/recipients/{id}.GET.parameters in the specification.
Constructors
| GetRecipientsIdParameters | |
Fields
| |
Instances
| Eq GetRecipientsIdParameters Source # | |
Defined in StripeAPI.Operations.GetRecipientsId Methods (==) :: GetRecipientsIdParameters -> GetRecipientsIdParameters -> Bool # (/=) :: GetRecipientsIdParameters -> GetRecipientsIdParameters -> Bool # | |
| Show GetRecipientsIdParameters Source # | |
Defined in StripeAPI.Operations.GetRecipientsId Methods showsPrec :: Int -> GetRecipientsIdParameters -> ShowS # show :: GetRecipientsIdParameters -> String # showList :: [GetRecipientsIdParameters] -> ShowS # | |
| ToJSON GetRecipientsIdParameters Source # | |
Defined in StripeAPI.Operations.GetRecipientsId Methods toJSON :: GetRecipientsIdParameters -> Value # toEncoding :: GetRecipientsIdParameters -> Encoding # toJSONList :: [GetRecipientsIdParameters] -> Value # | |
| FromJSON GetRecipientsIdParameters Source # | |
Defined in StripeAPI.Operations.GetRecipientsId Methods parseJSON :: Value -> Parser GetRecipientsIdParameters # parseJSONList :: Value -> Parser [GetRecipientsIdParameters] # | |
mkGetRecipientsIdParameters Source #
Arguments
| :: Text | |
| -> GetRecipientsIdParameters |
Create a new GetRecipientsIdParameters with all required fields.
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 object schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf in the specification.
Constructors
| GetRecipientsIdResponseBody200 | |
Fields
| |
Instances
mkGetRecipientsIdResponseBody200 :: GetRecipientsIdResponseBody200 Source #
Create a new GetRecipientsIdResponseBody200 with all required fields.
data GetRecipientsIdResponseBody200ActiveAccount' Source #
Defines the object schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.active_account.anyOf in the specification.
Hash describing the current account on the recipient, if there is one.
Constructors
| GetRecipientsIdResponseBody200ActiveAccount' | |
Fields
| |
mkGetRecipientsIdResponseBody200ActiveAccount' :: GetRecipientsIdResponseBody200ActiveAccount' Source #
Create a new GetRecipientsIdResponseBody200ActiveAccount' with all required fields.
data GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source #
Defines the oneOf schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.active_account.anyOf.properties.account.anyOf in the specification.
The ID of the account that the bank account is associated with.
Constructors
| GetRecipientsIdResponseBody200ActiveAccount'Account'Text Text | |
| GetRecipientsIdResponseBody200ActiveAccount'Account'Account Account |
Instances
data GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods' Source #
Defines the enum schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.active_account.anyOf.properties.available_payout_methods.items in the specification.
Constructors
| GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'EnumInstant | Represents the JSON value |
| GetRecipientsIdResponseBody200ActiveAccount'AvailablePayoutMethods'EnumStandard | Represents the JSON value |
Instances
data GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source #
Defines the oneOf schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.active_account.anyOf.properties.customer.anyOf in the specification.
The ID of the customer that the bank account is associated with.
Constructors
Instances
data GetRecipientsIdResponseBody200ActiveAccount'Object' Source #
Defines the enum schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.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
| GetRecipientsIdResponseBody200ActiveAccount'Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| GetRecipientsIdResponseBody200ActiveAccount'Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| GetRecipientsIdResponseBody200ActiveAccount'Object'EnumBankAccount | Represents the JSON value |
Instances
data GetRecipientsIdResponseBody200Cards' Source #
Defines the object schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.cards in the specification.
Constructors
| GetRecipientsIdResponseBody200Cards' | |
Fields
| |
Instances
mkGetRecipientsIdResponseBody200Cards' Source #
Arguments
| :: [Card] | |
| -> Bool | |
| -> Text | |
| -> GetRecipientsIdResponseBody200Cards' |
Create a new GetRecipientsIdResponseBody200Cards' with all required fields.
data GetRecipientsIdResponseBody200DefaultCard'Variants Source #
Defines the oneOf schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.default_card.anyOf in the specification.
The default card to use for creating transfers to this recipient.
Constructors
| GetRecipientsIdResponseBody200DefaultCard'Text Text | |
| GetRecipientsIdResponseBody200DefaultCard'Card Card |
Instances
data GetRecipientsIdResponseBody200Deleted' Source #
Defines the enum schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.deleted in the specification.
Always true for a deleted object
Constructors
| GetRecipientsIdResponseBody200Deleted'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| GetRecipientsIdResponseBody200Deleted'Typed Bool | This constructor can be used to send values to the server which are not present in the specification yet. |
| GetRecipientsIdResponseBody200Deleted'EnumTrue | Represents the JSON value |
Instances
data GetRecipientsIdResponseBody200MigratedTo'Variants Source #
Defines the oneOf schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.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
| GetRecipientsIdResponseBody200MigratedTo'Text Text | |
| GetRecipientsIdResponseBody200MigratedTo'Account Account |
Instances
data GetRecipientsIdResponseBody200Object' Source #
Defines the enum schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.object in the specification.
String representing the object's type. Objects of the same type share the same value.
Constructors
| GetRecipientsIdResponseBody200Object'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| GetRecipientsIdResponseBody200Object'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| GetRecipientsIdResponseBody200Object'EnumRecipient | Represents the JSON value |
Instances
data GetRecipientsIdResponseBody200RolledBackFrom'Variants Source #
Defines the oneOf schema located at paths./v1/recipients/{id}.GET.responses.200.content.application/json.schema.anyOf.properties.rolled_back_from.anyOf in the specification.
Constructors
| GetRecipientsIdResponseBody200RolledBackFrom'Text Text | |
| GetRecipientsIdResponseBody200RolledBackFrom'Account Account |