退款查询
- Endpoint:
POST /aggregate-pay/api/gateway/refundQuery - Tags: 收单
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
Content-Type (header) | string | Yes | |
sign (header) | string | Yes | 签名信息请参考技术文档 |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
version | string | Yes | 接口版本 当前值为：1.5 |
keyVersion | string | Yes | 密钥版本 当前值为：1 |
requestTime | string | Yes | 请求时间，符合rfc3339规范，格式：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 时间需要在当前时间两分钟内 |
appId | string | Yes | 商户应用Id，PayerMax分配给商户应用的唯一标识 |
merchantNo | string | No | 商户号，商户与PayerMax业务签约时生成的唯一标识 |
data | object | Yes | 请求数据体 |
data.outRefundNo | string | No | 原商户退款单号 |
data.refundTradeNo | string | No | PayerMax退款流水号，与原商户退款单号二选一上送 |
Responses
200 — ## 错误码
| 分类 | 结果码 | 结果描述 |
|---|---|---|
| SYSTEM_ERROR | System is busy, please try again later. | 系统错误；请联系PayerMax |
| REQ_TIME_OVER_TIME | requestTime effective in two minutes | 请求时间与服务端偏差超过2分钟，请检查requestTime后重新发起 |
| TOO_MANY_REQUEST | Exceed request limitation, please retry later | 触发接口并发限流,请稍后重试 |
| SIGN_VERIFY_FAILED | The signature verify failed. | 签名错误；请核实签名 |
| MERCHANT_INVALID | The merchant has been offline. | 无效商户 |
| MERCHANT_APP_INVALID | Signature key is not configured. | 无效商户APP |
| PARAMS_INVALID | ${field} length must be between ${min} and ${max},but your input value length is ${length}.Make sure all requests length is correct. | 无效参数-入参字段长度不符合要求；请参考官网字段描述 |
| PARAMS_INVALID | ${field} must be ${type} , but your input is ${valueType}.Make sure all requests type is correct. | 无效参数-入参字段类型不正确；请参考官网字段描述 |
| PARAMS_INVALID | ${field} is invalid,because ${field} is null. | 无效参数-入参字段不能为空；请参考官网字段描述 |
| REFUND_NO_INVALID | RefundNo shouldn't same with TradeNo. | 退款单号无效 |
| Field | Type | Required | Description | Enum |
|---|---|---|---|---|
code | string | Yes | 返回码，’APPLY_SUCCESS’代表成功。只代表接口请求成功，不代表订单状态。 | |
msg | string | Yes | 返回描述，’Success.’。只代表接口请求成功，不代表订单状态。 | |
data | object | No | ||
data.outRefundNo | string | No | 商户退款申请号 | |
data.refundTradeNo | string | No | PayerMax退款流水号 | |
data.refundAmount | number | No | 退款金额，金额的单位为元。 | |
data.refundCurrency | string | No | 退款币种（原交易币种） | |
data.outTradeNo | string | No | 原商户订单号 | |
data.status | string | No | 退款单状态，详见【退款状态】 | REFUND_SUCCESS, REFUND_PENDING , REFUND_FAILED |
data.resultMsg | string | No | 交易状态结果描述，仅失败时有值 | |
data.refundFinishTime | string | Yes | 退款完成时间 |