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 使用 OAuth 2.0 作为授权方式。
您的应用程序在用户授权时会询问特定的授权范围,并在用户批准后获得访问权限。
在您开始之前需要先注册您的应用程序,注册完成后系统将分配给您唯一的 Client ID 和 Client Secret,用于 OAuth 授权。请注意,Client Secret 需要妥善保存,不可分享给他人。

OAuth 流程 (Client Credentials 模式)#

第 1 步 - 使用 Client ID 和 Client Secret 获得访问令牌(Access Token)#

您的应用程序服务器可通过获取的授权码(code)请求 /auth 接口以获取 Access Token。
接口地址如下:
https://demo-api.easypayx.com/auth
接口参数如下:
grant_type:表示使用的授权模式,此处的值固定为 client_credentials(必选)
client_id:在您注册应用程序时得到的 Client ID(必选)
client_secret:在您注册应用程序时得到的 Client Secret(必选)
范例:
POST https://demo-api.easypayx.com/auth?grant_type=client_credentials&client_id=demo_client_id&client_secret=cwouf803ghv3op4ch32cu39djfhwpuow
您将接收到一个包含访问令牌 Access Token(以及其他详细信息)的 JSON 响应,范例如下:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
    "access_token": "xoxp-23984754863-2348975623103",
    "expires_in": 86400,
    "refresh_expires_in": 86400,
    "refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
    "token_type": "bearer",
    "not-before-policy": 0,
    "session_state": "e696e720-8117-4691-9554",
    "scope": "xyz"
}
访问令牌默认 1800 秒过期,即 30 分钟,过期后重新获取访问令牌。

第 2 步 - 使用访问令牌访问 API 资源#

您可以使用访问令牌调用本文档的 API 方法。
请求范例:
若访问令牌有效,服务端将返回给应用程序对应的数据。
修改于 2023-05-26 03:51:39
上一页
调用说明
下一页
异常
Built with