StripeAPI.Operations.GetTransfers

Contains the different functions to run the operation getTransfers

Documentation

getTransfers

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

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

Instances

Eq GetTransfersParameters

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersParameters -> GetTransfersParameters -> Bool

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

Show GetTransfersParameters

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersParameters -> ShowS

show :: GetTransfersParameters -> String

showList :: [GetTransfersParameters] -> ShowS

ToJSON GetTransfersParameters

Defined in StripeAPI.Operations.GetTransfers

Methods

toJSON :: GetTransfersParameters -> Value

toEncoding :: GetTransfersParameters -> Encoding

toJSONList :: [GetTransfersParameters] -> Value

toEncodingList :: [GetTransfersParameters] -> Encoding

FromJSON GetTransfersParameters

Defined in StripeAPI.Operations.GetTransfers

Methods

parseJSON :: Value -> Parser GetTransfersParameters

parseJSONList :: Value -> Parser [GetTransfersParameters]

mkGetTransfersParameters :: GetTransfersParameters

Create a new GetTransfersParameters with all required fields.

data GetTransfersParametersQueryCreated'OneOf1

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

Constructors

GetTransfersParametersQueryCreated'OneOf1

Fields

• getTransfersParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getTransfersParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getTransfersParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getTransfersParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetTransfersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersParametersQueryCreated'OneOf1 -> GetTransfersParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetTransfersParametersQueryCreated'OneOf1 -> GetTransfersParametersQueryCreated'OneOf1 -> Bool

Show GetTransfersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersParametersQueryCreated'OneOf1 -> ShowS

show :: GetTransfersParametersQueryCreated'OneOf1 -> String

showList :: [GetTransfersParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetTransfersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTransfers

Methods

toJSON :: GetTransfersParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetTransfersParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetTransfersParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetTransfersParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetTransfersParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetTransfers

Methods

parseJSON :: Value -> Parser GetTransfersParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetTransfersParametersQueryCreated'OneOf1]

mkGetTransfersParametersQueryCreated'OneOf1 :: GetTransfersParametersQueryCreated'OneOf1

Create a new GetTransfersParametersQueryCreated'OneOf1 with all required fields.

data 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

Instances

Eq GetTransfersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTransfers

Methods

(==) :: GetTransfersParametersQueryCreated'Variants -> GetTransfersParametersQueryCreated'Variants -> Bool

(/=) :: GetTransfersParametersQueryCreated'Variants -> GetTransfersParametersQueryCreated'Variants -> Bool

Show GetTransfersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTransfers

Methods

showsPrec :: Int -> GetTransfersParametersQueryCreated'Variants -> ShowS

show :: GetTransfersParametersQueryCreated'Variants -> String

showList :: [GetTransfersParametersQueryCreated'Variants] -> ShowS

ToJSON GetTransfersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTransfers

Methods

toJSON :: GetTransfersParametersQueryCreated'Variants -> Value

toEncoding :: GetTransfersParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetTransfersParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetTransfersParametersQueryCreated'Variants] -> Encoding

FromJSON GetTransfersParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetTransfers

Methods

parseJSON :: Value -> Parser GetTransfersParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetTransfersParametersQueryCreated'Variants]

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 object schema located at paths./v1/transfers.GET.responses.200.content.application/json.schema in the specification.

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.

• getTransfersResponseBody200Url :: Text

  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]

mkGetTransfersResponseBody200

Arguments

:: [Transfer]

getTransfersResponseBody200Data

-> Bool

getTransfersResponseBody200HasMore

-> Text

getTransfersResponseBody200Url

-> GetTransfersResponseBody200

Create a new GetTransfersResponseBody200 with all required fields.