Skip to main content
A setup intent is a link where a payer saves a card and agrees to let you charge it later. Nothing is charged when they save it. To learn more, see Charge a saved card.

Example

GET /setup-intents/{setupIntentId}
The object is everything inside data. The field names below are relative to it: attributes.status is data.attributes.status in the response.

Fields

string
required
Setup intent ID (set_*).
string
required
Resource type. Always setupIntent.
object
required
The setup intent’s details.
object
required
Related resources, each by type and ID.

Statuses

Permissions

Create and cancel need paymentIntents.create. Get needs paymentIntents.read.

Events

  • setupIntent.completed: Early access (setup intents). A payer saved a card. relationships.mandate links the new mandate, and mandate.created fires for it.
  • setupIntent.canceled: Early access (setup intents). You canceled an open setup intent. Its link no longer saves a card.

Errors

See the error codes these endpoints return.

Sandbox simulations

  • Card fixtures: Test successful payments, declines, 3-D Secure, subscriptions, settlement, cancels, and refunds in Sandbox