统一开放平台(正式)
  1. 收付结算API
统一开放平台(正式)
  • 准备开发
    • 接口调用说明
    • SDK包下载
    • 公共响应码
  • 基础数据API
    • 查询联行号信息
      POST
  • 银行账户API
    • 根据支付单据查询对应明细回单接口
      POST
    • 查询银行电子回单单个
      POST
  • 收付结算API
    • 创建应付单信息
      POST
    • 查询付款结果
      POST
  1. 收付结算API

创建应付单信息

POST
/api
yocyl.pay.payable.create

请求参数

Query 参数
appId
string 
必需
对接系统的appId
示例值:
1579794083549941760
systemCode
string 
企业对接系统的编码
必需
示例值:
ERP
command
string 
接口指令码
必需
示例值:
yocyl.pay.payable.create
version
string 
调用的接口版本
必需
示例值:
1.0.0
timestamp
string 
必需
发送请求的时间,格式"yyyyMMddHHmmss",请求时间10分钟内有效
charset
string 
仅支持UTF-8
必需
示例值:
UTF-8
format
string 
仅支持json
必需
示例值:
json
signType
string 
必需
签名算法类型,目前支持RSA2,RSA,SM2,推荐使用RSA2
示例值:
RSA2
sign
string 
请求参数的签名串
必需
notifyUrl
string 
必需
主动通知企业业务系统服务器里指定的页面http/https路径
Body 参数application/json
sourceBatchNumber
string 
来源系统批次号
必需
租户内同一业务系统唯一
payOrgName
string 
付方组织名称
必需
totalAmount
string 
总金额
必需
用于批次数据完整性校验
totalNum
integer 
总笔数
必需
用于批次数据完整性校验
batchInfo
array [object {37}] 
应付单数据集合
必需
sourceNoteCode
string 
来源单据号
可选
sourceFlowNumber
string 
来源系统流水号
必需
租户内同一业务系统唯一
transactionType
string 
交易类型
可选
1:境内;2:跨境,不填时通过收、付方账号开户行所属国家判断,国家相同为“境内”,国家不同为“跨境”,判断条件不足时默认“境内”
applyOrgName
string 
申请组织名称
必需
不填默认付方账号对应的付方组织
payDate
string 
应付日期
必需
格式:yyyyMMdd
payBizTypeCode
string 
支付业务类型
可选
用户自定义维护(基础数据中心-支付-支付业务类型)
currencyCode
string 
币种
必需
见币种编码枚举值
transAmount
string 
金额
必需
purpose
string 
用途
必需
submitBy
string 
提交人
可选
payWayCode
string 
支付方式
必需
见支付方式枚举值
payBankCode
string 
付方银行
可选
见银行编码枚举值,不填自动通过账号补全(须在系统中维护)
payAccountNumber
string 
付方账号
可选
payAccountName
string 
付方户名
可选
不填自动通过账号补全(须在系统中维护)
payBankLocation
string 
付方开户行
可选
不填自动通过账号补全(须在系统中维护)
payAreaCode
string 
付方地区
可选
见地区编码枚举值,不填自动通过账号补全(须在系统中维护)
recName
string 
收方名称
必需
recBankCode
string 
收方银行
可选
见银行编码枚举值,不填自动通过收方开户行补全
recAccountNumber
string 
收方账号
可选
当支付方式为”直连“时必填
recAccountName
string 
收方户名
可选
当支付方式为”直连“时必填
recBankLocation
string 
收方开户行
可选
当支付方式为”直连“时必填
recCountryCode
string 
收方银行所属国家
可选
recAreaCode
string 
收方银行所属地区
可选
见地区编码枚举值,不填自动通过收方开户行补全
recCnaps
string 
收方联行号
可选
不填自动通过收方开户行补全
recSwiftCode
string 
收方swift
可选
summary
string 
摘要
可选
不填默认用途
memo
string 
备注
可选
不填默认用途
reconcileCode
string 
对账码
可选
extensionInfo
string 
可选
isAppointment
string 
可选
appointmentDatetime
string 
预约支付时间
可选
payCountryCode
string 
付方国家
可选
recBankLocationAddress
string 
收方开户行地址
可选
payParticularInfo
array [object {10}] 
付款明细集合
可选
invoiceInfo
array [object {6}] 
发票信息(可传多条记录)
可选
 contractInfo
