Version: 3.0 版本

1.0-账户管理

1.1 充值账户查询

简要描述

查询收款银行账户信息

请求 URL

/settlement/openapi/v1/account/query

请求方式

返回类型

JSON

请求参数（无）

2.1.4 返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	响应状态码	数据字典-0001-响应状态码
success	boolean	是否成功	true/false
data	Object	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明	备注
account	Long	充值账号
abilityTypeCode	String	渠道编码	10.招商云直联 11.支付宝 15.微信 19.招商银企直联
accountName	String	开户名
bankName	String	银行名称	当渠道为招商云直联、招商银企直联时存在返回值
branchBankName	String	开户银行	当渠道为招商云直联、招商银企直联时存在返回值
branchBankAddress	String	开户银行地址	当渠道为招商云直联、招商银企直联时存在返回值
remark	String	备注

接口请求示例

{
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": [
    {
      "account": "121935959360001",
      "bankName": "中国招商银行",
      "accountName": "纽业态（上海）信息科技有限公司",
      "branchBankName": "招商银行陆家嘴分行",
      "branchBankAddress": "上海市陆家嘴金融广场276号",
      "remark": "5分钟内到账1、付款备注、摘要只能填写:服务费,否则会退款;2、请确保付款主体与签订的协议主体一致,否则会充值失败",
      "abilityTypeCode": 10
    }, 
    {
      "account": "newyetai@qq.com",
      "accountName": "纽业态（上海）信息科技有限公司",
      "remark": "5分钟内到账1、付款备注、摘要只能填写:服务费,否则会退款;2、请确保付款主体与签订的协议主体一致,否则会充值失败",
      "abilityTypeCode": 11
    }
  ]
}

1.2 账户余额查询

简要描述

查询账户余额

请求 URL

/settlement/openapi/v1/account/balance

请求方式

POST

返回类型

JSON

请求参数(POST)

请求参数不传则查所有账户的余额信息，有参数则按照参数条件查询

参数名称	参数类型	必填	参数说明	备注
subAccountNo	String	N	账户号码
subAccountStatus	String	N	账户状态	数据字典-0010-账户状态
abilityTypeCode	Integer	N	渠道编码	10.招商云直联 11.支付宝 15.微信 19.招商银企直联

返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	响应状态码	数据字典-0001-响应状态码
success	Boolean	是否成功	true/false
data	Object	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明	备注
subAccountNo	String	账户号码,即后续支付环节中使用的支付账号
defaultAccount	Boolean	是否默认账户(部分企业存在多账户),当为 TRUE时， subAccountNo为有效账户，才可在后续支付环节使用
accountBalance	BigDecimal	账户余额（账户可用余额+冻结金额）
availableBalance	BigDecimal	账户可用余额（账户余额-冻结金额）
frozenAmount	BigDecimal	账户冻结余额（用于订单支付中的金额
subAccountTypeDesc	String	账户名称
subAccountStatus	String	账户状态	数据字典-0010-账户状态

接口请求示例

无参数

{
  "msg": "请求成功",
  "code": "200",
  "success": true,
  "data": [
    {
      "subAccountNo": 1001102001000303,
      "defaultAccount": true,
      "accountBalance": 11698.93,
      "availableBalance": 11683.93,
      "frozenAmount": 15.0,
      "subAccountTypeDesc": "招商云直联基本户",
      "subAccountStatus": "1"
    },
    {
      "subAccountNo": 1001102003000206,
      "defaultAccount": false,
      "accountBalance": 2600045.0,
      "availableBalance": 2600045.0,
      "frozenAmount": 0.0,
      "subAccountTypeDesc": "招商云直联基本户",
      "subAccountStatus": "1"
    },
    {
      "subAccountNo": 1001102005000003,
      "defaultAccount": false,
      "accountBalance": 0.0,
      "availableBalance": 0.0,
      "frozenAmount": 0.0,
      "subAccountTypeDesc": "招商云直联基本户",
      "subAccountStatus": "1"
    }
  ]
}

有参数

{
    "subAccountNo":"1001102001000303",
    "subAccountStatus": "1"
}

