聚合支付平台接入手册

收钱吧

收钱吧API文档：

接口文档：https://doc.shouqianba.com/zh-cn/ B扫C接口：https://doc.shouqianba.com/zh-cn/api/interface/pay.html

服务商登陆网址：

https://crm.shouqianba.com/login

驾校开通收钱吧商户号操作流程：

商户信息收集-开放接口

 公共说明

o 公共请求

o 公共响应

o 签名

 接口列表

o 申请入驻（/api/cis/v1/merchants/apply）

o 查询申请进度（/api/cis/v1/merchants/apply/query）

o 创建门店（/api/cis/v1/stores/create）

o 门店列表（/api/cis/v1/stores/list）

o 门店信息（/api/cis/v1/stores/detail）

o 文件上传（/api/cis/v1/files/upload）

o 获取开户行名称（/api/cis/v1/utilities/banks/query_

by_

cardnumber）

o 模糊搜索银行名称（/api/cis/v1/utilities/banks/query_

by_

name）

o 查询银行的分支机构（/api/cis/v1/utilities/banks/branches/list）

 附录

o 地区编码表

o 行业编码

公共说明

公共请求

请求地址

生产：https://vapi.shouqianba.com

测试：https://vip-apigateway.iwosai.com

本平台所有请求格式均采用 JSON 格式，请求字符集采用 UTF-8 编码。所有请求均按照以下通用格式定义：

参数 出

现 类型 约束 描述

request 1 String

JSON 格式的

string 字符串 标志一次接口请求的请求体

request.head 1 String

JSON 格式的

string 字符串 标志本次请求的公共参数

request.body 1 String

JSON 格式的

string 字符串 标志本次请求的业务对象

signature 1 String 签名 本次请求的请求体的加密签名，用于接口安

全性校验。签名规则见本文档目录 1.3

参数 出

现 类型 约束 描述

request.head.appid 1 String

数字，最大

32 位 应用授权号，由收钱吧提供

request.head.request_time 1 String

字符串，最

大 64 位

请求时间，格式：2019-10-

01T12:08:56+05:30

request.head.sign_type 1 String

SHA1、

SHA256

签名算法，目前支持 SHA1。SHA1：

SHA1WithRSA；SHA256：

SHA256WithRSA

request.head.reserve

0-

1 String

字符串，长

度不限 业务反射参数

request.head.version 1 String

字符串，最

大 10 位

被调用方的接口版本号，当前版本

1.0.0

请求示例

请求示例

{

"

request"

:{"head"

:{

"

"

"

"

"

version

"

:

"1.0.0"

,

appid"

:

"28lp61847655"

,

sign_type

"

:

"SHA256"

,

"

request_time

:

"2001-07-04T12:08:56+05:30"

"

reserve

:

"{}"

,

},

"body

"

:{

"

client_id"

:

"

cef236aa5d58416092199ac6dede29a2"

"

client_merchant_sn

"

:

"73656906035"

,

}

},

"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1

QQ8rEV6+uMh3GWbyzH02Y9dJQCW==

"

}

公共响应

本平台所有响应返回均采用 JSON 格式，body 均采用 UTF-8 编码。

所有响应均按照以下通用格式定义：

参数 出

现 类型 约束 描述

response 1 String

JSON 格式的

string 字符串 标志本次业务返回结果体

response.head 1 String

JSON 格式的

string 字符串 标志本次业务返回结果体头部数据

response.body 1 String

JSON 格式的

string 字符串 标志本次业务返回结果体的业务返回对象

signature 1 String

签名，RSA 加

密

本次请求的返回体的加密签名，用于接口安

全性校验。签名规则见本文档目录 1.3

字段名	字段含 义	取值	备注
response.body.result_code	通讯响 应码	200，400， 500	200：通讯成功；400： 客户端错误；500:服务 端错误
response.body.error_code	通讯错 误码	见 通信错误 码表	通讯 失败 的时候才返 回
response.body.error_message	通讯错 误信息 描述	见 通信错误 码表	通讯 失败 的时候才返 回
response.body.biz_response	业务响 应数据	JSON 结构	通讯 成功 的时候才返 回
response.body.biz_response.result_code	业务执 行响应 码	见 业务响应 定义	SUCCESS：业务处理成 功，FAIL：业务处理失 败
response.body.biz_response.error_code	业务执 行结果 返回码	见 业务响应 定义	业务处理失败时返回
response.body.biz_response.error_message	业务执 行错误 信息	见 业务响应 定义	业务处理失败时返回
response.body.biz_response.data	业务执 行返回 参数	见各具体接 口的返回参 数定义

