Package com.stripe.service

Class SetupIntentService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.SetupIntentService

public final class SetupIntentService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
SetupIntentService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
SetupIntent	cancel(String intent)	You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
SetupIntent	cancel(String intent, RequestOptions options)	You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
SetupIntent	cancel(String intent, SetupIntentCancelParams params)	You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
SetupIntent	cancel(String intent, SetupIntentCancelParams params, RequestOptions options)	You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
SetupIntent	confirm(String intent)	Confirm that your customer intends to set up the current or provided payment method.
SetupIntent	confirm(String intent, RequestOptions options)	Confirm that your customer intends to set up the current or provided payment method.
SetupIntent	confirm(String intent, SetupIntentConfirmParams params)	Confirm that your customer intends to set up the current or provided payment method.
SetupIntent	confirm(String intent, SetupIntentConfirmParams params, RequestOptions options)	Confirm that your customer intends to set up the current or provided payment method.
SetupIntent	create()	Creates a SetupIntent object.
SetupIntent	create(RequestOptions options)	Creates a SetupIntent object.
SetupIntent	create(SetupIntentCreateParams params)	Creates a SetupIntent object.
SetupIntent	create(SetupIntentCreateParams params, RequestOptions options)	Creates a SetupIntent object.
StripeCollection<SetupIntent>	list()	Returns a list of SetupIntents.
StripeCollection<SetupIntent>	list(RequestOptions options)	Returns a list of SetupIntents.
StripeCollection<SetupIntent>	list(SetupIntentListParams params)	Returns a list of SetupIntents.
StripeCollection<SetupIntent>	list(SetupIntentListParams params, RequestOptions options)	Returns a list of SetupIntents.
SetupIntent	retrieve(String intent)	Retrieves the details of a SetupIntent that has previously been created.
SetupIntent	retrieve(String intent, RequestOptions options)	Retrieves the details of a SetupIntent that has previously been created.
SetupIntent	retrieve(String intent, SetupIntentRetrieveParams params)	Retrieves the details of a SetupIntent that has previously been created.
SetupIntent	retrieve(String intent, SetupIntentRetrieveParams params, RequestOptions options)	Retrieves the details of a SetupIntent that has previously been created.
SetupIntent	update(String intent)	Updates a SetupIntent object.
SetupIntent	update(String intent, RequestOptions options)	Updates a SetupIntent object.
SetupIntent	update(String intent, SetupIntentUpdateParams params)	Updates a SetupIntent object.
SetupIntent	update(String intent, SetupIntentUpdateParams params, RequestOptions options)	Updates a SetupIntent object.
SetupIntent	verifyMicrodeposits(String intent)	Verifies microdeposits on a SetupIntent object.
SetupIntent	verifyMicrodeposits(String intent, RequestOptions options)	Verifies microdeposits on a SetupIntent object.
SetupIntent	verifyMicrodeposits(String intent, SetupIntentVerifyMicrodepositsParams params)	Verifies microdeposits on a SetupIntent object.
SetupIntent	verifyMicrodeposits(String intent, SetupIntentVerifyMicrodepositsParams params, RequestOptions options)	Verifies microdeposits on a SetupIntent object.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SetupIntentService

public SetupIntentService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<SetupIntent> list(SetupIntentListParams params)
                                   throws StripeException

Returns a list of SetupIntents.

Throws:

StripeException

list

public StripeCollection<SetupIntent> list(RequestOptions options)
                                   throws StripeException

Returns a list of SetupIntents.

Throws:

StripeException

list

public StripeCollection<SetupIntent> list()
                                   throws StripeException

Returns a list of SetupIntents.

Throws:

StripeException

list

public StripeCollection<SetupIntent> list(SetupIntentListParams params,
 RequestOptions options)
                                   throws StripeException

Returns a list of SetupIntents.

Throws:

StripeException

create

public SetupIntent create(SetupIntentCreateParams params)
                   throws StripeException

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

Throws:

StripeException

create

public SetupIntent create(RequestOptions options)
                   throws StripeException

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

