Ctrlk

API Doc - Checkout Intent Routes - Get Checkout Intent

AllScale Open API Version: v5 Last updated: 2026-05-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

Path Parameters

Parameter
Type
Required
Description

checkout_intent_id

string

✅

AllScale checkout intent ObjectId string

Headers

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

Successful Response

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 | null

Fiat currency enum value. null when the intent was priced natively in a stable coin.

currency_symbol

string | null

Fiat currency symbol (e.g. USD). null when the intent was priced natively in a stable coin.

amount_cents

int | null

Amount in fiat cents. null when the intent was priced natively in a stable coin — the authoritative amount is amount_coins.

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 | null

Fiat → stable coin conversion rate. null when the intent was priced natively in a stable coin (no FX occurred).

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.

accepted_stable_coins

int | null

StableCoinFlag bitmask of stablecoins the payer may settle in for this intent (1 = USDT, 2 = USDC, 3 = either; bit n = StableCoin enum value n+1). null on intents created before the multi-coin rollout.

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

Appendix — Checkout Intent Status Enum

Value

Name

Meaning

Terminal

-1

FAILED

Checkout failed due to internal or processing error

✅

-2

REJECTED

Rejected by KYT (Know Your Transaction) checks

✅

-3

UNDERPAID

Paid amount is less than required

✅

-4

CANCELED

User manually canceled the checkout

✅

-5

TIMEOUT

Checkout expired due to inactivity or time limit

✅

1

CREATED

Checkout intent created, not yet viewed by user

❌

2

VIEWED

Hosted checkout page has been opened by the user

❌

3

TEMP_WALLET_RECEIVED

Temporary deposit wallet assigned (KYT flow only)

❌

4

MANUAL_OPERATION

Stuck in TEMP_WALLET_RECEIVED; pending manual review

❌

5

SEND_BACK

Refund in progress back to payer (KYT or underpaid)

❌

10

ON_CHAIN

On-chain transaction detected, awaiting confirmation

❌

20

CONFIRMED

Payment confirmed successfully on-chain

✅

End of document.

PreviousAPI Doc - Checkout Intent Routes - Get StatusNextAPI Doc - Optional Response Signing

Last updated