Striped v0.5.0

View Source Stripe.Terminal.ConnectionToken (Striped v0.5.0) (generated)

A Connection Token is used by the Stripe Terminal SDK to connect to a reader.

Related guide: Fleet Management.

Link to this section Summary

Types

t()

The terminal.connection_token type.

Functions

create(client, params \\ %{}, opts \\ [])

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.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Stripe.Terminal.ConnectionToken{
  location: binary(),
  object: binary(),
  secret: binary()
}

The terminal.connection_token type.

  • location The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see the docs on scoping connection tokens.
  • object String representing the object's type. Objects of the same type share the same value.
  • secret Your application should pass this token to the Stripe Terminal SDK.

Link to this section Functions

Link to this function

create(client, params \\ %{}, opts \\ [])

View Source 
@spec create(
  client :: Stripe.t(),
  params :: %{optional(:expand) => [binary()], optional(:location) => binary()},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

Details

  • Method: post
  • Path: /v1/terminal/connection_tokens