SCPSetupIntentStatus

Objective-C

enum SCPSetupIntentStatus : NSUInteger {}

Swift

enum SetupIntentStatus : UInt

The possible statuses of the SetupIntent.

  • Next step: collect a payment method by calling collectPaymentMethod.

    Declaration

    Objective-C

    SCPSetupIntentStatusRequiresPaymentMethod

    Swift

    case requiresPaymentMethod = 0
  • Next step: confirm the SetupIntent by calling confirmSetupIntent.

    Declaration

    Objective-C

    SCPSetupIntentStatusRequiresConfirmation

    Swift

    case requiresConfirmation = 1
  • If the setup requires additional actions, such as authenticating with 3D Secure, the SetupIntent has a status of requires_action.

    Declaration

    Objective-C

    SCPSetupIntentStatusRequiresAction

    Swift

    case requiresAction = 2
  • Once required actions are handled, the SetupIntent moves to processing. While for certain payment methods (e.g., cards) processing can be quick, other payment methods can take up to a few days to process.

    Declaration

    Objective-C

    SCPSetupIntentStatusProcessing

    Swift

    case processing = 3
  • The SetupIntent was canceled.

    Declaration

    Objective-C

    SCPSetupIntentStatusCanceled

    Swift

    case canceled = 4
  • The SetupIntent succeeded.

    Declaration

    Objective-C

    SCPSetupIntentStatusSucceeded

    Swift

    case succeeded = 5