API接口列表示例 - 财资云开放平台（开发版）

请求参数

Query 参数

appId

string

必需

资金系统分配的应用ID

示例值:

2023052000000001

command

string

接口指令

必需

示例值:

cfs.example.api

version

string

必需

调用的接口版本，固定为：1.0.0

示例值:

1.0.0

timestamp

string

必需

发送请求的时间，格式"yyyyMMddHHmmss",请求时间10分钟内有效

示例值:

20140724030750

charset

string

必需

请求使用的编码格式，仅支持UTF-8

示例值:

UTF-8

format

string

可选

请求使用的内容格式，仅支持JSON

示例值:

json

signType

string

必需

生成签名字符串所使用的签名算法类型，目前支持RSA2、RSA和SM2，推荐使用SM2

示例值:

RSA2

sign

string

请求参数的签名串

必需

notifyUrl

string

可选

服务器主动通知企业服务器里指定的页面http/https路径

示例值:

https://api.test.yocyl.com/interface/receive_notify.htm

bizContent

string

必需

请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体可参考Body 参数说明

Body 参数application/json

tradeNo

string

交易流水号

可选

该交易在资金系统中的交易流水号。最短 16 位，最长 64 位。和outTradeNo不能同时为空，如果同时传了 outTradeNo和 tradeNo，则以 tradeNo为准。

>= 16 字符<= 64 字符

示例值:

2013112611001004680073956707

outTradeNo

string

企业订单号

可选

订单支付时传入的企业订单号,和资金系统交易号不能同时为空。 tradeNo,outTradeNo如果同时存在优先取tradeNo

<= 64 字符

示例值:

HZ0120131127001

示例

{
    "tradeNo": "2013112611001004680073956707",
    "outTradeNo": "HZ0120131127001"
}

示例代码

Java

Shell

JavaScript

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '?appId=2023052000000001&command=cfs.example.api&version=1.0.0&timestamp=20140724030750&charset=UTF-8&format=json&signType=RSA2&sign=&notifyUrl=https://api.test.yocyl.com/interface/receive_notify.htm&bizContent=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tradeNo": "2013112611001004680073956707",
    "outTradeNo": "HZ0120131127001"
}'

返回响应

🟢200成功

application/json

Body

code

string

必需

msg

string

必需

data

object

必需

tradeNo

string

必需

outTradeNo

string

必需

示例

{
    "cfs_example_api_response": {
        "code": "10000",
        "msg": "Success",
        "tradeNo": "2013112111001004500000675971",
        "outTradeNo": "YX_001"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}