1. 2.接口规范
3ypay产品接口文档
  • 1.总体介绍
    • 1.1 阅读人员
    • 1.2 名词解释
    • 1.3 调试工具说明
  • 2.接口规范
    • 2.1 接口格式定义
    • 2.2 加签验签说明
    • 2.3 参数说明
    • 2.5 内部测试版sdk
  • 3.统一交易类
    • 3.1 统一交易类指引
      • 3.1.1【微信】 扫码交易指引
      • 3.1.3【微信】小程序交易指引
      • 3.1.4【微信】JSAPI交易指引
      • 3.1.5【微信】APP交易指引
      • 3.1.6【微信】H5交易指引
      • 3.1.7【微信】资金管控业务说明
      • 3.1.8【抖音】APP交易指引
      • 3.1.9【抖音】H5交易指引
    • 3.2 统一交易类接口
      • 3.2.1 统一支付接口
      • 3.2.2 统一交易查询
      • 3.2.3 统一交易通知
      • 3.2.4 统一退款接口
      • 3.2.5 统一退款查询
      • 3.2.6 统一退款通知
  • 4.支付宝产品类
    • 4.1 安全发接口
      • 4.1.1 安全发指引
      • 4.1.2 安全发API接口
        • 4.1.2.1 单笔转账接口
        • 4.1.2.2 单笔转账查询
        • 4.1.2.3 转账异步通知
        • 4.1.2.4 转账回单申请
        • 4.1.2.5 转账回单下载
    • 4.2 直付通接口
      • 4.2.1 直付通指引
      • 4.2.2 直付通API接口
        • 4.2.2.1 统一支付接口
        • 4.2.2.2 统一交易查询
        • 4.2.2.3 统一交易通知
        • 4.2.2.4 统一交易退款
        • 4.2.2.5 统一退款查询
        • 4.2.2.6 统一退款通知
      • 4.2.3 支付宝商家转账(定制)
        • 4.2.3.1 支付宝商家转账
  • 5.订单分账类
    • 5.1 订单分账指引
      • 5.1.1 控台分账指引
        • 5.1.1.1 控台自动分账指引
        • 5.1.1.2 控台手动分账指引
      • 5.1.2 接口分账指引
    • 5.2 订单分账接口
      • 5.2.1 请求分账
      • 5.2.2 分账查询
      • 5.2.3 分账完结
      • 5.2.4 分账退款
      • 5.2.5 分账退款查询
      • 5.2.6 分账结果通知
      • 5.2.7 分账退款通知
  • 6.余额分账类
    • 6.1 余额分账指引
    • 6.2 余额分账接口
      • 6.2.1 余额分账申请
      • 6.2.2 余额分账查询
      • 6.2.3 余额分账退款
      • 6.2.4 余额退款查询
      • 6.2.5 余额分账异步通知
      • 6.2.6 余额退款异步通知
  • 7.风控管理类
    • 7.1 投诉管理类
    • 7.2 风险管理类
  • 8.商户管理类
    • 8.1 商户进件类
      • 8.1.1 进件文件上传
      • 8.1.2 商户入网申请
      • 8.1.3 商户入网信息查询
      • 8.1.4 商户结算信息变更
      • 8.1.5 商户产品信息变更
      • 8.1.6 商户信息变更查询
      • 8.1.7 进件状态通知
      • 8.1.8 变更状态通知
    • 8.2 微信支付宝管理类
      • 8.2.1 商户AUT报备查询
      • 8.2.2 微信支付配置
      • 8.2.3 微信支付配置查询
      • 8.2.4 商户AUT拆分
    • 8.3 分账接收方管理类
      • 分账接收方录入
      • 分账接收方查询
      • 分账接收方变更
      • 分账变更查询
      • 分账关系绑定
      • 分账关系解绑
      • 分账关系更新
      • 分账关系查询
      • 入网报备通知
      • 结算变更通知
  • 9. 先享后付类
    • 9.1 微信支付分
    • 9.2 支付宝先享后付
  • 10.账户管理类
    • 10.1.分账提现管理类
      • 10.1.1 分账提现申请
      • 10.1.2 分账提现查询
      • 10.1.3 提现结果通知
  • 产品手册
    • AI智能路由指引-内测
    • 商户控台操作手册
    • AT投诉渠道配置
      • 微信投诉风险渠道配置
    • AT风险处理指引
      • 微信风控处理指引
    • 抖音支付申请指引
      • 抖音支付合作商家政策
      • 抖音支付申请材料
    • 支付宝可信商户报备
      • 可信降打扰权益服务介绍
      • 商户可信降打扰(存量客户)
      • 准入可信降打扰(新增客户)
    • 分账相关指引
      • 分账订阅-商户使用指引
  • 回收站
  • 数据模型
    • 公共请求参数
    • 公共返回参数
    • 公共响应结构
    • 商户入网材料
    • 业务请求参数
    • 营业执照信息
    • 文件上传请求
    • 法人证件信息
    • 商户入网请求
    • 结算卡信息
    • 进件标识查询请求
    • 入网查询请求
    • 结算卡变更请求
    • 产品变更请求
    • 结算卡更新信息
    • 变更查询请求
    • AUT查询请求
    • 分账关系绑定请求
    • AUT微信配置请求
    • 分账关系解绑请求
    • AUT配置详情查询请求
    • 分账关系更新请求
    • 微信支付配置响应
    • 分账关系查询请求
    • 授权目录配置状态
    • 商户入网响应
    • AppId配置状态
    • 商户变更响应
    • AUT拆分请求
    • 变更审核状态响应
    • 商户基本信息
    • 分账关系响应
    • 人员证件信息
    • 余额分账申请请求
    • 商户营业执照信息
    • 余额分账明细请求
    • 商户经营信息
    • 分账查询请求
    • 经营场景信息
    • 分账退款申请请求
    • 经营资质信息
    • 分账退款明细请求
    • 商户结算卡信息
    • 分账退款查询请求
    • 对公卡信息
    • 余额分账响应
    • 签约信息
    • 分账明细响应
    • 产品开通信息
    • 余额分账退款响应
    • 产品配置详情
    • 分账退款明细响应
    • AUT查询响应
    • 提现申请请求
    • 异步通知响应结构
    • 提现查询请求
    • 进件状态通知数据
    • 提现响应数据
    • 变更状态通知数据
    • 入网报备通知数据
    • 余额分账通知数据
    • 分账明细通知
    • 余额退款通知数据
    • 提现通知数据
    • 退款明细通知
  1. 2.接口规范

