Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryInboundTransfers

Contains the different functions to run the operation getTreasuryInboundTransfers

4 types
3 values

Packagestripeapi-3.0.0.0
Exports7
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryInboundTransfers.hs

valuegetTreasuryInboundTransfers

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

GET /v1/treasury/inbound_transfers

<p>Returns a list of InboundTransfers sent from the specified FinancialAccount.</p>

datadata GetTreasuryInboundTransfersParameters

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

Constructors

GetTreasuryInboundTransfersParameters
- getTreasuryInboundTransfersParametersQueryEndingBefore :: 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
- getTreasuryInboundTransfersParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryInboundTransfersParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  Returns objects associated with this FinancialAccount.
- getTreasuryInboundTransfersParametersQueryLimit :: 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.
- getTreasuryInboundTransfersParametersQueryStartingAfter :: 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
- getTreasuryInboundTransfersParametersQueryStatus :: Maybe GetTreasuryInboundTransfersParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryInboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
Show GetTreasuryInboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
FromJSON GetTreasuryInboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
ToJSON GetTreasuryInboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers

valuemkGetTreasuryInboundTransfersParameters

:: Text
getTreasuryInboundTransfersParametersQueryFinancialAccount
-> GetTreasuryInboundTransfersParameters

Create a new GetTreasuryInboundTransfersParameters with all required fields.

datadata GetTreasuryInboundTransfersParametersQueryStatus'

Defines the enum schema located at paths./v1/treasury/inbound_transfers.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

Only return InboundTransfers that have the given status: `processing`, `succeeded`, `failed` or `canceled`.

Constructors

GetTreasuryInboundTransfersParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryInboundTransfersParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryInboundTransfersParametersQueryStatus'EnumCanceled
Represents the JSON value "canceled"
GetTreasuryInboundTransfersParametersQueryStatus'EnumFailed
Represents the JSON value "failed"
GetTreasuryInboundTransfersParametersQueryStatus'EnumProcessing
Represents the JSON value "processing"
GetTreasuryInboundTransfersParametersQueryStatus'EnumSucceeded
Represents the JSON value "succeeded"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryInboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
Show GetTreasuryInboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
FromJSON GetTreasuryInboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
ToJSON GetTreasuryInboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers

datadata GetTreasuryInboundTransfersResponse

Represents a response of the operation getTreasuryInboundTransfers.

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

Constructors

GetTreasuryInboundTransfersResponseError String
Means either no matching case available or a parse error
GetTreasuryInboundTransfersResponse200 GetTreasuryInboundTransfersResponseBody200
Successful response.
GetTreasuryInboundTransfersResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryInboundTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
Show GetTreasuryInboundTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers

datadata GetTreasuryInboundTransfersResponseBody200

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

Constructors

GetTreasuryInboundTransfersResponseBody200
- getTreasuryInboundTransfersResponseBody200Data :: [Treasury'inboundTransfer]
  data: Details about each object.
- getTreasuryInboundTransfersResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryInboundTransfersResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryInboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
Show GetTreasuryInboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
FromJSON GetTreasuryInboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers
ToJSON GetTreasuryInboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryInboundTransfers

valuemkGetTreasuryInboundTransfersResponseBody200

:: [Treasury'inboundTransfer]
getTreasuryInboundTransfersResponseBody200Data
-> Bool
getTreasuryInboundTransfersResponseBody200HasMore
-> Text
getTreasuryInboundTransfersResponseBody200Url
-> GetTreasuryInboundTransfersResponseBody200

Create a new GetTreasuryInboundTransfersResponseBody200 with all required fields.