账户余额查询
# 代码示例
- 代码示例仅供参考,具体参数说明请参考请求参数说明
import com.google.gson.JsonObject;
public class BalanceQuery {
//MCH_ID: 商户ID
//请登录商户后台,点击 个人中心 > 个人信息 在基本信息中获取商户ID
private static final String MCH_ID = "S820250514103726000009";
// 平台公钥
private static final String PLAT_PUBLIC_KEY = "MIGfMA0GCSqG.........iDtQIDAQAB";
// 商户私钥(商户自己生成,需要防止泄露)
private static final String MCH_PRIVATE_KEY = "MIICeAIBAD9Fz0.......jKTtoWN6j3F1V0bdyvhh";
private static final String BALANCE_QUERY_URL = "https://vnm-openapi.toppay.asia/gateway/interface/getBalance";
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("currency", "VND"); // 币种(VND)
List<String> paramNameList = new ArrayList<>();
for (String key : maps.keySet()) {
paramNameList.add(key);
}
Collections.sort(paramNameList);
StringBuilder stringBuilder = new StringBuilder();
for (String key : paramNameList) {
// 拼接参数
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);
// 发送 post json请求
String responseJson = TopPayRequestUtil.doPost(orderQueryUrl, postJson);
System.out.println("Response Msg:" + responseJson);
}
}
# 请求地址
- 请求方式 : POST
- 请求地址 : https://vnm-openapi.toppay.asia/gateway/interface/getBalance
# 请求参数
| 参数 | 必填 | 类型 | 示例 |
|---|---|---|---|
| merchantCode | Y | 商户ID | S820211021094748000001 |
| currency | N | 币种 | VND(不传展示所有货币单位的余额) |
| sign | Y | RSA签名 | ja6R8eukQ... |
# 请求报文示例
{
"merchantCode": "S8202110212321300001",
"currency": "VND",
"sign": "X/o+IQUzLJqYe9Feid9Uww72mJGOvhJSJEIfo1EUChrZyVZnzGHtd61QhOqRmXCtAwk7V7k="
}
# 响应参数
| 参数 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| success | BOOLEAN | Y | 接口响应 | true/false |
| code | int | Y | 接口响应码 | 1000代表成功,其他的都为失败 |
| message | String | Y | 接口响应信息 | 返回具体响应信息 |
| data | Json | Y | 接口响应参数 | 以下参数都在data中返回,如失败则为null |
| mchId | String | Y | 商户ID | S8202110212321300001 |
| mchName | String | Y | 商户名称 | test |
| mchNo | String | Y | 商户编号 | TP123 |
| currency | String | Y | 币种 | VND |
| balance | String | Y | 可用余额 | 1000.00 |
| freeze | String | Y | 冻结余额 | 10.00 |
| waitingSettleAmount | String | Y | 待结算金额 | 200.00 |
| freezeWaitingSettleAmount | String | Y | 冻结待结算金额 | 100.00 |
| totalAmount | String | Y | 全部金额(可用余额+冻结余额+待结算金额+冻结待结算金额) | 20000.00 |
# 响应报文示例
{
"success": true,
"code": 1000,
"message": "SUCCESS",
"data": [
{
"mchId": "S82022091232130000001",
"mchName": "test",
"mchNo": "test",
"country": "VIETNAM",
"currency": "VND",
"balance": "1000000.01",
"freeze": "10.00",
"waitingSettleAmount": "10.00",
"freezeWaitingSettleAmount": "20.00",
"totalAmount": "1000040.01"
}
]
}