订单信息查询

# 代码示例

import com.google.gson.JsonObject;
public class OrderQuery {

  //MCH_ID: 商户ID
  //请登录商户后台,点击 个人中心 > 个人信息 在基本信息中获取商户ID
  private static final String MCH_ID = "S820211021094748000001";  // 商户号
  private static final String PLAT_PUBLIC_KEY = "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC2JoMfFqLsSJjAiCahEnlP3aRj8yCT+WHzR+VvPBTw9S1i7iYWb+MY09CG/HYuHF4+IxshXDJygmndxKf/esuwPybS8mAd//yubHpmZsmBqg1FffT8VH1APa6ZRWASUp4U01ZrbCCp35QA8FuWrJGMJxGx4xk7KUtV2yujxC8noQIDAQAB";  // 平台公钥
  private static final String MCH_PRIVATE_KEY = "MIICeAIBADANBgkqhkiG9w0BAQEFAASCAmIwggJeAgEAAoGBAJU8gKFKD0luIYx7X8+JRdCIE0UDBctS6LjXxWLEv/EO7jDBTid6zYP1KmNgpd2DAWWtBFBSQ+gcNwVZZSBHJiSDqVvvJVs2FEbeBvfdv4X93+IYRAXksBasSW5Tpdshbo82pVL4V7wuKCuFLk9UxBHbpQjWAbfyF66RmwIbZD71AgMBAAECgYBjPe7UU2nDDSfmQg0++CyjNjqKRC5QPfxhH6w1uF1kMueXKJWOj42n2RutJpJmsj31nY8m0u4xpsG4HvCu/GGSFhhKZCHLvzp41oY2ubYj9nuFNU//81LycQjulWo2y0UUBY0k2piEt+SwPaiUNbT6nMxNMjlnjRe2okp/3rw+KQJBANG3YlZWoVbCEqzy64bJJLxiPsCA5ErGB0NzRGitq44xkhqGtR8ZZQyVz40pruNa58d73O2xyJSy5+fmZGn4E+sCQQC2LBnguj0CSCKub0mPDcunTTz9V79VXBBZdlB1/YGmRUx2s4sQrJNZS7rL4EqBQ3maIRnG+s+AXCSTfsYrV6CfAkEAxugnVfpelhoGepEAgNuggyivmgfl/2Gpm/jk5l/qOjib+ZrQiQmeBPzGWX4yiSM8eMDrP2sC8r5pJFMp5DRONwJBAJ4n4XuSFJ9jgwCPy3vvzSv9SYLk6E6yM9uHdUlKgoGYzk6Lh6M9QFuY/J49plFdBDiEnj16yCU3WeXXfTJpzB8CQQDMNMR/rIOTE9xGybS3mlQbt22AUnO6XhupWcckEKW4nPGxATwYBQzCY3i/9FTGN0vA+9ZPC2cwHtNxI2kXf3Vp";  // 商户私钥
  private static final String orderQueryUrl = "https://id-openapi.toppay.asia/gateway/query";

  public static void main(String[] args) throws Exception {
    // 代收
    query();
  }
  private static void query() throws Exception {
    Map<String, String> requestParams = new TreeMap<>();
    requestParams.put("merchantCode", MCH_ID);
    requestParams.put("queryType", "CASH_QUERY"); // 支付渠道
    requestParams.put("orderNum", "186888188666"); // 商户订单号
    requestParams.put("platOrderNum", "PRE186888188666"); // 平台订单号
    requestParams.put("dateTime", "20220101105500"); // 时间戳 格式 yyyyMMddHHmmss

    StringBuilder stringBuilder = new StringBuilder();
    for (String key : requestParams.keySet()) {
      stringBuilder.append(requestParams.get(key)); // 拼接参数
    }

    String keyStr = stringBuilder.toString(); // 得到待加密的字符串
    System.out.println("keyStr:" + keyStr);
    String signedStr = TopPayRequestUtil.privateEncrypt(keyStr, TopPayRequestUtil.getPrivateKey(MCH_PRIVATE_KEY)); // 私钥加密
    requestParams.put("sign", signedStr);

    String postJson = new Gson().toJson(requestParams);
    System.out.println("Post Json Params:" + postJson);

    String responseJson = TopPayRequestUtil.doPost(orderQueryUrl, postJson); // 发送 post json 请求
    System.out.println("Response Msg:" + responseJson);
  }
}
暂无示例
暂无示例
暂无示例
暂无示例
暂无示例

