Package com.stripe.service

Class PaymentIntentService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.PaymentIntentService

public final class PaymentIntentService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
PaymentIntentService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
PaymentIntent	applyCustomerBalance(String intent)	Manually reconcile the remaining amount for a customer_balance PaymentIntent.
PaymentIntent	applyCustomerBalance(String intent, RequestOptions options)	Manually reconcile the remaining amount for a customer_balance PaymentIntent.
PaymentIntent	applyCustomerBalance(String intent, PaymentIntentApplyCustomerBalanceParams params)	Manually reconcile the remaining amount for a customer_balance PaymentIntent.
PaymentIntent	applyCustomerBalance(String intent, PaymentIntentApplyCustomerBalanceParams params, RequestOptions options)	Manually reconcile the remaining amount for a customer_balance PaymentIntent.
PaymentIntent	cancel(String intent)	You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
PaymentIntent	cancel(String intent, RequestOptions options)	You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
PaymentIntent	cancel(String intent, PaymentIntentCancelParams params)	You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
PaymentIntent	cancel(String intent, PaymentIntentCancelParams params, RequestOptions options)	You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
PaymentIntent	capture(String intent)	Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
PaymentIntent	capture(String intent, RequestOptions options)	Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
PaymentIntent	capture(String intent, PaymentIntentCaptureParams params)	Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
PaymentIntent	capture(String intent, PaymentIntentCaptureParams params, RequestOptions options)	Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
PaymentIntent	confirm(String intent)	Confirm that your customer intends to pay with current or provided payment method.
PaymentIntent	confirm(String intent, RequestOptions options)	Confirm that your customer intends to pay with current or provided payment method.
PaymentIntent	confirm(String intent, PaymentIntentConfirmParams params)	Confirm that your customer intends to pay with current or provided payment method.
PaymentIntent	confirm(String intent, PaymentIntentConfirmParams params, RequestOptions options)	Confirm that your customer intends to pay with current or provided payment method.
PaymentIntent	create(PaymentIntentCreateParams params)	Creates a PaymentIntent object.
PaymentIntent	create(PaymentIntentCreateParams params, RequestOptions options)	Creates a PaymentIntent object.
PaymentIntent	incrementAuthorization(String intent, PaymentIntentIncrementAuthorizationParams params)	Perform an incremental authorization on an eligible PaymentIntent.
PaymentIntent	incrementAuthorization(String intent, PaymentIntentIncrementAuthorizationParams params, RequestOptions options)	Perform an incremental authorization on an eligible PaymentIntent.
StripeCollection<PaymentIntent>	list()	Returns a list of PaymentIntents.
StripeCollection<PaymentIntent>	list(RequestOptions options)	Returns a list of PaymentIntents.
StripeCollection<PaymentIntent>	list(PaymentIntentListParams params)	Returns a list of PaymentIntents.
StripeCollection<PaymentIntent>	list(PaymentIntentListParams params, RequestOptions options)	Returns a list of PaymentIntents.
PaymentIntent	retrieve(String intent)	Retrieves the details of a PaymentIntent that has previously been created.
PaymentIntent	retrieve(String intent, RequestOptions options)	Retrieves the details of a PaymentIntent that has previously been created.
PaymentIntent	retrieve(String intent, PaymentIntentRetrieveParams params)	Retrieves the details of a PaymentIntent that has previously been created.
PaymentIntent	retrieve(String intent, PaymentIntentRetrieveParams params, RequestOptions options)	Retrieves the details of a PaymentIntent that has previously been created.
StripeSearchResult<PaymentIntent>	search(PaymentIntentSearchParams params)	Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.
StripeSearchResult<PaymentIntent>	search(PaymentIntentSearchParams params, RequestOptions options)	Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language.
PaymentIntent	update(String intent)	Updates properties on a PaymentIntent object without confirming.
PaymentIntent	update(String intent, RequestOptions options)	Updates properties on a PaymentIntent object without confirming.
PaymentIntent	update(String intent, PaymentIntentUpdateParams params)	Updates properties on a PaymentIntent object without confirming.
PaymentIntent	update(String intent, PaymentIntentUpdateParams params, RequestOptions options)	Updates properties on a PaymentIntent object without confirming.
PaymentIntent	verifyMicrodeposits(String intent)	Verifies microdeposits on a PaymentIntent object.
PaymentIntent	verifyMicrodeposits(String intent, RequestOptions options)	Verifies microdeposits on a PaymentIntent object.
PaymentIntent	verifyMicrodeposits(String intent, PaymentIntentVerifyMicrodepositsParams params)	Verifies microdeposits on a PaymentIntent object.
PaymentIntent	verifyMicrodeposits(String intent, PaymentIntentVerifyMicrodepositsParams params, RequestOptions options)	Verifies microdeposits on a PaymentIntent 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

