POST/api/v2/order/info

查询订单信息

通过 Cregis 订单编号查询订单信息。

频率限制： 1000 次/分钟

请求

请求体

required

application/json

noncestringrequired
6位随机字符串
pidinteger<int64>required
项目编号
signstringrequired
签名
timestampinteger<int64>required
时间戳
cregis_idstringrequired
Cregis 订单编号

响应

200成功

application/json

codestring
返回码
msgstring
返回信息
dataobject
- cregis_idstring
  Cregis 订单编号
- order_idstring
  商家订单编号
- order_amountstring
  订单金额
- order_currencystring
  订单币种
- created_timeinteger<int64>
  订单创建时间以13位unix时间戳格式
  
  e.g. 1750407942433 , i.e. 2024-07-09 14:57:49 092
- cancel_timeinteger<int64>
  订单取消时间以13位unix时间戳格式
  
  e.g. 1750407942433 , i.e. 2024-07-09 14:57:49 092
- transact_timeinteger<int64>
  订单完成时间以13位unix时间戳格式
  
  e.g. 1750407942433 , i.e. 2024-07-09 14:57:49 092
- valid_timeinteger<int32>
  单位：分钟
  
  订单的有效时间。如超过有效时间，将不可以再支付。
- statusstring
  enum: "new", "paid", "expired", "paid_over", "paid_partial", "canceled"
  订单状态
  
  new待支付
  
  paid已支付
  
  expired订单超出有效时间
  
  paid_over付款超出订单金额
  
  paid_partial付款小于订单金额
  
  canceled订单已取消，如已完成退款
- refund_requestedstring
  enum: "yes", "no"
  订单是否发生退款
  
  no无退款记录
  
  yes有退款记录
- payer_idstring
  付款人信息
- payer_namestring
  付款人名称
- payer_emailstring
  付款人邮箱
- remarkstring
  订单备注信息
- payment_detailarray<object>
  付款记录
  数组元素 · object
  payment_addressstring
  充值地址
  from_addressstring
  支付方地址
  receive_amountstring
  汇率转换后的订单金额
  receive_currencystring
  汇率转换后的订单币种
  pay_amountstring
  实际到账金额
  pay_currencystring
  到账币种
  exchange_ratestring
  汇率
  tx_idstring
  交易hash
  blockchainstring
  货币网络
  token_namestring
  链上币种展示名称。用于区分同一资产在不同网络或协议标准下的版本，例如 USDT-TRC20、USDT-ERC20。
- payment_infoarray<object>
  请求付款信息
  数组元素 · object
  payment_addressstring
  充值地址
  token_symbolstring
  支付币种符号。表示加密货币资产本身的代码，例如 USDT、BTC、ETH；不包含区块链网络信息。
  blockchainstring
  货币网络
  token_namestring
  链上币种展示名称。用于区分同一资产在不同网络或协议标准下的版本，例如 USDT-TRC20、USDT-ERC20。
  logo_urlstring
  货币logo地址
  token_decimalsinteger
  代币精度
  receive_amountstring
  汇率转换后的该收订单金额
  receive_currencystring
  汇率转换后订单货币代码
  exchange_ratestring
  货币汇率
  asset_logostring
  币种标识logo
- refund_dataobject
  退款订单相关讯息
  refund_statusinteger
  enum: 0, 1, 2
  退款状态
  
  0退款处理中
  
  1退款成功
  
  2退款失败
  
  refund_idstring
  Cregis退款订单编号
  cregis_idstring
  Cregis支付订单唯一编号
  reference_idstring
  商家内部的原订单编号
  recipient_idstring
  商家内部的客户编号
  recipient_namestring
  退款收款人姓名
  recipient_emailstring
  退款收款人邮箱
  recipient_addressstring
  退款收款人的链上地址
  tokenstring
  退款订单的币种填入加密货币token_name，格式：USDT-BEP20，USDT-TRC20
  networkstring
  退款订单的网络 blockchain
  refund_amountstring
  退款金额
  refund_feestring
  退款所需gas fee
  refund_tx_idstring
  退款交易哈希
  refund_created_timeinteger<int64>
  退款订单创建时间以13位unix时间戳格式
  
  e.g. 1720508269092 ,i.e. 2024-07-09 14:57:49 092
  refund_transact_timeinteger<int64>
  退款订单最后更新时间以13位unix时间戳格式
  
  e.g. 1720508269092 ,i.e. 2024-07-09 14:57:49 092
  actual_refund_amountstring
  扣减矿工费后的实际退款金额
  typeinteger
  enum: 1, 2
  退款类型
  
  1部分退款
  
  2全额退款
