Skip to main content
AllScale Open API
Version: v2
Last updated: 2026-03-19
Base Path: /v1/checkout_intents

Overview

The Checkout Intent Status API allows merchants to query the current status of a checkout intent. This API is used to:
  • Retrieve the checkout intent status by checkout_intent_id
  • Poll status after creating a checkout intent and redirecting users to hosted checkout

Important Design Notes

  • All enum values are represented as integers in API requests and responses
  • API consumers must always send and receive integer values
  • This endpoint returns only the status integer (in payload)

Authentication

All requests must include the following headers:

Notes

  • X-Nonce must be unique per request
  • X-Timestamp must be within allowed time window
  • Signature must be generated using raw request body bytes
  • Requests are protected against replay attacks

GET /v1/checkout_intents//status

Description

Get the checkout intent status as an integer.

Request

GET /v1/checkout_intents//status

Path Parameters

Headers

Note: This is a GET request, so there is no request body.

Successful Response

  • payload is the checkout intent status integer.

Response Fields


Possible Errors


Notes

  • This endpoint enforces permission checks: the checkout intent must belong to the authenticated store/business context.
  • Always log request_id for debugging.
  • Since payload is an int, do not expect payload.status or other nested fields.

Appendix — Checkout Intent Status Enum


End of document.