公共接口
681字约2分钟
1.账户查询
简要描述:
- 查询当前业务对应账号的账户的余额
URL:
currency为路径参数,需更换为要查询的币种,如美元:/usd/account/ledger
币种采用国际标准编码,三位大写英文字母,参考:Wikipedia-ISO_4217
/{currency}/account/ledger
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | Long | 业务ID(后台获取) |
sign | 是 | String | 签名 |
返回data参数说明
参数名 | 类型 | 说明 |
---|---|---|
bal | String | 账户余额 |
availableBal | String | 可用金额 |
frzBal | String | 冻结金额 |
unSettleBal | String | 待入账金额 |
sign | String | 签名 |
2.异步通知
简要描述:
- 当客户代收成功或失败,我方会推送订单状态,若首次通知失败,则每隔5分钟回调一次,持续5次
URL:贵方提供
,请配置在HaiPay后台
参数:
参数名 | 类型 | 说明 |
---|---|---|
appId | Long | 业务ID |
currency | String | 币种 |
orderId | String | 商户订单号 |
orderNo | String | 平台订单号 |
amount | String | 本次收款金额 |
fee | String | 手续费金额 |
status | Integer | 状态(2成功(终态),3失败(终态),4部分收款(终态),5超额收款(终态)) |
payTime | String | 支付成功时间(当status=2,4,5时有值)(本地时间), 格式: yyyy-MM-dd HH:mm:ss |
errorMsg | String | 支付失败原因(当status=3时有值) |
originalCurrency | String | 订单原始币种,可能为空,涉及汇率转换时有值 |
originalAmount | String | 订单原始金额,可能为空,涉及汇率转换时有值 |
inBankCode | String | 用户支付方式,可以参考每个地区的接口文档,与下单一致,可能为空 |
sign | String | 签名, |
说明
收到回到通知之后,请在响应体中返回SUCCESS (大写),不需要前后引号,否则会持续通知5次
3.对帐文件链接获取
说明:
- 文件格式与商户后台导出的文件格式一样,当天的数据会在第二天13点后生成对帐文件
URL:
/common/document/download
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 是 | Long | 业务ID(后台获取) |
type | 是 | Long | 类型,15:代付订单数据,20:代收订单数据,40:资金流水数据 |
date | 是 | String | 时间,格式yyyyMMdd |
sign | 是 | String | 签名 |
返回data参数说明
参数名 | 类型 | 说明 |
---|---|---|
appId | Long | 业务ID(后台获取) |
type | Long | 类型,15:代付订单数据,20:代收订单数据,40:资金流水数据 |
date | String | 时间,格式yyyyMMdd |
fileUrl | String | 文件下载地址 |
expired | String | 有效期,1小时 |
sign | String | 签名 |