HORIZON HASKELLDocslts/ghc-9.10.x248f8f02026-10-05Search names, modules, packages, or :: a typeCtrl K

GHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05

Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTestHelpersTreasuryOutboundPaymentsIdReturn

Contains the different functions to run the operation postTestHelpersTreasuryOutboundPaymentsIdReturn

  • 4 types
  • 3 values
  • Packagestripeapi-3.0.0.0
  • Exports7
  • LanguageHaskell2010
  • LicenceMIT
  • SourcePostTestHelpersTreasuryOutboundPaymentsIdReturn.hs
valuepostTestHelpersTreasuryOutboundPaymentsIdReturn
  1. :: MonadHTTP m
  2. => Text

    id | Constraints: Maximum length of 5000

  3. -> Maybe PostTestHelpersTreasuryOutboundPaymentsIdReturnRequestBody

    The request body to send

  4. -> ClientT m (Response PostTestHelpersTreasuryOutboundPaymentsIdReturnResponse)

    Monadic computation which returns the result of the operation

#
POST /v1/test_helpers/treasury/outbound_payments/{id}/return

<p>Transitions a test mode created OutboundPayment to the <code>returned</code> status. The OutboundPayment must already be in the <code>processing</code> state.</p>

datadata PostTestHelpersTreasuryOutboundPaymentsIdReturnRequestBody
#

Defines the object schema located at paths./v1/test_helpers/treasury/outbound_payments/{id}/return.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostTestHelpersTreasuryOutboundPaymentsIdReturnRequestBodyReturnedDetails'
#

Defines the object schema located at paths./v1/test_helpers/treasury/outbound_payments/{id}/return.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.returned_details in the specification.

Optional hash to set the the return code.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostTestHelpersTreasuryOutboundPaymentsIdReturnRequestBodyReturnedDetails'Code'
#

Defines the enum schema located at paths./v1/test_helpers/treasury/outbound_payments/{id}/return.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.returned_details.properties.code in the specification.

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata PostTestHelpersTreasuryOutboundPaymentsIdReturnResponse
#

Represents a response of the operation postTestHelpersTreasuryOutboundPaymentsIdReturn.

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

Constructors

Instances2Eq, Show