array [object {4}] 
合同信息(可传多条记录)
可选
attachmentInfo
array [object {3}] 
附件信息(可传多条记录)
可选
示例
{
    "totalNum": "36",
    "batchInfo": [
        {
            "sourceFlowNumber": "98",
            "applyOrgName": "片各眼比治二开",
            "payBizTypeCode": "34",
            "currencyCode": "1",
            "transAmount": "12",
            "purpose": "amet sunt exercitation",
            "payWayCode": "16",
            "recName": "或任与江广",
            "recCountryCode": "82",
            "payCountryCode": "60",
            "recAccountName": "门石属",
            "appointmentDatetime": "1978-03-29 14:08:45",
            "recCnaps": "adipisicing deserunt est incididunt",
            "payAreaCode": "30",
            "memo": "dolore reprehenderit pariatur",
            "sourceNoteCode": "24",
            "summary": "in",
            "payBankCode": "61",
            "recBankLocation": "eu cillum amet id",
            "extensionInfo": "quis sunt deserunt cupidatat",
            "recAreaCode": "5",
            "payAccountName": "电性片重",
            "payAccountNumber": "16",
            "isAppointment": "irure",
            "payDate": "2013-10-06",
            "submitBy": "id est esse",
            "recBankLocationAddress": "浙江省枣庄市其它区",
            "reconcileCode": "94",
            "recSwiftCode": "22",
            "transactionType": "id veniam ullamco nisi Excepteur",
            "payBankLocation": "fugiat",
            "recBankCode": "29",
            "recAccountNumber": "59"
        },
        {
            "sourceFlowNumber": "66",
            "applyOrgName": "应应群",
            "payBizTypeCode": "61",
            "currencyCode": "42",
            "transAmount": "3",
            "purpose": "sunt",
            "payWayCode": "84",
            "recName": "海每十积划受世",
            "summary": "incididunt consequat velit",
            "payDate": "2006-04-16",
            "recBankLocation": "sint nostrud magna",
            "recBankLocationAddress": "新疆维吾尔自治区海东市二林镇",
            "transactionType": "pariatur",
            "submitBy": "sint dolor ex",
            "recAccountName": "成效划历",
            "recSwiftCode": "7",
            "payBankLocation": "labore cillum minim amet veniam",
            "isAppointment": "dolore",
            "recBankCode": "61",
            "recCountryCode": "59",
            "recAccountNumber": "8",
            "extensionInfo": "et",
            "recCnaps": "Excepteur Ut dolore ad",
            "payCountryCode": "89",
            "memo": "Ut minim in aute do",
            "appointmentDatetime": "1994-06-16 07:15:23",
            "recAreaCode": "91",
            "sourceNoteCode": "57",
            "payBankCode": "16",
            "reconcileCode": "52",
            "payAccountName": "以认百",
            "payAccountNumber": "55",
            "payAreaCode": "95"
        }
    ],
    "attachmentInfo": [
        {
            "attachSize": "reprehenderit",
            " attachTitle": "把且目",
            "attachTitle": "北度目以即风局",
            "attachUrl": "http://bmouswtjt.ai/vdyugwwjf"
        },
        {
            " attachTitle": "南标响",
            "attachSize": "culpa adipisicing laborum ad eiusmod",
            "attachTitle": "清月建",
            "attachUrl": "http://xxuq.rw/oyyguipoe"
        },
        {
            "attachTitle": "线放进次圆利",
            " attachTitle": "备给拉",
            "attachSize": "ex incididunt nisi fugiat",
            "attachUrl": "http://vtls.wf/fshe"
        }
    ],
    "invoiceInfo": [
        {
            "currencyCode": "48",
            "invoiceCode": "60",
            "taxRate": "magna",
            "description": "件万毛世毛七话始把影头为厂起生加者。见技群存及术济总回状需手后斯切切。争八之而产线合情才除二级变深门史名。边立八先些外调义组市件太阶部地回务。相着开强周百打教世查引世改委道。",
            "invoiceDate": "1972-07-22",
            "amount": "45"
        }
    ],
    "payParticularInfo": [
        {
            "extensionInfo": "commodo",
            "subjectCode": "38",
            "subjectName": "京验求拉",
            "amount": "86",
            "projectName": "能温利",
            "currencyCode": "15",
            "numericalOrder": "61",
            "memo": "laborum culpa in irure reprehenderit",
            "summary": "consequat elit",
            "projectCode": "93"
        }
    ],
    " contractInfo": [
        {
            "contractCode": "74",
            "amount": "33",
            "contractFunditem": "nisi magna consectetur ut consequat",
            "currencyCode": "68"
        },
        {
            "amount": "52",
            "contractCode": "24",
            "contractFunditem": "elit proident deserunt id",
            "currencyCode": "97"
        },
        {
            "contractCode": "72",
            "amount": "51",
            "currencyCode": "85",
            "contractFunditem": "dolor deserunt consectetur"
        }
    ],
    "sourceBatchNumber": "81",
    "payOrgName": "采张维展象",
    "totalAmount": "85"
}

示例代码

