已支付列表查询接口

说明

根据支付流水号和支付完成时间、单据号获取已支付列表数据。 请至少设置一种查询条件也可以设置多种

  1. 支付流水号
  2. 支付完成时间:开始时间和结束时间为一组,二者选择一个参数后另一个参数必选
  3. 单据号:单据号和单据类型为一组,同时设置事条件才生效

接口地址

/api/openapi/paymenttransaction/paid/list

请求方式

POST

请求参数

请求参数说明

参数名称 参数值 是否必须 默认值 备注
pageSize int N 50 每次拉取的数量; 最大200
pageNum int N 1 页数
startPaidTime long N 支付完成时间-开始范围,毫秒的时间戳
endPaidTime long N 支付完成时间-结束范围,毫秒的时间戳
paymentNo string N '' 支付流水号
formCode string N 单据号
formType string N 单据类型
枚举值:REIMBURSE报销单、LOAN借款单、INSTALLMENT分期单、PAYMENT付款单。
formCode有值时,此参数必填

数据示例

{
  "formCode": "MK21070239",
  "formType": "REIMBURSE",
  "paymentNo": "",
  "pageSize": 50,
  "pageNum": 1,
  "startPaidTime": 1572506923082,
  "endPaidTime": 1572506924082
}

响应参数

参数说明

名称 类型 是否必须 默认值 备注 其他信息
code string Y 返回ACK或NACK
message string N
data object[] Y 支付单信息,参考下方表格
total number Y 总条数
lastPage boolean Y false表示之后还有数据
bizCode string N 业务编码
args object[] N 内部业务错误码
linkDetail boolean N 内部业务错误码
nonBizError boolean N session超时,common_error时为true
success boolean N 是否成功

data参数说明

名称 类型 是否必须 默认值 备注 其他信息
paymentNo string Y 支付流水,不能重复(若为null,则表示该流水未导出,而是直接标记支付成功)
paymentBizCode string Y 支付单号
payeeTargetBizCode string Y 单据code
payeeTargetBusinessCode string Y 单据号
legalEntityBizCode string Y 实体公司系统编码
legalEntityName string N 实体公司名
legalEntityCode string Y 实体公司业务编码
settlementType string Y 结算主体类型 个人INDIVIDUAL_SETTLE,企业 COOPERATION_SETTLE,个体工商户SELF_EMPLOYED_SETTLE
payerAccountType string Y 支付账户类型 从公司银行账户付款
从公司银行账户自动扣款
从公司支付宝账户付款
从公司现金付款
第三方支付
通过承兑汇票付款
通过其他方式付款
从公司微信账户付款
支票支付
payerAccountName string Y 支付账户
payerAccountNumber string Y 支付账号
payerBankName string N 支付银行名称
payerBankCode string Y 支付账户银行
payeeAccountType string Y 收款账户类型 银行BANK 支付宝ALIPAY
payeeAccountCurrency string Y 收款币种 注意:不是收款账户的币种
payeeAccountName string Y 收款账户名
payeeAccountNumber string Y 收款账户账号
payeeBankName string N 收款账户银行名称
payeeBankCode string N 收款账户银行
payeeBankProvince string N 收款账户银行省
payeeBankCity string N 收款账户银行市
payeeBankBranchName string N 收款账户银行分支行名称
payeeBankBranchNo string N 收款账户银行分支行联行号
payeeTarget string N 收款账户性质 对公CORP 对私PERSONAL
payableAmount number Y 金额
certificationTypeCode string N 见certificationTypeCode
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 终审时间戳 毫秒
payerBankProvince string N 付款账户银行省
payerBankCity string N 付款账户银行市
cbsDynaField Object N 配置字段,见cbsDynaField 配置的自定义字段对象
exportTimeStamp long N 导出资金平台时间戳
settlementType string N 结算类型
paymentChannel string N 资金平台字典 见paymentChannel
paymentChannelType string N 支付渠道下的支付模式 见paymentChannelType
payableAmountDataDto object N 带币种的结构应付金额 currency:币种 amount:金额
paidTimeStamp long N 已支付时间戳 毫秒
attachDataDtos List< OpenApiAttachDataDto > 回单
outPayNo string N 外部系统返回的支付流水号,对应【更新支付结果】paymentSystemNumber参数
batchNum string N 最近支付导出批次号 取支付列表的支付导出批次号字段
paymentType string N 付款执行方式 见paymentType
remittanceRemark string Y 汇款备注

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 通过其他方式付款
WECHAT 从公司微信账户付款
CHEQUE 支票支付
NONE

