| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostIdentityVerificationSessionsSessionCancel
Description
Contains the different functions to run the operation postIdentityVerificationSessionsSessionCancel
Synopsis
- postIdentityVerificationSessionsSessionCancel :: forall m. MonadHTTP m => Text -> Maybe PostIdentityVerificationSessionsSessionCancelRequestBody -> ClientT m (Response PostIdentityVerificationSessionsSessionCancelResponse)
- data PostIdentityVerificationSessionsSessionCancelRequestBody = PostIdentityVerificationSessionsSessionCancelRequestBody {}
- mkPostIdentityVerificationSessionsSessionCancelRequestBody :: PostIdentityVerificationSessionsSessionCancelRequestBody
- data PostIdentityVerificationSessionsSessionCancelResponse
Documentation
postIdentityVerificationSessionsSessionCancel Source #
Arguments
| :: forall m. MonadHTTP m | |
| => Text | session | Constraints: Maximum length of 5000 |
| -> Maybe PostIdentityVerificationSessionsSessionCancelRequestBody | The request body to send |
| -> ClientT m (Response PostIdentityVerificationSessionsSessionCancelResponse) | Monadic computation which returns the result of the operation |
POST /v1/identity/verification_sessions/{session}/cancel<p>A VerificationSession object can be canceled when it is in <code>requires_input</code> <a href="/docs/identity/how-sessions-work">status</a>.</p>
<p>Once canceled, future submission attempts are disabled. This cannot be undone. <a href="/docs/identity/verification-sessions#cancel">Learn more</a>.</p>
data PostIdentityVerificationSessionsSessionCancelRequestBody Source #
Defines the object schema located at paths./v1/identity/verification_sessions/{session}/cancel.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostIdentityVerificationSessionsSessionCancelRequestBody | |
Fields
| |
Instances
mkPostIdentityVerificationSessionsSessionCancelRequestBody :: PostIdentityVerificationSessionsSessionCancelRequestBody Source #
Create a new PostIdentityVerificationSessionsSessionCancelRequestBody with all required fields.
data PostIdentityVerificationSessionsSessionCancelResponse Source #
Represents a response of the operation postIdentityVerificationSessionsSessionCancel.
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), PostIdentityVerificationSessionsSessionCancelResponseError is used.
Constructors
| PostIdentityVerificationSessionsSessionCancelResponseError String | Means either no matching case available or a parse error |
| PostIdentityVerificationSessionsSessionCancelResponse200 Identity'verificationSession | Successful response. |
| PostIdentityVerificationSessionsSessionCancelResponseDefault Error | Error response. |