StripeAPI.Operations.GetTransfers

Contains the different functions to run the operation getTransfers

Documentation

getTransfers

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe String

created

-> Maybe String

destination: Only return transfers for the destination specified by this account ID. | Constraints: Maximum length of 5000

-> Maybe String

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

-> Maybe String

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

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

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

-> Maybe String

transfer_group: Only return transfers with the specified transfer group. | Constraints: Maximum length of 5000

-> GetTransfersRequestBody

The request body to send

-> m (Either HttpException (Response GetTransfersResponse))

Monad containing 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>

getTransfersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetTransfersRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/transfers

The same as getTransfers but returns the raw ByteString

getTransfersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetTransfersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetTransfersResponse))

GET /v1/transfers

Monadic version of getTransfers (use with runWithConfiguration)

getTransfersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetTransfersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/transfers

Monadic version of getTransfersRaw (use with runWithConfiguration)

data GetTransfersRequestBody

Defines the data type for the schema getTransfersRequestBody

Constructors

GetTransfersRequestBody

Instances

Eq GetTransfersRequestBody

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersRequestBody -> GetTransfersRequestBody -> Bool

(/=) :: GetTransfersRequestBody -> GetTransfersRequestBody -> Bool

Show GetTransfersRequestBody

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersRequestBody -> ShowS

show :: GetTransfersRequestBody -> String

showList :: [GetTransfersRequestBody] -> ShowS

ToJSON GetTransfersRequestBody

Defined in StripeAPI.Operations.GetTransfers

Methods

toJSON :: GetTransfersRequestBody -> Value

toEncoding :: GetTransfersRequestBody -> Encoding

toJSONList :: [GetTransfersRequestBody] -> Value

toEncodingList :: [GetTransfersRequestBody] -> Encoding

FromJSON GetTransfersRequestBody

Defined in StripeAPI.Operations.GetTransfers

Methods

parseJSON :: Value -> Parser GetTransfersRequestBody

parseJSONList :: Value -> Parser [GetTransfersRequestBody]

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

Instances

Eq GetTransfersResponse

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersResponse -> GetTransfersResponse -> Bool

(/=) :: GetTransfersResponse -> GetTransfersResponse -> Bool

Show GetTransfersResponse

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersResponse -> ShowS

show :: GetTransfersResponse -> String

showList :: [GetTransfersResponse] -> ShowS

data GetTransfersResponseBody200

Defines the data type for the schema GetTransfersResponseBody200

Constructors

GetTransfersResponseBody200

Fields

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

• getTransfersResponseBody200Object :: GetTransfersResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getTransfersResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/transfers'

Instances

Eq GetTransfersResponseBody200

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersResponseBody200 -> GetTransfersResponseBody200 -> Bool

(/=) :: GetTransfersResponseBody200 -> GetTransfersResponseBody200 -> Bool

Show GetTransfersResponseBody200

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersResponseBody200 -> ShowS

show :: GetTransfersResponseBody200 -> String

showList :: [GetTransfersResponseBody200] -> ShowS

ToJSON GetTransfersResponseBody200

Defined in StripeAPI.Operations.GetTransfers

Methods

toJSON :: GetTransfersResponseBody200 -> Value

toEncoding :: GetTransfersResponseBody200 -> Encoding

toJSONList :: [GetTransfersResponseBody200] -> Value

toEncodingList :: [GetTransfersResponseBody200] -> Encoding

FromJSON GetTransfersResponseBody200

Defined in StripeAPI.Operations.GetTransfers

Methods

parseJSON :: Value -> Parser GetTransfersResponseBody200

parseJSONList :: Value -> Parser [GetTransfersResponseBody200]

data GetTransfersResponseBody200Object'

Defines the enum schema GetTransfersResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetTransfersResponseBody200Object'EnumOther Value

GetTransfersResponseBody200Object'EnumTyped String

GetTransfersResponseBody200Object'EnumStringList

Instances

Eq GetTransfersResponseBody200Object'

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersResponseBody200Object' -> GetTransfersResponseBody200Object' -> Bool

(/=) :: GetTransfersResponseBody200Object' -> GetTransfersResponseBody200Object' -> Bool

Show GetTransfersResponseBody200Object'

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersResponseBody200Object' -> ShowS

show :: GetTransfersResponseBody200Object' -> String

showList :: [GetTransfersResponseBody200Object'] -> ShowS

ToJSON GetTransfersResponseBody200Object'

Defined in StripeAPI.Operations.GetTransfers

Methods

toJSON :: GetTransfersResponseBody200Object' -> Value

toEncoding :: GetTransfersResponseBody200Object' -> Encoding

toJSONList :: [GetTransfersResponseBody200Object'] -> Value

toEncodingList :: [GetTransfersResponseBody200Object'] -> Encoding

FromJSON GetTransfersResponseBody200Object'

Defined in StripeAPI.Operations.GetTransfers

Methods

parseJSON :: Value -> Parser GetTransfersResponseBody200Object'

parseJSONList :: Value -> Parser [GetTransfersResponseBody200Object']