1.文档说明

1.1文档目的

本文档的目的是为支付条线辅助交易系统定义一个接口规范,以帮助商户/集团技术人员快速接入宝付辅助交易系统相关接口。

1.2阅读对象

  • 商户开发人员、维护人员和管理人员
  • 宝付相关的技术人员

1.3技术支持

在开发或使用宝付辅助交易接口时,如果您有任何技术上的疑问,请按如下方式寻求帮助,宝付技术支持人员会及时处理,给予您答复:

技术支持热线:021-68819999-8005
技术支持Email:support@baofoo.com
技术支持QQ:800066689

DEMO下载

友情提示:DEMO仅供开发者参考,实际参数以对应产品接口文档为准。
Demo版本 更新日期 下载链接
JAVA版 2023-06-30 点击下载
PHP版 2023-06-30 点击下载

2.接口须知

2.1术语定义

符号 符号性质 符号说明
M 强制域(Mandatory) 必须填写的域
C 条件域(Conditional) 某条件成立时必须填写的域
O 选用域(Optional) 选填属性(可选预)
R 原样返回域(Returned) 必须与先前报文中对应域的值相同的域

3.当前余额查询接口

3.1接口说明

  1. 报文编号:T-1001-006-03
  2. 接口用于查询指定商户账户余额
    注:请求地址请结合宝付交易统一入口文档查看

3.2请求报文说明:

参数名称 类型 长度 出现要求 参数备注
version String 5 M 版本号4.0.0
memberTransId String [1,32] O 商户订单号
accountType String 20 M 账户类型 枚举类
BASE_ACCOUNT:基本户
FREEZE_ACCOUNT:冻结户
UNSETTLE_ACCOUNT:未结算户
MARGIN_ACCOUNT:保证金账户
FEE_ACCOUNT:手续费账户
MARKETING_ACCOUNT:营销户
SPECIAL_CAPITAL_ACCOUNT:资金专户;
ALL:所有账户

3.3返回报文说明

查询单个类型账户返回参数

参数名称 类型 长度 出现要求 参数备注
retCode int 4 M 返回码
errorCode String 20 C 错误码
errorMsg String 40 C 错误原因
back1 String 64 O 备用字段
back2 String 64 O 备用字段
back3 String 100 O 备用字段
accountType String 20 M 账户类型
balance BigDecimal [1,19] M 余额 单位元,最多2位小数

示例

{
    "accountType": "BASE_ACCOUNT",
    "balance": 10526.49,
    "retCode": 1
}

查询所有类型账户【ALL】返回参数

参数名称 类型 长度 出现要求 参数备注
retCode int 4 M 返回码
errorCode String 20 C 错误码
errorMsg String 40 C 错误原因
queryBalanceDetailResDtoList List C 账户集合
——accountType String 20 M 账户类型
——balance BigDecimal [1,19] M 余额 单位元,最多2位小数

示例

{
    "queryBalanceDetailResDtoList": [{
            "accountType": "BASE_ACCOUNT",
            "balance": 10526.49
        },
        {
            "accountType": "UNSETTLE_ACCOUNT",
            "balance": 50000.00
        },
        {
            "accountType": "FREEZE_ACCOUNT",
            "balance": 0.00
        },
        {
            "accountType": "MARGIN_ACCOUNT",
            "balance": 20000.00
        },
        {
            "accountType": "FEE_ACCOUNT",
            "balance": 0.00
        }
    ],
    "retCode": 1
}

4.历史日终余额查询接口

4.1接口说明

  1. 报文编号:T-1001-006-44
  2. 接口用于查询指定商户账户历史日终余额
    注1:历史记录查询查询时间不超过一周,不能查询当天记录。当日请用“当前余额查询接口”。
    注2:请求地址请结合宝付交易统一入口文档查看。
  3. 由于大数据跑批时间差问题,建议T日6点后查询T-1日的数据。
  4. 如果查询结果为空值或者未返回值,则表示可能无交易记录或账户为初始状态。

4.2请求报文说明:

参数名称 类型 长度 出现要求 参数备注
version String 5 M 版本号4.0.0
memberTransId String [1,32] O 商户订单号
startDate String 10 M 格式:yyyy-MM-hh
endDate String 10 M 格式:yyyy-MM-hh

说明:
A)“startDate”“endDate”
如无特殊需求,建议“startDate”“endDate”传同一天,按天查询。

4.3返回报文说明

参数名称 类型 长度 出现要求 参数备注
retCode int 4 M 返回码
errorCode String 20 C 错误码
errorMsg String 40 C 错误原因
back1 String 64 O 备用字段
back2 String 64 O 备用字段
back3 String 100 O 备用字段
balanceMap map 不限 M key-value模式

说明:
A)“balanceMap”
“balanceMap”为key-valure值。
key1=”日期”:[value1={list}]
list={“accountType”:”账户类型”, “balance”:”金额”},{“accountType”:”账户类型”, “balance”:”金额”}

参数名称 参数备注
账户类型 账户类型 枚举类
BASE_ACCOUNT:基本户
FREEZE_ACCOUNT:冻结户
UNSETTLE_ACCOUNT:未结算户
FEE_ACCOUNT:手续费账户
金额 余额 单位元,最多2位小数

balanceMap示例:

"balanceMap":{
            "2023-11-22":[
                {
                    "accountType":"BASE_ACCOUNT",
                    "balance":976.01
                },
                {
                    "accountType":"FEE_ACCOUNT",
                    "balance":4.2
                }
            ],
            "2023-11-23":[
                {
                    "accountType":"BASE_ACCOUNT",
                    "balance":984.28
                },
                {
                    "accountType":"FEE_ACCOUNT",
                    "balance":4.2
                }
            ]
        },

5.注意事项

初次使用请仔细核对,信息是否有误,出现错误请及时联系宝付技术人员。

附录

1、返回码

retCode 说明
1 成功
0 失败
2 处理中

2、宝付统一入口须知

宝付交易统一入口接口文档

作者:xiaofeng  创建时间:2023-06-30 09:05
最后编辑:xiaofeng  更新时间:2024-09-19 18:06