View Source ExOAPI.Stripe.SDK.SetupIntents (exoapi_stripe v0.1.1)
Link to this section Summary
Functions
description: <p>Returns a list of SetupIntents.</p>
description: <p>Retrieves the details of a SetupIntent that has previously been created. </p>
description: <p>Creates a SetupIntent object.</p>
description: <p>Updates a SetupIntent object.</p>
description: <p>A SetupIntent object can be canceled when it is in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>
description: <p>Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.</p>
description: <p>Verifies microdeposits on a SetupIntent object.</p>
Link to this section Types
Link to this section Functions
@spec get_setup_intents(client :: ExOAPI.Client.t(), [get_setup_intents_opts()]) :: {:ok, any()} | {:error, any()}
description: <p>Returns a list of SetupIntents.</p>
@spec get_setup_intents_intent( client :: ExOAPI.Client.t(), intent :: String.t(), [get_setup_intents_intent_opts()] ) :: {:ok, any()} | {:error, any()}
description: <p>Retrieves the details of a SetupIntent that has previously been created. </p>
Client-side retrieval using a publishable key is allowed when the client_secret
is provided in the query string.
When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the SetupIntent object reference for more details.
@spec post_setup_intents(client :: ExOAPI.Client.t(), body :: map()) :: {:ok, any()} | {:error, any()}
description: <p>Creates a SetupIntent object.</p>
After the SetupIntent is created, attach a payment method and confirmto collect any required permissions to charge the payment method later.
@spec post_setup_intents_intent( client :: ExOAPI.Client.t(), body :: map(), intent :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Updates a SetupIntent object.</p>
@spec post_setup_intents_intent_cancel( client :: ExOAPI.Client.t(), body :: map(), intent :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>A SetupIntent object can be canceled when it is in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p>
Once canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.
@spec post_setup_intents_intent_confirm( client :: ExOAPI.Client.t(), body :: map(), intent :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Confirm that your customer intends to set up the current or provided payment method. For example, you would confirm a SetupIntent when a customer hits the “Save” button on a payment method management page on your website.</p>
If the selected payment method does not require any additionalsteps from the customer, the SetupIntent will transition to the
succeeded
status.
Otherwise, it will transition to the requires_action
status andsuggest additional actions via next_action
. If setup fails,
the SetupIntent will transition to the
requires_payment_method
status.
post_setup_intents_intent_verify_microdeposits(client, body, intent)
View Source@spec post_setup_intents_intent_verify_microdeposits( client :: ExOAPI.Client.t(), body :: map(), intent :: String.t() ) :: {:ok, any()} | {:error, any()}
description: <p>Verifies microdeposits on a SetupIntent object.</p>