收款账户身份认证类型字段certificationTypeCode

参数名称 参数说明
01 居民身份证
02 临时身份证
03 护照
04 户口簿
05 军人身份证
06 武装警察身份证
08 外交人员身份证
09 外国人居留许可证
10 边民出入境通行证
11 对私其它
21 企业法人营业执照
22 企业营业执照
30 驻华机构登记证
31 个体工商户营业执照
33 组织机构代码证
47 港澳居民来往内地通行证(香港)
48 港澳居民来往内地通行证(澳门)
49 台湾居民来往大陆通行证

OpenApiAttachDataDto

参数 字段名 类型
url 回单url string
name 回单名称 string

响应示例

{
    "code": "ACK",
    "message": null,
    "data": [{
            "paymentNo":null,
            "paymentBizCode": "24020008",
            "payeeTargetBizCode":"BX210407ZS8UWHS",
            "payeeTargetBusinessCode":"MK21043407",
            "paymentPlatformCode":"CBS",
            "legalEntityCode":"ELC2103201EBII51C",
            "legalEntityName":"本币外币测试",
            "legalEntityBizCode":"ELC2103191UW7N6KG",
            "payerAccountType":"从公司银行账户付款",
            "payerAccountName":"杭州666子公司二号",
            "payerAccountNumber":"3301040160500221331",
            "payerBankName":"杭州银行",
            "payerBankCode":"hzb",
            "payerBankProvince":"浙江",
            "payerBankCity":"杭州市",
            "payeeAccountType":"从公司银行账户付款",
            "payeeAccountCurrency":"CNY",
            "payeeAccountName":"游贇周",
            "payeeAccountNumber":"6543212345678",
            "payeeBankName":"工商银行",
            "payeeBankCode":"icbc",
            "payeeBankProvince":"福建",
            "payeeBankCity":"厦门市",
            "payeeBankBranchName":"中国工商银行厦门鹭江支行",
            "payeeBankBranchNo":"102393000028",
            "payeeTarget":"PERSONAL",
            "payableAmount":1000,
            "certificationTypeCode":null,
            "identification":null,
            "coverEmployeeId":"1234",
            "coverEmployeeName":"游贇周",
            "departmentBizCode":"DI1803221E22UHXF",
            "departmentName":"杭州每时每刻有限公司",
            "departmentDingtalkId":"1",
            "formSubTypeName":"you报销单",
            "purpose":"未到票1000",
            "auditTimeStamp":1617762876000,
            "exportTimeStamp":1617762876000,
            "cbsDynaField":null,
            "settlementType":"INDIVIDUAL_SETTLE",
            "payableAmountDataDto":{
                "currency":"CNY",
                "amount":1000,
                "amountStr":"1000.00"
            },
            "paymentChannelType":"",
            "batchNum":"20230226141"
      }
    ],
    "lastPage": false,
    "total":233,
      "bizCode":null,
    "args":null,
    "linkDetail":false,
    "nonBizError":false,
      "success":false
}

异常结果

{
    "code":"NACK",
    "message":"支付完成时间(startPaidTime)不能为空",
    "data":[

    ],
    "bizCode":null,
    "args":null,
    "linkDetail":false,
    "lastPage":false,
    "nonBizError":false,
    "success":false
}
Copyright © 杭州每刻科技有限公司 www.maycur.com all right reserved,powered by Gitbook该文件修订时间: 2024-11-20 10:52:00

results matching ""

    No results matching ""

    results matching ""

      No results matching ""