接入指南

整体交互流程图

完成 接入准备 后，商家可根据对接的业务类型，选择对应的对接方式进行调试。

特别说明

1. 收银台对接，仅用于代收，支持匿名支付和实名支付，两者表示商家自己的用户是否需要完成登录到EPAY后进行支付操作。
2. API接口，支持代收和代付，商家自己的用户不需要额外注册登录EPAY账号。
3. 详细流程图请参见具体业务的流程说明：收银台对接流程，API代收流程，API代付流程（银行对接）， API代付流程（电子钱包对接），EPAY余额互转。

接口规则

接口命名

接口规范

报文采用JSON规范，基本报文格式参照如下说明：收银台代收接口的报文请求参数。

{
  "param": {
    "epayAccount": "test2020@epay.com", // 商家EPAY账号
    "merchantName": "ali BANK",// 商家名称
    "amount": "10.05", // 订单金额
    "currency": "EUR", // 订单币种
    "merchantOrderNo": "A092201", // 商家订单号
    "notifyUrl": "http://localhost/paymentApi/channel/send.do", // 回调地址
    "successUrl": "http://localhost/paymentApi/channel/sucess", // 成功跳转页面
    "failUrl": "http://localhost/paymentApi/channel/fail", // 失败跳转页面
    "remark": "备注",  // 订单备注
    "senderEpayAccount": "", // 强制付款EPAY账号
    "language": "CN", // 默认语言
    "version": "V2.0.0", // 版本号
    "extendFields": { // 其他扩展字段说明
      "field": "商户扩展字段"
    }
  },
  "sign": "签名" // 签名
}

sign为数据签名防止API接口请求数据被篡改。

接口版本

接口签名

1. 为了防止数据篡改，商户请求EPAY接口的参数必需带上sign签名参数。
2. EPAY会对发送给商户的通知进行签名，并将签名值放在回调接口参数中。商户应当验证签名，以确认请求来自EPAY，而不是其他的第三方。
3. 签名验证的算法请参考 开发指引-接口签名

调试API示意

• 第一步：获取API_KEY。

商家可以登录测试环境网页，在开发者 -> 开发配置 -> 我的API Key 菜单下 或者 用户头像 -> API管理 -> 我的API Key 菜单下，查看API_KEY。具体可参见文档说明：开发指引 -> API开通 -> 获取API_KEY。

• 第二步：封装接口请求入参。

• 第三步：使用API_KEY生成请求参数签名sign值。
• 第四步：请求接口参数及签名sign值。

调试API接口

您完成认证流程后，可以联系EPAY技术支持人员，根据调试环境和测试账号开始调试API接口。

获取API_KEY

通过EPAY系统页面开通API功能，申请获取API_KEY,并添加白名单IP，即可开始进行调试API接口。

API正式使用

您可通过生产环境信息，EPAY账号 和 ApiKey对接EPAY生产环境系统进行正式交易。