跳转到主要内容

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.

通过 orderId 获取任何订单(收款或付款)的当前状态和完整详情。此端点需要身份认证,用于商家服务器到服务器的通信。

请求

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

路径参数

orderId
string
必填
您在创建收款或付款时指定的订单标识符。

cURL

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

响应

成功的请求返回 HTTP 200,带 R<NotifyOrder> 信封。

NotifyOrder 对象

orderId
string
创建收款或付款时使用的订单标识符。
uid
string
与订单关联的用户标识符(如果提供)。
orderType
string
订单类型:COLLECTIONPAYOUT
status
string
当前订单状态:
  • INIT — 订单已创建,等待客户支付
  • PENDING — 检测到交易,等待确认
  • PENDING_CONFIRMATION — 等待区块确认
  • SUCCESS — 支付已成功确认
  • EXPIRED — 订单过期,未收到支付
  • FAILED — 交易失败
reason
string | null
如果订单失败或过期,此字段包含原因。否则为 null
amount
string
请求的金额,十进制字符串格式。
actualAmount
string
实际收到/支付的金额。由于网络费用或部分支付,可能与 amount 不同。确认前为 null
fee
string
扣除的平台处理费用。零费用配置下为 "0"
transaction
object | null
区块链交易详情。检测到交易前为 null。详见下方。

Transaction 对象

chain
string
区块链网络。
symbol
string
代币符号。
txid
string
区块链交易哈希。
from
string
发送方的区块链地址。
to
string
接收方的区块链地址。
amount
string
十进制格式的转账金额。
blockNum
integer
包含此交易的区块号。
confirmedNum
integer
已收到的区块确认数。
status
string
区块链交易状态:PENDINGSUCCESSFAILED
timestamp
integer
交易被包含在区块中的 Unix 时间戳。

示例响应

{
  "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
    }
  }
}
Last modified on May 31, 2026