Throws:

StripeException

create

public SetupIntent create()
                   throws StripeException

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

Throws:

StripeException

create

public SetupIntent create(SetupIntentCreateParams params,
 RequestOptions options)
                   throws StripeException

Creates a SetupIntent object.

After you create the SetupIntent, attach a payment method and confirm it to collect any required permissions to charge the payment method later.

Throws:

StripeException

retrieve

public SetupIntent retrieve(String intent,
 SetupIntentRetrieveParams params)
                     throws StripeException

Retrieves the details of a SetupIntent that has previously been created.

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.

Throws:

StripeException

retrieve

public SetupIntent retrieve(String intent,
 RequestOptions options)
                     throws StripeException

Retrieves the details of a SetupIntent that has previously been created.

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.

Throws:

StripeException

retrieve

public SetupIntent retrieve(String intent)
                     throws StripeException

Retrieves the details of a SetupIntent that has previously been created.

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.

Throws:

StripeException

retrieve

public SetupIntent retrieve(String intent,
 SetupIntentRetrieveParams params,
 RequestOptions options)
                     throws StripeException

Retrieves the details of a SetupIntent that has previously been created.

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.

Throws:

StripeException

update

public SetupIntent update(String intent,
 SetupIntentUpdateParams params)
                   throws StripeException

Updates a SetupIntent object.

Throws:

StripeException

update

public SetupIntent update(String intent,
 RequestOptions options)
                   throws StripeException

Updates a SetupIntent object.

Throws:

StripeException

update

public SetupIntent update(String intent)
                   throws StripeException

Updates a SetupIntent object.

Throws:

StripeException

update

public SetupIntent update(String intent,
 SetupIntentUpdateParams params,
 RequestOptions options)
                   throws StripeException

Updates a SetupIntent object.

Throws:

StripeException

cancel

public SetupIntent cancel(String intent,
 SetupIntentCancelParams params)
                   throws StripeException

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

cancel

public SetupIntent cancel(String intent,
 RequestOptions options)
                   throws StripeException

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

cancel

public SetupIntent cancel(String intent)
                   throws StripeException

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

cancel

public SetupIntent cancel(String intent,
 SetupIntentCancelParams params,
 RequestOptions options)
                   throws StripeException

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

confirm

public SetupIntent confirm(String intent,
 SetupIntentConfirmParams params)
                    throws StripeException

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.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

Throws:

StripeException

confirm

public SetupIntent confirm(String intent,
 RequestOptions options)
                    throws StripeException

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.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

Throws:

StripeException

confirm

public SetupIntent confirm(String intent)
                    throws StripeException

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.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

Throws:

StripeException

confirm

public SetupIntent confirm(String intent,
 SetupIntentConfirmParams params,
 RequestOptions options)
                    throws StripeException

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.

If the selected payment method does not require any additional steps from the customer, the SetupIntent will transition to the succeeded status.

Otherwise, it will transition to the requires_action status and suggest additional actions via next_action. If setup fails, the SetupIntent will transition to the requires_payment_method status or the canceled status if the confirmation limit is reached.

Throws:

StripeException

verifyMicrodeposits

public SetupIntent verifyMicrodeposits(String intent,
 SetupIntentVerifyMicrodepositsParams params)
                                throws StripeException

Verifies microdeposits on a SetupIntent object.

Throws:

StripeException

verifyMicrodeposits

public SetupIntent verifyMicrodeposits(String intent,
 RequestOptions options)
                                throws StripeException

Verifies microdeposits on a SetupIntent object.

Throws:

StripeException

verifyMicrodeposits

public SetupIntent verifyMicrodeposits(String intent)
                                throws StripeException

Verifies microdeposits on a SetupIntent object.

Throws:

StripeException

verifyMicrodeposits

public SetupIntent verifyMicrodeposits(String intent,
 SetupIntentVerifyMicrodepositsParams params,
 RequestOptions options)
                                throws StripeException

Verifies microdeposits on a SetupIntent object.

Throws:

StripeException