Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.PostTerminalConnectionTokens

Contains the different functions to run the operation postTerminalConnectionTokens

Synopsis

value postTerminalConnectionTokens
data PostTerminalConnectionTokensRequestBody
value mkPostTerminalConnectionTokensRequestBody
data PostTerminalConnectionTokensResponse

Packagestripeapi-3.0.0.0
Exports4
LanguageHaskell2010
LicenceMIT
SourcePostTerminalConnectionTokens.hs

valuepostTerminalConnectionTokens

:: MonadHTTP m
=> Maybe PostTerminalConnectionTokensRequestBody
The request body to send
-> ClientT m (Response PostTerminalConnectionTokensResponse)
Monadic computation which returns the result of the operation

POST /v1/terminal/connection_tokens

<p>To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.</p>

datadata PostTerminalConnectionTokensRequestBody

Source#

Defines the object schema located at paths./v1/terminal/connection_tokens.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.

Constructors

PostTerminalConnectionTokensRequestBody
- postTerminalConnectionTokensRequestBodyExpand :: Maybe [Text]
  expand: Specifies which fields in the response should be expanded.
- postTerminalConnectionTokensRequestBodyLocation :: Maybe Text
  location: The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq PostTerminalConnectionTokensRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTerminalConnectionTokens
Show PostTerminalConnectionTokensRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTerminalConnectionTokens
FromJSON PostTerminalConnectionTokensRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTerminalConnectionTokens
ToJSON PostTerminalConnectionTokensRequestBodyDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTerminalConnectionTokens

valuemkPostTerminalConnectionTokensRequestBody :: PostTerminalConnectionTokensRequestBody

Source#

Create a new PostTerminalConnectionTokensRequestBody with all required fields.

datadata PostTerminalConnectionTokensResponse

Source#

Represents a response of the operation postTerminalConnectionTokens.

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

Constructors

PostTerminalConnectionTokensResponseError String
Means either no matching case available or a parse error
PostTerminalConnectionTokensResponse200 Terminal'connectionToken
Successful response.
PostTerminalConnectionTokensResponseDefault Error
Error response.

Instances2Eq, Show

Eq PostTerminalConnectionTokensResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTerminalConnectionTokens
Show PostTerminalConnectionTokensResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.PostTerminalConnectionTokens