Skip to main content

Read payment statuses

To track payments you can look at two types and levels of payment statuses:

  • checkout_status
  • authorization.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_statusDescription
OpenPayment authorization requires further action. Refer to the next_action to be informed about your next step.
SucceededPayment was successfully authorized. See the authorization object for detailed acquirer response.
FailedPayment 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.

info

Currently, payments are limited to one authorization attempt. A declined or errored payment will be closed with a failed checkout_status.

authorization.statusDescription
createdAuthorization attempt initiated, awaiting result.
pendingPayment finalization in progress, awaiting final status.
approvedAuthorization approved by scheme owner, acquirer, or issuer.
declinedAuthorization declined by scheme owner, acquirer, or issuer.
errorAuthorization 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:

Scenarioauthorization.statuscheckout_status
No authorization object exists-open
Authorization initiated, awaiting resultcreatedopen
Finalization in progresspendingopen
Authorization approvedapprovedsucceeded
Authorization declineddeclinedfailed
Authorization error occurrederrorfailed