Payment statuses
What each payment status means, when to credit money and why a timeout is not a decline.
The status answers the question of how the payment ended. The inReview flag answers a second question: whether the outcome is still being settled on our side. Read both.
Statuses
| Status | Meaning | What the checkout does | Final |
|---|---|---|---|
CREATED | The payment is created and has not gone to the provider yet. | Wait; with fieldsOnPage, send the payer by action. | no |
PROCESSING | The payment is at the provider; the outcome is not known yet. | Wait: the money may have gone through. | no |
AWAITING_CUSTOMER | Waiting for the payer. | Send the payer by action. | no |
SUCCEEDED | Paid. | Credit paidMinor once inReview is false. | yes |
PARTIALLY_PAID | Less than requested arrived. | Do not credit: our side reviews the payment. | yes |
OVERPAID | More than requested arrived. | Do not credit: our side reviews the payment. | yes |
FAILED | Declined, no money. | You may offer to pay again. | yes |
CANCELLED | The payment is cancelled. There is no cancellation through the API, so a payment created through the API never gets this status. | Do not credit. | yes |
EXPIRED | The payment deadline has passed. | Do not ask to pay again: late money. | yes |
REJECTED | Rejected on our side before reaching the provider, with no attempt: a blocked customer, antifraud or a routing rule. The reason is in reason. | Do not credit. | yes |
A payment never leaves SUCCEEDED, FAILED or REJECTED.
When to credit
A timeout is not a decline
If the provider did not answer, or answered so that the outcome cannot be understood, the payment stays PROCESSING with inReview: true. This is not a decline: the money may have gone through. We ask the provider about the outcome ourselves, and if the provider does not know either, a person on our side names the outcome.
While the outcome is unknown, do not credit the money and do not offer the payer to pay again: if the first payment went through, a second one would charge them again.
Late money
EXPIRED means that the provider did not confirm the payment by the deadline expiresAt. If the provider confirms it later, the payment moves to SUCCEEDED, or to PARTIALLY_PAID or OVERPAID if the amount does not match. That is why a payer with an expired payment who has already sent the money does not need to pay again. The checkout re-reads expired payments in a reconciliation: a notification about late money may not arrive.
Review on our side
inReview: true means that the outcome is still being settled on our side, by a provider inquiry or by a person: the outcome is unknown, the amount did not match, the provider named the money in another currency or sent a disputed report after success. Do not credit such a payment, even with SUCCEEDED.
A definitive answer from the provider lifts the review. Without such an answer, the payment stays under review until a person on our side decides it. For PARTIALLY_PAID and OVERPAID the review is never lifted: our side decides about the money, and there is no point in polling such a payment further.
Status reason
reason names the cause of a decline, rejection, expiry or cancellation and is null when there is nothing to name.
| Code | What happened |
|---|---|
declined_by_bank | The payer's bank declined the operation. |
declined_by_provider | The provider declined the operation. |
insufficient_funds | Insufficient funds. |
issuer_limit_exceeded | The card issuer's limit is exceeded. |
card_expired | The card has expired. |
invalid_card_data | Invalid card details. |
fraud_suspected | The operation was declined as suspicious. |
3ds_failed | The payer failed the 3-D Secure check. |
3ds_abandoned | The payer did not complete the 3-D Secure check. |
3ds_rejected | The bank declined the operation at the 3-D Secure check. |
method_not_enabled | The payment method is not enabled for the merchant. |
attempts_exhausted | The allowed attempts to process the payment are used up. |
request_expired | The payment deadline has passed. |
abandoned_by_customer | The payer did not complete the payment. |
technical_failure | A technical failure at the provider or on our side. |
not_available | The payment method is not available right now. |
customer_blocked | The customer is blocked. |
firewall_blocked | Declined by antifraud. |
rule_declined | Declined by a routing rule. |
Handle an unknown code by the status: new reasons are added without an API version change, and the changelog announces them.