获取导出中的支付单列表
业务说明
- 出纳在支付页面将未支付的支付单选择资金平台导出。
- 该接口只会拉取“导出中”状态的支付单,拉取后支付单状态不会修改,需要调用方通过 更新支付结果接口 更新导出状态为已导出/支付成功/支付失败,更新状态后将不会再被拉取。
- 调用方通过第三方支付平台支付后,无论成功失败,通过 更新支付结果接口 更新支付状态。
- 出纳可以更新“支付失败”状态的支付单为“导出中”状态,并生成新的支付流水。
- 接口调用顺序:调用本接口获取导出中的支付单数据-->调用更新支付结果接口更新数据状态为已导出-->(第三方支付平台更新支付结果后)调用 更新支付结果接口更新数据状态为支付成功/支付失败-->再次拉取本接口(不会拉取到已标记状态的支付单)
访问每刻数据规范
接口地址
/api/openapi/paymenttransaction/list
请求方式
POST
HTTP请求体规范
数据示例
{
"startPaymentNo": "",
"pageSize": 10
}
参数说明
参数名称 | 参数值 | 是否必须 | 默认值 | 备注 |
---|---|---|---|---|
startPaymentNo | string | N | '' | 起始支付流水号(不包括自己) |
pageSize | int | N | 200 | 每次拉取的数量; 非必填,默认值为200 |
HTTP响应体规范
数据示例
{
"code": "ACK",
"message": null,
"data": [
{
"paymentBizCode": "23070280",
"paymentNo": "FPO2307261CV064G0",
"payeeTargetBizCode": "BX23072510NKO9Z4",
"payeeTargetBusinessCode": "wx230725000000273",
"payeeTargetFormType": "REIMBURSE",
"paymentPlatformCode": "CBS",
"legalEntityCode": "ELC2105201HOC0RNK",
"legalEntityName": "GJM测试专用U8V12抬头",
"legalEntityBizCode": "ELC2105201HOC0RNK",
"payerAccountType": "从公司银行账户付款",
"payerAccountName": "新可乐家族专用支付账户",
"payerAccountNumber": "62825729892903",
"payerBankName": "建设银行",
"payerBankCode": "ccb",
"payerBankProvince": "安徽",
"payerBankCity": "池州市",
"payerBankBranchName": "中国建设银行股份有限公司河池分行",
"payerBankBranchNo": "123413212341",
"payeeAccountType": "从公司银行账户付款",
"payeeAccountCurrency": "CNY",
"baseCurrency": "CNY",
"payeeAccountName": "endless的往来单位",
"payeeAccountNumber": "121231231",
"payeeBankName": "Banca Apulia",
"payeeBankCode": "bank_code1837",
"payeeBankProvince": null,
"payeeBankCity": null,
"payeeBankBranchName": null,
"payeeBankBranchNo": null,
"payeeTarget": "CORP",
"payeeBsbNumber": null,
"payeeAbroadBankCodeEN": null,
"payableAmount": 49.50,
"payableBaseAmount": 49.50,
"certificationTypeCode": null,
"identification": null,
"coverEmployeeId": "TRP23050810XQLTVK",
"coverEmployeeName": "endless的往来单位",
"departmentBizCode": "devolop",
"departmentName": "研发部",
"departmentDingtalkId": null,
"operatorEmployeeId": "WX001",
"operatorEmployeeName": "吴限",
"formSubTypeName": "wx报销单",
"formSubTypeCode": "FT22033011Z6IIGW",
"formSubTypeBizCode": "FT22033011Z6IIGW",
"purpose": "测试往来单位账号特殊字段",
"auditTimeStamp": 1690269307000,
"exportTimeStamp": 1690352733952,
"cbsDynaField": {
"TRSUSE": "",
"EXITX1": "",
"ERPCM1": "测试往来单位账号特殊字段",
"ERPCM2": "测试往来单位账号特殊字段",
"ERPCM3": "",
"PAYSON": "",
"ERPCM4": "",
"ERPCM5": "",
"ERPCM6": "",
"ERPCM7": "",
"ERPCM8": ""
},
"settlementType": "COOPERATION_SETTLE",
"payableAmountDataDto": {
"currency": "CNY",
"amount": 49.50,
"amountStr": "49.50"
},
"paymentChannel": "COMMON",
"paymentChannelType": "COMMON_PAY",
"exportIndex": 0,
"remittanceRemark": null,
"outPayNo": null,
"planPayTime": 0,
"creditScore": 80.00,
"creditRank": "还行",
"paymentType": "BANK",
"moneyOrderNumber": null,
"paidTimeStamp": 0,
"attachDataDtos": null,
"paymentTransactionLogIds": null,
"ibanNumber": "123456",
"abaNumber": "98765",
"signMarkCode": "1123123"
}
],
"bizCode": null,
"args": null,
"linkDetail": false,
"lastPage": true,
"total": 0,
"nonBizError": false,
"success": true
}
参数说明
名称 | 类型 | 是否必须 | 默认值 |
---|---|---|---|
code | string | Y | 返回ACK或NACK |
message | string | N | |
data | object[] | Y | 支付单信息, 详细见下方data数据结构 |
lastPage | boolean | Y | false表示之后还有数据 |
data参数说明
名称 | 类型 | 是否必须 | 备注 | 其他信息 |
---|---|---|---|---|
paymentBizCode | string | Y | 支付单号 | 同一张支付单多次导出不会改变,可用于唯一标识 |
paymentNo | string | Y | 支付流水 | 单企业唯一,每次导出均会生成一个新的编码 |
payeeTargetBizCode | string | Y | 单据内码 | 对应formDataCode |
payeeTargetBusinessCode | string | Y | 单据外码 | 对应formCode |
formSubTypeBizCode | string | Y | 单据小类类型业务编码-外码 | 需对应具体单据类型时,用此参数 |
payeeTargetFormType | string | Y | 对应单据类型 | 报销单:REIMBURSE 借款单:LOAN 分期付款单:INSTALLMENT 付款单:PAYMENT |
legalEntityBizCode | string | Y | 公司抬头系统编码 | |
legalEntityName | string | N | 公司抬头名称 | |
legalEntityCode | string | Y | 公司抬头业务编码 | 系统内公司抬头外码 |
settlementType | string | Y | 结算主体类型 | 个人(员工)INDIVIDUALSETTLE 企业(往来单位)COOPERATIONSETTLE 个体工商户(往来单位)SELFEMPLOYEDSETTLE |
payerAccountType | string | Y | 支付账户类型 | |
payerAccountName | string | Y | 支付账户名 | |
payerAccountNumber | string | Y | 支付账号 | |
payerBankName | string | N | 支付银行名称 | |
payerBankCode | string | Y | 支付账户银行编码 | 如“ICBC” |
payerBankBranchNo | string | Y | 分支行联行号 | |
payerBankBranchName | string | Y | 分支行名称 | |
payeeAccountType | string | Y | 收款账户类型 | 可选值: 从公司银行账户付款; 从公司银行账户自动扣款; 从公司支付宝账户付款; 从公司现金付款; 第三方支付; 通过承兑汇票付款; 通过其他方式付款; 从公司微信账户付款; 支票支付; 无; |
payeeAccountCurrency | string | Y | 收款币种(单据所选的收款账户的收款币种) | 注意:不是收款账号的限制可选币种 |
baseCurrency | string | Y | 本币币种(单据所选的公司抬头的本币币种) | |
payeeAccountName | string | Y | 收款账户名 | |
payeeAccountNumber | string | Y | 收款账户账号 | |
payeeBankName | string | N | 收款账户银行名称 | |
payeeBankCode | string | N | 收款账户银行编码 | 如“ICBC” |
payeeBankProvince | string | N | 收款账户银行省 | |
payeeBankCity | string | N | 收款账户银行市 | |
payeeBankBranchName | string | N | 收款账户银行分支行名称 | |
payeeBankBranchNo | string | N | 收款账户银行分支行联行号 | |
payeeTarget | string | N | 收款账户性质 | 对公CORP 对私PERSONAL |
payableAmount | number | Y | 金额 | |
payableBaseAmount | number | Y | 本币金额 | |
certificationTypeCode | string | N | 收款账户身份认证类型编码 . 中国银行时必填 | 见 收款账户身份认证类型字段 |
identification | string | N | 证件号码. 中国银行时必填 | |
departmentBizCode | string | N | 部门编码 | |
departmentName | string | N | 部门名称 | |
departmentDingtalkId | string | N | 钉钉部门ID | |
coverEmployeeId | string | N | 收款人客户号 | 当收款人为个人时,取值“员工工号”; 当收款人为往来单位时,取值“往来单位编码” |
coverEmployeeName | string | N | 收款人客户名称 | |
formSubTypeName | string | N | 单据类型 如“差旅报销单” | |
purpose | string | Y | 交易用途(默认值:事由) | |
auditTimeStamp | long | N | 终审时间戳 | 毫秒 |
exportTimeStamp | long | N | 导出时间戳 | 毫秒 |
payerBankProvince | string | N | 付款账户银行省 | |
payerBankCity | string | N | 付款账户银行市 | |
cbsDynaField | Object | N | 配置字段,见cbsDynaField | 配置的自定义字段对象 |
exportIndex | integer | N | 记录导出至资金平台的顺序 | |
operatorEmployeeId | string | N | 操作人工号 | 若设置为自动导出,则此参数为null |
operatorEmployeeName | string | N | 操作人姓名 | 若设置为自动导出,则此参数为null |
paymentChannel | string | N | 支付渠道 | 见paymentChannel |
paymentChannelType | string | N | 支付渠道下的支付模式 | 见paymentChannelType |
remittanceRemark | string | N | 汇款备注(不区分对公对私) | |
planPayTime | long | N | 计划付款时间 | 毫秒 |
creditScore | BigDecimal | N | 信用分 | |
creditRank | string | N | 信用等级 | |
paymentType | string | N | 付款执行方式 | 见paymentType |
moneyOrderNumber | string | N | 承兑汇票号 | |
ibanNumber | string | N | ibanNumber | |
abaNumber | string | N | abaNumber | |
signMarkCode | string | N | 签收汇总编号 | |
payeeAccountBizCode | string | N | 收款账号业务编码 | |
batchNum | string | N | 最近一次导出批次号 |
cbsDynaField字段说明
参数名称 | 类型 | 是否必须 | 参数说明 |
---|---|---|---|
TRSUSE | string | N | 用途 |
EXITX1 | string | N | 摘要 |
ERPCM1 | string | N | ERP备注1 |
ERPCM2 | string | N | ERP备注2 |
ERPCM3 | string | N | ERP备注3 |
PAYSON | string | N | 是否加急 |
ERPCM4 | string | N | ERP备注4 |
ERPCM5 | string | N | ERP备注5 |
ERPCM6 | string | N | ERP备注6 |
ERPCM7 | string | N | ERP备注7 |
ERPCM8 | string | N | ERP备注8 |
支付渠道paymentChannel
参数名称 | 参数说明 |
---|---|
OFFLINE | 线下支付 |
CBS | cbs资金平台 |
ALIPY | 支付宝批量付款 |
NBBANK | 宁波银行 |
COMMON | 资金平台 |
HZBANK | 杭州银行 |
CBSC | 招商银行云直联 |
NBCZ | 宁波银行财资大管家 |
支付模式paymentChannelType
参数名称 | 参数说明 |
---|---|
EXTERNAL_PAY | 对外支付模式 |
AGENCY_PAY | 代发模式 |
COMMON_PAY | 资金平台/宁波银行APP支付模式 |
NBCZ_AGENCY_PAY | 宁波财资代发工资模式 |
NBCZ_BATCH_PAY | 宁波财资批量转账模式 |
付款执行方式字段paymentType
参数名称 | 参数说明 |
---|---|
BANK | 从公司银行账户付款 |
BANK_AUTOMATIC | 从公司银行账户自动扣款 |
ALIPAY | 从公司支付宝账户付款 |
CASH | 从公司现金付款 |
THIRD_PARTY | 第三方支付 |
MONEY_ORDER | 通过承兑汇票付款 |
OTHER | 通过其他方式付款 |
从公司微信账户付款 | |
CHEQUE | 支票支付 |
NONE | 无 |
收款账户身份认证类型字段certificationTypeCode
参数名称 | 参数说明 |
---|---|
01 | 居民身份证 |
02 | 临时身份证 |
03 | 护照 |
04 | 户口簿 |
05 | 军人身份证 |
06 | 武装警察身份证 |
08 | 外交人员身份证 |
09 | 外国人居留许可证 |
10 | 边民出入境通行证 |
11 | 对私其它 |
21 | 企业法人营业执照 |
22 | 企业营业执照 |
30 | 驻华机构登记证 |
31 | 个体工商户营业执照 |
33 | 组织机构代码证 |
47 | 港澳居民来往内地通行证(香港) |
48 | 港澳居民来往内地通行证(澳门) |
49 | 台湾居民来往大陆通行证 |
金额类型 AmountInput
字段 | 类型 | 意义 |
---|---|---|
amount | BigDecimal | 金额 |
currency | String | 币种 |
amountStr | String | 金额 |
更新记录
2020-03-19:新增业务实体外部编码字段
2021-04-06:新增字段 `exportIndex`
2021-04-08: 新增字段`paymentBizCode`和`payeeTargetFormType`
2021-04-14:新增字段:`baseCurrency` 和 `payableBaseAmount`
2021-05-07:新增字段:`operatorEmployeeId`和 `operatorEmployeeName`
2022-07-29:新增字段 `formSubTypeCode`和 `formSubTypeBizCode`