Yo Pay Open API

外观

Yo Pay Open API 开发者文档 ​

本文档面向接入 Yo Pay 开放接口的商户开发者，覆盖收款、退款、提现 / 代付、订单查询、账务流水和商户通知。

接口范围 ​

创建收款订单POST /api/v1/open/pay/order创建退款订单POST /api/v1/open/pay/refund创建提现 / 代付订单POST /api/v1/open/pay/payout查询订单GET /api/v1/open/pay/query查询提现 / 代付GET /api/v1/open/pay/withdrawQuery关闭订单POST /api/v1/open/pay/close查询账务流水GET /api/v1/open/bill/list商户通知notify_url 接收加密通知

当前协议 ​

  • 所有 Open API 请求都必须签名。
  • POST 请求体必须是加密信封：encrypted_key + biz_content。
  • GET 请求只签名、不加密，响应不返回账号、证件号、手机号等敏感原文。
  • 商户身份头使用 X-Mch-Id，值为平台商户号 merchant_no。
  • 订单创建成功后，商户系统应保存平台订单号 trade_no，用于后续查询、关闭和通知幂等处理。

推荐阅读顺序 ​

  1. 快速开始：确认接入步骤和最小调用流程。
  2. 凭证与密钥：确认 merchant_no、secret_key、平台公钥和商户公钥。
  3. 签名：实现 6 行签名串和 HMAC-SHA256。
  4. 加密信封：实现 RSA-OAEP + AES-256-GCM 请求和响应解密。
  5. 接口参考：查看参数、响应和业务 JSON 示例。
  6. 商户通知：处理平台通知、验签、解密和重试。

环境地址 ​

联调环境地址由平台商务或技术支持提供。本文档示例使用占位地址：

text
Base URL: https://api.example.com
Open Pay: /api/v1/open/pay
Open Bill: /api/v1/open/bill

本地开发或测试环境可按实际部署替换 Base URL，签名中的 PATH 只使用不带域名和 query 的路径。