Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetBitcoinReceivers

Contains the different functions to run the operation getBitcoinReceivers

3 types
3 values

Packagestripeapi-3.0.0.0
Exports6
LanguageHaskell2010
LicenceMIT
SourceGetBitcoinReceivers.hs

valuegetBitcoinReceivers

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

GET /v1/bitcoin/receivers

<p>Returns a list of your receivers. Receivers are returned sorted by creation date, with the most recently created receivers appearing first.</p>

datadata GetBitcoinReceiversParameters

Defines the object schema located at paths./v1/bitcoin/receivers.GET.parameters in the specification.

Constructors

GetBitcoinReceiversParameters
- getBitcoinReceiversParametersQueryActive :: Maybe Bool
  queryActive: Represents the parameter named 'active'
  Filter for active receivers.
- getBitcoinReceiversParametersQueryEndingBefore :: 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
- getBitcoinReceiversParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getBitcoinReceiversParametersQueryFilled :: Maybe Bool
  queryFilled: Represents the parameter named 'filled'
  Filter for filled receivers.
- getBitcoinReceiversParametersQueryLimit :: 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.
- getBitcoinReceiversParametersQueryStartingAfter :: 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
- getBitcoinReceiversParametersQueryUncapturedFunds :: Maybe Bool
  queryUncaptured_funds: Represents the parameter named 'uncaptured_funds'
  Filter for receivers with uncaptured funds.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetBitcoinReceiversParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
Show GetBitcoinReceiversParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
FromJSON GetBitcoinReceiversParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
ToJSON GetBitcoinReceiversParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers

valuemkGetBitcoinReceiversParameters :: GetBitcoinReceiversParameters

Create a new GetBitcoinReceiversParameters with all required fields.

datadata GetBitcoinReceiversResponse

Represents a response of the operation getBitcoinReceivers.

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

Constructors

GetBitcoinReceiversResponseError String
Means either no matching case available or a parse error
GetBitcoinReceiversResponse200 GetBitcoinReceiversResponseBody200
Successful response.
GetBitcoinReceiversResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetBitcoinReceiversResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
Show GetBitcoinReceiversResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers

datadata GetBitcoinReceiversResponseBody200

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

Constructors

GetBitcoinReceiversResponseBody200
- getBitcoinReceiversResponseBody200Data :: [BitcoinReceiver]
  data
- getBitcoinReceiversResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getBitcoinReceiversResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/bitcoin/receivers'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetBitcoinReceiversResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
Show GetBitcoinReceiversResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
FromJSON GetBitcoinReceiversResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers
ToJSON GetBitcoinReceiversResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetBitcoinReceivers

valuemkGetBitcoinReceiversResponseBody200

:: [BitcoinReceiver]
getBitcoinReceiversResponseBody200Data
-> Bool
getBitcoinReceiversResponseBody200HasMore
-> Text
getBitcoinReceiversResponseBody200Url
-> GetBitcoinReceiversResponseBody200

Create a new GetBitcoinReceiversResponseBody200 with all required fields.