Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xpaylabs.com/llms.txt

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

Fetch the current status and full details of any order (collection or payout) by its orderId. This endpoint is authenticated and intended for merchant server-to-server use.

​
Request

GET http://your-gateway:3010/v1/order/status/{orderId}

​
Path Parameters

​
orderId
string
required
The order identifier you specified when creating the collection or payout. Example: order_1042.

​
cURL

curl http://your-gateway:3010/v1/order/status/order_1042 \
  -H "Content-Type: application/json"

​
Response

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

​
NotifyOrder Object

​
orderId
string
The order identifier that was used when creating the collection or payout.
​
uid
string
The user identifier associated with the order, if provided.
​
orderType
string
The type of order: COLLECTION or PAYOUT.
​
status
string
Current order status:
  • INIT — Order created, awaiting customer payment
  • PENDING — Transaction detected, awaiting confirmations
  • PENDING_CONFIRMATION — Waiting for block confirmations
  • SUCCESS — Payment confirmed successfully
  • EXPIRED — Order expired without payment
  • FAILED — Transaction failed
​
reason
string | null
If the order failed or expired, this field contains the reason. null otherwise.
​
amount
string
The requested amount as a decimal string (e.g., "250.00").
​
actualAmount
string
The actual amount received/paid. May differ from amount due to network fees or partial fills. null until confirmed.
​
fee
string
The platform handling fee deducted (if applicable). "0" for zero-fee configurations.
​
transaction
object | null
Blockchain transaction details. null until a transaction is detected. See below.

​
Transaction Object

​
chain
string
The blockchain network (e.g., "TRON", "ETH", "BSC").
​
symbol
string
The token symbol (e.g., "USDT").
​
txid
string
The blockchain transaction hash.
​
from
string
The sender’s blockchain address.
​
to
string
The receiver’s blockchain address.
​
amount
string
The transfer amount in decimal format.
​
blockNum
integer
The block number where the transaction was included.
​
confirmedNum
integer
The number of block confirmations received.
​
status
string
Blockchain transaction status: PENDING, SUCCESS, or FAILED.
​
timestamp
integer
Unix timestamp of when the transaction was included in a block.

​
Example Response

{
  "code": 200,
  "msg": "success",
  "data": {
    "orderId": "order_1042",
    "uid": "user_42",
    "orderType": "COLLECTION",
    "status": "SUCCESS",
    "reason": null,
    "amount": "250.00",
    "actualAmount": "249.50",
    "fee": "0.00",
    "transaction": {
      "chain": "TRON",
      "symbol": "USDT",
      "txid": "a1b2c3d4e5f6...",
      "from": "TXyz...",
      "to": "TWkKZkmuB8DpVeiMoHiKf99ZoFHzk73CqR",
      "amount": "250.00",
      "blockNum": 12345678,
      "confirmedNum": 3,
      "status": "SUCCESS",
      "timestamp": 1717000123
    }
  }
}