Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTransfers

Contains the different functions to run the operation getTransfers

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetTransfers.hs

valuegetTransfers

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

GET /v1/transfers

<p>Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.</p>

datadata GetTransfersParameters

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

Constructors

GetTransfersParameters
- getTransfersParametersQueryCreated :: Maybe GetTransfersParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getTransfersParametersQueryDestination :: Maybe Text
  queryDestination: Represents the parameter named 'destination'
  Only return transfers for the destination specified by this account ID.
  Constraints:
  - Maximum length of 5000
- getTransfersParametersQueryEndingBefore :: 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
- getTransfersParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTransfersParametersQueryLimit :: 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.
- getTransfersParametersQueryStartingAfter :: 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
- getTransfersParametersQueryTransferGroup :: Maybe Text
  queryTransfer_group: Represents the parameter named 'transfer_group'
  Only return transfers with the specified transfer group.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
Show GetTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
FromJSON GetTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
ToJSON GetTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers

valuemkGetTransfersParameters :: GetTransfersParameters

Create a new GetTransfersParameters with all required fields.

datadata GetTransfersParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/transfers.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetTransfersParametersQueryCreated'OneOf1
- getTransfersParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getTransfersParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getTransfersParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getTransfersParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTransfersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
Show GetTransfersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
FromJSON GetTransfersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
ToJSON GetTransfersParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers

valuemkGetTransfersParametersQueryCreated'OneOf1 :: GetTransfersParametersQueryCreated'OneOf1

Create a new GetTransfersParametersQueryCreated'OneOf1 with all required fields.

datadata GetTransfersParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/transfers.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetTransfersParametersQueryCreated'GetTransfersParametersQueryCreated'OneOf1 GetTransfersParametersQueryCreated'OneOf1
GetTransfersParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTransfersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
Show GetTransfersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
FromJSON GetTransfersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
ToJSON GetTransfersParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers

datadata GetTransfersResponse

Represents a response of the operation getTransfers.

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

Constructors

GetTransfersResponseError String
Means either no matching case available or a parse error
GetTransfersResponse200 GetTransfersResponseBody200
Successful response.
GetTransfersResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
Show GetTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers

datadata GetTransfersResponseBody200

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

Constructors

GetTransfersResponseBody200
- getTransfersResponseBody200Data :: [Transfer]
  data: Details about each object.
- getTransfersResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTransfersResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/transfers'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
Show GetTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
FromJSON GetTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers
ToJSON GetTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTransfers

valuemkGetTransfersResponseBody200

:: [Transfer]
getTransfersResponseBody200Data
-> Bool
getTransfersResponseBody200HasMore
-> Text
getTransfersResponseBody200Url
-> GetTransfersResponseBody200

Create a new GetTransfersResponseBody200 with all required fields.