stripeapi-0.1.0.0: Stripe-Library

Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetRecipientsId

Description

Contains the different functions to run the operation getRecipientsId

Synopsis

Documentation

getRecipientsId Source #

Arguments

:: (MonadHTTP m, SecurityScheme s) 
=> Configuration s

The configuration to use in the request

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> String

id | Constraints: Maximum length of 5000

-> 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 String -> String -> GetRecipientsIdRequestBody -> m (Either HttpException (Response ByteString)) Source #

GET /v1/recipients/{id}

The same as getRecipientsId but returns the raw ByteString

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.

data GetRecipientsIdResponseBody200 Source #

Defines the data type for the schema GetRecipientsIdResponseBody200

Constructors

GetRecipientsIdResponseBody200 

Fields

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.

Instances
Eq GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Generic GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200ActiveAccount'Account'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200ActiveAccount'Account'Variants = D1 (MetaData "GetRecipientsIdResponseBody200ActiveAccount'Account'Variants" "StripeAPI.Operations.GetRecipientsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "GetRecipientsIdResponseBody200ActiveAccount'Account'Account" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Account)) :+: C1 (MetaCons "GetRecipientsIdResponseBody200ActiveAccount'Account'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

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.

Instances
Eq GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Generic GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants = D1 (MetaData "GetRecipientsIdResponseBody200ActiveAccount'Customer'Variants" "StripeAPI.Operations.GetRecipientsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "GetRecipientsIdResponseBody200ActiveAccount'Customer'Customer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Customer)) :+: (C1 (MetaCons "GetRecipientsIdResponseBody200ActiveAccount'Customer'DeletedCustomer" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 DeletedCustomer)) :+: C1 (MetaCons "GetRecipientsIdResponseBody200ActiveAccount'Customer'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))

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
Eq GetRecipientsIdResponseBody200ActiveAccount'Metadata' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200ActiveAccount'Metadata' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200ActiveAccount'Metadata' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200ActiveAccount'Metadata' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

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.

Instances
Eq GetRecipientsIdResponseBody200ActiveAccount'Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200ActiveAccount'Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200ActiveAccount'Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200ActiveAccount'Object' Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

data GetRecipientsIdResponseBody200Cards' Source #

Defines the data type for the schema GetRecipientsIdResponseBody200Cards'

Constructors

GetRecipientsIdResponseBody200Cards' 

Fields

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

data GetRecipientsIdResponseBody200DefaultCard'Variants Source #

Define the one-of schema GetRecipientsIdResponseBody200Default_card'

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

Instances
Eq GetRecipientsIdResponseBody200DefaultCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200DefaultCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Generic GetRecipientsIdResponseBody200DefaultCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200DefaultCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200DefaultCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200DefaultCard'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200DefaultCard'Variants = D1 (MetaData "GetRecipientsIdResponseBody200DefaultCard'Variants" "StripeAPI.Operations.GetRecipientsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "GetRecipientsIdResponseBody200DefaultCard'Card" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Card)) :+: C1 (MetaCons "GetRecipientsIdResponseBody200DefaultCard'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

data GetRecipientsIdResponseBody200Deleted' Source #

Defines the enum schema GetRecipientsIdResponseBody200Deleted'

Always true for a deleted object

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.

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.

Instances
Eq GetRecipientsIdResponseBody200MigratedTo'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200MigratedTo'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Generic GetRecipientsIdResponseBody200MigratedTo'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200MigratedTo'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200MigratedTo'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200MigratedTo'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200MigratedTo'Variants = D1 (MetaData "GetRecipientsIdResponseBody200MigratedTo'Variants" "StripeAPI.Operations.GetRecipientsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "GetRecipientsIdResponseBody200MigratedTo'Account" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Account)) :+: C1 (MetaCons "GetRecipientsIdResponseBody200MigratedTo'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

data GetRecipientsIdResponseBody200Object' Source #

Defines the enum schema GetRecipientsIdResponseBody200Object'

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

data GetRecipientsIdResponseBody200RolledBackFrom'Variants Source #

Define the one-of schema GetRecipientsIdResponseBody200Rolled_back_from'

Instances
Eq GetRecipientsIdResponseBody200RolledBackFrom'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Show GetRecipientsIdResponseBody200RolledBackFrom'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

Generic GetRecipientsIdResponseBody200RolledBackFrom'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

ToJSON GetRecipientsIdResponseBody200RolledBackFrom'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

FromJSON GetRecipientsIdResponseBody200RolledBackFrom'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200RolledBackFrom'Variants Source # 
Instance details

Defined in StripeAPI.Operations.GetRecipientsId

type Rep GetRecipientsIdResponseBody200RolledBackFrom'Variants = D1 (MetaData "GetRecipientsIdResponseBody200RolledBackFrom'Variants" "StripeAPI.Operations.GetRecipientsId" "stripeapi-0.1.0.0-A3hJyYFbMZN6w4qjBpK6b6" False) (C1 (MetaCons "GetRecipientsIdResponseBody200RolledBackFrom'Account" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Account)) :+: C1 (MetaCons "GetRecipientsIdResponseBody200RolledBackFrom'String" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))