CBK企业钱包分账

更新时间:2024-11-21 15:10:22

日期 接口 内容
2022-09-19 2.8分账交易退回 新增接口
2022-09-20 1.3CBK账户鉴权 1.4添加分账关系 1.3接口支持富友通道协议过期重发
1.4接口增加字段contract_type支持富友通道签约方式选择
2022-11-10 1.3CBK账户鉴权
1.5账户查询
增加返回字段
2022-12-08 1.4添加分账关系 版本号传入200时,返回银行预留手机号字段account_phone
2022-12-26 1.1CBK账户开户 增加品牌编号和角色id字段,用于将CBK账号归类到一个品牌下。
2023-10-12 1.5账户查询
1.6账户余额查询
api_ver增加110版本,增加返回字段。1.6账户余额查询接口增加返回“冻结的待结算金额”、“冻结的可提现金额”。1.5账户查询接口增加返回“银行转账充值账号”
2023-12-12 部分接口 新增三方门店编号:partner_store_no_out 三方门店出账户
partner_store_no_in 三方门店入帐户
2024-03-22 2.1账户余额分账 增加渠道类型order_type

接口调用流程

有自己做入网开户后台需求的,可以对接接口中的账户类接口开户(看下方各通道开户流程)。若不自己做开户操作,可使用CBK后台进行入网开户,或者联系运营同事协助进行开户,只需要对接交易类接口(看流程中的分账流程)。

各通道开户流程

富友通道

第一步:调用1.1CBK账户开户接口,如果有扫呗商户号,可直接填写扫呗商户号进行开户;如果没有 扫呗商户,可传递开户信息(cust_info)进行开户。

第二步:调用1.4添加分账关系接口,添加分账关系时,签约类型需使用短信或者签约链接。如果contract_type 使用的是1.短信,将会向银行卡预留手机号发送短信,对公户收到的短信内的签约链接为填写打款金额,对私户收到的签约链接为人脸认证。如果contract_type 使用的是签约链接,接口直接返回链接,由调用方自己决定怎么使用这个签约链接。可通过1.8分账关系查询1.5账户查询,来确认分账关系是否建立成功或者账户是否已授权。

第三步:如果第二步中的签约操作在24小时内没有进行确认,需要调用1.3CBK账户鉴权接口,会重新进行链接的发送。如果没有超过24小时,调用1.3接口将会返回错误提示。

第四步:若第二步中添加分账关系提示银行卡相关错误,需要调用1.7结算卡信息修改接口,如果没有报错,可以忽略此步骤。后续如果有结算卡变更的需求,也可调用该接口。

第五步:根据分账场景,调用2.2批量订单分账或者2.1账户余额分账接口。分账时可传递回调地址,分账成功时可向指定地址发送通知,回调地址的编写要求为2.6分账交易回调通知接口

第六步:其它接口可根据需求选择使用。

中信通道

第一步:调用1.1CBK账户开户接口,如果有扫呗商户号,可直接填写扫呗商户号进行开户;如果没有 扫呗商户,可传递开户信息(cust_info)进行开户。

第二步:调用1.2CBK账户开通接口,接口中使用扫呗商户号或者账号(2选 1)进行账户开通,接口中其它非必填参数可以不用传。

第三步:如果在调用1.2开通接口时,出现绑定银行卡的错误提示,需要调用1.7结算卡信息修改接口,如果没有报错,可以忽略此步骤。后续如果有结算卡变更的需求,也可调用该接口。

第四步:调用1.4添加分账关系接口,非必填参数可以不用传。

第五步:调用2.1账户余额分账接口,中信没有订单分账接口,并且没有回调通知接口。

第六步:其它接口可根据需求选择使用。

平安通道

第一步:调用1.1CBK账户开户接口,如果有扫呗商户号,可直接填写扫呗商户号进行开户;如果没有 扫呗商户,可传递开户信息(cust_info)进行开户。

第二步:调用1.3CBK账户鉴权接口,会根据结算卡是对公还是对私来决定是发短信还是打款。签约 类型( contract_type )字段不需要传递。

第三步:调用1.2CBK账户开通接口,根据第二步中收到的短信验证码或者打款金额,来决定验证类型( verify_type)的传值。

第四步:如果在第三步调用1.2开通接口时,出现绑定银行卡的错误提示,需要调用1.7结算卡信息修改接口,如果没有报错,可以忽略此步骤。由于平安通道修改结算卡需要鉴权,所以账户开通成功后,暂不支持结算卡的修改。

第五步:调用1.4添加分账关系接口,非必填参数可以不用传。

第六步:根据分账场景,如果配置了自动清分,只需要调用2.1账户余额分账接口进行子户分账;平安通道暂时无法使用订单分账接口。平安通道没有回调通知接口。

第七步:其它接口可根据需求选择使用。

账户类接口

1.1CBK账户开户

  • URL:account/open/createaccount
  • Method: POST
  • ContentType: application/json
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
brand_no String 8 Y 品牌编号
trace_no String 32 Y 请求流水号,不带“-”的uuid,商户侧需保证唯一性
merchant_no String 15 N 扫呗商户号(传扫呗商户号,则基于该商户的主体资料开户,cust_type和cust_info不需要传)
cust_type String 1 N 开户类型 1企业,2个体工商户,3个人(小微商户)(不传商户号,此字段必填)
cust_info String 1024 N 开户信息,JSON字符串,需要转义
identity_id String 11 N 账户类型id,值见下方说明。不传默认使用:8
key_sign String 32 Y 签名检验串,点击查看签名算法

identity_id账户类型id可用值,自定义账户类型,需要联系运营同事提供对应账户类型id

