Order Status
The status field in payment APIs (Create payment, Query order, Payment callback) indicates the current order state. Use status for business logic (e.g. ship or settle only when Success).
Status overview
| Status | Description | Typical usage |
|---|---|---|
Processing | Processing, awaiting payment | Order created successfully; payment link returned to merchant; waiting for user to complete payment |
Success | Payment successful | Order payment has been completed |
Failed | Failed | Order creation failed, or payment channel returned failure |
Refunded | Fully refunded | After a successful payment, the order has been fully refunded via the refund API |
Partial_Refunded | Partially refunded | After a successful payment, one or more partial refunds have been completed, with some amount still remaining |
Status details
Processing
Order creation has succeeded; the platform has generated a payment link and returned it to the merchant. The merchant directs the user to that link and waits for the user to complete payment. In this state, use the async callback or poll the query API until the order becomes Success or Failed.
Success
Order payment has been completed. Only when callback or query returns Success should you run the above business logic.
Failed
- Order creation failed: The create API returns
Failedwhen the order is not created (e.g. risk rejection, invalid parameters). - Payment channel returned failure: User payment rejected, insufficient balance, channel error, etc.; you will see
Failedin callback or query.
Do not expect a Failed order to later become successful; prompt the user or create a new order as needed.
Refunded
The order was paid successfully and later fully refunded through the refund API.
Partial_Refunded
The order was paid successfully and later received one or more partial refunds, with some remaining amount not refunded.
Status by API
| API | Possible statuses |
|---|---|
| Create payment | Success, Failed |
| Query order | Processing, Success, Failed, Refunded, Partial_Refunded |
| Payment callback | Success, Failed, Refunded, Partial_Refunded (final states) |
Related
- Create payment: Response includes order status
- Query order: Get current status by order id
- Payment callback: Async notification status, verification, idempotency