EasyPay API
EasyPay 官网
EasyPay 官网
  1. 文档介绍
  • 文档介绍
    • 调用说明
    • 认证
    • 异常
    • 版本
    • 请求幂等
    • 对接指引
    • API 清单
  • 认证
    • 认证
      POST
  • 账户
    • 创建账户
      POST
    • 查询账户列表
      GET
    • 查询账户
      GET
    • 修改账户实名
      PUT
  • 余额
    • 查询账户余额
      GET
  • 申请收款账户
    • 申请收款账户
      POST
    • 查询申请列表
      GET
    • 查询申请
      GET
  • 收款账户
    • 查询收款账户列表
      GET
    • 查询收款账户
      GET
  • 收单
    • 支付
      • APP 支付
      • 小程序支付
      • 公众号支付
      • H5支付
      • 查询支付单
      • 取消支付单
      • 查询支付单列表
    • 退款
      • 退款
      • 查询退款
      • 查询退款单列表
    • 对账单
      • 查询对账单列表
    • 结算单
      • 查询结算单列表
      • 查询结算单
    • 报关
      • 报关
      • 身份信息校验
      • 报关查询
      • 报关重推
      • 报关信息修改
    • 汇率
      • 查询渠道汇率
  • 入账
    • 查询入账列表
    • 查询入账
    • 入账凭证下载
  • 汇率
    • 查询汇率
  • 换汇
    • 创建换汇订单
    • 查询换汇订单列表
    • 查询换汇订单
    • 更新结汇明细
    • 手动确认交割
  • 付款
    • 付款
    • 查询付款列表
    • 查询付款
    • 补充材料
    • 付款凭证下载
  • 转账
    • 转账
    • 查询转账列表
    • 查询转账
  • 流水
    • 查询账户流水
    • 根据 transaction ID 查询
  • 账户实名更新请求
    • 查询实名更新请求列表
    • 提交实名更新
  • 收款人
    • 收款人信息校验
  • 模拟
    • 通过实名
    • 驳回实名
    • 创建实名更新
    • 通过实名更新
    • 拒绝更新请求
    • 收款账户审核通过
    • 收款账户审核驳回
    • 入账
    • 通过付款
    • 拒绝付款
    • 通过换汇
    • 拒绝换汇
    • 通过提现
    • 拒绝提现
    • 收款
  • Webhooks
    • 创建 Webhook
    • 查询 Webhook
    • 修改 Webhook
    • 删除 Webhook
    • 创建 Webhook HMAC Key
  • 通知
    • 账户审核通过
    • 账户审核驳回
    • 实名待更新
    • 实名更新审核通过
    • 实名更新审核驳回
    • 收款账户申请成功
    • 收款账户申请失败
    • 收款账户已下发
    • 收款账户信息变更
    • 收单支付成功通知
    • 收单退款成功通知
    • 收单退款失败通知
    • 入账成功
    • 换汇成功
    • 换汇失败
    • 结汇明细失败
    • 付款成功
    • 付款失败
    • 付款银行退回
    • 转账成功
    • 转账失败
  1. 文档介绍

API 清单

'