2.1 接口格式定义

1. 协议规则#

1.1接入方对接API须遵循以下规则:#

传输方式:HTTPS
提交方式:采用POST方式提交
数据格式:JSON
字符编码:统一采用UTF-8字符编码
签名算法:RSA2
所有图片地址都必须是https协议开头

2. 公共参数#

2.1 通用报文格式#

【公共请求参数】
M必填 O选填 C条件必填
参数名称参数含义是否必须数据类型备注
appId应用APPIDMstring商户应用APPID,为汇联商户控台中的应用APPID,非微信公众号与小程序的APPID
requestId请求IDMstring请求唯一标识,无其他意义,必须每一次请求不允许重复,用于定位问题
signType签名方式Mstring固定值:RSA2
timestamp请求时间戳Minteger(int64)毫秒,13位
version版本号Mstring固定值:1.0
charset字符编码Mstring固定值:UTF-8
subSn子商户号Cstring非必传项,普通商户可忽略,平台商户以及代理商可传
sign签名串Mstring参照签名方法
bizContent业务请求参数体Mstring业务请求参数,JSON 格式字符串
【公共返回参数】
参数名称参数含义是否必须数据类型备注
code响应状态Minteger响应状态,非200时为网关层,鉴权效验服务层拦截,将不会入库,非200时 只会返回code,msg两个参数
msg响应说明Mstring
appId应用APPIDOstring固定值:RSA2
signType签名方式:RSA2OString固定值:RSA2
timestamp响应时间戳Ostring单位毫秒
sign签名串Ostring签名值
data响应业务数据Ostring业务响应参数,JSON 格式字符串

2.2 报文示例#

