Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryOutboundPayments

Contains the different functions to run the operation getTreasuryOutboundPayments

4 types
3 values

Packagestripeapi-3.0.0.0
Exports7
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryOutboundPayments.hs

valuegetTreasuryOutboundPayments

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

GET /v1/treasury/outbound_payments

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

datadata GetTreasuryOutboundPaymentsParameters

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

Constructors

GetTreasuryOutboundPaymentsParameters
- getTreasuryOutboundPaymentsParametersQueryCustomer :: Maybe Text
  queryCustomer: Represents the parameter named 'customer'
  Only return OutboundPayments sent to this customer.
  Constraints:
  - Maximum length of 5000
- getTreasuryOutboundPaymentsParametersQueryEndingBefore :: 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
- getTreasuryOutboundPaymentsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryOutboundPaymentsParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  Returns objects associated with this FinancialAccount.
- getTreasuryOutboundPaymentsParametersQueryLimit :: 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.
- getTreasuryOutboundPaymentsParametersQueryStartingAfter :: 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
- getTreasuryOutboundPaymentsParametersQueryStatus :: Maybe GetTreasuryOutboundPaymentsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return OutboundPayments that have the given status: `processing`, `failed`, `posted`, `returned`, or `canceled`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryOutboundPaymentsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
Show GetTreasuryOutboundPaymentsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
FromJSON GetTreasuryOutboundPaymentsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
ToJSON GetTreasuryOutboundPaymentsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments

valuemkGetTreasuryOutboundPaymentsParameters

:: Text
getTreasuryOutboundPaymentsParametersQueryFinancialAccount
-> GetTreasuryOutboundPaymentsParameters

Create a new GetTreasuryOutboundPaymentsParameters with all required fields.

datadata GetTreasuryOutboundPaymentsParametersQueryStatus'

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

Represents the parameter named 'status'

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

Constructors

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryOutboundPaymentsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
Show GetTreasuryOutboundPaymentsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
FromJSON GetTreasuryOutboundPaymentsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
ToJSON GetTreasuryOutboundPaymentsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments

datadata GetTreasuryOutboundPaymentsResponse

Represents a response of the operation getTreasuryOutboundPayments.

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

Constructors

GetTreasuryOutboundPaymentsResponseError String
Means either no matching case available or a parse error
GetTreasuryOutboundPaymentsResponse200 GetTreasuryOutboundPaymentsResponseBody200
Successful response.
GetTreasuryOutboundPaymentsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryOutboundPaymentsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
Show GetTreasuryOutboundPaymentsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments

datadata GetTreasuryOutboundPaymentsResponseBody200

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

Constructors

GetTreasuryOutboundPaymentsResponseBody200
- getTreasuryOutboundPaymentsResponseBody200Data :: [Treasury'outboundPayment]
  data: Details about each object.
- getTreasuryOutboundPaymentsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryOutboundPaymentsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/treasury/outbound_payments'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryOutboundPaymentsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
Show GetTreasuryOutboundPaymentsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
FromJSON GetTreasuryOutboundPaymentsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments
ToJSON GetTreasuryOutboundPaymentsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryOutboundPayments

valuemkGetTreasuryOutboundPaymentsResponseBody200

:: [Treasury'outboundPayment]
getTreasuryOutboundPaymentsResponseBody200Data
-> Bool
getTreasuryOutboundPaymentsResponseBody200HasMore
-> Text
getTreasuryOutboundPaymentsResponseBody200Url
-> GetTreasuryOutboundPaymentsResponseBody200

Create a new GetTreasuryOutboundPaymentsResponseBody200 with all required fields.