账户类型id 账户类型名称 说明
6 入账方 仅能作为分账接收方或提现
8 门店 通道能力允许的条件下能进行门店间的分账或提现
不传商户号cust_info字段如下:
参数名称 类型 长度 必填 说明
license_no String 32 N 证件号码,与企业证件类型对应的企业注册号 (企业与个体户必传)
license_name String 64 N 工商注册名称(与注册工商信息时一致) (企业与个体户必传)
license_expire String 10 N 证件到期日(格式YYYY-MM-DD)(企业与个体户必传)
legal_name String 32 N 法人姓名,用于实名认证企业的法人姓名(与注册工商信息时一致)(企业与个体户必传)
legal_no String 20 N 法人证件号码,用于实名认证企业的法人身份证号码(与注册工商信息时一致)(企业与个体户必传)
id_card_start_date String 10 Y 证件发证日期 yyyy-MM-dd(企业与个体户传法人,小微传负责人)
id_card_end_date String 10 N 证件到期日期 yyyy-MM-dd,如果证件到期日期为“长期”,则传:“2999-12-31”(企业与个体户传法人,小微传负责人)
legal_phone String 11 N 法人联系电话 (企业与个体户必传)
account_type String 1 Y 结算卡业务类型 枚举值:1:对公2:对私
account_name String 32 Y 结算卡开户姓名,绑定卡是对公卡,户名是企业名称,如果对私,户名是法人姓名
merchant_name String 20 N 户名简称。当account_name长度大于20时必传该字段。否则会因为account_name过长报错。
account_cardno String 30 Y 结算银行卡号
account_phone String 11 Y 结算卡银行预留手机号。
account_idnum String 20 Y 结算卡身份证号
bank_name String 64 Y 开户支行名称
bank_no String 25 Y 支行编号。银行编号表下载.
province_code String 8 Y 银联省code 省市区编号表下载
city_code String 8 Y 银联市code
county_code String 8 N 银联区code
image_business_license String 255 N 营业执照图片url
img_idcard_front String 255 N 身份证正面照url
img_idcard_back String 255 N 身份证背面照url
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
account_no String 19 N 扫呗CBK账户账号用于分账,提现,查询余额等接口交互
account_core_no String 19 N 通道子账户
cust_info String 1024 Y 返回信息,JSON字符串,需要转义

1.2CBK账户开通

  • URL:account/open/openaccount
  • Method: POST
  • ContentType: application/json
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 N CBK账号
merchant_no String 15 N 扫呗商户号(与CBK账号二选一)
verify_type String 1 N 验证类型:1.打款金额 2.短信验证码
verify_no String 16 N verify_type为1输入短信指令码
verify_type为2输入短信验证码
verify_amt String 11 N 打款金额(单位元),verify_type为1必填
key_sign String 32 Y 签名检验串,点击查看签名算法
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
account_no String 32 N CBK账号
account_status String 1 N 账户状态,枚举值: 0未申请 1正常 2上游审核中 3已冻结 4未开通 9已关闭
back_url String 255 N 开户签约地址

1.3CBK账户鉴权

说明:

  1. 平安分账通道时,调用完1.1CBK账户开户接口后,需要调用该接口进行账户鉴权,然后再调用1.2CBK账户开通接口。
  2. 富友分账通道时,如果调用1.4添加分账关系接口后,没有及时的做签约操作(操作24小时没签约),需要调用该接口进行重新签约。

结算卡对私:

银联验证卡信息:姓名、证件、卡号、银行预留手机是否相符以及校验个体工商户的工商五要素是否相符,相符则发送给会员手机动态验证码并返回成功,不相符则返回失败。验证码有效期120秒,需通过1.2CBK账户开通接口传入验证码对CBK账户进行开通,若验证码失效,这个步骤重新调用该接口即可

结算卡对公:

该接口发起成功后,银行会向提现账户转入小于等于0.5元的随机金额,并短信通知客户查看,客户查看后,需将收到的金额大小,通过1.2CBK账户开通接口传入验证金额对CBK账户进行开通,金额回填有效时间默认是48小时,每24小时只能发起1次。

  • URL:account/open/accountAuthentication
  • Method: POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 CBK账号(与扫呗商户号二选一)
merchant_no String 15 选填 扫呗商户号(与CBK账号二选一)
contract_type String 1 N 签约类型1.短信 2.签约链接 , 不传默认1(富友通道重新发起签约传此字段)
key_sign String 32 Y 签名检验串,点击查看签名算法

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
contract_url String 255 N 签约链接(富友通道,
contract_type=2返回)
account_type String 1 Y 结算卡类型:1对公 2对私

1.4添加分账关系

注:该接口的作用是把出账方和入账方两者的分账关系进行绑定。绑定分账关系时设置的分账规则,是分账最大可用比例,并不是要分账的比例,调用分账接口时可使用最大分账比例内任意比例计算金额进行分账。

  • Method: POST
  • url:account/open/addAccountIn

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 版本号,固定值200
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 30 Y 流水号
account_no_out String 32 Y 出账方CBK账号
account_rule String 1024 Y 分账规则,Json格式
contract_type String 1 N 签约类型 0免签约 1.短信 2.签约链接 , 不传默认0
relation_mode String 1 N 分账关系类型,不传时默认使用0。0.账户分账关系 1.非法人结算 2.委托付款 3.资金归集
relation_img String 1024 N 分账关系证明图片
key_sign String 32 Y 签名检验串,点击查看签名算法

以下字段为account_rule字段