PaymentIntentService

public PaymentIntentService(StripeResponseGetter responseGetter)

Method Details

list

public StripeCollection<PaymentIntent> list(PaymentIntentListParams params)
                                     throws StripeException

Returns a list of PaymentIntents.

Throws:

StripeException

list

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

Returns a list of PaymentIntents.

Throws:

StripeException

list

public StripeCollection<PaymentIntent> list()
                                     throws StripeException

Returns a list of PaymentIntents.

Throws:

StripeException

list

public StripeCollection<PaymentIntent> list(PaymentIntentListParams params,
 RequestOptions options)
                                     throws StripeException

Returns a list of PaymentIntents.

Throws:

StripeException

create

public PaymentIntent create(PaymentIntentCreateParams params)
                     throws StripeException

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

Throws:

StripeException

create

public PaymentIntent create(PaymentIntentCreateParams params,
 RequestOptions options)
                     throws StripeException

Creates a PaymentIntent object.

After the PaymentIntent is created, attach a payment method and confirm to continue the payment. Learn more about the available payment flows with the Payment Intents API.

When you use confirm=true during creation, it’s equivalent to creating and confirming the PaymentIntent in the same call. You can use any parameters available in the confirm API when you supply confirm=true.

Throws:

StripeException

retrieve

public PaymentIntent retrieve(String intent,
 PaymentIntentRetrieveParams params)
                       throws StripeException

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

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Throws:

StripeException

retrieve

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

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

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Throws:

StripeException

retrieve

public PaymentIntent retrieve(String intent)
                       throws StripeException

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

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Throws:

StripeException

retrieve

public PaymentIntent retrieve(String intent,
 PaymentIntentRetrieveParams params,
 RequestOptions options)
                       throws StripeException

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

You can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.

If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.

Throws:

StripeException

update

public PaymentIntent update(String intent,
 PaymentIntentUpdateParams params)
                     throws StripeException

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Throws:

StripeException

update

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

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Throws:

StripeException

update

public PaymentIntent update(String intent)
                     throws StripeException

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Throws:

StripeException

update

public PaymentIntent update(String intent,
 PaymentIntentUpdateParams params,
 RequestOptions options)
                     throws StripeException

Updates properties on a PaymentIntent object without confirming.

Depending on which properties you update, you might need to confirm the PaymentIntent again. For example, updating the payment_method always requires you to confirm the PaymentIntent again. If you prefer to update and confirm at the same time, we recommend updating properties through the confirm API instead.

Throws:

StripeException

search

public StripeSearchResult<PaymentIntent> search(PaymentIntentSearchParams params)
                                         throws StripeException

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Throws:

StripeException

search

public StripeSearchResult<PaymentIntent> search(PaymentIntentSearchParams params,
 RequestOptions options)
                                         throws StripeException

Search for PaymentIntents you’ve previously created using Stripe’s Search Query Language. Don’t use search in read-after-write flows where strict consistency is necessary. Under normal operating conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up to an hour behind during outages. Search functionality is not available to merchants in India.

Throws:

StripeException

applyCustomerBalance

public PaymentIntent applyCustomerBalance(String intent,
 PaymentIntentApplyCustomerBalanceParams params)
                                   throws StripeException

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

Throws:

StripeException

applyCustomerBalance

public PaymentIntent applyCustomerBalance(String intent,
 RequestOptions options)
                                   throws StripeException

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

Throws:

StripeException

applyCustomerBalance

public PaymentIntent applyCustomerBalance(String intent)
                                   throws StripeException

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

Throws:

StripeException

applyCustomerBalance

public PaymentIntent applyCustomerBalance(String intent,
 PaymentIntentApplyCustomerBalanceParams params,
 RequestOptions options)
                                   throws StripeException

Manually reconcile the remaining amount for a customer_balance PaymentIntent.

