Payment intents
Few statuses. Clear meanings.
A payment only moves forward through these statuses, and each one means the same thing in the API, hosted checkout, events, and plugins.
requires_payment_methodSafe to chooserequires_actionPayer must approveprocessingDo not pay againsucceededPayment confirmed| Status | What it means | What to do | Words to say |
|---|---|---|---|
| requires_action | The payer must approve the payment, for example on their phone or on the card acquirer's secure page. | Do not create another attempt. | Waiting · “Waiting for the customer to approve on their phone” |
| processing | The payment method has not confirmed the result yet. | Keep checking the same payment; never send it again. | Confirming · “Still confirming · don't ask the customer to pay again” |
failed / cancelled / expired | The payment did not go through, and will not. | A new attempt may be offered if checkout remains open. | Not paid · “Not paid · it didn't go through”, with the reason when there is one |
failed · customer_cancelled | The payer left the card acquirer's page without paying, or you reported a cancel while they were on it. A card cancel ends failed, not cancelled, and sends payment_intent.failed. | Treat it as not paid. Offer another try if checkout remains open. | Not paid · “Not paid · the customer left the card page without paying” |
| succeeded | The payment is confirmed for the expected amount and currency. | Fulfill the order once. | Paid · “Paid · confirmed by EcoCash at 18:02 CAT” |
The words are the ones the dashboard shows and answer.sentence says, so every assistant and every person reads the same payment the same way.