StripeAPI.Types.SourceRedirectFlow

Contains the types generated from the schema SourceRedirectFlow

Documentation

data SourceRedirectFlow

Defines the object schema located at components.schemas.source_redirect_flow in the specification.

Constructors

SourceRedirectFlow

Fields

• sourceRedirectFlowFailureReason :: Maybe Text

  failure_reason: The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`.

  Constraints:

  • Maximum length of 5000
• sourceRedirectFlowReturnUrl :: Text

  return_url: The URL you provide to redirect the customer to after they authenticated their payment.

  Constraints:

  • Maximum length of 5000
• sourceRedirectFlowStatus :: Text

  status: The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused).

  Constraints:

  • Maximum length of 5000
• sourceRedirectFlowUrl :: Text

  url: The URL provided to you to redirect a customer to as part of a `redirect` authentication flow.

  Constraints:

  • Maximum length of 2048

Instances

Eq SourceRedirectFlow

Defined in StripeAPI.Types.SourceRedirectFlow

Methods

(==) :: SourceRedirectFlow -> SourceRedirectFlow -> Bool

(/=) :: SourceRedirectFlow -> SourceRedirectFlow -> Bool

Show SourceRedirectFlow

Defined in StripeAPI.Types.SourceRedirectFlow

Methods

showsPrec :: Int -> SourceRedirectFlow -> ShowS

show :: SourceRedirectFlow -> String

showList :: [SourceRedirectFlow] -> ShowS

ToJSON SourceRedirectFlow

Defined in StripeAPI.Types.SourceRedirectFlow

Methods

toJSON :: SourceRedirectFlow -> Value

toEncoding :: SourceRedirectFlow -> Encoding

toJSONList :: [SourceRedirectFlow] -> Value

toEncodingList :: [SourceRedirectFlow] -> Encoding

FromJSON SourceRedirectFlow

Defined in StripeAPI.Types.SourceRedirectFlow

Methods

parseJSON :: Value -> Parser SourceRedirectFlow

parseJSONList :: Value -> Parser [SourceRedirectFlow]

mkSourceRedirectFlow

Arguments

:: Text

sourceRedirectFlowReturnUrl

-> Text

sourceRedirectFlowStatus

-> Text

sourceRedirectFlowUrl

-> SourceRedirectFlow

Create a new SourceRedirectFlow with all required fields.