相应示例

响应示例

{

"

"

response

: {

"head"

: {

"

version

"

:

"1.0.0"

,

"

appid"

:

"28lp61847655"

,

"

sign_type

"

:

"SHA256"

,

"

response_time

"

:

"2001-07-04T12:08:56+05:30"

,"

"

reserve

:

"{}"

},

"body

"

: {

"

result_code

"

:

"biz_response

"

"

result_code

"data

"

: {

"

client_id"

"200"

: {

"

:

,

"SUCCESS"

,

"

"

"

:

cef236aa5d58416092199ac6dede29a2"

client_merchant_sn

"

:

"73656906035"

,

status

"

: 1

,

}

}

}

},

"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+u

Mh3GWbyzH02Y9dJQCW==

"

}

通讯错误码

序号	result_code	error_code	error_message
1	200	-	-	通讯成功
2	400	ILLEGAL_SIGN	签名错误	请求签名不正确
3	400	ILLEGAL_APPLICATION	非法应用	调用 appid 不存在
4	400	INVALID_PARAMS	参数错误	参数不复合接口调用规则
5	500	UNKNOWN_ERROR	系统错误	服务端出现未知错误

业务响应码序

号 result_code error_code error_message 说明

1 SUCCESS - - 业务执行成功

2 FAIL 实际业务错误

码

业务执行失败原

因

业务执行失败，失败原因：

error_meesage

签名

请求参数签名：

 第一步：商户生成一份 RSA 公钥私钥，将公钥交付于收钱吧，收钱吧会使用该公

钥验证签名，RSA 密钥使用 2048 位

 第二步：将完整的请求内容（不包含”

request”字段，仅包括 request 的值）使用

RSA 私钥签名，并转换为 BASE64 编码

 第三步：将生成的签名填充到请求体中的 signature 当中

返回结果验签：

 第一步：收钱吧生成一份 RSA 公钥私钥，将公钥交付于商户，商户需要使用该公

钥验证返回结果，RSA 密钥使用 2048 位

 第二步：使用正则表达式将请求字符串和签名字符串从完整的请求字符串中分离出

来

 第三步：使用收钱吧的公钥对于返回体签名进行验签

接口列表

申请入驻（/api/cis/v1/merchants/apply）

接口地址: {api_domain}/api/cis/v1/merchants/apply

请求方式: POST

签名 ：需要签名，参考统一签名说明

请求参数：参数

名称 参数 类型**(长度)** 必传 参数说明

客户

代码 client_id String(32)

由收钱吧提供

二选

一

服务

商编

号

vendor_sn String(32) 需先提供给收钱吧业务人员配置

推广

者账

号

crm_promoter_account String(32) N

1. 销售人员的疯狂收钱吧账

户

2. 若未提供正确账号，则使

用服务商在疯狂收钱吧的

账号

客户

系统

商户

号

client_merchant_sn String(32) Y

1、客户系统商户号，需在客户系

统内唯一

2、若申请被驳回，可使用同一商

户号重新提交资料，资料提交后

会覆盖原申请信息

联系

人信

息

contact object Y 指定联系人的信息

主体

信息 legal_entity object Y 商家的营业执照/登记证书、经营

者/法人的证件等信息

门店

信息 store object Y 商户门店的入网材料

结算

银行

账户

bank_account object Y 商家提现收款的银行账户信息

request.contact（联系人信息）：

参数

名称 参数 类型**(**长

度**)**

必

传 字段限制 参数说明姓名 name String(20) Y

2 至 20 个字符，支

持中文，不支持英

文、数字、特殊符

号、emoji，不支持

电话 cellphone String(11) Y

身份

证件

号码

id_number String(18) N

身份

证件

人像

照片

id_front_photo String(255) N jpg、jpeg，图片大小不

超过 1M

联系

人邮

箱