参数名称 类型 长度 必填 说明
account_no_in String 32 Y 入账的CBK账号
allocate_scale Integer 5 Y 设置最大可分账比例(传值为0-10000),精度为0.01%,传3即比例为0.03%。设置最大可分账比例后,分账时可使用最大比例内任意比例计算分账金额后,调用2.1或2.2接口进行分账。

响应参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码01,成功 02失败
return_msg String 32 Y 业务响应描述
trace_no String 30 Y 请求流水号
result_code String 2 Y 业务处理响应码,01成功 02失败
relation_status String 1 N 分账关系状态:0.正常 1.已暂停 2.审核中
contract_url String 255 N 签约链接(富友通道,contract_type=2返回)
account_phone String 11 N 接收短信的手机号。(api_ver为200时,且contract_type为1或者2时返回)
key_sign String 32 Y 签名检验串,点击查看签名算法

1.5账户查询

  • URL:account/open/queryaccount
  • Method: POST
  • ContentType: application/json
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值140
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 32 选填 扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no String 32 选填 三方编号(与扫呗商户号、CBK账号、三方编号三选一)
key_sign String 32 Y 签名检验串,点击查看签名算法
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
identity_name String 32 N 账户类型名称
account_no String 32 Y 扫呗CBK账号
account_custom_name String 32 N CBK账户名
account_name String 32 Y 结算卡开户姓名
account_cardno String 32 Y 结算银行卡号
account_status String 1 Y 账户状态,枚举值: 0未申请 1正常 2上游审核中 3已冻结 4未开通 5已授权,到账银行卡更换处理中 9已关闭
bank_name String 30 Y 发卡行名称
open_time String 19 Y 开户时间yyyy-MM-dd HH:mm:ss
account_channel String 1 Y CBK账户当前分账通道:5.富友 6中信 7平安
channel_account_no String 32 N 通道子帐号
account_core_no String 32 N 通道子帐号
register_status String 1 N 分账通道申请状态 0未申请 1入驻开通成功 2待鉴权 3入驻申请中 4入驻申请驳回 5更换银行卡失败 6已风控 7其他错误 9已关闭
account_idnum String 20 Y 结算人身份证号
account_type String 1 Y 结算卡类型:1对公 2对私
account_phone String 11 Y 结算人手机号
business_license_type String 1 N 账户类型:1企业,2个体工商户,3个人(小微商户)
license_name String 32 N 营业执照名称
license_no String 32 N 营业执照编号
legal_name String 32 N 法人名称
legal_idnum String 32 N 法人身份证号

1.6账户余额查询

  • URL:account/open/querybalance
  • Method: POST
  • ContentType: application/json
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,可用值:100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 32 选填 扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no String 32 选填 三方编号(与扫呗商户号、CBK账号、三方编号三选一)
key_sign String 32 Y 签名检验串,点击查看签名算法
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
account_no String 32 N CBK账号
freeze_bal String 11 N 冻结金额,查询的账户已冻结的金额(账户总额-账户可用金额-待结算金额)单位分
total_bal String 11 N 账户总额,查询的账户的账户总额(冻结金额+账户可用金额+待结算金额)单位分
available_bal String 11 N 账户可用金额,查询的账户的可提现金额(账户总额-冻结金额-待结算金额)单位分
prepaid_bal String 11 N 待结算金额(不可提现) 单位分

1.7结算信息修改

  • URL:account/open/updateaccount
  • Method: POST
  • ContentType: application/json
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 32 选填 扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no String 32 选填 三方编号(与扫呗商户号、CBK账号、三方编号三选一)
account_info Sting 2 Y 结算信息 JSON格式字符串
key_sign String 32 Y 签名检验串,点击查看签名算法
account_info:
参数名称 类型 长度 必填 说明
account_cardno String 32 Y 结算银行卡号
account_name String 32 Y 结算卡开户姓名,绑定卡是对公卡,户名是企业名称,如果对私,户名是法人姓名
bank_no String 25 Y 支行编号,支行编号的值参见银行简称附录.银行编号表下载.
bank_name String 64 Y 开户支行名称
province_code String 8 Y 银联省code 省市区编号表下载
city_code String 8 Y 银联市code
account_idnum String 20 Y 结算卡身份证号
principal_phone String 11 N 银行预留手机号(若需要只修改手机号,可只传该字段,其它字段可不传)
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid

1.8分账关系查询

  • Method: POST
  • url:account/open/queryAccountIn
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 版本号,固定值100
trace_no String 32 Y 流水号
inst_no String 8 Y 机构编号,扫呗分配
account_no_out String 32 选填 出账方CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 32 选填 出账方扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no_out String 32 选填 出账方三方编号(与扫呗商户号、CBK账号、三方编号三选一)
account_no_in String 32 N 分账入账方CBK账号
partner_store_no_in String 32 N 分账入账方三方编号
key_sign String 32 Y 签名检验串,点击查看签名算法

响应参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码01,成功 02失败
return_msg String 32 Y 业务响应描述
trace_no String 30 Y 请求流水号
account_in_list String 1 Y JsonArray 入账方
result_code String 2 Y 业务处理响应码,01成功 02失败
key_sign String 32 Y 签名检验串,点击查看签名算法

account_in_list:

参数名称 类型 长度 必填 说明
account_no_in String 32 Y 分账入账户
account_name_in String 32 Y 入账方方名称
allocate_scale String 32 Y 分账比例 单位(万分之)
ledger_status String 32 Y '分账状态:0正常 1已失效 2申请中 3未申请'

1.9分账对账单下载

  • URL:https://example.com/order/account/day/inst_no/key_sign/inst_no_day.txt
  • Method:GET
  • 请注意:对账单只能获取生产环境数据,测试环境测试数据无法获取。
  • 有对账单下载需求的机构,请先联系利楚商务提交开通对账单下载功能邮件申请。
  • 只能下载“对账单下载”功能开启后的对账单,无法下载未开启功能之前的对账单。
  • 接口不能下载当天的对账单,只能下载前一天的对账单。


