Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetFinancialConnectionsAccounts

Contains the different functions to run the operation getFinancialConnectionsAccounts

4 types
4 values

Packagestripeapi-3.0.0.0
Exports8
LanguageHaskell2010
LicenceMIT
SourceGetFinancialConnectionsAccounts.hs

valuegetFinancialConnectionsAccounts

:: MonadHTTP m
=> GetFinancialConnectionsAccountsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetFinancialConnectionsAccountsResponse)
Monadic computation which returns the result of the operation

GET /v1/financial_connections/accounts

<p>Returns a list of Financial Connections <code>Account</code> objects.</p>

datadata GetFinancialConnectionsAccountsParameters

Defines the object schema located at paths./v1/financial_connections/accounts.GET.parameters in the specification.

Constructors

GetFinancialConnectionsAccountsParameters
- getFinancialConnectionsAccountsParametersQueryAccountHolder :: Maybe GetFinancialConnectionsAccountsParametersQueryAccountHolder'
  queryAccount_holder: Represents the parameter named 'account_holder'
  If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.
- getFinancialConnectionsAccountsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named 'ending_before'
  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  Constraints:
  - Maximum length of 5000
- getFinancialConnectionsAccountsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getFinancialConnectionsAccountsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getFinancialConnectionsAccountsParametersQuerySession :: Maybe Text
  querySession: Represents the parameter named 'session'
  If present, only return accounts that were collected as part of the given session.
  Constraints:
  - Maximum length of 5000
- getFinancialConnectionsAccountsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named 'starting_after'
  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFinancialConnectionsAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
Show GetFinancialConnectionsAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
FromJSON GetFinancialConnectionsAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
ToJSON GetFinancialConnectionsAccountsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts

valuemkGetFinancialConnectionsAccountsParameters :: GetFinancialConnectionsAccountsParameters

Create a new GetFinancialConnectionsAccountsParameters with all required fields.

datadata GetFinancialConnectionsAccountsParametersQueryAccountHolder'

Defines the object schema located at paths./v1/financial_connections/accounts.GET.parameters.properties.queryAccount_holder in the specification.

Represents the parameter named 'account_holder'

If present, only return accounts that belong to the specified account holder. `account_holder[customer]` and `account_holder[account]` are mutually exclusive.

Constructors

GetFinancialConnectionsAccountsParametersQueryAccountHolder'
- getFinancialConnectionsAccountsParametersQueryAccountHolder'Account :: Maybe Text
  account
  Constraints:
  - Maximum length of 5000
- getFinancialConnectionsAccountsParametersQueryAccountHolder'Customer :: Maybe Text
  customer
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFinancialConnectionsAccountsParametersQueryAccountHolder'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
Show GetFinancialConnectionsAccountsParametersQueryAccountHolder'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
FromJSON GetFinancialConnectionsAccountsParametersQueryAccountHolder'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
ToJSON GetFinancialConnectionsAccountsParametersQueryAccountHolder'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts

value

mkGetFinancialConnectionsAccountsParametersQueryAccountHolder' :: GetFinancialConnectionsAccountsParametersQueryAccountHolder'

Create a new GetFinancialConnectionsAccountsParametersQueryAccountHolder' with all required fields.

datadata GetFinancialConnectionsAccountsResponse

Represents a response of the operation getFinancialConnectionsAccounts.

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), GetFinancialConnectionsAccountsResponseError is used.

Constructors

GetFinancialConnectionsAccountsResponseError String
Means either no matching case available or a parse error
GetFinancialConnectionsAccountsResponse200 GetFinancialConnectionsAccountsResponseBody200
Successful response.
GetFinancialConnectionsAccountsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetFinancialConnectionsAccountsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
Show GetFinancialConnectionsAccountsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts

datadata GetFinancialConnectionsAccountsResponseBody200

Defines the object schema located at paths./v1/financial_connections/accounts.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetFinancialConnectionsAccountsResponseBody200
- getFinancialConnectionsAccountsResponseBody200Data :: [FinancialConnections'account]
  data: Details about each object.
- getFinancialConnectionsAccountsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getFinancialConnectionsAccountsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/financial_connections/accounts'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetFinancialConnectionsAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
Show GetFinancialConnectionsAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
FromJSON GetFinancialConnectionsAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts
ToJSON GetFinancialConnectionsAccountsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetFinancialConnectionsAccounts

valuemkGetFinancialConnectionsAccountsResponseBody200

:: [FinancialConnections'account]
getFinancialConnectionsAccountsResponseBody200Data
-> Bool
getFinancialConnectionsAccountsResponseBody200HasMore
-> Text
getFinancialConnectionsAccountsResponseBody200Url
-> GetFinancialConnectionsAccountsResponseBody200

Create a new GetFinancialConnectionsAccountsResponseBody200 with all required fields.