contact_email String(32) N

request.legal_entity（主体信息）：

参

数

名

称

参数 类型**(**长

度**)**

必

传 字段限制 联系人姓名

1、手机号码，11 位数

字

2、用于接收微信支付的

重要管理信息及日常操

作验证码请填写有效并

且可以拨通的电话号码

1、联系人证件号码

2、可填写身份证、港澳

通行证、台胞证证、非

中国护照等证件号码

联系人身份证件人像面

照片

1、需要带@，遵循邮箱

格式校验

2、用于接收微信支付的

开户邮件及日常业务通

知

参数说明主

体

类

型

行

业

信

息

行

业

许

可

证

证

照

图

片

type industry trade_license entity_photo String Y

String(32) N

String(255) N jpg、jpeg，图片

大小不超过 2M

String(255)

条

件

选

填

jpg、jpeg，图片

大小不超过 2M

请根据主体类型填写一

下代码。

0: 无营业执照

1：个体工商户

2：企业

3：事业单位

4：民办非企业单位

5：社会团体

6：基金会

参考收钱吧行业表，提

供行业编码

例：自动售货机行业

传：002028

若未传正确的行业编

码，则将按照配置的默

认行业入网

jpg、jpeg，图片大小不

超过 2M

1、无营业执照不填，

其他主体类型必填

2、主体为个体户工商

户/企业，请上传营业执

照，需年检章齐全，当

年注册除外；

3、事业单位，请上传

事业单位法人证书、统

一社会信用代码证书；

4、民办非企业单位/社

会团体/基金会，请上传

社会团体法人登记证

书、民办非企业单位登

记证书、基金会法人登

记证书单

位

授

权

函

证

照

号

码

证

照

主

体

名

称

主

体

简

称

证

照

注

册

地

址

certificate_letter_photo String(255)

条

件

选

填

entity_number String(18)

条

件

选

填

entity_name String(128)

条

件

选

填

entity_shortname String(40) Y

entity_address String(128)

条

件

选

填

jpg、jpeg，图片

大小不超过 2M

1.个体工商户营

业执照：15 位或

18 位，支持数

字、大写字母；

2、其他证照：18

位，支持数字或

大写字母；

2 至 50 个字

符，支持中英

文、中英文括

号、《》-

至 40 个字符，

支持中英文、数

字、中英文

（）、《》、

，

至少包含 1 个中

文、不支持其他

特殊符号、emoji

营业证照登记的

注册地址，128

个字符，支持中

英文数字、字

符，不支持

emoji

1、事业单位必填，其

他主体类型选填

2、请参照示例图打印

单位证明函，全部信息

需打印，不支持手写商

户信息，并加盖公章

1、上传证照图片必填

2、营业执照，请填写

营业执照注册号

3、证书，请填写证书

号码

1、上传证照图片必填

2、营业执照上的商户

名称，

3、个体户，不能以

“公司”结尾，若营业

执照上商户名称为“空

“或“无”时，填写"个

体+经营者姓名"

，如

“个体张三”

4、证书，登记证书上

的商户名称

1. 在支付完成页向

买家展示

2. 商户经营名称

1、无营业执照，不填

2、个体工商/企业/事业

单位/民办非企业单位/

社会团体/基金会，请填

写证书的注册地址证

照

有

效

日

期

开

始

时

间

entity_period_begin String(32)

条

件

选

填

1、无营业执照，不填

2、其他主体类型，请

填写证照有效期

示例：2019-01-01

证

照

有

效

日

期

结

束

时

间

entity_period_end String(32)

条

件

选

填

1、无营业执照不填/其

他类型必填

2、若证件有效期为长

期，请填写：长期

3、结束日期大于开始

日期

4、有效期必须大于 60

天

示例：2019-08-01，长

期

经

营

者/

法

人

证

件

representative object

条

件

选

填

无营业执照选填，其他

主体类型必填

request.legal_entity.representative（主体资料-经营者/法人身份证件）：

参数名

称 参数 类型**(**长

度**)**

必

传 字段限制 参数说明证件类

型 id_type 证件正

面照片 id_front_photo 证件背

面照片 id_back_photo 证件姓

名 id_name 证件号

码 id_number String(32) Y

