必读说明

请求地址

测试服务地址 https://xxx.a.com 请使用此地址拼接请求地址，例如订单查询 https://xxx.a.com/api/v1/openapi/card/query

服务地址请咨询商务获取

1. customerId为商户ID，商户密钥为双方通信加密使用，所有请求无需传递原文密钥，请咨询商务获取
2. 所有接口请使用post application/json请求
3. 接口地址未经授权，禁止告诉任何非合作公司或个人
4. 异步回掉http code == 200 是正确接受，最大尝试通知3次，请务必支持冥等！
5. 参数不符合约定内容，可能返回http 500 错误

提交卡密

请求地址

/api/v1/openapi/card/submit

sign生成规则

customerId&orderNo&productCode&face&cardNo&cardPassword&notifyURL&商户密钥 md5加密后转小写 其中cardNo cardPassword须未加密计算sign

卡号卡密加密方式

加密密钥为商户密钥的前32位 AES/ECB/PKCS5Padding 128位 结果hex

java加密示例

   /**
     * AES加密
     *
     * @param data
     * @return
     * @throws Exception
     */
    public static String encrypt(String data, String keyStr) throws Exception {
        Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding");
        SecretKeySpec key = new SecretKeySpec(keyStr.getBytes(StandardCharsets.UTF_8), "AES");
        cipher.init(1, key);
        return HexBin.encode(cipher.doFinal(data.getBytes(StandardCharsets.UTF_8)));
    }

    /**
     * AES解密
     *
     * @return
     * @throws Exception
     */
    public static String decrypt(String base64Data, String keyStr) throws Exception {
        Cipher cipher = Cipher.getInstance("AES/ECB/PKCS5Padding");
        SecretKeySpec key = new SecretKeySpec(keyStr.getBytes(StandardCharsets.UTF_8), "AES");
        cipher.init(2, key);
        return new String(cipher.doFinal(HexBin.decode(base64Data)));
    }

PHP加密示例

bin2hex(openssl_encrypt('需要加密的内容', 'aes-256-ecb', '32位密钥', OPENSSL_RAW_DATA))

请求示例

{
    "batchNo": "D1000010",
    "cardNo": "7D5C813D566EDEB336997FC49A7F72B2FC3E5D0631E90681685820FA578D06C8",
    "cardPassword": "F7A21C51BA90005326ECFCEF0AF592EDFC3E5D0631E90681685820FA578D06C8",
    "customerId": 5,
    "face": 100,
    "notifyURL": "https://baidu.com",
    "orderNo": "F1000899900",
    "productCode": 5,
    "sign": "cb40e654a76cfe3d2ea3d5585ef84fb2"
}

返回示例

提交成功

{
    "customerId": 5,
    "orderNo": "F100089990002",
    "remarks": "提交成功",
    "status": "Ok"
}
提交失败
{
    "customerId": 5,
    "orderNo": "F100089990002",
    "remarks": "卡已有处理中记录",
    "status": "F006"
}

返回参数说明

提交结果状态说明

订单查询

请求URL

/api/v1/openapi/card/query

sign生成规则

customerId&orderNo&商户密钥 md5加密后转小写

返回示例

销卡失败
 {
    "orderNo": "F1000899901110",
    "remarks": "卡无效",
    "status": "Fail"
}
销卡成功状态
{
    "settlementAmount": 87.0000,
    "customerId": 5,
    "finishTime": "2021-08-31 17:14:17",
    "orderNo": "F1000899900",
    "actualFace": 100,
    "remarks": "销卡成功",
    "status": "Ok",
    "systemOrderNo": "F16299501209738407332"
}

返回参数说明

状态说明

异步通知

请求示例

销卡成功
{
    "actualFace": 1000,
    "customerId": 20000,
    "finishTime": "2021-09-17 11:04:10",
    "orderNo": "F16318478480965062625",
    "productCode": 100000,
    "remarks": "销卡成功",
    "settlementAmount": "862.0000",
    "sign": "5ad56153c2e3be079a79f7d2d062847e",
    "status": "Ok",
    "systemOrderNo": "JW1631847849423F1000"
}
其他状态
{
    "actualFace": 0,
    "customerId": 20000,
    "finishTime": "2021-09-17 11:04:10",
    "orderNo": "F16318478480965062625",
    "productCode": 100000,
    "remarks": "卡有处理记录",
    "settlementAmount": "0.0000",
    "sign": "5ad56153c2e3be079a79f7d2d062847e",
    "status": "Fail",
    "systemOrderNo": "JW1631847849423F1000"
}

请求参数说明

sign生成规则

customerId&orderNo&systemOrderNo&productCode&status&actualFace&settlementFace&settlementAmount&商户密钥 md5加密后转换成小写

status 说明

Ok 核销成功
Process 处理中
Fail 销卡失败

取消订单

请求URL

/api/v1/openapi/card/cancel

请求参数

sign生成规则

customerId&orderNo&商户密钥 md5加密后转小写

返回示例

取消失败
 {
    "message": "暂不支持取消",
    "orderNo": "F1000899900",
    "status": "F999"
}

取消已被受理
 {
    "message": "success",
    "orderNo": "F1000899900",
    "status": "Ok"
}

返回参数说明

状态说明

xxxxxxxxxx
Ok 取消被受理
F999 取消失败