Setup intent statuses

The following statuses represent the various states of a payment card being set up and saved by a customer for future use. For more information about how to get the details of a setup intent, see Getting a setup intent.

  • REQUIRES_PAYMENT_METHOD: The initial status of the setup intent. A payment method must be associated with the setup intent before the payment method can be saved.

    A setup intent moves back to the REQUIRES_PAYMENT_METHOD status if the setup intent fails to be confirmed.

  • PROCESSING: The setup intent moves to the PROCESSING status once your integration calls the confirmIntent SDK function. The setup intent cannot be modified while in the PROCESSING status.

  • SUCCEEDED: The setup intent moves into the SUCCEEDED status if the setup intent has been successfully confirmed and associated with the customer record. The payment method can be used for future transactions and payments.