queryDownload需要签名验签
集成商可调用此接口获取文件下载的结果。
报文结构
万里汇接口报文结构包括:请求头、请求体、响应体。
请求头
字段名 | 是否必传 | 范例 | 说明 |
Client-Id | 是 |
| 关于这些参数的解释说明,详见:请求头 |
Signature | 是 |
| |
Content-Type | 是 |
| |
Request-Time | 是 |
| |
Connected-CustomerId | 否(有条件) |
| 当集成商操作商户账户时需要传递 |
入参
requestId String REQUIRED
针对本次下载指令,由集成商指定的唯一请求号。
更多信息:
- 此为幂等字段。
- 最大长度:64 字符
出参
result Result REQUIRED
本次API调用的结果。
requestId String REQUIRED
针对本次下载指令,由集成商指定的唯一请求号。
此字段只有当 result.resultStatus = S
时才会按需返回。
更多信息:
- 最大长度:64 字符
downloadBizType String REQUIRED
下载业务类型。可取值:
DOWNLOAD_STATEMENT_DETAIL_PDF
:PDF格式的交易凭证。
此字段只有当 result.resultStatus = S
时才会按需返回。
downloadStatementPDFDetail DownloadStatementPDFDetail REQUIRED
交易凭证中需要展示的交易细节。
此字段只有当 result.resultStatus = S
时才会按需返回。
downloadResult DownloadResult REQUIRED
文件下载的结果。
此字段只有当 result.resultStatus = S
时才会按需返回。
fileDownloadUrl String
文件下载链接。
此字段只有当 result.resultStatus = S
时才会按需返回。
notifyUrl String
接收下载通知的URL地址。
此字段只有当 result.resultStatus = S
时才会按需返回。
请求
响应
Result processing logic
集成商调用接口后,万里汇返回集成商API调用结果。result.resultStatus 和downloadResult.resultStatus字段取值范围为:
result.resultCode
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
SUCCESS | S | Success | |
PROCESSING | S | Success | |
PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | 参考API文档页面,确认请求头和传参是否正确。 |
PROCESS_FAIL | F | A general business failure occurred. Do not retry. | 需要人工介入,联系万里汇技术支持以解决此问题。 |
UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | 服务器错误,若稍后重试问题依旧,联系万里汇技术支持以解决问题 |
OAUTH_FAIL | F | OAuth process failed. | 联系万里汇技术支持了解详情 |
INVALID_API | F | The called API is invalid or not active. | 确认是否调用正确的API |
INVALID_CLIENT | F | The client is invalid. | Client ID不存在或无效 |
INVALID_SIGNATURE | F | The signature is invalid. | 确认请求正确加签 |
METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | 确认HTTP请求方法为 |
downloadResult.resultCode
结果码 | 值 | 结果码信息 | 行动建议 |
---|---|---|---|
USER_NOT_EXIST | F | The user does not exist. | 使用正确的用户信息重试 |
SYSTEM_ERROR | F | System error. | 请勿重试,联系万里汇技术支持了解详情 |
SERVICE_NOT_ALLOWED | F | Service not allowed. | 使用正确的信息重试,若问题依旧,联系万里汇技术支持以解决问题 |
CONTRACT_CHECK_FAIL | F | The contract check has failed. | 检查合约状态后重试 |
ACCESS_TOKEN_EXPIRED | F | The access token expired. | 刷新token接口以重新获取访问令牌(access token),或联系万里汇技术支持以解决问题 |
AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | 当前授权关系不存在,请联系万里汇技术支持检查授权关系 |
ORDER_NOT_EXIST | F | The order does not exist. | 确认订单号有效后重试。 |