查询付款结果 - 统一开放平台（正式）

请求参数

Query 参数

appId

string

必需

对接系统的appId

示例值:

202205206412479702

systemCode

string

企业对接系统的编码

必需

示例值:

ERP

command

string

接口指令码

必需

示例值:

yocyl.pay.query

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

来源系统批次号

必需

租户内同一业务系统唯一

>= 0 字符<= 32 字符

batchInfo

array [object {1}]

来源系统流水号集合

必需

sourceFlowNumber

string

来源系统流水号

可选

>= 0 字符<= 64 字符

示例

{
    "sourceBatchNumber": "string",
    "batchInfo": [
        {
            "sourceFlowNumber": "string"
        }
    ]
}

示例代码

Java

Shell

JavaScript

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi-pre.yocyl.com/api?appId=202205206412479702&systemCode=ERP&command=yocyl.pay.query&version=1.0.0&timestamp=&charset=UTF-8&format=json&signType=RSA2&sign=&notifyUrl=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sourceBatchNumber": "string",
    "batchInfo": [
        {
            "sourceFlowNumber": "string"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

yocyl_pay_query_response

object

付款结果返回信息

必需

code

string

结果编码

必需

msg

string

结果

必需

sourceBatchNumber

string

来源系统批次号

必需

batchInfo

array [object {33}]

付款结果查询明细集合

必需

sign

string

签名

必需

示例

{
    "yocyl_pay_query_response": {
        "code": "string",
        "msg": "string",
        "sourceBatchNumber": "string",
        "batchInfo": [
            {
                "sourceFlowNumber": "string",
                "sourceNoteCode": "string",
                "reconcileCode": "string",
                "paySerialNumber": "string",
                "bankSerialNumber": "string",
                "payState": 0,
                "payResultCode": "string",
                "payResultInfo": "string",
                "bankDealResult": "string",
                "payFinishDatetime": "string",
                "bankCardNum": "string",
                "holdName": "string",
                "payBankCode": "string",
                "source": 0,
                "realPayCurrencyCode": "string",
                "realPayAmount": 0,
                "tenantId": "string",
                "bizBatchNo": "string",
                "bizSystemCode": "string",
                "payOrgCode": "string",
                "payBankSubject": "string",
                "realPayOrgId": "string",
                "payableCurrencyCode": "string",
                "payableAmount": 0,
                "payBankLocation": "string",
                "payBankCnaps": "string",
                "recAccountNumber": "string",
                "recAccountName": "string",
                "recBankCode": "string",
                "recBankName": "string",
                "recBankLocation": "string",
                "recCnaps": "string",
                "recSwiftCode": "string"
            }
        ]
    },
    "sign": "string"
}