Packages

tiger_stripe

0.1.2
0.4.0 0.3.0 0.2.0 0.1.11 0.1.10 0.1.9 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

HexDocs

Current section

Files

Jump to
Readme
15 Versions
4 Dependencies
Dependants
Files
Activity
tiger_stripe lib stripe services confirmation_token_service.ex
Raw

lib/stripe/services/confirmation_token_service.ex 

# File generated from our OpenAPI spec

defmodule Stripe.Services.ConfirmationTokenService do

  @moduledoc """

  ConfirmationTokensResourceConfirmationToken



  ConfirmationTokens help transport client side data collected by Stripe JS over

  to your server for confirming a PaymentIntent or SetupIntent. If the confirmation

  is successful, values present on the ConfirmationToken are written onto the Intent.



  To learn more about how to use ConfirmationToken, visit the related guides:

  - [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server)

  - [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation).

  """

  alias Stripe.Client



  @doc """

  Retrieve a ConfirmationToken



  Retrieves an existing ConfirmationToken object

  """

  @spec retrieve(Client.t(), String.t(), map(), keyword()) ::

          {:ok, term()} | {:error, Stripe.Error.t()}

  def retrieve(client, confirmation_token, params \\ %{}, opts \\ []) do

    Client.request(

      client,

      :get,

      "/v1/confirmation_tokens/#{confirmation_token}",

      Keyword.merge(opts, params: params)

    )

  end

end