简要描述:

  • 异步处理,上传银行流水文件,返回受理编号,通过查询接口查询识别结果;
  • 支持EXCEL、PDF、JPG等格式;
  • 支持银行流水、支付宝账单、微信账单三类;

请求URL:

请求方式:

  • POST

请求头:

参数名 是否必须 类型 说明
token string token

请求参数:

参数名 是否必须 类型 说明
serviceName string bank_trade_pdf_ocr
platformNo string 商户号
reqData string 请求json字符串
image file 银行流水pdf文件
reqData参数:
参数名 是否必须 类型 说明
outside_no string 外部订单编号
timestamp string yyyy-MM-dd-HH-mm-ss格式时间

请求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 错误描述

查询接口:

  • 上传受理编号,返回处理结果

请求URL:

请求方式:

  • 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 原始文件名称
1、data参数说明:
名称 类型 必选 约束 说明
doc_type string true none excel-excel文件,ePDF-文本PDF,imagePDF-图片PDF
page_sum string true none 总计合并的页数
error_page string true none 未处理或者报错的页码
outres1 object true none 表外开户信息,包含开户行、户名、账号、身份证号、有效期等
outres2 [object] true none 表内流水内容,以行为单位输出原文,未加工
outres3 [object] true none 表内流水内容,转化成统一格式输出
2、outres1参数说明:
名称 类型 必选 约束 说明
bank_name string true none 银行名称编号,参考“金融机构信息对照表”,http://doc.shargoodata.com/docs/bank20230709/bank20230709-1evq63akq38ur
account_num string true none 账号号码
account_name string true none 账号名称
account_type string true none 对公,对私
idcard_num string true none 用户身份证号
date_start string true none 起始日期
date_end string true none 结束日期
3、outres2参数说明:
名称 类型 必选 约束 说明
row_order string true none 行数据位置,页码+行序
header_row string true none 是否表头行,true:是;false:不是
con string true none 单元格OCR识别内容,以行为单位
row_label string true none 以行为单位,显示流水的“资金用途”标签和交易对方的所属“行业”标签
account_label string true none 会计分录
4、outres3参数说明:
名称 类型 必选 约束 说明
row_order string true none 行数据位置,页码+行序
header_row string true none 是否表头行,true:是;false:不是
con string true none 统一的指定格式的输出字段的

4.1、con包含的标准字段

序号 字段名 说明 示例
1 交易日期 流水发生时间,只有日期,不含时分秒 2022/03/15
2 交易金额 只有数字,不显示正负号; 3571.42
3 收支类型 代表资金的流动方向:收入、支出、其他; 收入
4 账户余额 交易变动之后的账户余额数字 3571.42
5 对方户名 交易对方的户名 张..
6 对方账号 交易对方的账号 622841……8978
7 对方行名 交易对方的开户行名称 工商银行
8 交易己方 己方信息,微信/支付宝账单中包含此字段 零钱
9 业务类型 交易发起方的场景; 网上快捷支付;
10 交易渠道 发起交易的终端或平台; 自动柜员机
11 用途1 资金用途,交易商品说明 跨行转账
文档更新时间: 2024-09-06 11:54   作者:admin