响应格式
业务响应通常使用包含 status、msg、data 的包络结构。
响应码 status 为 int 类型,成功值为 200,JSON 示例中不加引号;成功描述 msg 为葡萄牙语 "sucesso"。MED 的流程状态、订单的 orderStatus 等业务枚举与整数响应码是不同字段,类型和取值以对应接口定义为准。
交易查询响应中的业务状态字段
收款、退款、付款、换汇订单查询在 data 中使用 dataStatus 和 dataMsg 表示业务处理结果,即 data.dataStatus、data.dataMsg。外层 status、msg 仍表示接口响应状态及描述。
余额查询、MED 相关接口、Pix Key 查询、汇率报价和付款凭证查询不增加 dataStatus、dataMsg。下单、退款申请、注册、上传和提交等操作接口也不增加这组字段;原有外层 status、msg 保持不变。
| 字段 | 类型 | 说明 |
|---|---|---|
data.dataStatus | int | 响应码 |
data.dataMsg | string | 与 dataStatus 对应 |
dataStatus 为 int 类型,dataStatus = 200 表示业务正常,此时 dataMsg = "SUCCESS";非 200 表示业务错误,错误原因见 dataMsg。应按整数状态码判断,不能按字段是否有值判断;字段缺失、为空或类型不正确时不能判定为业务正常。业务正常不代表交易已经完成,交易进度及最终结果仍以 orderStatus 等业务状态字段为准。
具体字段以同步后的 Merchant API 页面与 Schema 为准。