Confirm Payment Intent
stripe.confirm_payment_intent
ActionBusiness appsconnection required
Calls the Stripe API with the connection's secret key.
Confirm a PaymentIntent so Stripe attempts the payment.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Stripe
- Secret shape
- the Stripe secret key (sk_...)
- Resolved by
- config.connection_id, else node.connection_id
Configuration
5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
payment_intent_id The PaymentIntent to act on (pi_...). Supports {{ }} expressions. | string | Yes | — | — | pi_3MtwBwLkdIwHu7ix28a3tqPa |
payment_method The payment method to charge (pm_...), if the intent has none yet. | string | No | — | — | — |
return_url Where the customer comes back to after authenticating, for payment methods that redirect. | string | No | — | url format | — |
off_session The customer is not present for this attempt. | boolean | No | — | — | — |
idempotency_key Overrides the key this node derives from the step. Set it to a business identifier (an order id, say) when the same write must not repeat across runs; leave it blank and a retry of this step reuses the step's own key. | string | No | — | ≤ 255 characters | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"payment_intent_id": "pi_3MtwBwLkdIwHu7ix28a3tqPa"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The PaymentIntent id (pi_...). | string | — |
status One of requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled or succeeded. | string | — |
amount Amount to collect, in the currency's minor unit. | number | — |
amount_received Amount collected so far, in the minor unit. | number | — |
amount_capturable Authorised amount still to capture, in the minor unit. | number | — |
currency Three-letter lowercase ISO currency code. | string | — |
customer The customer this intent belongs to, or null. | string | — |
description The description stored on the intent. | string | — |
payment_method The attached payment method id, or null. | string | — |
latest_charge The charge this intent last produced, or null. | string | — |
capture_method When the funds are captured for this intent. | string | — |
cancellation_reason Why the intent was cancelled, when it was. | string | — |
receipt_email Where Stripe sends the receipt, or null. | string | — |
created Creation time, as a Unix timestamp in seconds. | number | — |
metadata The key/value pairs stored on the intent. | object | — |
{
"amount": 0,
"amount_capturable": 0,
"amount_received": 0,
"cancellation_reason": "",
"capture_method": "",
"created": 0,
"currency": "",
"customer": "",
"description": "",
"id": "",
"latest_charge": "",
"metadata": {},
"payment_method": "",
"receipt_email": "",
"status": ""
}Notes
- A confirmed intent can still land on requires_action; check 'status' before treating the payment as taken.
See Confirm Payment Intent run in a workflow.
In a technical demo we add the Stripe connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.