PayerMax接口说明
1. 通讯协议
商户接入PayerMax 服务，调用API须遵循以下规则：
| 类型 | 说明 |
|---|---|
| 传输方式 | 为保证交易安全性，采用HTTPS传输，且TLS版本不低于1.2，详情参考 TLS升级说明 |
| 提交方式 | 采用POST方法提交 |
| 数据格式 | 提交和返回数据都为application/json格式 |
| 字符编码 | 统一采用UTF-8字符编码 |
| 签名算法 | SHA256WithRSA |
| 签名要求 | 请求和接收数据均需要校验签名，详细方法请参考 配置与签名 |
| 判断逻辑 | 先判断协议字段返回，再判断业务返回，最后判断交易状态 |
2. 接口结构
如下是调用payermax接口的http结构，接口名称放到请求地址后面，data里边的内容为不同业务结构拼接而成的报文
json
POST https://pay-gate.payermax.com/aggregate-pay/api/gateway/{接口名称}
Content-Type: application/json
Content-Length: 580
sign: 根据请求body使用merchant privateKey签名
{
"version": "1.1",
"keyVersion": "1",
"requestTime": "2022-01-17T08:04:13.879+00:00",
"appId": "3b242b56a8b64274bcc37dac281120e3",
"merchantNo": "020213827212251",
"data": {
}
}请求地址:
| 联调环境 | 请求地址 |
|---|---|
| Test | https://pay-gate-uat.payermax.com/aggregate-pay/api/gateway |
| Prod | https://pay-gate.payermax.com/aggregate-pay/api/gateway |
3. 接口列表
| 产品 | 集成模式 | 接口名称 | Endpoint | 描述 |
| 收款 | 收银台支付 | 下单 | /orderAndPay | 使用payermax收银台进行支付 |
| 交易查询 | /orderQuery | |||
| 下单异步通知 | 通知 | |||
| 退款申请 | /refund | |||
| 退款查询 | /refundQuery | |||
| 退款结果通知 | 通知 | |||
| 纯API支付 | 申请Token | /applyToken | 使用商户自己收银台进行支付 | |
| 下单 | /orderAndPay | |||
| 交易查询 | /orderQuery | |||
| 下单异步通知 | 通知 | |||
| 退款申请 | /refund | |||
| 退款查询 | /refundQuery | |||
| 退款结果通知 | 通知 | |||
| Tokenization支付 | paymentTokenID查询 | /inquirePaymentToken | 当用户使用卡支付方式，支付成功后会把卡token给商户，后续商户发起支付带上卡token进行支付，方便用户快速完成支付 | |
| paymentTokenID解绑 | /removePaymentToken | |||
| 异步通知 | 通知 | |||
| PayByLink支付 | 创建支付链接 | /createPaybylink | 直接帮商家创建一个支付链接，发送给消费者后进行支付 | |
| 查询链接详情 | /queryPaybylink | |||
| 失效支付链接 | /expirePaybylink | |||
| 更新异步回调 | 通知 | |||
| 争议 | 争议异步通知 | 通知 | 交易完成后用户进行拒付、争议、欺诈、投诉等产生的订单通知给商户 | |
| 案件回复 | /caseReplay | |||
| 案件查询 | /caseSearch | |||
| 付款 | API付款 | 付款请求 | /paymentOrderPay | 商户向用户进行付款 |
| 付款交易查询 | /paymentOrderQry | |||
| 异步通知 | 通知 | |||
| 账户余额 | 余额查询 | 实时余额查询 | /currentBalanceQuery | 商户进行余额查询 |
| 日终余额查询 | /dayEndBalanceQuery | |||
| 支付方式 | 支付方式查询 | 可用支付方式查询 | /consultPaymentMethod | 商户可以查询当前可用支付方式, 包括： 支付方式编码、支付币种、开通时间、支付方式状态（可用/不可用）、限额范围等 |
4. 接口传参规则
| 是否必填 | 描述 |
|---|---|
| M | 必填（Mandatory） |
| O | 选填（Optional） |
| C | 特定条件下必填（Condition） |