stripeapi-2.0.0.1: Stripe-Library
Safe HaskellNone
LanguageHaskell2010

StripeAPI.Operations.GetTransfers

Description

Contains the different functions to run the operation getTransfers

Synopsis

Documentation

getTransfers Source #

Arguments

:: forall m. 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>

data GetTransfersParameters Source #

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

Constructors

GetTransfersParameters 

Fields

  • 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

data GetTransfersParametersQueryCreated'OneOf1 Source #

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

data GetTransfersParametersQueryCreated'Variants Source #

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

Represents the parameter named 'created'

data GetTransfersResponse Source #

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.

data GetTransfersResponseBody200 Source #

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

Constructors

GetTransfersResponseBody200 

Fields