String(255) Y jpg、jpeg，图片大小

不超过 1M

String(255)

条

件

选

填

jpg、jpeg，图片大小

不超过 1M

String(32) Y

1）身份证：2 至 40

个字符，支持中文及

【·】；

2）港澳台：2 至 40

个字符，支持中文，

或英文加空格；

3）非中华人民共和国

护照：2 至 40 个字

符，支持英文加空

格；

String(32) Y

1、身份证：18 位数

字或 X；

2、港澳居民来往内地

通行证：H 或 M 开

证件类型：1：中国大

陆身份证、2：非中国

护照、3：台胞证、

4：港澳通行证

1、请上传证件人像页

照片

2、可上传 1 张图

片，请填写通过图片

上传接口预先上传图

片生成好的 url

1、身份证，请上传国

徽面照片

2、非中国护照，请上

传入境盖章页

3、台胞证、港澳通行

证可不填写

4、可上传 1 张图

片，请填写通过图片

上传接口预先上传图

片生成好的 url

证件上的姓名

证件上的号码头+8 位数字

3、台湾居民来往大陆

通行证：8 位数字

4、非中华人民共和国

护照：9 位数字或字

母

证件有

效日期

开始时

间

结束时间大于开始时

id_period_begin String(32) Y

间

示例：2019-01-01

证件有

效日期

截止时

间

id_period_end String(32) Y

1、必填，请按照示例

值填写

2、若证件有效期为长

期，请填写：长期

3、结束时间大于开始

时间

4、证件有效期需大于

60 天

示例：2030-01-01、

长期

request.store（主体资料-店铺信息）：

参

数

名

称

参数 类型**(长度)** 必

传 字段限制 参数说明门

店

名

称

store_name 客

服

电

话

service_phone 店

铺

地

区

编

码

address_code 店

铺

地

址

address 门

头

照

片

store_photo 室

外

环

境

照

片