若返回以上内容,并不是说密钥不对。提示是未找到对账单文件,请检查是否开启对账单下载功能,或者检查拼接的地址是否正确。


请求路径中example.com只是个示例,请联系对接人员获取真实域名。请求路径中除了/order、account.txt,其它全部是变量名,在实际请求中需要替换成变量的值,示例如下:

http://open.lcsw.cn/order/account/20220918/33100010/0161c86f602b02ddf9be76d2da/33100010_20220918.txt

签名算法
MD5加密,utf-8格式转小写,加密后得到key_sign的值,并替换url中的key_sign。

String key_sign = MD5.encode(day=xxxxxx&inst_no=xxxxxx&key=xxxxxx);

签名参数:
参数名称 说明
day 日期,yyyyMMdd,例如:20170208
inst_no 机构号
key 机构号对应的令牌
请求结果中,每一行表示一条交易记录,记录中各参数以,号分隔。各参数含义如下所示: "出账CBK账号","出账CBK名称","入账CBK账号","入账CBK名称","创建日期","创建时间","交易金额(分)","手续费(分)","交易单号","CBK出账订单号","合作商交易流水号","交易类型","入账状态","完成时间","返回码描述","分账通道","附加数据"

参数说明:

参数名称 说明
出账CBK账号 出账CBK账号
出账CBK名称 出账CBK名称
入账CBK账号 入账CBK账号
入账CBK名称 入账CBK名称
创建日期 创建日期
创建时间 创建时间
交易金额 单位 分
手续费 单位 分
交易单号 交易单号
CBK出账订单号 对应出账CBK单号
合作商交易流水号 合作商交易流水号
交易类型 交易类型 2转账(包括实时清分)3充值 4提现
入账状态 入账状态 1成功 2失败
完成时间 完成时间
返回码描述 返回码描述
分账通道 6 中信
附加数据 附加数据

1.10新增绑定结算信息

  • URL: account/open/manager/addBindCard
  • Method: POST
  • ContentType: application/json;charset:utf-8;

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 Y CBK账号
account_cardno String 32 Y 结算银行卡号
account_name String 32 Y 结算卡开户姓名,绑定卡是对公卡,户名是企业名称,如果对私,户名是法人姓名
bank_no String 25 Y 支行编号
account_idnum String 20 Y 结算卡身份证号
account_phone String 11 Y 银行预留手机号
bank_name String 64 Y 开户支行名称
inst_no String 8 Y 机构编号,扫呗分配
brand_no String 8 N 品牌编号
province_code String 8 Y 银联省code
city_code String 8 Y 银联市code
county_code String 8 N 银联区code
parent_bank_no String 8 Y 开户行code
settle_type String 1 Y 结算类型 1对公 2对私
key_sign String 32 Y 签名检验串,点击查看签名算法
bind_type Integer 4 Y 0:新增 1:新增并切同时绑定

返回参数:

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
key_sign String 32 N 签名检验串,点击查看签名算法

交易类接口

2.1账户余额分账

  • URL:account/open/dotrans
  • Method: POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 Y 分账流水号,可使用商户订单号,多次请求时请勿使用同一个值,每次请求需使用不同的值。
account_out String 32 选填 出账方CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_out String 15 选填 出账方扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no_out String 32 选填 出账方三方编号(与扫呗商户号、CBK账号、三方编号三选一)
account_in String 32 选填 入账方CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_in String 15 选填 入账方扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no_in String 32 选填 入账方三方编号(与扫呗商户号、CBK账号、三方编号三选一)
amt String 11 Y 分账金额,单位分
notify_url String 128 N 回调通知地址
order_type String 1 N 业务来源类型:1微信 2支付宝 3其他 4抖音 5美团 6饿了么 7通联 8快手 9大众点评 10富友 11随行付 12乐刷 13库享
order_body String 128 Y 交易备注
attach String 128 N 附加数据
key_sign String 32 Y 签名检验串,点击查看签名算法

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 N 分账流水号,原样返回
out_trade_no String 32 N 分账交易订单号,分账完成后生成的唯一流水号
trade_status String 1 N 订单状态 1:成功 2:失败 3:处理中(需使用回调或者查询)
attach String 128 N 交易备注

2.2扫呗支付订单分账

注:

1.该接口只支持富友通道。

2.若要根据扫呗支付的每笔订单,单笔计算分账金额,并进行分账,可使用该接口。非扫呗支付订单,不支持订单分账,请使用2.1余额分账。

3.当天的支付订单,发起订单分账,为预分帐操作,在第二天完成资金到账。若是对之前的订单发起分账,则分账资金实时到账。

  • URL:account/open/batchAllocate
  • Method:POST