- order_details
  shopping_costnumber
  订单的运费
  tax_costnumber
  订单的税费
  itemsarray
  订单内购买商品的详情
  数组元素
  item_idstring
  商品唯一ID
  item_namestring
  商品名称
  item_pricenumber
  商品价格
  price_currencystring
  商品币种
  item_quantityinteger<int64>
  商品数量
- settlement_statusstring
  enum: "unsettled", "settling", "settled"
  结算状态
  
  unsettled尚未结算
  
  settling正在结算
  
  settled结算已完成
- settlement_typestring
  enum: "system", "manual"
  结算类型
  
  system自动结算
  
  manual手动结算
- sub_merchant
  sub_merchant_idstring
  子商户唯一编号
  sub_merchant_namestring
  子商户名称

在线测试

该接口由服务端签名，无需在此填写密钥。

请求体 (JSON)

请求示例

application/json

{
  "nonce": "m8jisx",
  "pid": 1382528827416576,
  "sign": "cebd2bfd56766f1143dc40d078b64dac",
  "timestamp": 1687848653294,
  "cregis_id": "po1420761885130752"
}

响应示例

200 · application/json

{
  "code": "00000",
  "msg": "ok",
  "data": {
    "cregis_id": "po1420761885130752",
    "order_id": "merchant_order_id_123",
    "order_amount": "5.00",
    "order_currency": "HKD",
    "created_time": 1687848653294,
    "cancel_time": 1687850453294,
    "transact_time": 1687849000000,
    "valid_time": 30,
    "status": "paid",
    "refund_requested": "no",
    "payer_id": "user_001",
    "payer_name": "张三",
    "payer_email": "[email protected]",
    "remark": "购买商品",
    "payment_detail": [
      {
        "payment_address": "TUX9zGoPFVXd6RC7pg18nfVLATeN9vgBeX",
        "from_address": "sender_wallet_address",
        "receive_amount": "5.123456",
        "receive_currency": "USDT",
        "pay_amount": "5.00",
        "pay_currency": "USDT",
        "exchange_rate": "0.9775",
        "tx_id": "abc123def456...",
        "blockchain": "TRON",
        "token_name": "USDT-TRC20"
      }
    ],
    "payment_info": [
      {
        "payment_address": "TMainWalletAddressXXXXXXXXXXXXXXXXXX",
        "token_symbol": "USDT",
        "blockchain": "TRON",
        "token_name": "USDT-TRC20",
        "logo_url": "https://static.cregis.io/pic/coin/USDT-TRX.png",
        "token_decimals": 6,
        "receive_amount": "5.123456",
        "receive_currency": "USDT",
        "exchange_rate": "0.9775",
        "asset_logo": "https://cdn.cregis.com/tokens/usdt.png"
      }
    ],
    "refund_data": {
      "refund_status": 1,
      "refund_id": "rf1420761885130752",
      "cregis_id": "po1420761885130752",
      "reference_id": "ref_merchant_order_123",
      "recipient_id": "recipient_001",
      "recipient_name": "Refund User",
      "recipient_email": "[email protected]",
      "recipient_address": "TRefundAddressXXXXXXXXXXXXXXXXXX",
      "token": "USDT-TRC20",
      "network": "TRON",
      "refund_amount": "5.00",
      "refund_fee": "0.05",
      "refund_tx_id": "refund_abc123...",
      "refund_created_time": 1719994183015,
      "refund_transact_time": 1719994383015,
      "actual_refund_amount": "4.95",
      "type": 2
    },
    "order_details": {
      "shopping_cost": 10.88,
      "tax_cost": 10,
      "items": [
        {
          "item_id": "10001",
          "item_name": "Product1",
          "item_price": 123,
          "price_currency": "USD",
          "item_quantity": 1
        }
      ]
    },
    "settlement_status": "unsettled",
    "settlement_type": "system",
    "sub_merchant": {
      "sub_merchant_id": "submerchant10001",
      "sub_merchant_name": "Merchant1"
    }
  }
}