跳转到主要内容
如果您要快速理解 HaiPay API,这一页主要回答 3 个问题:支持哪些接入方式、接口通信要遵循什么规则、以及请求结构是什么。

1. 接入方式

接口类型API文档路径适用业务范围功能说明
全球收银台全球(收银台)全球业务一次对接,支持全球多种支付方式。系统根据用户IP自动跳转至对应国家支付页面,用户可选择支付方式完成付款。
本地收银台北美、南美、欧洲、亚洲、中东等单一国家业务单一国家业务独立对接,API同步返回指定国家支持的支付页面,供用户选择并完成支付。
纯API支付接口北美、南美、欧洲、亚洲、中东等单一国家业务单一国家业务独立对接,API同步返回指定支付方式的相关信息,便于客户自定义支付页面。
其他支付接口全球(国际信用卡、信用卡订阅)和稳定币全球业务独立对接,API同步返回支付页面,一次性支付; 信用卡支持订阅扣款。

2. 通信协议

商户接入HaiPay服务,调用API须遵循以下规则:
类型说明
传输方式为保证交易安全性,采用HTTPS传输
提交方式采用POST方法提交
数据格式提交和返回数据都为application/json格式
字符编码统一采用UTF-8字符编码
签名算法SHA256WithRSA
签名要求请求和接受数据均需要校验签名,详细方法参考 配置与签名
SSL/TLS协议版本TLSv1.2 TLSv1.3

3. 接口结构

如下是调用HaiPay接口的http结构,接口名称放到请求地址后面,data里边的内容为不同业务结构拼接而成的报文
POST https://uat-interface.haipay.asia/{币种}/{接口地址}
{
    "appId": 1054,
    "orderId": "M233323000059",
    ...
    "sign": "af0gAHkUOyYHu9owQp8NJ4mPEeUW4vuJcjdxqLIzrVw8AvpLSjD1DXupReSG/CyuSkFRyiIvCp5u703AuGGmfgD2gKDH3Ywau41bAbG2jnHJ8mtjiSJ5iWUzanyd4Kr7d1+rETbzUl7/BkW3t0X8UUFdqpxwG8DPUjAwUKfplWDHV7koG51Ozexd80DCsmW6eWdouAZ1uNXGLYmV3ftE3BmfNRtuv1C5bfTJWrTEIOxbF6g2uYOFZTlIgrQgd7/2PsAYwQQXNz8Q8CYl4OxqCv4pXJxaLWPbR5tqZu9og5kn32C9aHW/NlU1y39vzz+4ef81yPAqUV9oHlSMSPrMmw=="
}
请求地址:
联调环境请求地址
测试https://uat-interface.haipay.asia
生产上线提供

4. 接口列表

产品接口名称接口地址描述
代收代收申请/collect/apply用户向商户进行付款(充值)
代收查询/collect/query
退款申请/refund/apply
代付代付申请/pay/apply商户向用户进行付款(提现)
代付查询/pay/query
账户余额查询账户/account/ledger商户进行余额查询
详情查看 接口文档

5. 参数

请求接口公共参数
参数名必选类型说明
appIdInteger业务ID(后台获取,需要根据URL中的币种传递对应的业务ID)
signString签名(详情查看 配置与签名
请求示例:
{
    "appId": 1000,
    ......
    "sign": "fCywFPOojpRIPi4ph81+CwoAvMXV1va2XR1DQVJeGnZwzNVd0hmvpud7nbP/3lc5JeTVELomruwVTGLtr+BTGT0IweAFTGNvNUuqOs3I4KG5tjvhPM7wm9NtwK2uAX1niLoylt4DcLfy2TeaxPQYDCJJRf7Qm7sDwJX5VoFt8RO9EC2ih+0Ike2+cAyRpIfKENPoIGQbUwvH6KkzHzjljcuvcSqq4D+iZid7up58A866RFrrJH9vkwaF+2mYxa/7awQIwAq8HPOxHkzLfVg74MZC8I1TOKvQAxkAquoNMMyrcAqRIopURfrgEaAtyW/ThPdyduYVlFeMg7BkpGLqZQ=="
}
响应接口公共参数
参数名必选类型说明
statusString1:正常,0:异常
errorString错误编码
msgString错误描述
dataObject业务数据(参与验签)
响应示例:
    {
        "status": "1",
        "error": "00000000",
        "msg": "",
        "data": {
            "...": "...",
            "sign": "PWA7B2u1hGr1VRxOCZbRuXQXtJiA6BgPExFnFv73hKJ+zcZfOe/R+y+inlwWcdDBzfix35+dl6raEs/yG/hcYyQOwDQ+mVjIt5wFk6iX7GPw557138yBdAmuMqvWM2IF+omLFcQFJvzfbR84rCyOmebDJlhkYMga5TTFHVLicUx3bPIrOJLoWJHrnZfcVFAJ+P5mUQhMH/cf+YmYZvrqq34pMJh6PcP5vyruJ8aNV0QfyHR42AHLIgp+HnOcZpA0aUzFXM5zpsgXK3QR/KO3vLiKd77UaZNO6g5TN/Ck2MtLkBVxyvIHstgXFXKF1e+uc91FdBHK5nfmrjLQ2wyeUA=="
        }
    }
错误编码
错误编码英文回复中文含义
1001param is null参数为空
1002Illegal Param非法参数
1003system exception系统异常(订单可能已入库,等待异步通知或者查询结果确定最终状态)
1004system is busy系统繁忙(订单可能已入库,等待异步通知或者查询结果确定最终状态)
4005order already exit订单已存在
4011appId do not exit业务ID不存在
4012you do not have an available product, please connect admin商户业务产品不可用,联系管理员
4013order not exit订单不存在
4014order is already end status订单为终态
4015this merchant do not have a collect bank没有可用的收款账号
4016your account do not have enough money账号余额不足
4031ip adress is Forbidden非法IP
5012pay in channel not functional, please connect customer service系统异常
Last modified on April 15, 2026