# 请求地址

  • 请求方式:POST
  • 请求地址:https://id-openapi.toppay.asia/gateway/query

# 请求参数

  • 注:商户订单号和平台订单号两者必需传递其中一个,也可以同时传递
参数 是否必填(Y-是,N-否) 描述 示例
merchantCode Y 商户ID,在商户平台-个人中心-个人信息中获取 S820190712000002
queryType Y 查询类型
代收: ORDER_QUERY
代付: CASH_QUERY
ORDER_QUERY
orderNum Y 商户订单号 T1231511321515
platOrderNum Y 平台订单号 PRE1234567890
dateTime Y 时间戳 (格式:yyyyMMddHHmmss) 20191018105510
sign Y RSA签名 ja6R8eukQ...

# 请求报文示例

{
  "dateTime": "20220101105500",
  "merchantCode": "S820211021094748000001",
  "orderNum": "T1642593166888",
  "platOrderNum": "PRE1642593166888",
  "queryType": "ORDER_QUERY",
  "sign": "lGw1OJcuUL0MGaIq44U2u2bFM5dalJJuT/G6mQWbIBT9dmVAJaLwR125emPDXYYSdnOtNxja86A2VJJLf40BCg2HevHolebvt2ay3ukCQaUhwNkIGz4KF0Ud+XMUA36LoFTWZbDYv9y8vgCnWxwZFKj7ePrfLxc+TA7jpqv65lQ\u003d"
}

# 响应参数说明(格式参考-代收订单查询响应报文示例)

参数 类型 必填 描述 示例
success BOOLEAN Y 接口响应 true/false
code int Y 接口响应码 1000 代表查询成功,其他的都为查询失败
message String Y 接口响应信息 返回具体响应信息
data Json Y 接口响应参数 以下参数都在 data 中返回,如失败则为null
msg String Y 订单状态详细信息 Request Transaction Success
platOrderNum String Y 平台订单号 PI1453242857400963072
amount String Y 支付金额 1500
fee String Y 手续费金额 5
orderNum String Y 商户订单号 23645782
inAddress String N 入账地址 TLRx8JXsDidC7PYVLmeD6Bhk5k5CUjnPV3
sendAddress String N 出账地址 TLRx8JcxDidC7PYVLmeD6Bhk5k5CUjnPV3
platRespCode String Y 请求业务是否成功 FAIL:失败\SUCCESS:成功
platRespMessage String Y 接口响应信息提示 Request Transaction Success
status int/String Y 订单状态 代收状态返回 string 类型,代付状态返回 int 类型
  • 代收订单响应报文示例
{
  "success": true,
  "code": 1000,
  "message": "Success",
  "data": {
    "msg": "Payment Success",
    "platOrderNum": "BCA1483771634191044608",
    "amount": "150",
    "fee": "16",
    "orderNum": "T1642593166888",
    "platRespCode": "SUCCESS",
    "platRespMessage": "success",
    "status": "SUCCESS"
  }
}
  • 代付订单响应报文示例
{
  "success": true,
  "code": 1000,
  "message": "Success",
  "data": {
    "msg": "test cash",
    "platOrderNum": "W0620220119174331000001",
    "amount": "125",
    "fee": "7",
    "orderNum": "186888188666",
    "platRespCode": "SUCCESS",
    "platRespMessage": "success",
    "status": 2
  }
}