【请求报文】
{"appId":"APP_01863208408","timestamp":1763041713870,"requestId":"e34ec4043d4c3a3a16c0d8d533431d3b","version":"1.0","signType":"RSA2","charset":"UTF-8","bizContent":"{\"account_book_id\":\"2088970907720362\",\"mch_order_no\":\"fdb9d43464353242343315\",\"trans_amount\":\"0.1\",\"product_code\":\"AQF-TRANSFER-BANKCARD\",\"order_title\":\"踢脚线驳船哼尽管关于\",\"notify_url\":\"https://api.3ypay.com/pay-service/openapi/order/notify\",\"payee_info\":{\"identity_type\":\"ALIPAY_LOGON_ID\",\"name\":\"张三\",\"identity\":\"95\",\"bankcard_ext_info\":{\"account_type\":\"1\",\"inst_name\":\"招商银行\"}},\"remark\":\"veniam fugiat sunt\",\"business_params\":{\"payer_show_name_use_alias\":false,\"withdraw_timeliness\":\"T0\",\"payer_show_name\":\"湛奕辰\"}}","sign":"VfeYUX28nn/9ZOBEpezfpmb3194jtWr2Ohh2BrRj3DzivljdPdWTkQLyN4aefAq6sUzswXEZgnKwwBmYzQr0omGo7zdJ3GSr/5T9c/X1jvjHbDzIyXNyJmLj9w8yRhAoK6pIwD6+znBdk9sIQmYwhYKrDkPsMxxTN/JBBA9xnJPQmTBEiO2t0i0Q0fpbSP755ZMt6m9gfXw9KBr7mIq/OIE5Y2LfWiqY5hMGfpF0GJKV/v9pf6cVkaJbMif6MnBiiWQhUd9Rp2AlUvlOGx94Yhnhd2QF5CDkXKfdPYvVA+v3SPUArscw+oggIPyF2jPNyOYlw1dXBnLwkVA+E6YQqw=="}
【响应报文】
{
    "appId": "APP_01863208408",
    "code": 200,
    "data": "{\"order_title\":\"踢脚线驳船哼尽管关于\",\"batch_no\":\"\",\"account_book_id\":\"2088970907720362\",\"bill_file_id\":\"\",\"bill_error_message\":\"\",\"remark\":\"veniam fugiat sunt\",\"out_biz_no\":\"N202511101459127284\",\"trans_amount\":\"0.10\",\"product_code\":\"AQF-TRANSFER-BANKCARD\",\"bill_download_url\":\"\",\"fee_rate\":\"[{\\\"rateType\\\":\\\"SINGLE_PERCENT\\\",\\\"percentRate\\\":1}]\",\"fee_amount\":\"0.00\",\"agreement_no\":\"20255804217399244554\",\"business_params\":{\"payer_show_name\":\"湛奕辰\",\"payer_show_name_use_alias\":false,\"withdraw_timeliness\":\"T0\"},\"fail_reason\":\"[40004][Business Failed][CARD_BIN_ERROR][收款人银行账号不正确]\",\"channel_sn\":\"AQF20250918234100476107840426\",\"payee_info\":{\"bankcard_ext_info\":{\"account_type\":\"1\",\"inst_name\":\"招商银行\"},\"identity\":\"95\",\"name\":\"张三\",\"identity_type\":\"BANKCARD_ACCOUNT\"},\"order_id\":\"\",\"mch_order_no\":\"fdb9d4346435454354134643be3315\",\"status\":4}",
    "msg": "请求成功",
    "sign": "WN6hi/D7GK2JnfuMqhA+5AjoGXpoSDS9Ej/inx7nP5rrDlt6MQ3NlPijwfiJOmByGpYAEda9GkcK6SotzVwzYGREkA48Pnw0bOutuEi/B3Ht4Se8c8bu8kF72yiTSY/bCRZGxD7bZ9gPN4qdAOcEbNknlH1PxCVaZYxTh4I/YHJ8m4CPmr4x0vCTGODWJyNeaExJgifCbzz+uGLgEePHxXDFTcHCT/n7YEHC/xu0EKVWX7cu6cb65o5zgSGbycS9eYWtYFUsabBd8myiekZq6QxiyijuDA8KRBtuWCNo2ULnJikLk4g9I3hq0M+BjE+8QJhGnyJwmxWS0qUz4mLWNQ==",
    "signType": "RSA2",
    "timestamp": 1763042195135
}
上一页
1.3 调试工具说明
下一页
2.2 加签验签说明
Built with