请求参数
参数名称 类型 长度 必填 说明
pay_ver String 3 Y 版本号,固定值100
inst_no String 15 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 出账方CBK账号(与扫呗商户号、CBK账号二选一)
merchant_no String 15 选填 出账方扫呗商户号(与扫呗商户号、CBK账号二选一)
trade_no String 32 Y 分账流水号,可使用商户订单号,多次请求时请勿使用同一个值,每次请求需使用不同的值。
rule_list_json String 1024 Y 分账列表,json字符串
order_body String 128 N 订单描述
out_trade_no_list List 32 Y 扫呗支付的扫呗订单号
attach String 128 N 附加数据,原样返回
notify_url String 128 N 回调通知地址
key_sign String 32 Y 签名检验串,点击查看签名算法
以下字段为rule_list_json字段
参数名称 类型 长度 必填 说明
account_in String 15 Y 分账入账户
allocate_amt Number 11 Y 分账固定金额 单位:分
allocate_trace String 32 Y 入账流水号(需生成唯一值,后续用于分账查询
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 Y 分账流水号,返回商户系统的订单号
out_trade_no String 32 Y 利楚唯一分账订单号
allocate_date String 32 N 分账发起日期
allocate_in_list String N 入账订单集合
attach String 32 N 附加数据,原样返回
以下字段为 allocate_in_list字段
参数名称 类型 长度 必填 说明
account_in String 15 Y 分账入账户
allocate_amt Number 11 Y 分账入账金额 单位:分
allocate_trace String 32 N 入账流水号
sub_trade_no String 32 Y 利楚入账子订单号
trade_status String 2 Y 入账交易状态 1:成功 2:失败 3:处理中 4.待分账
allocate_msg String 128 Y 子订单交易状态描述

2.3账户提现

  • URL:account/open/withdrawapply
  • Method: POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trade_no String 32 Y 提现流水号,商户侧需保证唯一性
trace_no String 32 Y 请求流水号,不带“-”的uuid
amt String 11 Y 交易金额,单位分
account_no String 32 选填 CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 15 选填 扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no String 32 选填 三方编号(与扫呗商户号、CBK账号、三方编号三选一)
attach String 128 N 交易备注
notify_url String 255 N 外部系统通知地址
key_sign String 32 Y 签名检验串,点击查看签名算法

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 N 提现流水号,原样返回
out_trade_no String 32 N 交易订单号,交易完成后生成的唯一流水号
poundage String 11 N 提现手续费,单位分
trade_status String 2 N 订单状态 2:失败 3:处理中
attach String 128 N 交易备注

2.4交易详情查询

  • URL:account/open/queryorder
  • Method: POST
  • ContentType: application/json
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 N 交易请求(分账、提现)流水号(使用2.1账户余额分账接口进行分账时,该字段传2.1账户余额分账接口里返回的trade_no;使用2.2批量订单分账接口进行分账时,该字段传递2.2批量订单分账接口里返回的allocate_trace;查询提现明细时,该字段传递2.3账户提现接口trade_no),
trade_no和out_trade_no两者选其一
out_trade_no String 32 N 扫呗交易订单号(使用2.1账户余额分账接口进行分账时,该字段传2.1账户余额分账接口里返回的out_trade_no。使用2.2批量订单分账接口进行分账时,该字段传递2.2批量订单分账接口里返回的sub_trade_no),
trade_no和out_trade_no两者选其一
key_sign String 32 Y 签名检验串,点击查看签名算法
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
trade_no String 32 N 商户自己的交易流水号,原样返回
out_trade_no String 32 N 扫呗交易订单号,交易完成后生成的唯一流水号
amt String 11 N 交易金额,单位分
name_out String 32 N 出账方姓名
account_out String 15 N 出账方CBK账号
account_in String 15 N 入账方CBK账号,提现交易返回银行卡号.
name_in String 32 N 入账方账户名
create_time String 19 N 交易创建时间yyyy-MM-dd HH:mm:ss
finish_time String 19 N 交易完成时间yyyy-MM-dd HH:mm:ss
trade_status String 2 N 交易状态:0.未知 1.成功 2.失败 3.处理中 4.待分账 5.分账回退成功
trade_type String 1 N 交易类型: 0.未知 1.订单分账 2.余额分账 3.充值 4.提现 5.清分
attach String 128 N 交易备注

2.5提现交易回调通知

  • Method: POST
  • ContentType: application/json
注:商户成功接收回调,请返回{"return_code": "01","return_msg": "success"} JSON字符串. 推送参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trade_no String 32 N 商户交易流水号
out_trade_no String 32 N 交易订单号
amt String 11 N 交易金额,单位分
trade_status String 1 N 交易状态1:成功,2:失败
finish_time String 19 N 交易完成时间yyyy-MM-dd HH:mm:ss
attach String 128 N 交易备注
order_body String 255 N 备用字段
需返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 返回信息提示

2.6分账交易回调通知

  • Method: POST
  • ContentType: application/json
注:商户成功接收回调,请返回{"return_code": "01","return_msg": "success"} JSON字符串. 推送参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trade_no String 32 N 商户交易流水号
out_trade_no String 32 N 分账订单号
sub_out_trade_no String 32 N 入账子订单号
total_transfer_amt String 11 N 分账订单总金额,单位分
amt String 11 N 分账入账金额,单位分
trade_status String 1 N 分账状态1:成功,2:失败
account_out String 32 N 出账方CBK账号
merchant_out String 15 N 扫呗出账商户号
account_in String 32 N 入账方CBK账号
merchant_in String 15 N 扫呗入账商户号
finish_time String 19 N 分账完成时间yyyy-MM-dd HH:mm:ss
attach String 128 N 备注
order_body String 255 N 备用字段
需返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 返回信息提示

2.7分账数据列表查询

  • Method: POST
  • url:account/open/queryTradesByDate

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 版本号,固定值100
trace_no String 32 Y 请求流水号,不带“-”的uuid
inst_no String 15 Y 机构编号,扫呗分配
account_no String 32 Y CBK账号
start_date String 8 Y 查询开始日期,格式为yyyyMMdd
end_date String 8 Y 查询结束日期,格式为yyyyMMdd
page String 11 Y 页码
query_flag String 1 N 查询标志
中信:不需要传这个字段,默认查所有类型数据
平安:必传参数:1:交易明细汇总 2:提现 3:清分
key_sign String 32 Y 签名检验串,点击查看签名算法

响应参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码01,成功 02失败
return_msg String 32 Y 业务响应描述
trace_no String 30 Y 请求流水号
tradeDataList List 1 Y CBK账号交易详情
result_code String 2 Y 业务处理响应码,01成功 02失败
key_sign String 32 Y 签名检验串,点击查看签名算法
total_page String 15 Y 总页数
total_number String 15 Y 记录总数
account_channel int 11 Y CBK账号所属通道

tradeDataList列表

参数名称 类型 长度 必填 说明
trans_date String 8 Y 交易日期,格式:
YYYYMMDD
trans_time String 6 Y 交易时间,格式:HHMMSS
trans_type String 1 Y 交易类型: 1.订单分账 2.余额分账3. 充值(清分)4.提现 5.分账退回
trans_flag String 1 N 资金方向
1:转出 2:转入
amt String 11 Y 交易金额,单位:分
out_trade_no String 15 Y CBK分账订单号
channel_trade_no String 10 Y 通道分账订单号
trade_status String 1 Y 0:成功
order_body String 128 Y 交易备注

2.8分账交易退回

  • URL:account/open/allocateRefund
  • Method:POST
接口说明: 1、 允许多次回退。累计退回金额需小于等于源分账金额。 2、 退回发起时,入账方余额不足的情况下,此笔退回交易失败,后续需继续尝试退回,需重新调用本接口。
请求参数
参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 15 Y 机构编号,扫呗分配
brand_no String 15 N 品牌编号
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 Y 退会单号,可使用商户系统的分账退回订单号(多次请求退回时,要保证每次的单号唯一,不能重复使用一个单号)
out_trade_no String 32 N 原分账订单号(sub_trade_no不传时,此字段必填)
account_in String 15 N 原分账入账CBK账号(sub_trade_no不传时,此字段必填)
sub_trade_no String 32 N 原分账入账子订单号(或余额分账接口返回的out_trade_no)
allocate_amt Number 11 Y 分账退回金额 单位:分
attach String 128 N 附加数据,原样返回
key_sign String 32 Y 签名检验串,点击查看签名算法
返回参数
参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 Y 交易流水号,返回商户系统的订单号
out_refund_no String 32 N 利楚分账退回订单号
trade_status String 2 N 订单状态 1:退回成功 2:退回失败
attach String 32 N 附加数据,原样返回

2.9查询时间段内渠道入金交易明细

  • Method: POST
  • url:account/open/manager/queryChannelTransIn

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 当前可用版本号100、110
trace_no String 32 Y 请求流水号,不带“-”的uuid
inst_no String 15 Y 机构编号,扫呗分配
brand_no String 15 Y 品牌编号,扫呗分配
trans_in_date String 10 Y 入金日期,(格式YYYY-MM-DD)
current_pageid int 8 Y 页码,初始值为1
key_sign String 32 Y 签名检验串,点击查看签名算法

响应参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码01,成功 02失败
return_msg String 32 Y 业务响应描述
trace_no String 30 Y 请求流水号
transDataList String 1024 Y 挂账交易详情
result_code String 2 Y 业务处理响应码,01成功 02失败
key_sign String 32 Y 签名检验串,点击查看签名算法
total_page String 15 Y 总页数
total_number String 15 Y 记录总数
account_channel int 11 Y CBK账号所属通道

transDataList为json字符串类型

参数名称 类型 长度 必填 说明
trans_date String 8 N 交易日期,格式:
YYYY-MM-DD
trans_amt String 12 N 交易金额,单位:分
bank_info String 50 N 转账银行信息
remark String 50 N 转账备注
channel_trade_no String 50 N 渠道流水号
account_no_in String 32 N CBK账号(api_ver=110时返回)
trans_in_no String 25 N 入金账号
trans_in_name String 25 N 入金账户名称
trans_out_no String 25 N 出金账号
trans_out_name String 25 N 出金账户名称
trans_type String 2 N 01:转账入金
02:会员充值/退票入账
03:支付渠道入金

CBK收银台

测试环境地址:http://test.lcsw.cn:4601

接口调用流程

画板

3.1收银台H5链接

  • URL: /account/open/100/cashierlink
  • Method: POST
  • ContentType: application/json;charset:utf-8;
  • CBK收银台H5链接
调用该接口,需先调用订单同步接口,返回预支付单号。

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
trace_no String 32 Y 请求流水号,不带“-”的uuid
inst_no String 32 Y 机构号
account_no String 32 选填 出账方CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 32 选填 出账方扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no String 32 选填 出账方三方编号(与扫呗商户号、CBK账号、三方编号三选一)
prepay_no String 32 Y 预支付订单号
key_sign String 32 Y 签名检验串,点击查看签名算法

返回参数:

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
key_sign String 32 N 签名检验串,点击查看签名算法
cashier_url String N CBK收银台H5链接地址

3.2订单同步

  • URL: /account/open/100/ordersync
  • Method: POST
  • ContentType: application/json;charset:utf-8;
  • 订单同步

支持多订单批量同步,单批次订单数量不能超过25个,接口返回预支付订单号(获取收银台链接使用)

同步订单成功后30分钟内允许支付

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 15 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 出账方CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_no String 32 选填 出账方扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no String 32 选填 出账方三方编号(与扫呗商户号、CBK账号、三方编号三选一)
order_list String Y 订单列表,json字符串
notify_url String 255 N 回调通知地址
key_sign String 32 N 签名检验串,点击查看签名算法
order_list:
参数名称 类型 长度 必填 说明
order_trace String 32 Y 订单号,商户侧需保证唯一性(如果商户侧没有订单号,生成随机的唯一值即可)
account_in String 32 选填 入账方CBK账号(与扫呗商户号、CBK账号、三方编号三选一)
merchant_in String 32 选填 入账方扫呗商户号(与扫呗商户号、CBK账号、三方编号三选一)
partner_store_no_in String 32 选填 入账方三方编号(与扫呗商户号、CBK账号、三方编号三选一)
amt String 11 Y 分账金额,单位分
order_body String 128 N 交易备注:商品描述
reciver_address String 128 N 收货地址
attach String 128 N 订单备注

返回参数:

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
key_sign String 32 N 签名检验串,点击查看签名算法
account_no String 32 N 出账方CBK账号
merchant_no String 32 N 出账方扫呗商户号
prepay_no String 32 Y 预支付订单号(收银台链接使用)
order_list String Y 订单列表,json字符串
order_list:
参数名称 类型 长度 必填 说明
trade_no String 32 Y CBK订单号(可用于查询订单交易详情)
order_trace String 32 Y 订单号,商户侧需保证唯一性(如果商户侧没有订单号,生成随机的唯一值即可)
account_in String 32 Y 入账方CBK账号
merchant_in String 32 N 入账方扫呗商户号
amt String 11 Y 分账金额,单位分
order_body String 128 N 交易备注:商品描述
reciver_address String 128 N 收货地址
attach String 128 N 附加数据,原样返回
create_time String Y 订单创建时间 yyyy-MM-dd HH:mm:ss

3.3订单交易详情查询

  • URL: /account/open/100/orderquery
  • Method: POST
  • ContentType: application/json;charset:utf-8;
  • 订单交易详情查询

订单查询,单号传递有三种方式,三选一,推荐优选方式一:

方式一:用CBK订单号,传:trade_no

方式二:用商户订单号,传:order_trace

方式三:用分账订单号,传:out_trade_no(订单未分账时,不能使用该字段查询)

同时传递时,会默认使用CBK订单号trade_no查询

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 15 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
key_sign String 32 N 签名检验串,点击查看签名算法
trade_no String 32 N CBK订单号 (与商户订单号,分账订单号三选一)
order_trace String 32 N 商户订单号 (与CBK订单号,分账订单号三选一)
out_trade_no String 32 N 分账订单号(与CBK订单号,商户订单号三选一)

返回参数:

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
key_sign String 32 N 签名检验串,点击查看签名算法
trade_no String 32 Y CBK收银台订单号
order_trace String 32 Y 商户订单号
out_trade_no String 32 N 分账订单号
amt String 11 Y 订单金额(单位分)
account_out String 32 Y 出账方CBK账号
name_out String 32 N 出账方CBK名称
merchant_out String 32 N 出账方扫呗商户号
account_in String 32 Y 收款方CBK账号
name_in String 32 N 收款方CBK名称
merchant_in String 32 N 收款方扫呗商户号
trade_status String 10 N 交易状态
SUCCESS 支付成功,
PAYERROR 支付失败, NOTPAY 未支付,
NOPAY 未支付支付超时,
USERPAYING 用户支付中,
REVOKED 已撤销, CLOSED 已关闭
order_body String 128 N 商品信息
reciver_address String 128 N 订单收货地址
attach String 128 N 订单备注
channel_result_msg String 128 N 失败原因
create_time String Y 订单创建时间 yyyy-MM-dd HH:mm:ss
finish_time String N 订单交易完成时间 yyyy-MM-dd HH:mm:ss
close_time String N 订单关闭时间 yyyy-MM-dd HH:mm:ss

3.4订单关闭

  • URL: /account/open/100/orderclose
  • Method: POST
  • ContentType: application/json;charset:utf-8;
  • 订单关闭

订单关闭,单号传递有两种方式,二选一,推荐优选方式一:

方式一:用CBK订单号,传:trade_no

方式二:用商户订单号,传:order_trace

同时传递时,会默认使用CBK订单号trade_no查询

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 15 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
key_sign String 32 N 签名检验串,点击查看签名算法
trade_no String 32 选填 CBK订单号 (与商户订单号,分账订单号三选一)
order_trace String 32 选填 商户订单号 (与CBK订单号,分账订单号三选一)
out_trade_no String 32 选填 分账订单号(与CBK订单号,商户订单号三选一)

返回参数:

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 原请求流水号
key_sign String 32 N 签名检验串,点击查看签名算法
trade_no String 32 Y CBK订单号
order_trace String 32 Y 商户订单号
account_out String 32 Y 出账方CBK账号
name_out String 32 N 出账方CBK名称
account_in String 32 Y 收款方CBK账号
name_in String 32 N 收款方CBK名称
close_time String Y 订单交易完成时间 yyyy-MM-dd HH:mm:ss

3.5交易回调通知

支付完成后,订单信息会通过订单同步接口中的 notify_url 异步通知,通过 POST 请求将支付结果作为参数通知到商户系统,商户需要接收处理,并按文档规范返回应答。

注:商户成功接收回调,请返回{"return_code": "01","return_msg": "success"} JSON字符串.

注意:
1、后台通知交互时,如果收到商户的应答超时,会判定本次通知失败,目前仅发送一次通知,不会发送多次通知,不保证通知最终一定能成功。

2、在订单状态不明或者没有收到支付结果通知的情况下,建议商户主动调用【查询交易详情接口】确认订单状态。

  • Method: POST
  • Content-type:application/json
  • URL:下单传入的notify_url

推送参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
trade_no String 32 Y CBK订单号
order_trace String 32 Y 商户订单号
out_trade_no String 32 N 分账订单号
amt String 11 Y 订单金额(单位分)
account_out String 32 Y 出账方CBK账号
merchant_out String 32 N 出账方扫呗商户号
account_in String 32 Y 收款方CBK账号
merchant_in String 32 N 收款方扫呗商户号
trade_status String 10 N 交易状态
SUCCESS 支付成功,
PAYERROR 支付失败
finish_time String N 订单支付完成时间 yyyy-MM-dd HH:mm:ss
attach String N 订单备注

需返回参数:

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 返回信息提示

数据类接口

4.1 申请电子业务凭证

  • URL:account/open/applyicreceipt
  • Method: POST
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 3 Y 版本号,固定值100
inst_no String 8 Y 机构编号,扫呗分配
trace_no String 32 Y 请求流水号,不带“-”的uuid
account_no String 32 选填 CBK账号(与扫呗商户号二选一)
merchant_no String 15 选填 扫呗商户号(与CBK账号二选一)
trade_type Sting 2 Y 订单类型:1.分账 2提现
out_trade_no String 32 Y 扫呗订单号
key_sign String 32 Y 签名检验串,点击查看签名算法

返回参数

参数名称 类型 长度 必填 说明
return_code String 2 Y 业务响应码,01成功 02失败
return_msg String 128 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
result_code String 2 N 业务处理响应码,01成功 02失败
trace_no String 32 Y 请求流水号,不带“-”的uuid
out_trade_no String 32 N 扫呗订单号
receipt_no String 32 N 电子回单编号
base_content String 2048 N 电子回单pdf转 base64码

不明来账接口

查询不明来账

  • Method: POST
  • url:account/zx/queryUnknownAccounts
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 版本号,固定值100
trace_no String 32 Y 请求流水号,不带“-”的uuid
brand_no String 8 Y 品牌编号
inst_no String 15 Y 机构编号,扫呗分配
page String 8 Y 页码,从1开始, 每页默认为20条
trans_date String 8 Y 交易日期,格式为yyyyMMdd
trans_status String 1 Y 交易状态
0:未处理,1:处理成功,9:所有
key_sign String 32 Y 签名检验串,点击查看签名算法

响应参数

参数名称 类型 长度 必填 说明
result_code String 2 Y 业务处理响应码,01成功 02失败
return_code String 2 Y 业务响应码01,成功 02失败
trace_no String 30 Y 请求流水号
return_msg String 32 Y 业务响应描述
total_number String 15 Y 记录总数
total_page String 10 Y 总页数
account_type String 1 Y 账户类型
current_page String 10 Y 当前页数
unkonwAccounts List Y 不明来账账单
key_sign String 32 Y 签名检验串,点击查看签名算法

unkonwAccounts列表

trans_status String 1 Y 交易状态
0:未处理,1:处理成功,2:处理中
account String 19 Y 交易资金账号
trdt String 8 Y 交易日期
格式:YYYYMMDD,主键组成字段
jrno String 14 Y 交易日志号
time_stampe String 26 Y 时间戳
opbn String 14 Y 对方行号
退款时,必上送字段
tram String 17 Y 交易金额
acsq String 6 Y 账户序号
客户账返回
bkno String 3 Y 银行号
客户账返回
actn String 13 Y 账户交易序号
客户账返回
ftfl String 1 Y 金融交易标识
客户账返回
remark String 100 Y 备注
reark1 String 100 Y 备用字段1
来账账号
reark2 String 100 Y 备用字段2
来账名称

处理不明来账

  • Method: POST
  • url:account/zx/handleUnknownAccount
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 版本号,固定值100
trace_no String 32 Y 请求流水号,不带“-”的uuid
inst_no String 15 Y 机构编号,扫呗分配
brand_no String 8 Y 品牌编号
operate_type String 1 Y 操作类型
0:退款,1:重新匹配,2实时清分
account_type String 1 Y 交易资金账户类型
0:客户账,1:内部账
account String 19 Y 交易资金账号
查询接口返回
trdt String 8 Y 交易日期
查询接口返回
jrno String 14 Y 交易日志号
查询接口返回
time_stampe String 26 Y 时间戳
查询接口返回
opbn String 14 Y 对方行号
退款时必输,重新匹配时可为空
tram String 17 Y 交易金额
查询接口返回
key_sign String 32 Y 签名检验串,点击查看签名算法

响应参数

result_code String 2 Y 业务处理响应码,01成功 02失败
return_code String 2 Y 业务响应码01,成功 02失败
trace_no String 30 Y 请求流水号
return_msg String 32 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法

查询不明来账处理状态

  • Method: POST
  • url:account/zx/handleQueryUnknownAccount
  • ContentType: application/json

请求参数

参数名称 类型 长度 必填 说明
api_ver String 11 Y 版本号,固定值100
trace_no String 32 Y 请求流水号,不带“-”的uuid
inst_no String 15 Y 机构编号,扫呗分配
brand_no String 8 Y 品牌编号
account_type String 1 Y 交易资金账户类型
0:客户账,1:内部账
account String 19 Y 交易资金账号
查询接口返回
trdt String 8 Y 交易日期
查询接口返回
jrno String 14 Y 交易日志号
查询接口返回
time_stampe String 26 Y 时间戳
查询接口返回
tram String 17 Y 交易金额
查询接口返回
key_sign String 32 Y 签名检验串,点击查看签名算法

响应参数

result_code String 2 Y 业务处理响应码,01成功 02失败
return_code String 2 Y 业务响应码01,成功 02失败
trace_no String 30 Y 请求流水号
return_msg String 32 Y 业务响应描述
key_sign String 32 Y 签名检验串,点击查看签名算法
trans_status String 1 Y 交易状态
0:未处理,1:处理成功,2:处理中

© 利楚商服 2020 All rights reserved.