支付结果回传 (付款单)
- 接口:common/document/payStatus
- Method:PUT
- 数据格式:JSON
- 限流信息:100次每天和50次每小时
- 多语言环境:在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(
繁体),请选取其中一种
- 接口说明:付款单支付结果回传,如属于PAY支付单请使用
支付结果回传 (支付单)
接口
请求参数
字段名称 |
字段类型 |
字段描述 |
是否必填 |
长度 |
bizId |
String |
当前接口同步的唯一标识 |
TRUE |
36 |
timestamp |
Number |
当前接口同步的对应时间戳 |
TRUE |
13 |
data |
Object |
请求数据 |
TRUE |
/ |
data.document_num |
String |
单据号 |
ONE-OF 1 |
64 |
data.external_id |
String |
外部系统单据号 |
ONE-OF 1 |
64 |
data.status |
String |
是否支付成功Y /N |
TRUE |
1 |
data.external_status |
String |
外部系统状态值 |
FALSE |
64 |
data.external_message |
String |
外部系统处理结果 |
FALSE |
64 |
data.additional_columns |
Object |
扩展字段 |
FALSE |
/ |
data.additional_columns.待更新字段 |
String |
单据头待更新字段 |
FALSE |
255 |
请求数据
{
"bizId": "5362e076-36f5-4d06-a6fe-4ca5f3786592",
"timestamp": 1670846866173,
"data": {
"document_num": "EXP0000000001",
"status": "Y"
}
}
{
"bizId": "838ec964-cf37-453b-8caa-75b3ae5e74fd",
"timestamp": 1671001563461,
"data": {
"document_num": "EXP0000000002",
"status": "Y",
"external_status": "success",
"external_message": "支付成功",
"additional_columns": {
"field_name": "field_value"
}
}
}
返回参数
字段名称 |
字段类型 |
字段描述 |
resCode |
Integer |
响应状态码(见附录) |
resMsg |
String |
返回信息描述 |
返回数据
{
"resCode": 200000,
"resMsg": "修改成功"
}
{
"resCode": 200001,
"resMsg": "单据不存在"
}
{
"resCode": 500000,
"resMsg": "修改失败"
}