Version | Update Time | Status | Author | Description |
---|---|---|---|---|
v2 |
2022-11-10 |
release |
xcd |
1.2版本 |
1.商户接口
1.1.发起批量转账
Type: POST
Content-Type: application/json
Description: 发起批量转账
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
mchOrderNo |
string |
商户业务单号 (商户需确保唯一性) |
true |
- |
agreementNo |
string |
签约号 (由平台提供,可通过 /agreement/query 进行查询) |
true |
- |
orderDate |
string |
结算日期 |
true |
- |
paymentType |
string |
支付类型 PAYMENT_TYPE_BANK (银行) PAYMENT_TYPE_WECHAT (微信) PAYMENT_TYPE_ALIPAY (支付宝) |
true |
- |
orderTaxType |
string |
税费方式 ORDER_TAX_TYPE_PRE (税前) ORDER_TAX_TYPE_AFTER (税后) |
true |
- |
totalNum |
int32 |
总笔数 |
true |
- |
totalAmount |
number |
总任务金额 |
true |
- |
remark |
string |
备注 |
false |
- |
details |
array |
批量代发明细 |
true |
- |
└─mchDetailNo |
string |
商户明细号 (商户需确保单内唯一性) |
true |
- |
└─jobAgreementNo |
string |
任务协议号 (由平台提供,可通过 /job/query 进行查询) |
true |
- |
└─userName |
string |
收款人姓名 (AES加密) |
true |
- |
└─mobile |
string |
手机号码 (AES加密) |
true |
- |
└─idEntity |
string |
身份证 (AES加密) |
true |
- |
└─wxOpenId |
string |
个人微信openid (paymentType=PAYMENT_TYPE_WECHAT 时必填) |
false |
- |
└─wxAppId |
string |
商户自有微信appid (paymentType=PAYMENT_TYPE_WECHAT 时必填) |
false |
- |
└─bankCardNo |
string |
银行卡 (paymentType=PAYMENT_TYPE_BANK 时必填) |
false |
- |
└─alipayLoginId |
string |
支付宝登录号 (paymentType=PAYMENT_TYPE_ALIPAY 时必填) |
false |
- |
└─amount |
number |
任务款 |
true |
- |
└─remark |
string |
备注 |
false |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/transfer/batch' --data '{
"mchOrderNo": "\"CUNO00001\"",
"agreementNo": "1468878407301922818",
"orderDate": "",
"paymentType": "PAYMENT_TYPE_ALIPAY",
"orderTaxType": "ORDER_TAX_TYPE_AFTER",
"totalNum": 1,
"totalAmount": 1000.00,
"remark": "",
"details": [
{
"mchDetailNo": "D000001",
"jobAgreementNo": "100001",
"userName": "李三",
"mobile": "13812345678",
"idEntity": "\"110101199001010001\"",
"wxOpenId": "\"\"",
"wxAppId": "\"\"",
"bankCardNo": "\"\"",
"alipayLoginId": "\"\"",
"amount": 1000.00,
"remark": "\"remark\""
}
]
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
1.2.批量转账结果查询
Type: POST
Content-Type: application/json
Description: 批量转账结果查询
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
pageCurrent |
int32 |
当前页 |
false |
- |
pageSize |
int32 |
每页显示大小 |
false |
- |
mchOrderNo |
string |
商户业务单号 |
true |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/transfer/batch/query' --data '{
"pageCurrent": 1,
"pageSize": 10,
"mchOrderNo": "CUNO00001"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
└─header |
object |
结算头 |
- |
└─mchOrderNo |
string |
商户批次号 |
- |
└─journalNo |
string |
流水号 |
- |
└─orderNo |
string |
业务处理单号 |
- |
└─contractNo |
string |
合同编号 |
- |
└─enterpriseName |
string |
企业名称 |
- |
└─taxType |
string |
税费方式 ORDER_TAX_TYPE_PRE (税前) ORDER_TAX_TYPE_AFTER (税后) |
- |
└─paymentType |
string |
支付类型 PAYMENT_TYPE_BANK (银行) PAYMENT_TYPE_WECHAT (微信) PAYMENT_TYPE_ALIPAY (支付宝) |
- |
└─status |
string |
状态 |
- |
└─statusName |
string |
状态名称 |
- |
└─detailNum |
int32 |
笔数 |
- |
└─amount |
number |
发起金额 |
- |
└─serviceFee |
number |
服务费 |
- |
└─totalAmount |
number |
结算总金额 |
- |
└─personServiceFee |
number |
个人服务费 |
- |
└─personAmount |
number |
个人应收 |
- |
└─pendingDescription |
string |
待处理描述 |
- |
└─orderTime |
string |
业务时间 |
- |
└─details |
array |
结算明细 当 status=FINISHED | TERMINATION 时显示 |
- |
└─orderDetailNo |
string |
业务处理明细号 |
- |
└─paymentJournalNo |
string |
支付流水号 |
- |
└─mchDetailNo |
string |
商户明细号 |
- |
└─receiptNo |
string |
付款回单号 |
- |
└─receiptMessage |
string |
付款回复信息 |
- |
└─batchNo |
string |
批次号 |
- |
└─jobAgreementNo |
string |
授权商户号 |
- |
└─jobName |
string |
任务名称 |
- |
└─userName |
string |
收款人名称 |
- |
└─accountNo |
string |
收款人账号 |
- |
└─amount |
number |
任务款 |
- |
└─serviceFee |
number |
服务费 |
- |
└─totalAmount |
number |
结算金额 |
- |
└─personServiceFee |
number |
个人服务费 |
- |
└─personAmount |
number |
个人应收 |
- |
└─status |
string |
状态 |
- |
└─statusName |
string |
状态名称 |
- |
└─remark |
string |
备注 |
- |
└─startTime |
string |
提交时间 |
- |
└─finishTime |
string |
完成时间 |
- |
└─pageInfo |
object |
明细分页信息 当 status=FINISHED | TERMINATION 时显示 |
- |
└─totalCount |
int64 |
总记录数 |
- |
└─pageSize |
int64 |
每页记录数 |
- |
└─pageCurrent |
int64 |
当前页数 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
1.3.商户签约查询
Type: POST
Content-Type: application/json
Description: 商户签约查询
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
pageCurrent |
int32 |
当前页(默认1) |
false |
- |
pageSize |
int32 |
每页显示大小(默认10) |
false |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/agreement/query' --data '{
"pageCurrent": 1,
"pageSize": 10
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
└─totalCount |
int32 |
总记录数 |
- |
└─pageSize |
int32 |
每页记录数 |
- |
└─pageCurrent |
int32 |
当前页数 |
- |
└─list |
array |
列表数据 |
- |
└─agreementNo |
string |
签约号 |
- |
└─contractNo |
string |
合同编号 |
- |
└─agreementDominant |
string |
签约主体 |
- |
└─agreementEnterprise |
string |
签约企业 |
- |
└─merchantEnterpriseNo |
string |
商户企业编码 |
- |
└─contractServiceRate |
number |
合同费率 |
- |
└─status |
int32 |
合同状态 0-无效;1-有效 |
- |
└─statusName |
string |
状态 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
1.4.商户签约任务查询
Type: POST
Content-Type: application/json
Description: 商户签约任务查询
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
pageCurrent |
int32 |
当前页 |
false |
- |
pageSize |
int32 |
每页显示大小 |
false |
- |
agreementNo |
string |
签约号 (由平台提供,可通过 /agreement/query 进行查询) |
false |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/job/query' --data '{
"pageCurrent": 1,
"pageSize": 10,
"agreementNo": "1468878407301922818"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
└─totalCount |
int32 |
总记录数 |
- |
└─pageSize |
int32 |
每页记录数 |
- |
└─pageCurrent |
int32 |
当前页数 |
- |
└─list |
array |
列表数据 |
- |
└─jobAgreementNo |
string |
任务协议号 |
- |
└─jobName |
string |
任务名称 |
- |
└─jobTypeName |
string |
任务类型 |
- |
└─contractNo |
string |
合同编号 |
- |
└─agreementDominant |
string |
签约主体 |
- |
└─agreementEnterprise |
string |
签约企业 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
1.5.商户签约余额查询
Type: POST
Content-Type: application/json
Description: 商户签约余额查询
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
agreementNo |
string |
签约号 (由平台提供,可通过 /agreement/query 进行查询) |
true |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/agreement/balance/query' --data '{
"agreementNo": "1468878407301922818"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
array |
响应数据 |
- |
└─accountName |
string |
账号名称 |
- |
└─bankName |
string |
开户银行 |
- |
└─accountNo |
string |
银行账号 |
- |
└─paymentType |
string |
账号类型 |
- |
└─balance |
number |
余额 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
1.6.上传交付文件
Type: POST
Content-Type: application/json
Description: 上传交付文件
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
mchOrderNo |
string |
商户业务单号 |
true |
- |
documentUrl |
string |
证明文件url (url 和 Base64 必须有一个) |
false |
- |
documentBase64 |
string |
证明文件Base64 (url 和 Base64 必须有一个) |
false |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/transfer/supporting/document/upload' --data '{
"mchOrderNo": "\"CUNO00001\"",
"documentUrl": "\"https://xxx.domain.com/xxxx.pdf\"",
"documentBase64": "\"\""
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
1.7.批量转账回单下载
Type: POST
Content-Type: application/json
Description: 批量转账回单下载
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
pageCurrent |
int32 |
当前页 |
false |
- |
pageSize |
int32 |
每页显示大小 |
false |
- |
mchOrderNo |
string |
商户业务单号 |
true |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/merchant/{version}/transfer/batch/receipt/download' --data '{
"pageCurrent": 1,
"pageSize": 10,
"mchOrderNo": "CUNO00001"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
└─mchOrderNo |
string |
商户业务单号 |
- |
└─details |
object |
明细 |
- |
└─totalCount |
int32 |
总记录数 |
- |
└─pageSize |
int32 |
每页记录数 |
- |
└─pageCurrent |
int32 |
当前页数 |
- |
└─list |
array |
列表数据 |
- |
└─mchDetailNo |
string |
商户明细号 |
- |
└─receiptNo |
string |
付款回单号 |
- |
└─downloadUrl |
string |
下载链接 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
2.个人接口
2.1.上传身份证件
Type: POST
Content-Type: application/json
Description: 上传身份证件
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
idEntity |
string |
身份证 (AES加密) |
true |
- |
frontUrl |
string |
身份证正面url (身份证正面url和Base64必须有一个) |
false |
- |
frontBase64 |
string |
身份证正面Base64 (身份证正面url和Base64必须有一个) |
false |
- |
backUrl |
string |
身份证反面url (身份证反面url和Base64必须有一个) |
false |
- |
backBase64 |
string |
身份证反面Base64 (身份证反面url和Base64必须有一个) |
false |
- |
copiesUrl |
string |
复印件url (复印件url和Base64必须有一个) |
false |
- |
copiesBase64 |
string |
复印件Base64 (复印件url和Base64必须有一个) |
false |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/person/{version}/identity/file/upload' --data '{
"idEntity": "\"110101199001010001\"",
"frontUrl": "\"https://xxx.domain.com/xxxx-front.jgp\"",
"frontBase64": "\"\"",
"backUrl": "\"https://xxx.domain.com/xxxx-back.jgp\"",
"backBase64": "\"\"",
"copiesUrl": "",
"copiesBase64": ""
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
2.2.更新电话号码
Type: POST
Content-Type: application/json
Description: 更新电话号码
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
idEntity |
string |
身份证 (AES加密) |
true |
- |
mobile |
string |
手机号码 (AES加密) |
true |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/person/{version}/mobile/update' --data '{
"idEntity": "\"110101199001010001\"",
"mobile": "13812345678"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
2.3.上传合同文件
Type: POST
Content-Type: application/json
Description: 上传合同文件
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
idEntity |
string |
身份证 (AES加密) |
true |
- |
agreementNo |
string |
签约号 (由平台提供,可通过 /agreement/query 进行查询) |
true |
- |
contractNo |
string |
合同号 |
false |
- |
contractUrl |
string |
合同文件url (url 和 Base64 必须有一个) |
false |
- |
contractBase64 |
string |
合同文件Base64 (url 和 Base64 必须有一个) |
false |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/person/{version}/contract/file/upload' --data '{
"idEntity": "\"110101199001010001\"",
"agreementNo": "1468878407301922818",
"contractNo": "",
"contractUrl": "\"https://xxx.domain.com/xxxx-front.jgp\"",
"contractBase64": "\"\""
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
2.4.合同签署申请
Type: POST
Content-Type: application/json
Description: 合同签署申请
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
idEntity |
string |
身份证 (AES加密) |
true |
- |
userName |
string |
姓名 (AES加密) |
true |
- |
agreementNo |
string |
签约号 (由平台提供,可通过 /agreement/query 进行查询) |
true |
- |
appletPlatform |
int32 |
签约环境 (0-H5签约;1-小程序签约) |
true |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/person/{version}/contract/apply' --data '{
"idEntity": "\"110101199001010001\"",
"userName": "李三",
"agreementNo": "1468878407301922818",
"appletPlatform": 0
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
└─status |
string |
个人合同状态 |
- |
└─statusName |
string |
个人合同状态 |
- |
└─contractNo |
string |
合同号 |
- |
└─verifyUrl |
string |
实名url |
- |
└─signUrl |
string |
签约url |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
2.5.合同下载
Type: POST
Content-Type: application/json
Description: 合同下载
Request-headers:
Header | Type | Description | Required | Since |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
timestamp |
long |
请求时间戳 |
true |
- |
nonce |
string |
请求随机数 |
true |
- |
sign |
string |
签名 |
true |
- |
Body-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
idEntity |
string |
身份证 (AES加密) |
true |
- |
agreementNo |
string |
签约号 (由平台提供,可通过 /agreement/query 进行查询) |
true |
- |
Request-example:
curl -X POST -k -H 'Content-Type: application/json' -H 'appKey:xcdb3a0a97530c9c7fb3' -H 'timestamp' -H 'nonce' -H 'sign' -i 'https://demo.xincaiduo.com.cn/xcd-api/person/{version}/contract/download' --data '{
"idEntity": "\"110101199001010001\"",
"agreementNo": "1468878407301922818"
}'
Response-fields:
Field | Type | Description | Since |
---|---|---|---|
code |
int32 |
请求响应码 |
- |
resultCode |
string |
返回代码 |
- |
resultMessage |
string |
返回消息 |
- |
description |
string |
返回描述 |
- |
result |
object |
响应数据 |
- |
└─agreementNo |
string |
签约号 |
- |
└─contractNo |
string |
合同编号 |
- |
└─downloadUrl |
string |
实名url |
- |
requestId |
string |
请求序列号 |
- |
requestTime |
string |
响应时间 |
- |
3.通知
商户提供通知接收地址,由薪才多进行配置后生效
Type: POST
Content-Type: application/json;charset=UTF-8
Description: 通知数据包体
Request-headers:
Body-parameters:
Field | Type | Description | Since | |
---|---|---|---|---|
appKey |
string |
商户appKey |
true |
- |
id |
string |
唯一ID |
- |
|
createTime |
string |
创建时间 |
- |
|
resourceType |
string |
通知类型(5.2.通知类型) |
- |
|
resource |
object |
通知内容(需要AES解密,解密后为JSON格式);参见各自resourceType的数据结构 |
- |
3.1.批量转账通知
resourceType: TRANSFER_BATCH
Field | Type | Description | Since |
---|---|---|---|
mchOrderNo |
string |
商户批次号 |
- |
journalNo |
string |
流水号 |
- |
orderNo |
string |
业务处理单号 |
- |
contractNo |
string |
合同编号 |
- |
enterpriseName |
string |
企业名称 |
- |
taxType |
string |
税费方式 ORDER_TAX_TYPE_PRE (税前) ORDER_TAX_TYPE_AFTER (税后) |
- |
paymentType |
string |
支付类型 PAYMENT_TYPE_BANK (银行) PAYMENT_TYPE_WECHAT (微信) PAYMENT_TYPE_ALIPAY (支付宝) |
- |
status |
string |
状态 |
- |
statusName |
string |
状态名称 |
- |
detailNum |
int32 |
笔数 |
- |
amount |
number |
发起金额 |
- |
serviceFee |
number |
服务费 |
- |
totalAmount |
number |
结算总金额 |
- |
personServiceFee |
number |
个人服务费 |
- |
personAmount |
number |
个人应收 |
- |
pendingDescription |
string |
待处理描述 |
- |
orderTime |
string |
业务时间 |
- |
3.2.个人实名验证
resourceType: PERSON_VERIFY
Field | Type | Description | Since |
---|---|---|---|
idEntity |
string |
身份证 |
- |
userName |
string |
姓名 |
- |
verify |
boolean |
是否实名成功 |
- |
3.3.个人合同签署
resourceType: PERSON_CONTRACT_SIGN
Field | Type | Description | Since |
---|---|---|---|
idEntity |
string |
身份证 |
- |
signed |
boolean |
是否签约成功 |
- |
agreementNo |
string |
签约号 |
- |
4.错误码列表
Error code | Description |
---|---|
Success |
成功 |
InvalidParameter |
参数错误 |
InvalidParameter.Timestamp |
timestamp不能为空 |
InvalidParameter.Nonce |
nonce不能为空 |
InvalidParameter.Sign |
sign不能为空 |
InvalidParameter.AppKey |
appKey不能为空 |
InvalidParameterValue |
参数值错误 |
InvalidParameterValue.AESDecrypt |
参数值错误.AES解密错误 |
MissingParameter |
缺少参数 |
AuthFailure.AppKeyNotFound |
appKey不存在 |
AuthFailure.SignatureFailure |
签名失败 |
AuthFailure.SignatureExpire |
签名过期 |
UnauthorizedOperation.Disable |
APIKEY被禁用 |
UnauthorizedOperation.AgreementNotFound |
商户签约号不存在 |
UnauthorizedOperation.JobAgreementNotFound |
任务协议号不存在 |
UnauthorizedOperation.PermissionDenied |
未授权操作 |
UnauthorizedOperation.EnterpriseNotFound |
商户企业签约号不存在 |
UnauthorizedOperation.EnterpriseDisabled |
商户企业被禁用 |
RequestLimitExceeded |
请求的次数超过了频率限制 |
RequestIsRunning |
业务处理中,请等待 |
BusinessOperation.MchOrderNoNotFound |
商户业务单号不存在 |
BusinessOperation.DuplicateMchOrderNo |
商户业务单号重复 |
BusinessOperation.InsufficientBalance |
账户余额不足 |
BusinessOperation.OrderNotFound |
对应结算单未找到,请联系服务商 |
BusinessOperation.OrderNotFinish |
对应结算单未完成 |
BusinessOperation.DominantNotFound |
主体信息不存在 |
BusinessOperation.MemberPaymentVerificationFail |
收款人收款信息验证失败 |
BusinessOperation.InvalidMemberPayment |
无效的收款人收款信息 |
BusinessOperation.UploadFailure |
上传错误 |
BusinessOperation.NoSignedContract |
没有签署的的合同 |
BusinessOperation |
业务执行异常 |
5.数据字典
5.1.请求响应码
Code | Type | Description |
---|---|---|
200 |
int32 |
请求成功 |
400 |
int32 |
请求语法错误 |
401 |
int32 |
非法访问 |
403 |
int32 |
拒绝访问 |
404 |
int32 |
资源无法找到 |
500 |
int32 |
服务器内部错误 |
501 |
int32 |
不支持请求的功能 |
502 |
int32 |
从远程服务器接收到了一个无效的响应 |
503 |
int32 |
服务器暂时无响应 |
901 |
int32 |
警告 |
999 |
int32 |
执行异常 |
5.2.通知类型
Code | Type | Description |
---|---|---|
string |
未知 |
|
TRANSFER_BATCH |
string |
批量转账通知 |
PERSON_VERIFY |
string |
个人实名验证 |
PERSON_CONTRACT_SIGN |
string |
个人合同签署 |
5.3.结算单状态
Code | Type | Description |
---|---|---|
string |
未知 |
|
NEW |
string |
新单 |
PENDING_CONFIRM |
string |
待审核 |
PENDING_PAYMENT |
string |
待支付 |
TRANSFERRING |
string |
转账中 |
PENDING_PAYING |
string |
待发放 |
PAYING |
string |
发放中 |
FINISHED |
string |
已完成 |
TERMINATION |
string |
终止 |
PAY_FAILED |
string |
发放失败 |
CANCEL |
string |
取消 |
REPEALED |
string |
作废 |
5.4.个人合同状态
Code | Type | Description |
---|---|---|
string |
未知 |
|
PENDING_VERIFY |
string |
待实名 |
VERIFYING |
string |
实名中 |
PENDING_SIGN |
string |
待签署 |
SIGNING |
string |
签署中 |
FINISHED |
string |
完成 |
CANCEL |
string |
取消 |