1. 通信协议

商户接入HaiPay服务，调用API须遵循以下规则：

类型	说明
传输方式	为保证交易安全性，采用HTTPS传输
提交方式	采用POST方法提交
数据格式	提交和返回数据都为application/json格式
字符编码	统一采用UTF-8字符编码
签名算法	SHA256WithRSA
签名要求	请求和接受数据均需要校验签名，详细方法参考 配置与签名
SSL/TLS协议版本	TLSv1.2 TLSv1.3

2. 接口结构

如下是调用HaiPay接口的http结构，接口名称放到请求地址后面，data里边的内容为不同业务结构拼接而成的报文

POST https://uat-interface.haipay.asia/{币种}/{接口地址}
{
    "appId": 1054,
    "orderId": "M233323000059",
    ...
    // sign: 根据请求body使用merchant privateKey签名
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="  
}

请求地址：

联调环境	请求地址
测试	https://uat-interface.haipay.asia
生产	上线提供

3. 接口列表

产品	接口名称	接口地址	描述
代收	代收申请	/collect/apply	用户向商户进行付款
	代收查询	/collect/query
	退款申请	/refund/apply
代付	代付申请	/pay/apply	用户向商户进行付款
	代付查询	/pay/query
账户余额	查询账户	/account/ledger	商户进行余额查询

详情查看 接口文档 。

4. 参数

请求接口公共参数

参数名	必选	类型	说明
appId	是	Integer	业务ID（后台获取）
sign	是	String	签名（详情查看 配置与签名）

请求示例：

{
    "appId": 1000,
    ......
    "sign": "fCywFPOojpRIPi4ph81+CwoAvMXV1va2XR1DQVJeGnZwzNVd0hmvpud7nbP/3lc5JeTVELomruwVTGLtr+BTGT0IweAFTGNvNUuqOs3I4KG5tjvhPM7wm9NtwK2uAX1niLoylt4DcLfy2TeaxPQYDCJJRf7Qm7sDwJX5VoFt8RO9EC2ih+0Ike2+cAyRpIfKENPoIGQbUwvH6KkzHzjljcuvcSqq4D+iZid7up58A866RFrrJH9vkwaF+2mYxa/7awQIwAq8HPOxHkzLfVg74MZC8I1TOKvQAxkAquoNMMyrcAqRIopURfrgEaAtyW/ThPdyduYVlFeMg7BkpGLqZQ=="
}

响应接口公共参数

参数名	必选	类型	说明
status	是	String	1：正常，0：异常
error	是	String	错误编码
msg	是	String	错误描述
data	是	Object	业务数据(参与验签)

响应示例：

{
    {
        "status": "1",
        "error": "00000000",
        "msg": "",
        "data": {
            ......
            "sign": "PWA7B2u1hGr1VRxOCZbRuXQXtJiA6BgPExFnFv73hKJ+zcZfOe/R+y+inlwWcdDBzfix35+dl6raEs/yG/hcYyQOwDQ+mVjIt5wFk6iX7GPw557138yBdAmuMqvWM2IF+omLFcQFJvzfbR84rCyOmebDJlhkYMga5TTFHVLicUx3bPIrOJLoWJHrnZfcVFAJ+P5mUQhMH/cf+YmYZvrqq34pMJh6PcP5vyruJ8aNV0QfyHR42AHLIgp+HnOcZpA0aUzFXM5zpsgXK3QR/KO3vLiKd77UaZNO6g5TN/Ck2MtLkBVxyvIHstgXFXKF1e+uc91FdBHK5nfmrjLQ2wyeUA=="
        }
    }
}

错误编码

错误编码	英文回复	中文含义
1001	param is null	参数为空
1002	Illegal Param	非法参数
1003	system exception	系统异常(订单可能已入库，等待异步通知或者查询结果确定最终状态)
1004	system is busy	系统繁忙(订单可能已入库，等待异步通知或者查询结果确定最终状态)
4005	order already exit	订单已存在
4011	appId do not exit	业务ID不存在
4012	you do not have an available product, please connect admin	商户业务不可用，联系管理员
4012	product do not available, please connect admin	费率产品不可用，联系管理员
4013	order not exit	订单不存在
4014	order is already end status	订单为终态
4015	this merchant do not have a collect bank	没有可用的收款账号
4016	your account do not have enough money	账号余额不足
4031	ip adress is Forbidden	非法IP
5012	pay in channel not functional, please connect customer service	系统异常