PaymentIntentsStatus enum

Status of the payment intent.

For more info about payment intent status see: https://stripe.com/docs/payments/intents#intent-statuses.

Inheritance
Available extensions
Annotations
  • @JsonEnum(fieldRename: FieldRename.snake)

Values

requiresPaymentMethod → const PaymentIntentsStatus

When the PaymentIntent is created, it has a status of requires_payment_method until a payment method is attached. We recommend creating the PaymentIntent as soon as you know how much you want to charge, so that Stripe can record all the attempted payments.

requiresConfirmation → const PaymentIntentsStatus

Optional After the customer provides their payment information, the PaymentIntent is ready to be confirmed. In most integrations, this state is skipped because payment method information is submitted at the same time that the payment is confirmed.

requiresAction → const PaymentIntentsStatus

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

requiresCapture → const PaymentIntentsStatus

If you’re separately authorising and capturing funds, your PaymentIntent can instead move to requires_capture. In that case, attempting to capture the funds moves it to processing.

processing → const PaymentIntentsStatus

Once required actions are handled, the PaymentIntent moves to processing. While for some payment methods (for example, cards) processing can be quick, other types of payment methods can take up to a few days to process.

succeeded → const PaymentIntentsStatus

A PaymentIntent with a status of succeeded means that the payment flow it is driving is complete. The funds are now in your account and you can confidently fulfill the order. If you need to refund the customer, you can use the Refunds API.

canceled → const PaymentIntentsStatus

You may cancel a PaymentIntent at any point before it is processing or succeeded. This invalidates the PaymentIntent for future payment attempts, and cannot be undone. If any funds have been held, cancellation returns those funds.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<PaymentIntentsStatus>
A constant List of the values in this enum, in order of their declaration.