Skip to main content

SetupIntentStatus

The possible status types for setup intents.

enum SetupIntentStatus {
  CANCELED
  PROCESSING
  REQUIRES_ACTION
  REQUIRES_CONFIRMATION
  REQUIRES_PAYMENT_METHOD
  SUCCEEDED
}

Values​

SetupIntentStatus.CANCELED​

You can cancel a SetupIntent at any point before it’s in a processing or succeeded state. Canceling it invalidates the SetupIntent for future payment attempts, and can’t be undone. If any funds have been held, cancellation releases them.

SetupIntentStatus.PROCESSING​

After required actions are handled, the SetupIntent moves to processing for asynchronous payment methods, such as bank debits. These types of payment methods can take up to a few days to process. Other payment methods, such as cards, are processed more quickly and don’t go into the processing status.

SetupIntentStatus.REQUIRES_ACTION​

If the payment requires additional actions, such as authenticating with 3D Secure, the SetupIntent has a status of requires_action.

SetupIntentStatus.REQUIRES_CONFIRMATION​

After the customer provides their payment information, the SetupIntent is ready to be confirmed.

SetupIntentStatus.REQUIRES_PAYMENT_METHOD​

SetupIntent is created, it has a status of requires_payment_method1 until a payment method is attached.

SetupIntentStatus.SUCCEEDED​

A SetupIntent with a status of succeeded means that the payment flow it is driving is complete.

Member of​

CardSetupIntent object