outdoor_photos 室 indoor_photos String(40） Y

2 至 40 个字符，支持

中英文数字，支持符号()

（）-·

~

_

<>《》

不支持特殊符号、emoji

String(32) Y 5-20 位数字，支持固

话、手机号

String(32) Y

String(128） Y

5 至 128 字符，支持中

英文数字，至少包含一

个中文，支持符号()

（）-

~

·

、

_

<>《》|#；

不支持特殊符号，emoji

String(255)

条

件

选

填

jpg、jpeg，图片大小不

超过 2M

[ String(255) ]

条

件

选

填

jpg、jpeg，图片大小不

超过 2M

[ String(255) ] 条 jpg、jpeg，图片大小不 在交易记录中向

买家展示，请确

保电话畅通以便

平台回拨确认

填写门店省市编

码，只能由数字

组成，详细参见

省市对照表

填写店铺详细地

址，具体区/县及

街道门牌号或大

厦楼层

1、提交门店门

口照片，要求招

牌清晰可见

2、可上传 1 张

图片，请填写通

过图片上传接口

预先上传图片生

成好的 url

1、至少上传 1

张门店外部环境

照片，请填写通

过图片上传接口

预先上传图片生

成好的 url

1、门店内部环内

环

境

照

片

件

选

填

超过 2M 其

他

照

片

other_photos [ String(255) ] N jpg、jpeg，图片大小不

超过 2M

经

营

场

地

证

明

address_certification String(255) N jpg、jpeg，图片大小不

超过 2M

request.bank_account：（结算银行账户）：

参

数

名

称

参数 类型**(长度)** 必

传 字段限制 境照片

2、至少上传 1

张，请填写通过

图片上传接口预

先上传图片生成

好的 url

1、特殊场景需

要补充上传图片

1、请上传门面

租赁合同扫描件

或经营场地证明

（需与身份证同

名）

2、可上传 1 张

图片，请填写通

过图片上传接口

预先上传图片生

成好的 url

参数说明账

户

类

型

开

户

名

称

银

行

账

号

开

户

银

行

名

称

开

户

地

区

account_type enum Y

account_name String(128） Y

account_number String(32) Y

bank_name String(128） Y

bank_address_code String(32) Y

对私：2 至

40 个字符，

支持中文及

【·】

对公：2 至

50 个字符，

支持中英文、

数字、半角全

角（）-

《》，不支持

特殊符号、

emoji

1、对私：14

至 19 位数字

（不支持存

折）

2、对公：7

至 32 位数字

1：对私个人银行

卡，2：对公银行账

户

无营业执照/个体工

商可结算至对私

选择“对公银行账

户”时，开户名称必

须与营业执照上的

“商户名称”

一致

1、数字

开户银行全程可通过

对私银行卡号或者关

键词查询

至少精确到市，详细

参见省市区编号对照

表编

码

开

户

支

行

全

称

账

户

证

明

照

片

银

行

卡

有

效

期

结

算

人

身

份

证

信

息

授

权

函

辅

助

证

branch_name String(128） Y

account_photo String(255) Y

card_validity_date String(32) N

account_holder Object

条

件

选

填

auth_photo String(255)

条

件

选

填

hand_letter_of_authorization [ String(255) ]

条

件

选

jpg、jpeg，图

片大小不超过

2M

jpg、jpeg，图

片大小不超过

3M

开户支行全称，需通

过开户银行名称和开

户地区编码查询

1、对私个人银行

卡：银行卡照片

2、对公银行账户：

开户许可证/银行印

鉴卡/银行回单（三

选一）

1、对私结算必填，

示例：2030-10

2、对公银行账户不

需要填写

1、无营业执照必填

2、若结算账户为非

法人对私账户，则结

算人身份证信息必

填。

主体类型非无营业执

照，且结算至非法人

账户，则提供授权

函。

1、最多提交三张照

片，小于 3m明

材

料

填 2、个体工商户非法

人结算，如果授权委

托书不能加盖公章，

需要提供辅助证明：

 授权人和结算

人的关系证明

（户口本、结

婚证、出生

证、房产证等

证明授权人和

结算人的亲属

关系）

 提供授权人手

持委托书和结

算人的合照

 被授权人与该

商户门头的合

影

request.bank_account.account_holder（结算账户-开户人证件信息）：

参数名称 参数 类型**(**长

度**)**

必

传 字段限制 参数说明身份证人

像页照片 id_front_photo String(255) Y jpg、jpeg，图片

大小不超过 1M

1、请上传身份证人像页照

片

2、可上传 1 张图片，请

填写通过图片上传接口预

先上传图片生成好的 url

身份证国

徽页照片 id_back_photo String(255) Y jpg、jpeg，图片

大小不超过 1M

1、身份证，请上传国徽面

照片

2、可上传 1 张图片，请

填写通过图片上传接口预

先上传图片生成好的 url

身份证姓

名 id_name String(32) Y

2 至 40 个字

符，支持中文

及【·】

身份证姓名

身份证号

码 id_number String(18) Y 身份证：18 位

数字或 X 身份证号码

身份证有

效日期开

始时间

id_period_begin String(32) Y 1、结束时间大于开始时间

示例：2019-01-01

身份证有

效日期截

止时间

id_period_end String(32) Y

1、必填，请按照示例值填

写

2、若证件有效期为长期，

请填写：长期

3、结束时间大于开始时间

4、证件有效期需大于 60

天

示例：2030-01-01、长期

响应参数：无业务响应参数，完整响应示例

提交成功响应示例

{

"

"

response

: {

"head"

: {

"

version

"

:

"1.0.0"

,

"

appid"

:

"28lp61847655"

,

"

sign_type

"

:

"SHA256"

,"

response_time

"

:

"2001-07-04T12:08:56+05:30"

,

"

"

reserve

:

"{}"

},

"body

"

: {

"

result_code

"

:

"200"

,

"biz_response

"

: {

"

result_code

"

:

"SUCCESS"

}

}

},

"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+u

Mh3GWbyzH02Y9dJQCW==

"

}

查询申请进度（/api/cis/v1/merchants/apply/query）

接口地址: {api_domain}/api/cis/v1/merchants/apply/query

请求方式: POST

签名 ：需要签名，参考统一签名说明

请求参数：

参数名称 参数 类型**(长度)** 必填项 参数说明

客户编号 client_id String(32)

由收钱吧分配的客户 ID

二选一

服务商编号 vendor_sn String(32) 需先提供给收钱吧业务人员配置

外部商户号 client_merchant_sn String(32) Y 客户系统商户号，商户系统唯一

响应参数

参数名

称 参数 类型

必

填

项

参数说明

客户编

号 client_id String(32) Y 客户编号

客户系 统商户 号	client_merchant_sn	String(32)	Y	客户系统商户号
收钱吧 商户号	merchant_sn	String(32)	N	入网成功后返回该字段
商户名 称	name	String(32)	Y	提交申请时传入的商户名称
申请状 态	status	String(32)	Y	1:入网中、2: 待账户验证、3: 待签约、 4: 入网成功、5：开通中 、6：待店铺 认证、 9: 已驳回
签约链 接	sign_url	String(255)	N	1、请联系人用微信扫码打开签约链 接，根据页面指引完成绑定微信号、账 户验证、签约等操作 2、绑定微信号后，后续申请单进度可 通过公众号自动通知联系人
驳回原 因	reject_reason	String(512)	N	驳回说明
审核详 情	audit_detail	[ AuditDetail ]	N	各资料驳回原因，当申请状态为已驳回 时，才返回该字段
商户二 维码	merchant_qrcode	String	N	申请状态为待店铺认证时返回，需商户 实地拍摄门店照片

参数名称	参数	类型	必填项	参数说明
字段属性	field	String(64)	Y	驳回信息属性名
字段名称	field_name	String(32)	N	驳回信息名称
驳回原因	reject_reason	String(64)	N	驳回原因

AuditDetail

创建门店（/api/cis/v1/stores/create）接口地址: {api_domain}/api/cis/v1/stores/create

请求方式: POST

签名 ：需要签名，参考统一签名说明

请求参数：

参数 名称	参数	类型	必 填 项	参数说明
商户 号	merchant_sn	String(32)	Y	商户审核通过后查询到的收钱吧商户号
商户 门店 号	client_store_sn	String(32)	Y	商户系统的门店号，商户系统中唯一
门店 名称	name	String(128)	Y	商户门店名称
联系 人名 称	contact_name	String(32)	N	只支持中英文、数字
联系 人电 话	contact_cellphone	String(13)	N
联系 人邮 箱	contact_email	String(32)	N
地区 编码	area	String(6)	Y	标准地区编码，参见附录
详细 地址	street_address	String(128)	Y	5 至 128 字符，支持中英文、数字，支持 符号（），。 -；不支持特殊符号，emoji
门头 照片	brand_photo	String(255)	N	通过上传文件接口获取的 url
室内	indoor_photo	String(255)	N	通过上传文件接口获取的 url

照片

室外

照片 outdoor_photo String(255) N 通过上传文件接口获取的 url

其他

照片 other_photos String(1024) N 通过上传文件接口获取的 url，多张图片请

用”

,

”分割

备注 remark String(255) N

经度 longitude String(16) N 116.307490

纬度 latitude String(16) N 39.984154

响应参数：

参数名称 参数 类型 必填

项 参数说明

商户号 merchant_sn String(32) Y 商户审核通过后查询到的收钱吧商户号

商户门店

号

client_

store_sn

String(32) Y 商户系统的门店号，商户系统中唯一

门店名称 name String(32) Y 商户门店名称

状态 status String(2) Y 0-申请中，1-已入网；在创建时只会返

回 0

门店列表（/api/cis/v1/stores/list）

接口地址: {api_domain}/api/cis/v1/stores/list

请求方式: POST

签名 ：需要签名，参考统一签名说明

请求参数：

参数名称 参数 类型 必填项 参数说明

请求页码 page String(32) Y 第一页为 1页面大小 page_size String(32) Y 最大支持 100

商户号 merchant_sn String(32) Y 商户审核通过后查询到的收钱吧商户号

商户门店号 client_store_sn String(32) N 商户系统的门店号，商户系统中唯一

门店名称 name String(32) N 商户门店名称

响应参数：

参数名称 参数 类型 必填项 参数说明

总记录数 total String(32) Y 查询匹配的全部门店数

当前页码 page String(32) Y 第一页为 1

页面大小 page_size String(32) Y 查询页面大小，最大为 20

页面内容 records Store[] Y 门店列表，

门店：

参数名称 参数 类型 必填

项 参数说明

商户门店

号 records.client_store_sn String(32) Y 商户的门店号

店号 收钱吧门

records.store_sn N 收钱吧门店号，创建门店申请通过

后存在

门店激活

码 records.active_code String(16) N 收钱吧门店激活码，创建门店申请

通过后存在

状态 records.status String(2) Y 0-申请中，1-已入网；

门店名称 records.store_name Y 商户门店名称

门头照 records.brand_photo String(255) N url，创建门店时传入的门头照

备注 records.remark String(255) N 门店备注信息

门店信息（/api/cis/v1/stores/detail）接口地址: {api_domain}/api/cis/v1/stores/detail

请求方式: POST

签名 ：需要签名，参考统一签名说明

请求参数：

参数名称 参数 类型 必填

项 参数说明

商户号 merchant_sn String(32) Y 商户审核通过后查询到的收钱吧商户号

收钱吧门店

号 store_sn String(32) N 收钱吧门店号，与商户门店号不可同时

为空。

商户门店号 client_store_sn String(32) N 商户门店号，传入收钱吧门店号时，该

值无效

响应参数：

参数名

称 参数 类型

必

填

项

参数说明

商户号 merchant_sn String(32) Y 商户审核通过后查询到的收钱吧商户号

收钱吧

门店号 store_sn String(32) N 收钱吧门店号，创建门店申请通过后存在

活码 门店激

active_code String(16) N 收钱吧门店激活码，创建门店申请通过后

存在

商户门

店号 client_stroe_sn String(32) Y 商户系统的门店号，商户系统中唯一

状态 status String(2) Y 0-申请中，1-已入网；

门店名

称 name String(32) Y 商户门店名称

联系人

名称 contact_name String(32) N 只支持中英文、数字联系人

电话 contact_cellphone String(13) N

联系人

邮箱 contact_email String(32) N

地区编

码 area String(16) Y 标准地区编码，参见附录

详细地

址 street_address String(128) Y 5 至 128 字符，支持中英文、数字，支持

符号（），。

-；不支持特殊符号，emoji

门头照

片 brand_photo String(255) N 通过上传文件接口获取的 url

室内照

片 indoor_photo String(255) N 通过上传文件接口获取的 url

室外照

片 outdoor_photo String(255) N 通过上传文件接口获取的 url

其他照

片 other_photos String(1024) N 通过上传文件接口获取的 url，多张图片

用"

,

"分割

备注 remark String(255) N

经度 longitude String(16) N 116.307490

纬度 latitude String(16) N 39.984154

文件上传（/api/cis/v1/files/upload）

文件上传使用 multipart/form-data 形式进行上传。

接口地址: {api_domain}/api/cis/v1/files/upload

请求方式: POST

请求参数：

参数名称 参数 类型 必填项 参数说明

图片信息 file File Y

参数名称	参数	类型	必填项	参数说明
图片地址	url	字符串(255)	Y	上传图片的访问地址

参数名称	参数	类型	必填项	参数说明
银行卡号	card_number	String(45)	N	仅支持个人账户用该字段查询

参数名称	参数	类型	必填项	参数说明
银行名称	bank_name	String	Y

响应参数：

获取开户行名称

（/api/cis/v1/utilities/banks/query_

by_

cardnumber）

接口地址：{api_domain}/api/cis/v1/utilities/banks/query_by_cardnumber

请求方式：POST

签名 ：需要签名，参考统一签名说明

请求参数：

请求响应：

模糊搜索银行名称

（/api/cis/v1/utilities/banks/query_

by_

name）

接口地址：{api_domain}/api/cis/v1/utilities/banks/query_by_name

请求方式：POST

签名 ：需要签名，参考统一签名说明

请求参数：

参数名称	参数	类型	必填项	参数说明
银行类型	bank_type	Integer	Y	1=对私银行，2=对公银行
银行名称	bank_name	String(45)	Y	银行名称，模糊查询
请求页码	page	String(32)	Y	第一页为 1
页面大小	page_size	String(32)	Y	页码最大支持 100，默认 20

请求响应：

参数名称	参数	类型	必填项	参数说明
总记录数	total	String(32)	Y	查询匹配的总记录数
当前页码	page	String(32)	Y	第一页为 1
页面大小	page_size	String(32)	Y	查询页面大小，最大为 100，默认 20
页面内容	records	Bank []	Y
参数名称	参数	类型	必填项	参数说明
银行名称	bank_name	String Y

请求示例

{

"

request"

: {

"head"

: {

"

"

"

"

"

version

"

:

"1.0.0"

,

appid"

:

"28lp61847655"

,

sign_type

"

:

"SHA256"

,

"

response_time

:

"2001-07-04T12:08:56+05:30"

,

"

reserve

:

"{}"

},

"body

"

: {

"

"

page

:

"1"

,

"

page_size

"

:

"bank_type

"

"bank_name

:

"

"20"

"1"

:

"农业"

}

},"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+u

Mh3GWbyzH02Y9dJQCW==

"

}

响应示例

{

"

"

response

: {

"head"

: {

"

version

"

:

"1.0.0"

,

"

appid"

:

"28lp61847655"

,

"

sign_type

"

:

"SHA256"

,

"

response_time

"

:

"2001-07-04T12:08:57+05:30"

,

"

"

reserve

:

"{}"

},

"body

"

: {

"

result_code

"

:

"200"

,

"biz_response

"

: {

"

result_code

"

:

"SUCCESS"

,

"data

"

: {

"total"

:

"1"

"

"

page

:

"1"

"

page_size

"

:

"20"

"

records

"

:[

{"bank_name

"

:

"中国农业银行"}

]

}

}

}

},

"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+u

Mh3G231212danlajnlkja02Y9dJQCW==

"

}

查询银行的分支机构

（/api/cis/v1/utilities/banks/branches/list）

接口地址：{api_domain}/api/cis/v1/utilities/banks/branches/list请求方式：POST

签名 ：需要签名，参考统一签名说明

请求参数：

参数名称	参数	类型	必填项	参数说明
开户银行名	bank_name	String(45)	Y
开户地区编号	bank_area	String(6)	Y
请求页码	page	String(32)	Y	第一页为 1
页面大小	page_size	String(32)	Y	页码最大支持 100，默认 20

请求响应：

参数名称 参数			类型		必填项		参数说明
总记录数 total			String(32)	Y		查询匹配总记录数
当前页码	page	String(32)		Y		第一页为 1
页面大小	page_size	String(32)		Y			查询页面大小，最大为 100，默认 20
页面内容	records		Branch []	Y
参数名称		参数		类型		必填项 参数说明
银行分支名称		branch_name		String Y

请求示例

{

"

request"

: {

"head"

: {

"

"

"

"

"

version

"

:

"1.0.0"

,

appid"

:

"28lp61847655"

sign_type

"

:

"SHA256"

,

response_time

"

:

"

reserve

:

"{}"

,

"2001-07-04T12:08:56+05:30"

,

},

"body

"

: {

"

"

page

:

"1"

,"

page_size

"

:

"bank_name

"

"20"

"

"bank_area

:

:

"中国农业银行"

,

"320506"

,

}

},

"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+u

Mh3GWbyzH02Y9dJQCW==

"

}

响应示例

{

"

response

"

: {

"head"

: {

"

version

"

:

"1.0.0"

,

"

appid"

:

"28lp61847655"

,

"

sign_type

"

:

"SHA256"

,

"

response_time

"

:

"2001-07-04T12:08:57+05:30"

,

"

"

reserve

:

"{}"

},

"body

"

: {

"

result_code

"

:

"200"

,

"biz_response

"

: {

"

result_code

"

:

"SUCCESS"

,

"data

"

: {

"total"

:

"35"

"

"

page

:

"1"

"

page_size

"

:

"20"

"

records

"

:[

{"bank_name

"

:

"中国农业银行苏州市镇湖分理处"},

{"bank_name

"

:

"中国农业银行苏州城中支行"},

{"bank_name

"

:

"中国农业银行苏州浒关支行"},

...

]

}

}

}

},

"

signature

"

:

"blmSaxUF6/N2XOcz7UWRRVQ5XsVCEz1BpZl6R9Rc6TA3+IfWhJtmCsUZjtw72w1QQ8rEV6+u

Mh3G231212danlajnlkja02Y9dJQCW==

"

}