Skip to content

Status Reference

Payment intent statuses

StatusDescriptionTerminal?
requires_payment_methodNo payment method attachedNo
requires_confirmationPayment method attached, awaiting confirmNo
requires_actionCustomer action required (e.g. 3DS)No
processingSubmitted to PSP, awaiting resultNo
succeededPayment completedYes
refundedAll captured funds have been refundedYes
failedPayment declined or erroredYes
canceledExplicitly canceledYes

See Payment Lifecycle for the transition rules between these states.

Refund statuses

Refunds are separate objects linked to a payment intent.

StatusDescription
succeededRefund confirmed by PSP
pendingSubmitted to PSP, awaiting confirmation
failedPSP rejected the refund

A failed refund does not affect the parent payment intent’s status. To retry, issue a new refund request.

Setup intent statuses

Setup intents are used to save a payment method for future use.

StatusDescriptionTerminal?
requires_payment_methodNo payment method collectedNo
processingSubmitted to PSP for verificationNo
succeededPayment method savedYes
failedSetup failedYes
canceledExplicitly canceledYes

Payment methods

Payment methods (pm_xxx) do not have a status field. A payment method either exists (and is usable) or has been deleted. The used flag on the tokenization result indicates whether a single-use token has already been consumed.