Payment status updates
Monitor and verify payment status, so that you can respond to successful and failed payments.
PaymentIntents update in response to actions taken by the customer or payment method. Your integration can inspect the PaymentIntent to determine the status of the payment process, so that you can take business actions or respond to states that require further intervention.
You can also use the Stripe Dashboard to configure your account to email you about payment status, such as successful payments. Change your email notifications in your user settings.
Payment statuses and PaymentIntent statuses
The Payments page in the Dashboard shows a payment status for each payment, which you can use to filter the list. This status summarizes the payment but doesn’t include the additional details provided by the PaymentIntent status.
A PaymentIntent’s status tracks the status of a payment and indicates when a payment requires further processing or customer actions. A payment that uses a PaymentIntent might require a payment method, confirmation, or other action to succeed. In the Dashboard, these states map to Incomplete.
To understand a payment’s incomplete status, click the payment and use Workbench Inspector to see the PaymentIntent’s details in JSON. Search for status to see the exact value.
The following table maps each PaymentIntent status to the payment statuses in the Dashboard. Edge cases such as expired attempts and specific decline codes can affect this mapping. Use the API or Workbench Inspector to get the authoritative state.
PaymentIntent status | Payment status | Description |
|---|---|---|
requires_payment_method | Incomplete | Typically occurs if there’s no latest_charge or the intent hasn’t progressed past collection. Depending on the payment method, amounts, and errors, the payment status can also be Partially paid, Waiting on funding, or Failed. |
requires_confirmation | Incomplete | Occurs after your customer provides payment information and is ready to confirm. Most integrations skip this state because they submit payment method information when the payment is confirmed. |
requires_action | Incomplete | Occurs when the payment requires additional actions, such as authenticating with 3D Secure. The payment status in the Dashboard can also be Partially paid, Waiting on funding, or Failed under certain authentication or error conditions. |
processing | Pending | Occurs when required actions are complete and the payment uses an asynchronous payment method, such as bank debits. These payment methods can take up to a few days to process. |
requires_capture | Uncaptured or Partial capture | Occurs if your flow uses separate capture. If any amount is received toward the intent, the status is Partial capture. If no amount is received, the status is Uncaptured. |
succeeded | Succeeded | A PaymentIntent with a succeeded status means the corresponding payment flow is complete. The funds are in your account and you can fulfill the order. If the payment attempt fails (for example, due to a decline), the PaymentIntent’s status returns to requires_payment_method so the payment can be retried. Subsequent refunds, disputes, and outcomes are reflected on the Charge. These might change what you see in the Dashboard, even though the PaymentIntent remains succeeded. |
canceled | Canceled | Occurs when the payment is canceled. If the intent was canceled as part of a failed invoice flow and the latest charge failed, the status might show Failed. |
Handle next actions
Some payment methods require additional steps, such as authentication, to complete the payment process. Stripe.js handles these automatically when confirming the PaymentIntent, but if you have an advanced integration, you can handle these manually.
The PaymentIntent’s next_action property exposes the next step that your integration must handle to complete the payment. Available next actions vary by payment method. For a full list, see the API reference.
Learn how to handle a payment method’s required next actions.
Check PaymentIntent status on the client
When completing a payment on the client with the confirmPayment function, you can inspect the returned PaymentIntent to determine its current status:
The following are the possible outcomes of using the confirmPayment function:
| Event | What Happened | Expected Integration |
|---|---|---|
| Resolves with a PaymentIntent | The customer completed payment on your checkout page | Inform the customer that their payment succeeded |
| Resolves with an error | The customer’s payment failed on your checkout page | Display an error message and prompt your customer to attempt payment again |
The promise returned by confirmPayment resolves when the payment process has either completed or failed with an error. When it completes successfully and returns a PaymentIntent, the status is always succeeded (or requires_capture if capturing later). When the payment requires an additional step such as authentication, the promise doesn’t resolve until that step is either complete or has timed out.
Check PaymentIntent status on the client without using confirmPayment
To check the status of a PaymentIntent without using the confirmPayment function, retrieve it independently by using the retrievePaymentIntent function and passing in the client secret.
(async () => {
const {paymentIntent} = await stripe.retrievePaymentIntent(clientSecret);
if (paymentIntent && paymentIntent.status === 'succeeded') {
// Handle successful payment here
} else {
// Handle unsuccessful, processing, or canceled payments and API errors here
}
})();
The following are some possible statuses of the PaymentIntent following a confirmation:
| What Happened | Expected PaymentIntent Status |
|---|---|
| The customer completed payment on your checkout page | succeeded |
| The customer didn’t complete the checkout | requires_action |
| The customer’s payment failed on your checkout page | requires_payment_method |
Read more about the PaymentIntent statuses.
Monitor a PaymentIntent with webhooks
Stripe can send webhook events to your server to notify you when the status of a PaymentIntent changes, which you can use for purposes such as determining when to fulfill goods and services.
Don’t attempt to handle order fulfillment on the client side because customers can leave the page after payment is complete but before the fulfillment process initiates. Instead, use webhooks to monitor the payment_intent.succeeded event and handle its completion asynchronously instead of attempting to initiate fulfillment on the client side.
Caution
You can use polling instead of webhooks to monitor for changes caused by asynchronous operations—repeatedly retrieving a PaymentIntent to check its status—but it’s much less reliable and might trigger rate limits. Stripe enforces rate limits on API requests, so use caution if you use polling.
To handle a webhook event, create a route on your server and configure a corresponding webhook endpoint in the Dashboard. Stripe sends the payment_intent.succeeded event when a payment succeeds, and the payment_intent.payment_failed event when a payment fails.
The webhook payload includes the PaymentIntent object. The following example shows how to handle both events:
Select a language
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
require 'sinatra'
require 'stripe'
post '/webhook' do
payload = request.body.read
sig_header = request.env['HTTP_STRIPE_SIGNATURE']
event = nil
begin
event = Stripe::Webhook.construct_event(
payload, sig_header, endpoint_secret
)
rescue JSON::ParserError => e
# Invalid payload
status 400
return
rescue Stripe::SignatureVerificationError => e
# Invalid signature
status 400
return
end
case event['type']
when 'payment_intent.succeeded'
intent = event['data']['object']
puts "Succeeded:", intent['id']
# Fulfill the customer's purchase
when 'payment_intent.payment_failed'
intent = event['data']['object']
error_message = intent['last_payment_error'] && intent['last_payment_error']['message']
puts "Failed:", intent['id'], error_message
# Notify the customer that payment failed
end
status 200
end
When payment is unsuccessful, you can find more details by inspecting the PaymentIntent’s last_payment_error property. You can notify the customer that their payment didn’t complete and encourage them to try again with a different payment method. Reuse the same PaymentIntent to continue tracking the customer’s purchase.
Handling specific webhook events
The following list describes how to handle webhook events:
| Event | Description | Next steps |
|---|---|---|
processing | The customer’s payment was submitted to Stripe successfully. Only applicable to payment methods with delayed success confirmation. | Wait for the initiated payment to succeed or fail. |
succeeded | The customer’s payment succeeded. | Fulfill the purchased goods or services. |
amount_capturable_updated | The customer’s payment is authorized and ready for capture. | Capture the funds that are available for payment. |
payment_failed | The customer’s payment was declined by a card network or otherwise expired. | Reach out to your customer through email or push notification and prompt them to provide another payment method. |
To test webhooks locally, you can use Stripe CLI. After you install it, you can forward events to your server:
Command Line
stripe listen --forward-to localhost:4242/webhook
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)
Learn more about setting up webhooks.
Identifying charges on a PaymentIntent
When you attempt to collect payment from a customer, the PaymentIntent creates a Charge. To get the ID of the most recent charge, inspect the PaymentIntent’s latest_charge property:
Select a language
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
# Don't put any keys in code. See https://docs.stripe.com/keys-best-practices.
# Find your keys at https://dashboard.stripe.com/apikeys.
client = Stripe::StripeClient.new('sk_test_BQokikJOvBiI2HlWgH4olfQ2')
intent = client.v1.payment_intents.retrieve('{{PAYMENT_INTENT_ID}}')
latest_charge = intent.latest_charge
To view all of the charges associated with a PaymentIntent, including any unsuccessful charges, list all charges and specify the payment_intent parameter.
Command Line
Select a language
cURL
Stripe CLI
Ruby
Python
PHP
Java
Node.js
Go
.NET
No results
