为了帮助商户快速接入支付系统,本文详细介绍了如何获取API Key、如何进行API签名和常用接口的使用方法。通过这些步骤,商户可以轻松集成支付功能,支持代收代付、订单查询等多种服务。
1. 获取API Key
登录收银台 -> 开发者中心 -> API Key -> 创建API Key。
每个API Key有独立的配置页面,支持绑定固定IP地址(0.0.0.0表示任何IP都可访问)。
请妥善保管Access Key和Secret Key,确保安全。
1.1 创建API Key
进入开发者中心,选择“API Key”并创建新的API Key。
配置调试模式、API Key权限和白名单地址。
创建后请保存Secret Key,因生成后无法查看。如遗忘,可回收密钥并申请新密钥。
2. 如何使用API Key
在请求头中添加以下参数:
access_key
:API Keytimestamp
:时间戳(13位)nonce
:UUID(36位)sign
:签名(通过HMAC_SHA1加密Base64编码)
3. 技术接入流程
根据API文档配置参数并进行接入。
4. 接口签名
为确保请求未被篡改,私有接口需通过API Key进行签名认证。
签名步骤:
定义Map字典,将请求参数与
access_key
、timestamp
、nonce
一起排序。使用
secret_key
进行HMAC_SHA1加密并Base64编码生成sign
值。
5. 接口列表
5.1 测试接口连通性
请求URL:
/ping
响应:
{"version": "1.0.1", "timestamp": 1688116827306}
5.2 创建代收订单
请求URL:
/api/v3/ph/createCollectingOrder
请求方式:POST
请求参数:
amount
:收款金额(最大两位小数)channelType
:支付类型(如QRIS、WALLET、BANK)externalOrderId
:商户订单号notifyUrl
:通知回调URL响应数据:
cashierUrl
:收银台链接currency
:货币类型(如PHP)orderId
:系统订单ID
5.3 创建代付订单
请求URL:
/api/v3/ph/createTransferOrder
请求方式:POST
请求参数:
currencyAmount
:代付金额channelType
:支付方式(如BANK)BankName
:银行或支付平台名称AccountNo
:收款银行账号UserInfoName
:收款人姓名UserInfoNo
:收款人电话号码响应数据:
orderId
:系统订单IDorderStatus
:订单状态(如已受理)
5.4 查询代收订单
请求URL:
/api/v3/ph/query/collectingOrder
请求方式:POST
请求参数:
externalOrderId
:商户订单号orderId
:系统订单号响应数据:
orderStatus
:订单状态orderAmount
:订单金额currencyType
:货币类型
5.5 查询代付订单
请求URL:
/api/v3/ph/query/transferOrder
请求方式:POST
请求参数:
externalOrderId
:商户订单号orderId
:系统订单号响应数据:
orderStatus
:订单状态currencyType
:货币类型errorMsg
:错误信息
5.6 查询余额
请求URL:
/api/v3/ph/query/balance
请求方式:GET
响应数据:
accountBalance
:账户余额accountFreezeAmount
:账户冻结金额accountStatus
:账户状态
5.7 查询银行列表
请求URL:
/api/v3/ph/query/bankList
请求方式:POST
响应数据:返回支持的银行信息列表
6. 回调信息
支付回调、代付回调与验签步骤可参考API文档详细内容。
发表评论
2024-11-19 06:07:00 回复该评论
2024-11-19 06:06:59 回复该评论
2024-11-19 06:12:03 回复该评论
2024-11-19 06:11:56 回复该评论
2024-11-19 06:12:02 回复该评论
2024-11-19 06:12:01 回复该评论
2024-11-19 06:11:56 回复该评论
2024-11-19 06:07:01 回复该评论
2024-11-19 06:12:02 回复该评论
2024-11-19 06:07:02 回复该评论
发表评论: