Payment Intents

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: Payment Intents API

Endpoints

Create a PaymentIntent

• POST /v1/payment_intents

Update a PaymentIntent

• POST /v1/payment_intents/:id

Retrieve a PaymentIntent

• GET /v1/payment_intents/:id

List all PaymentIntents

• GET /v1/payment_intents

List all PaymentIntent LineItems

• GET /v1/payment_intents/:id/amount_details_line_items

Cancel a PaymentIntent

• POST /v1/payment_intents/:id/cancel

Capture a PaymentIntent

• POST /v1/payment_intents/:id/capture

Confirm a PaymentIntent

• POST /v1/payment_intents/:id/confirm

Increment an authorization

• POST /v1/payment_intents/:id/increment_authorization

Reconcile a customer_balance PaymentIntent

• POST /v1/payment_intents/:id/apply_customer_balance

Search PaymentIntents

• GET /v1/payment_intents/search

Verify microdeposits on a PaymentIntent

• POST /v1/payment_intents/:id/verify_microdeposits

Events

• payment_intent.amount_capturable_updated Occurs when a PaymentIntent has funds to be captured. Check the amount_capturable property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an amount_to_capture value up to the specified amount. Learn more about capturing PaymentIntents.

• payment_intent.canceled Occurs when a PaymentIntent is canceled.

• payment_intent.created Occurs when a new PaymentIntent is created.

• payment_intent.partially_funded Occurs when funds are applied to a customer_balance PaymentIntent and the ‘amount_remaining’ changes.

• payment_intent.payment_failed Occurs when a PaymentIntent has failed the attempt to create a payment method or a payment.

• payment_intent.processing Occurs when a PaymentIntent has started processing.

• payment_intent.requires_action Occurs when a PaymentIntent transitions to requires_action state

• payment_intent.succeeded Occurs when a PaymentIntent has successfully completed payment.