{
    "msg": "请求成功",
    "code": "200",
    "success": true,
    "data": [
        {
            "subAccountNo": 1001102001000303,
            "defaultAccount": true,
            "accountBalance": 11698.93,
            "availableBalance": 11683.93,
            "frozenAmount": 15.00,
            "subAccountTypeDesc": "招商云直联基本户",
            "subAccountStatus": "1"
        }
    ]
}

1.3 账户流水查询

简要描述

查询账户下的流水明细信息

请求 URL

/settlement/openapi/v1/account/trade

请求方式

POST

返回类型

JSON

请求参数(POST)

请求参数不传则查所有账户的余额信息，有参数则按照参数条件查询

参数名称	参数类型	必填	参数说明	备注
pageSize	Long	N	分页大小
pageNo	Long	N	分页号	不填默认第一页
subAccountNo	String	Y	账户号码
tradeType	String	N	交易类型	数据字典-0009-交易类型
tradeTimeStart	String	N	交易时间起	格式：yyyy-MM-dd HH:mm:ss
tradeTimeEnd	String	N	交易时间止	格式：yyyy-MM-dd HH:mm:ss
tradeAmountStart	BigDecimal	N	交易金额起
tradeAmountEnd	BigDecimal	N	交易金额止

返回参数(JSON)

参数名称	参数类型	参数说明	备注
msg	String	返回结果描述
code	String	响应状态码	数据字典-0001-响应状态码
success	boolean	是否成功	true/false
data	Object	返回数据	详情见下表

返回数据明细（data）

参数名称	参数类型	参数说明
pageNo	Long	页号
pageSize	Long	分页大小
pageCount	Long	分页总数
totalCount	Long	数据总条数
entityList	List	结果集

结果集明细（entityList）

参数名称	参数类型	参数说明	备注
subAccountNo	String	账户号码
tradeAmount	BigDecimal	交易金额
tradeType	String	交易类型	数据字典-0009-交易类型
tradeTime	DateTime	交易时间
tradeRemark	Long	交易备注

接口请求示例

=====================

必填参数查询

{
    "subAccountNo":"1001102001000303"
}

{
    "msg": "请求成功",
    "code": "200",
    "success": true,
    "data": [
        {
            "subAccountNo": "1001102001000303",
            "tradeAmount": 699.93,
            "tradeType": "3",
            "tradeTime": "2020-03-22 12:33:44",
            "tradeRemark": null
        },
        {
            "subAccountNo": "1001102001000303",
            "tradeAmount": 9999.00,
            "tradeType": "5",
            "tradeTime": "2020-03-22 12:33:44",
            "tradeRemark": null
        },
        {
            "subAccountNo": "1001102001000303",
            "tradeAmount": 1000.00,
            "tradeType": "3",
            "tradeTime": "2020-01-17 10:26:22",
            "tradeRemark": null
        }
    ]
}

多参数查询

{
    "subAccountNo":"1001102001000303",
    "tradeType":"3",
    "tradeAmountStart":699.93,
    "tradeTimeStart":"2020-03-22 00:00:00"
}

{
    "msg": "请求成功",
    "code": "200",
    "success": true,
    "data": [
        {
            "subAccountNo": "1001102001000303",
            "tradeAmount": 699.93,
            "tradeType": "3",
            "tradeTime": "2020-03-22 12:33:44",
            "tradeRemark": "服务费"
        }
    ]
}

1.1 充值账户查询​

简要描述​

请求 URL​

请求方式​

返回类型​

请求参数（无）​

2.1.4 返回参数(JSON)​

接口请求示例​

1.2 账户余额查询​

简要描述​

请求 URL​

请求方式​

返回类型​

请求参数(POST)​

返回参数(JSON)​

接口请求示例​

1.3 账户流水查询​

简要描述​

请求 URL​

请求方式​

返回类型​

请求参数(POST)​

返回参数(JSON)​

接口请求示例​

1.1 充值账户查询

简要描述

请求 URL

请求方式

返回类型

请求参数（无）

2.1.4 返回参数(JSON)

接口请求示例

1.2 账户余额查询

简要描述

请求 URL

请求方式

返回类型

请求参数(POST)

返回参数(JSON)

接口请求示例

1.3 账户流水查询

简要描述

请求 URL

请求方式

返回类型

请求参数(POST)

返回参数(JSON)

接口请求示例