Skip to main content

Documentation Index

Fetch the complete documentation index at: https://neilyan.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

A lightweight endpoint that returns only the order’s current status. Use this for polling scenarios where you need to check whether a payment has been confirmed without retrieving the full order details.

​
Request

GET http://your-gateway:3010/v1/order/getOrderStatus?orderId={orderId}&sign={sign}

​
Query Parameters

​
orderId
string
required
The order identifier. Example: order_1042.
​
sign
string
required
HMAC-SHA256 signature computed over the orderId value.

​
cURL

curl "http://your-gateway:3010/v1/order/getOrderStatus?orderId=order_1042&sign=a1b2c3d4e5f6..."

​
Response

A successful request returns HTTP 200 with the R<PaymentOrderStatus> envelope.

​
PaymentOrderStatus Object

​
status
string
Current order status:
  • INIT — Awaiting payment
  • PENDING — Transaction detected
  • PENDING_CONFIRMATION — Awaiting block confirmations
  • SUCCESS — Payment confirmed
  • EXPIRED — Order expired
  • FAILED — Payment failed

​
Example Response

{
  "code": 200,
  "msg": "success",
  "data": {
    "status": "SUCCESS"
  }
}

​
Usage Example

// Polling loop for payment confirmation
async function waitForPayment(orderId, token) {
  const sign = computeSign(orderId, token);

  for (let i = 0; i < 120; i++) {
    const response = await fetch(
      `http://your-gateway:3010/v1/order/getOrderStatus?orderId=${orderId}&sign=${sign}`
    );
    const result = await response.json();

    if (result.data.status === "SUCCESS") {
      console.log("Payment confirmed!");
      return true;
    }
    if (result.data.status === "EXPIRED" || result.data.status === "FAILED") {
      console.log("Payment failed or expired");
      return false;
    }

    await new Promise(r => setTimeout(r, 2000)); // poll every 2 seconds
  }
  return false;
}