Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryOutboundTransfers

Contains the different functions to run the operation getTreasuryOutboundTransfers

4 types
3 values

Packagestripeapi-3.0.0.0
Exports7
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryOutboundTransfers.hs

valuegetTreasuryOutboundTransfers

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

GET /v1/treasury/outbound_transfers

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

datadata GetTreasuryOutboundTransfersParameters

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

Constructors

GetTreasuryOutboundTransfersParameters
- getTreasuryOutboundTransfersParametersQueryEndingBefore :: 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
- getTreasuryOutboundTransfersParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryOutboundTransfersParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  Returns objects associated with this FinancialAccount.
- getTreasuryOutboundTransfersParametersQueryLimit :: 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.
- getTreasuryOutboundTransfersParametersQueryStartingAfter :: 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
- getTreasuryOutboundTransfersParametersQueryStatus :: Maybe GetTreasuryOutboundTransfersParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryOutboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
Show GetTreasuryOutboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
FromJSON GetTreasuryOutboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
ToJSON GetTreasuryOutboundTransfersParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers

valuemkGetTreasuryOutboundTransfersParameters

:: Text
getTreasuryOutboundTransfersParametersQueryFinancialAccount
-> GetTreasuryOutboundTransfersParameters

Create a new GetTreasuryOutboundTransfersParameters with all required fields.

datadata GetTreasuryOutboundTransfersParametersQueryStatus'

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

Represents the parameter named 'status'

Only return OutboundTransfers that have the given status: `processing`, `canceled`, `failed`, `posted`, or `returned`.

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryOutboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
Show GetTreasuryOutboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
FromJSON GetTreasuryOutboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
ToJSON GetTreasuryOutboundTransfersParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers

datadata GetTreasuryOutboundTransfersResponse

Represents a response of the operation getTreasuryOutboundTransfers.

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

Constructors

GetTreasuryOutboundTransfersResponseError String
Means either no matching case available or a parse error
GetTreasuryOutboundTransfersResponse200 GetTreasuryOutboundTransfersResponseBody200
Successful response.
GetTreasuryOutboundTransfersResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryOutboundTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
Show GetTreasuryOutboundTransfersResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers

datadata GetTreasuryOutboundTransfersResponseBody200

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

Constructors

GetTreasuryOutboundTransfersResponseBody200
- getTreasuryOutboundTransfersResponseBody200Data :: [Treasury'outboundTransfer]
  data: Details about each object.
- getTreasuryOutboundTransfersResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryOutboundTransfersResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryOutboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
Show GetTreasuryOutboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
FromJSON GetTreasuryOutboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers
ToJSON GetTreasuryOutboundTransfersResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundTransfers

valuemkGetTreasuryOutboundTransfersResponseBody200

:: [Treasury'outboundTransfer]
getTreasuryOutboundTransfersResponseBody200Data
-> Bool
getTreasuryOutboundTransfersResponseBody200HasMore
-> Text
getTreasuryOutboundTransfersResponseBody200Url
-> GetTreasuryOutboundTransfersResponseBody200

Create a new GetTreasuryOutboundTransfersResponseBody200 with all required fields.