Throws:

StripeException

cancel

public PaymentIntent cancel(String intent,
 PaymentIntentCancelParams params)
                     throws StripeException

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

cancel

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

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

cancel

public PaymentIntent cancel(String intent)
                     throws StripeException

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

cancel

public PaymentIntent cancel(String intent,
 PaymentIntentCancelParams params,
 RequestOptions options)
                     throws StripeException

You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.

After it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.

You can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.

Throws:

StripeException

capture

public PaymentIntent capture(String intent,
 PaymentIntentCaptureParams params)
                      throws StripeException

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Throws:

StripeException

capture

public PaymentIntent capture(String intent,
 RequestOptions options)
                      throws StripeException

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Throws:

StripeException

capture

public PaymentIntent capture(String intent)
                      throws StripeException

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Throws:

StripeException

capture

public PaymentIntent capture(String intent,
 PaymentIntentCaptureParams params,
 RequestOptions options)
                      throws StripeException

Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.

Uncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.

Learn more about separate authorization and capture.

Throws:

StripeException

confirm

public PaymentIntent confirm(String intent,
 PaymentIntentConfirmParams params)
                      throws StripeException

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.

Throws:

StripeException

confirm

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

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.

Throws:

StripeException

confirm

public PaymentIntent confirm(String intent)
                      throws StripeException

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.

Throws:

StripeException

confirm

public PaymentIntent confirm(String intent,
 PaymentIntentConfirmParams params,
 RequestOptions options)
                      throws StripeException

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the selected payment method requires additional authentication steps, the PaymentIntent will transition to the requires_action status and suggest additional actions via next_action. If payment fails, the PaymentIntent transitions to the requires_payment_method status or the canceled status if the confirmation limit is reached. If payment succeeds, the PaymentIntent will transition to the succeeded status (or requires_capture, if capture_method is set to manual). If the confirmation_method is automatic, payment may be attempted using our client SDKs and the PaymentIntent’s client_secret. After next_actions are handled by the client, no additional confirmation is required to complete the payment. If the confirmation_method is manual, all payment attempts must be initiated using a secret key. If any actions are required for the payment, the PaymentIntent will return to the requires_confirmation state after those actions are completed. Your server needs to then explicitly re-confirm the PaymentIntent to initiate the next payment attempt.

Throws:

StripeException

incrementAuthorization

public PaymentIntent incrementAuthorization(String intent,
 PaymentIntentIncrementAuthorizationParams params)
                                     throws StripeException

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

Throws:

StripeException

incrementAuthorization

public PaymentIntent incrementAuthorization(String intent,
 PaymentIntentIncrementAuthorizationParams params,
 RequestOptions options)
                                     throws StripeException

Perform an incremental authorization on an eligible PaymentIntent. To be eligible, the PaymentIntent’s status must be requires_capture and incremental_authorization_supported must be true.

Incremental authorizations attempt to increase the authorized amount on your customer’s card to the new, higher amount provided. Similar to the initial authorization, incremental authorizations can be declined. A single PaymentIntent can call this endpoint multiple times to further increase the authorized amount.

If the incremental authorization succeeds, the PaymentIntent object returns with the updated amount. If the incremental authorization fails, a card_declined error returns, and no other fields on the PaymentIntent or Charge update. The PaymentIntent object remains capturable for the previously authorized amount.

Each PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines. After it’s captured, a PaymentIntent can no longer be incremented.

Learn more about incremental authorizations.

Throws:

StripeException

verifyMicrodeposits

public PaymentIntent verifyMicrodeposits(String intent,
 PaymentIntentVerifyMicrodepositsParams params)
                                  throws StripeException

Verifies microdeposits on a PaymentIntent object.

Throws:

StripeException

verifyMicrodeposits

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

Verifies microdeposits on a PaymentIntent object.

Throws:

StripeException

verifyMicrodeposits

public PaymentIntent verifyMicrodeposits(String intent)
                                  throws StripeException

Verifies microdeposits on a PaymentIntent object.

Throws:

StripeException

verifyMicrodeposits

public PaymentIntent verifyMicrodeposits(String intent,
 PaymentIntentVerifyMicrodepositsParams params,
 RequestOptions options)
                                  throws StripeException

Verifies microdeposits on a PaymentIntent object.

Throws:

StripeException