简要描述:
- 异步处理,上传银行流水文件,返回受理编号,通过查询接口查询识别结果;
- 支持EXCEL、PDF、JPG等格式;
- 支持银行流水、支付宝账单、微信账单三类;
请求URL:
接口地址:https://gauss.shargoodata.com/gauss/api/bank_trade_asyn_ocr.json
请求方式:POST
数据类型:
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
token | 是 | string | token |
请求参数:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
serviceName | 是 | string | bank_trade_pdf_ocr |
platformNo | 是 | string | 商户号 |
reqData | 是 | string | 请求json字符串 |
outside_no | 是 | string | 外部订单编号 |
timestamp | 是 | string | yyyy-MM-dd-HH-mm-ss格式时间 |
image | 是 | file | 银行流水pdf文件 |
请求curl示例
curl –location ‘https://gauss.shargoodata.com/gauss/api/bank_trade_asyn_ocr.json'
–header ‘token: token加密值’
–form ‘serviceName=”bank_trade_pdf_ocr”‘
–form ‘platformNo=”商户号”‘
–form ‘reqData=”{"outside_no":"外部订单编号","timestamp":"2023-08-01 21:19:00"}”‘
–form ‘image=@”0718.pdf”‘
返回示例:
正确时返回:
{
"success": true,
"outside_no": "外部订单编号",
"data": "DPA108S02822023080200001",
"time_stamp": 1690979756
}
返回参数说明:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
success | 是 | boolean | 是否处理成功 |
outside_no | 是 | string | 外部订单编号 |
data | 否 | string | 受理编号 |
error_code | 否 | string | 错误代码 |
message | 否 | string | 错误描述 |
查询接口:
接口地址:https://gauss.shargoodata.com/gauss/bank_trade_ocr/finalResult.json
请求方式:POST
请求头:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
token | 是 | string | token |
请求参数:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
no | 是 | string | 受理编号 |
platformNo | 是 | string | 商户号 |
请求示例
curl –location ‘http://gauss.shargoodata.com/gauss/bank_trade_ocr/finalResult.json'
–header ‘token: token加密值’
–form ‘no=”受理编号”‘
–form ‘platformNo=”商户号”‘
返回示例:
正确时返回:
{
"insideNo": "cntsf8ssgi9e0tkb18gg",
"process": {
"cellData": {
},
"docData": {
"agent_type": "",
"file_format": "ImagePDF"
}
},
"docName": "DPA108S00012024032100003.pdf",
"data": {
"error_page": [],
"outres2": [
{"row_order": "001_001",
“con”:{
"1.1": "交易日期",
"1.2": "交易时间",
"1.3": "交易摘要",
"1.4": "交易金额",
"1.5": "本次余额",
"1.6": "对手信息",
"1.7": "交易渠道",
"1.8": "交易附言"
},
"header_row": true
},
{
"row_label": {
"trader_nature": "铝压延加工",
"in_spend_type": "支出"
},
con:{
"2.1": "20210301",
"2.2": "234826",
"2.3": "支付宝",
"2.4": "-15.80",
"2.5": "78322.46",
"2.6": "215500690",
"2.7": "电子商务",
"2.8": "NA202103013779666320226220311902深圳市朗**实业有 限公司"
},
"row_order": "001_002",
"header_row": false,
}
],
"outres3": [
{ con:{
"1.1": "交易日期",
"1.2": "交易金额",
"1.3": "收支类型",
"1.4": "余额",
"1.5": "对方账号",
"1.6": "对方户名",
"1.7": "备注1",
"1.8": "备注2",
},
"row_order": "001_001",
"header_row": true
},
{ con:{
"2.1": "2021/03/01",
"2.2": 15.8,
"2.3": "支出",
"2.4": 78322.46,
"2.5": "",
"2.6": "215500690",
"2.7": "支付宝",
"2.8": "NA202103013779666320226220311902深圳市朗丽文实业有限公司"
},
"row_order": "001_002",
"header_row": false
}
],
"page_sum": "002",
"doc_type": "imagePDF",
"outres1": {
"agent_type": "bank",
"idcard_num": "",
"account_num": "6228480404745846315",
"account_type": "对私",
"date_start": "2021/03/01",
"account_name": "陆**",
"bank_name": "GY0004",
"date_end": "2022/02/28"
}
},
"success": true,
"errorCode": 0,
"outsideNo": "111",
"message": ""
}
返回参数说明:
参数名 | 是否必须 | 类型 | 说明 |
---|---|---|---|
success | 是 | boolean | true-执行成功;false-执行失败/处理中;如果error_code报“30005”码,表示文件还在处理中,继续等待查询结果 |
outside_no | 是 | string | 外部订单编号 |
data | 否 | json | 识别结果 |
error_code | 否 | string | 错误代码; |
message | 否 | string | 错误描述 |
insideNo | 否 | string | 受理编号,查询使用 |
docname | 否 | string | 原始文件名称 |
data参数说明:
参数名 | 必须 | 类型 | 说明 | 输出示例 |
---|---|---|---|---|
doc_type | 是 | string | ImagePDF:图片PDF文件, excel:电子表格, ePDF:文本PDF文件 | imagePDF |
page_sum | 是 | string | 文件总页数 | 25 |
error_page | 是 | list | 不符合要求或者报错的⻚⾯ | |
outres1 | 是 | json | 表外信息,关于账单的户名、开户机构等信息 | |
agent_type | 是 | string | 机构类型, bank:银行 alipay:支付宝 wechat:微信支付 |
bank |
bank_name | 是 | string | 交易发布机构名称 | 交通银行 |
bank_code | 是 | string | 交易发布机构编号,参考《银行机构对照表》 | GY0001 |
account_num | 是 | string | 账号 | 6228480322520271 |
account_name | 是 | string | 户名 | 李数 |
idcard_num | 是 | string | 用户身份证号码,一般支付宝账单和微信账单会有 | 330724197805240011 |
date_start | 是 | string | 起始日期 | 2022-05-22 |
date_end | 是 | string | 结束日期 | 2022-11-22 |
account_type | 是 | string | 账户类型 | 对私 |
outres2 | 是 | json | 表格内的流水信息,按行输出,未经转化格式的原文数据 | |
row_order | 是 | string | 当前行的位置,页码+行序 | 003_008 |
header_row | 是 | string | 当前行是否是表头行,true代表是,false代表不是 | false |
con | 是 | 当前行内容 | 1.1:“2” 1.2:“2022-07-19” |
|
outres3 | 是 | json | 列数据重排,按照固定的表头行字段输出的流水,以及每行的资金用途标签和会计分录 | |
row_order | 是 | string | 当前行位置,页码+行序 | 003_008 |
header_row | 是 | string | 是否为表头行,true代表是,false代表不是 | true |
con | 是 | 当前行的内容,按照固定字段输出,字段参考如下 | 1.1:“交易金额” 1.2:“交易日期” |
|
row_label | 是 | 标签 | ||
product_type | 是 | string | 资金用途标签 | A0104 利息 |
trader_nature | 是 | string | 交易对方的“行业”分类标签 | 快餐服务 |
account_label | 是 | 会计分录,有两条记录 | ||
accounting_type | 是 | string | 分录类型,N:主方分录,S:副方分录 | N |
accounting_item | 是 | string | 科目标签 | Z08账户余额 |
accounting_order | 是 | string | 分录编号,两个分录末尾数字不同 | FL001-001-0 |
subject | 是 | string | 分录对象 | 张集/中国银行/622841……8978 |
accounting_entry | 是 | string | 分录方向 | 减少 |
amount | 是 | string | 金额 | 28,000.00 |
outres3的con中的固定表头行字段
表头行名 | 说明 | 输出示例 |
---|---|---|
交易日期 | 流水发生时间,日期 | 2022-03-15 |
交易时间 | 流水发生时间,时分秒 | 22:20:15 |
交易金额 | 只有数字,不显示正负号; | 3571.42 |
收支类型 | 代表资金的流动方向,收入/支出/其他; | 收入 |
账户余额 | 交易变动之后的账户余额 | 3571.42 |
对方户名 | 交易对方的户名 | 王五 |
对方账号 | 交易对方的账号 | 622841……789 |
对方行名 | 交易对方的开户行名称 | 工商银行 |
交易己方 | 己方的户名、开户行、账号信息,因为支付宝和微信账单的交易己方不固定,所以每行流水该字段不一样 | 张集/中国银行/622841……8978 |
业务类型 | 交易发起方的场景; | 网上快捷支付; |
交易渠道 | 发起交易的终端或平台; | 自动柜员机 |
资金用途1 | 资金用途,交易商品说明,如果有多个,就显示多个 | 跨行转账 |
资金用途2 | 资金用途,交易商品说明,如果有多个,就显示多个 | 12月工资 |
文档更新时间: 2025-01-19 14:26 作者:admin