Java
Shell
JavaScript
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Java
Shell
JavaScript
Swift
curl --location --request POST 'https://openapi-pre.yocyl.com/api?appId=1579794083549941760&systemCode=ERP&command=yocyl.pay.payable.create&version=1.0.0&timestamp=&charset=UTF-8&format=json&signType=RSA2&sign=&notifyUrl=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "totalNum": "36",
    "batchInfo": [
        {
            "sourceFlowNumber": "98",
            "applyOrgName": "片各眼比治二开",
            "payBizTypeCode": "34",
            "currencyCode": "1",
            "transAmount": "12",
            "purpose": "amet sunt exercitation",
            "payWayCode": "16",
            "recName": "或任与江广",
            "recCountryCode": "82",
            "payCountryCode": "60",
            "recAccountName": "门石属",
            "appointmentDatetime": "1978-03-29 14:08:45",
            "recCnaps": "adipisicing deserunt est incididunt",
            "payAreaCode": "30",
            "memo": "dolore reprehenderit pariatur",
            "sourceNoteCode": "24",
            "summary": "in",
            "payBankCode": "61",
            "recBankLocation": "eu cillum amet id",
            "extensionInfo": "quis sunt deserunt cupidatat",
            "recAreaCode": "5",
            "payAccountName": "电性片重",
            "payAccountNumber": "16",
            "isAppointment": "irure",
            "payDate": "2013-10-06",
            "submitBy": "id est esse",
            "recBankLocationAddress": "浙江省枣庄市其它区",
            "reconcileCode": "94",
            "recSwiftCode": "22",
            "transactionType": "id veniam ullamco nisi Excepteur",
            "payBankLocation": "fugiat",
            "recBankCode": "29",
            "recAccountNumber": "59"
        },
        {
            "sourceFlowNumber": "66",
            "applyOrgName": "应应群",
            "payBizTypeCode": "61",
            "currencyCode": "42",
            "transAmount": "3",
            "purpose": "sunt",
            "payWayCode": "84",
            "recName": "海每十积划受世",
            "summary": "incididunt consequat velit",
            "payDate": "2006-04-16",
            "recBankLocation": "sint nostrud magna",
            "recBankLocationAddress": "新疆维吾尔自治区海东市二林镇",
            "transactionType": "pariatur",
            "submitBy": "sint dolor ex",
            "recAccountName": "成效划历",
            "recSwiftCode": "7",
            "payBankLocation": "labore cillum minim amet veniam",
            "isAppointment": "dolore",
            "recBankCode": "61",
            "recCountryCode": "59",
            "recAccountNumber": "8",
            "extensionInfo": "et",
            "recCnaps": "Excepteur Ut dolore ad",
            "payCountryCode": "89",
            "memo": "Ut minim in aute do",
            "appointmentDatetime": "1994-06-16 07:15:23",
            "recAreaCode": "91",
            "sourceNoteCode": "57",
            "payBankCode": "16",
            "reconcileCode": "52",
            "payAccountName": "以认百",
            "payAccountNumber": "55",
            "payAreaCode": "95"
        }
    ],
    "attachmentInfo": [
        {
            "attachSize": "reprehenderit",
            " attachTitle": "把且目",
            "attachTitle": "北度目以即风局",
            "attachUrl": "http://bmouswtjt.ai/vdyugwwjf"
        },
        {
            " attachTitle": "南标响",
            "attachSize": "culpa adipisicing laborum ad eiusmod",
            "attachTitle": "清月建",
            "attachUrl": "http://xxuq.rw/oyyguipoe"
        },
        {
            "attachTitle": "线放进次圆利",
            " attachTitle": "备给拉",
            "attachSize": "ex incididunt nisi fugiat",
            "attachUrl": "http://vtls.wf/fshe"
        }
    ],
    "invoiceInfo": [
        {
            "currencyCode": "48",
            "invoiceCode": "60",
            "taxRate": "magna",
            "description": "件万毛世毛七话始把影头为厂起生加者。见技群存及术济总回状需手后斯切切。争八之而产线合情才除二级变深门史名。边立八先些外调义组市件太阶部地回务。相着开强周百打教世查引世改委道。",
            "invoiceDate": "1972-07-22",
            "amount": "45"
        }
    ],
    "payParticularInfo": [
        {
            "extensionInfo": "commodo",
            "subjectCode": "38",
            "subjectName": "京验求拉",
            "amount": "86",
            "projectName": "能温利",
            "currencyCode": "15",
            "numericalOrder": "61",
            "memo": "laborum culpa in irure reprehenderit",
            "summary": "consequat elit",
            "projectCode": "93"
        }
    ],
    " contractInfo": [
        {
            "contractCode": "74",
            "amount": "33",
            "contractFunditem": "nisi magna consectetur ut consequat",
            "currencyCode": "68"
        },
        {
            "amount": "52",
            "contractCode": "24",
            "contractFunditem": "elit proident deserunt id",
            "currencyCode": "97"
        },
        {
            "contractCode": "72",
            "amount": "51",
            "currencyCode": "85",
            "contractFunditem": "dolor deserunt consectetur"
        }
    ],
    "sourceBatchNumber": "81",
    "payOrgName": "采张维展象",
    "totalAmount": "85"
}'

返回响应

🟢200成功
application/json
Body
yocyl_pay_payable_create_response
object 
创建应付单结果返回
必需
code
string 
结果编码
必需
msg
string 
结果信息
必需
sourceBatchNumber
string 
来源系统批次号
必需
repeatSourceDetails
string 
必需
重复落库来源系统流水号集合,多个逗号分隔
示例
{
    "yocyl_pay_payable_create_response": {
        "code": "string",
        "msg": "string",
        "sourceBatchNumber": "string",
        "repeatSourceDetails": "string"
    }
}
修改于 2023-02-28 05:48:15
上一页
查询银行电子回单单个
下一页
查询付款结果
Built with