模块 API 名称 描述
【认证】 认证 获取访问 EasyPay API 访问令牌 (Access Token)
【账户】用于创建 EasyPay Account 创建账户 使用接口发起创建 EasyPay Account,需要保存 account ID,其它接口都会用到
查询账户列表 使用接口分页查询账户列表信息
查询账户 使用接口根据 account ID 查询账户
修改账户实名 当账户审核驳回后可使用接口根据 account ID 修改实名信息
【账户余额】查询账户余额 查询账户余额 使用接口查询账户余额
【流水】获取账户流水信息 查询账户流水 分页查询账户流水
根据 transaction ID 查询 根据 transaction ID 查询单条流水
【申请收款账户】通过该接口申请收款账户 申请收款账户 通过该接口申请收款账户
查询申请列表 分页查询申请列表
查询申请 根据申请ID查询申请
【收款账户】获取 VA 账户详情 查收收款账户列表 分页查询收款账户列表
查询收款账户 根据收款账户 ID 查询收款账户
【入账】获取资金入账信息 查询入账列表 分页查询入账列表
查询入账 根据入账 ID 查询入账
【汇率】查询实时汇率 查询汇率 查询实时汇率
【换汇】发起或查询换汇交易 创建换汇订单 发起换汇
查询换汇订单列表 分页查询换汇订单列表
查询换汇订单 根据换汇订单 ID 查询
【付款】发起付款或查询付款交易 创建付款订单 发起付款
查询付款订单列表 分页查询付款列表
查询付款订单 根据付款 ID 查询付款订单
【转账】可支持主账户和子账户之间的互转 创建转账订单 发起转账订单
查询转账订单列表 分页查询转账列表
查询转账订单 根据转账 ID 查询转账订单
【实名更新】一般用于有效期到期后的实名信息更新 查询实名更新请求列表 查询需要更新实名List
提交实名更新 提交实名更新,ID 是与查询实名更新请求列表中返回的 ID 是一致
【Webhooks】用于订阅通知 创建 Webhook 创建 Webhook, types 支持 * 参数传 ["*"]表示监听所有业务类型的通知
查询 Webhook 查询 Webhook
修改 Webhook 修改 Webhook
删除 Webhook 删除 Webhook
创建 Webhook HMAC Key 调用该接口创建 HMAC key,请将该 key 保存好。EasyPay 将使用强哈希算法生成 HMAC。如果创建过 HMAC key,在回调 header 中会返回 Ep-Hmac-Digest。Ep-Hmac-Digest 的计算规则是使用 HMAC key 将请求 body 做 SHA-512
【通知】商户通知 账户审核通过 账户审核通过
账户审核驳回 账户审核驳回
实名待更新 实名待更新
实名更新审核通过 实名更新审核通过
实名更新审核驳回 实名更新审核驳回
收款账户申请成功 收款账户申请成功
收款账户申请失败 收款账户申请失败
收款账户已下发 收款账户已下发
收款账户信息变更 收款账户信息变更
入账成功 入账成功
换汇成功 换汇成功
换汇失败 换汇失败
付款成功 付款成功
付款失败 付款失败
转账成功 转账成功
转账失败 转账失败

收单

模块 API 名称 描述
【收单-支付】商户下单支付 扫码支付 扫码支付
APP 支付 APP 支付
小程序支付 小程序支付
公众号支付 公众号支付
H5 支付 H5 支付
查询支付单 根据支付单ID查询
取消支付单 取消支付单
查询支付单列表 查询支付单列表
【收单-退款】收单退款 退款 发起退款
查询退款 根据退款 ID 查询
查询退款单列表 查询退款单列表
【收单-对账单】查询对账单 查询对账单列表 查询对账单列表
【收单-结算单】 查询结算单列表 分页查询结算单列表
查询结算单 根据结算单 ID 查询
【收单-报关】 报关 报关
身份信息校验 身份信息校验
报关查询 报关查询
报关重推 报关重推
报关信息修改 报关信息修改
【收单-汇率】查询渠道汇率 查询渠道汇率 查询渠道汇率
【通知】收单结果通知 (商户可通过配置 Webhook 或者随下单时填写通知地址) 收单支付成功通知 收单支付成功通知
收单退款成功通知 收单退款成功通知
收单退款失败通知 收单退款失败通知

模拟 API

模块 API 名称 描述
【模拟】用于测试环境场景测试 通过实名 发送账户审核通过通知
驳回实名 发送账户审核驳回通知
创建实名更新 发送实名待更新通知
通过实名更新 发送实名更新审核通过通知
拒绝实名更新 发送实名更新审核失败通知
收款账户审核通过 发送收款账户申请成功通知;如果是贸易申请VA账户还会发送收款账户已下发
收款账户审核驳回 发送收款账户申请失败通知
入账 发送入账成功通知
通过付款 发送付款成功通知
拒绝付款 发送付款失败通知
通过换汇 发送换汇成功通知
拒绝换汇 发送换汇失败通知
修改于 2024-09-02 07:41:31
上一页
对接指引
下一页
认证
Built with