Payment status updates

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.

Check PaymentIntent status on the client

When completing a payment on the client with the confirmCardPayment function, you can inspect the returned PaymentIntent to determine its current status:

stripe.confirmCardPayment(clientSecret).then(function(response) {
  if (response.error) {
    // Handle error here
  } else if (response.paymentIntent && response.paymentIntent.status === 'succeeded') {
    // Handle successful payment here
  }
});

The following are the possible outcomes of using the confirmCardPayment function:

The promise returned by confirmCardPayment 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 like authentication, the promise doesn’t resolve until that step is either complete or has timed out.

Check PaymentIntent status on the client without using confirmCardPayment

To check the status of a PaymentIntent without using the confirmCardPayment function, retrieve it independently by using the retrievePaymentIntent function and passing in the client secret.

The following are some possible statuses of the PaymentIntent following a confirmation:

Read more about the payment statuses.

stripe.retrievePaymentIntent(clientSecret).then(function(response) {
  if (response.paymentIntent && response.paymentIntent.status === 'succeeded') {
    // Handle successful payment here
  } else {
    // Handle unsuccessful, processing, or canceled payments and API errors here
  }
});

Monitor a PaymentIntent with webhooks

Stripe can send webhook events to your server to notify you when the status of a PaymentIntent changes. This is useful for purposes like determining when to fulfill the goods and services purchased by the customer.

Your integration shouldn’t attempt to handle order fulfillment on the client side because it is possible for customers to 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.

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 payment is successful and the payment_intent.payment_failed event when payment isn’t successful.

The webhook payload includes the PaymentIntent object. The following example shows how to handle both events:

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:

To test webhooks locally, you can use Stripe CLI. After you install it, you can forward events to your server:

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. You can inspect the PaymentIntent’s charges.data property to obtain the latest charge:

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_4eC39HqLyjWDarjtT1zdp7dc'

intent = Stripe::PaymentIntent.retrieve('{{PAYMENT_INTENT_ID}}')
charges = intent.charges.data

A PaymentIntent’s Charge property only contains the most recent charge. To view all of the charges associated with a PaymentIntent, list all charges with the payment_intent​ parameter specified. Note that in addition to the final successful charge, the list includes any unsuccessful charges created during the payment process.

Handling next actions

Some payment methods require additional steps, such as authentication, in order to complete the payment process. The Stripe.js confirmCardPayment function handles these automatically, but some advanced integrations may wish to handle these manually.

The PaymentIntent’s next_action property exposes the next step that your integration must handle in order to complete the payment. The type of possible next actions can differ between various payment methods.

The following is a list of next action types and the payment methods that may require them:

You can refer to the documentation for individual payment methods for more details about how to handle their required next actions.