📃API Doc - Checkout Intent Routes - Get Checkout Intent

AllScale Open API

Version: v3

Last updated: 2026-03-06

Base Path: /v1/checkout_intents

---

Overview

The Checkout Intent Query API allows merchants to retrieve the full details of a checkout intent.

This API is used to:

• Fetch complete checkout intent information by checkout_intent_id

• Display order, user, and payment details

• Inspect on-chain transaction metadata after payment

• Debug or reconcile payment lifecycle issues

---

Important Notes

• All enum values are represented as integers in API requests and responses

• Monetary values involving stable coins are returned as strings to preserve precision

• This endpoint returns a structured object in payload

• Permission checks are enforced at the store/business level

---

Authentication

All requests must include the following headers:

Header	Description
X-API-Key	API key
X-Timestamp	Unix timestamp (seconds)
X-Nonce	Unique request identifier
X-Signature	HMAC signature

Notes

• X-Nonce must be unique per request

• X-Timestamp must be within the allowed time window

• Signature must be generated using raw request body bytes

• Requests are protected against replay attacks

---

GET /v1/checkout_intents/{checkout_intent_id}

Description

Retrieve the full checkout intent object, including payment configuration, order metadata, and on-chain transaction details (if available).

---

Request

GET /v1/checkout_intents/{checkout_intent_id}

Path Parameters

Parameter	Type	Required	Description
checkout_intent_id	string	✅	AllScale checkout intent ObjectId string

Headers

X-API-Key: <your_api_key>
X-Timestamp: <unix_timestamp>
X-Nonce: <uuid>
X-Signature: v1=<signature>

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

---

Successful Response

{
  "code": 0,
  "payload": {
    "all_scale_checkout_intent_id": "65c9d4e5a9f4e0d2b6a1e123",
    "currency": 1,
    "currency_symbol": "USD",
    "amount_cents": 2500,
    "chain_id": 1,
    "amount_coins": "2.500000",
    "coin_symbol": "USDT",
    "coin_contract": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
    "currency_rate": "1.000000",
    "status": 20,
    "order_id": "order_8899",
    "order_description": "Premium subscription",
    "user_id": "user_001",
    "user_name": "Alice",
    "tx_hash": "0xabc123...",
    "tx_from": "0xSenderAddress",
    "tx_to": "0xReceiverAddress",
    "payment_method_type": 1,
    "actual_paid_amount": "2.500000",
    "net_income_amount": "2.400000",
    "service_fee_amount": "0.100000"
  },
  "error": null,
  "request_id": "req_xxxxx"
}

---

Response Fields

Top-Level Fields

Field	Type	Description
code	int	0 indicates success
payload	object	Checkout intent object
error	object | null	Error object
request_id	string	Request identifier

---

Payload — Checkout Intent Object

Field	Type	Description
all_scale_checkout_intent_id	string	Checkout intent ID
currency	int	Fiat currency enum value
currency_symbol	string	Fiat currency symbol (e.g. USD)
amount_cents	int	Amount in fiat cents
chain_id	int | null	EIP-155 chain ID
amount_coins	string	Amount in stable coin
coin_symbol	string	Stable coin symbol (USDT / USDC)
coin_contract	string | null	Stable coin contract address
currency_rate	string	Fiat → stable coin conversion rate
status	int	Checkout intent status enum value
order_id	string | null	Merchant order ID
order_description	string | null	Merchant order description
user_id	string | null	Merchant user ID
user_name	string | null	Merchant user name
error_message	string | null	Error message (if failed)
tx_hash	string | null	On-chain transaction hash from the customer's wallet to the ephemeral wallet
tx_hash_2	string | null	On-chain transaction hash of the second transfer, from the ephemeral wallet to the merchant's wallet
tx_from	string | null	Customer's wallet address
tx_to	string	Merchant's AllScale wallet address
actual_paid_amount	string | null	Actual stablecoin amount paid by the user
service_fee_amount	string | null	AllScale service fee deducted from the payment amount
net_income_amount	string | null	Net stablecoin amount credited to the merchant. Calculated as actual_paid_amount - service_fee_amount.
payment_method_type	integer	Payment method type used for this transaction. Value must correspond to the PaymentMethodType enum: 0=UNKNOWN, 1=WALLET_SCAN, 2=WALLET_CONNECT, 3=ALL_SCALE_PAY.

---

Possible Errors

Code	Meaning
10001	Validation error
20001	Missing authentication headers
20002	Invalid signature
30001	Forbidden (no permission to view this checkout intent)
40001	Rate limit exceeded
50001	Checkout intent not found
90000	Internal server error, pls contact us
99999	Unknown error, pls contact us

---

Notes

• This endpoint enforces store/business ownership checks

• Enum fields (such as currency and status) are returned as integers only

• Decimal values are returned as strings to avoid precision loss

• Always log request_id when debugging production issues

• If you only need the status value, prefer GET /v1/checkout_intents/{checkout_intent_id}/status for lower payload size

---

Related APIs

• POST /v1/checkout_intents

• GET /v1/checkout_intents/{checkout_intent_id}/status

---

End of document.