跳转到主要内容

1. 接口概述

简要描述:
  • 根据代付订单号生成支付凭证 PDF 文件(只有当订单状态为成功或失败时);当只传一个订单号时返回单个 PDF 文件,多笔订单时返回 ZIP 压缩包。
请求方式:
  • HTTP MethodPOST
  • Content-Typeapplication/json
接口地址: /common/voucher/pdf

2. 请求参数

请求体:JSON

3. 请求示例

3.1 单个订单号示例(返回 PDF)

请求体示例:

3.2 多个订单号示例(返回 ZIP)

请求体示例:

4. 响应说明

4.1 成功响应

  • HTTP 状态码200
  • 响应体:二进制文件流
    • orderNos 只有 1 个订单号时:
      • 返回单个 PDF 文件
      • Content-Type 通常为:application/pdf
    • orderNos 包含多个订单号时:
      • 返回 ZIP 压缩包
      • Content-Type 通常为:application/zip
建议:
  • 根据响应头 Content-Type 以及文件大小,将响应体按二进制方式直接保存到本地文件。
  • 文件名可根据业务自行命名,也可从响应头Content-Disposition 中 获取:例如 attachment;filename*=UTF-8''vouchers_20251229200623.zip
  • 该api接口请求时间随订单数量进行增加,可能达到 30s+,注意保持网络的稳定。。

4.2 失败响应

当参数校验失败、签名错误、IP 不在白名单或 PDF/ZIP 生成失败时,接口会返回 JSON 结构的错误信息,示例如下:

相关主题

最后修改于 2026年7月13日