Query Payment Checkout
Query the status of a previously created payment checkout session using its checkoutId. Returns checkout-level status, amount, and the linked transactionId.
When to Use
▾
Use this endpoint when:
- Polling for payment status during a direct checkout flow
- Confirming a checkout session is complete before redirecting the customer
Payment checkout is not the same as payment transaction info. Checkout only returns status, amount, and redirectUrl. For full transaction details, use Query By Transaction ID with the transactionId from the checkout response.
Direct Payment Checkout requires polling this endpoint to keep payment status updated. Suggested polling interval is 3–5 seconds.
How to Use
▾
/v3/payment/online?checkoutId={checkoutId}Step 1: Get the Checkout ID
▾
Capture checkoutId from the Hosted Payment Checkout response.
Step 2: Send the Query
▾
GET /v3/payment/online?checkoutId=<id>.
Step 3: Poll Until Complete
▾
Repeat every 3-5 seconds until status reaches a terminal state.
Request Parameters
▾
Payment checkout ID (query parameter)
Response Parameters
▾
"SUCCESS" if the request succeeded.
Error details
Error code.
Error message.
Debug message (sandbox only).
Response item
Payment checkout ID.
Payment checkout type.
Payment transaction ID. Use this to query the transaction via Query Transaction.
Order details
Order ID.
Order title.
Order currency type.
Order amount.
Order detail.
Order additional data.
Payment checkout platform.
Payment checkout available methods.
Payment redirect URL.
Payment notify URL.
Payment checkout start date time.
Payment checkout status.
Payment checkout created date time.
Payment checkout last updated date time.