Read payment statuses
To track payments you can look at two types and levels of payment statuses:
checkout_statusauthorization.status
Checkout status
The checkout_status is the primary indicator of a payment's state, telling you whether a payment has succeeded or not.
| checkout_status | Description |
|---|---|
| Open | Payment authorization requires further action. Refer to the next_action to be informed about your next step. |
| Succeeded | Payment was successfully authorized. See the authorization object for detailed acquirer response. |
| Failed | Payment authorization was declined or encountered an error. |
For failed payments, you can find detailed information about the decline or error in the authorization object, specifically in the status, decline_details, and error_details fields.
Authorization status
Each payment attempt creates an authorization object, and the checkout_status is determined by the latest authorization.status.
Currently, payments are limited to one authorization attempt. A declined or errored payment will be closed with a failed checkout_status.
| authorization.status | Description |
|---|---|
| created | Authorization attempt initiated, awaiting result. |
| pending | Payment finalization in progress, awaiting final status. |
| approved | Authorization approved by scheme owner, acquirer, or issuer. |
| declined | Authorization declined by scheme owner, acquirer, or issuer. |
| error | Authorization process encountered an error. |
Status mapping
Use the checkout_status to determine whether to proceed with delivering goods or services. Here's how authorization states map to checkout statuses:
| Scenario | authorization.status | checkout_status |
|---|---|---|
| No authorization object exists | - | open |
| Authorization initiated, awaiting result | created | open |
| Finalization in progress | pending | open |
| Authorization approved | approved | succeeded |
| Authorization declined | declined | failed |
| Authorization error occurred | error | failed |