退款申请
- Endpoint:
POST /aggregate-pay/api/gateway/refund - Tags: 收单
Description
仅适用于支持退款的支付方式，同时仅支持180天内的交易发起退款。 退款到账时效取决于银行和机构的处理时效。
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 | No | 请求数据体 |
data.outRefundNo | string | Yes | 商户退款申请号，唯一标识一笔退款申请交易 |
data.refundAmount | number | Yes | 退款金额，金额的单位为元。 除以下国家外按照各国币种支持的小数点位（最大四位）上送。 注意：巴林、科威特、伊拉克，约旦、突尼斯、利比亚、奥马尔地区，本币只支持两位小数； 印尼、中国台湾、巴基斯坦、哥伦比亚地区，本币不支持带小数金额。 |
data.refundCurrency | string | Yes | 退款币种（原交易币种） |
data.outTradeNo | string | No | 原商户订单号，可以传outTradeNo，也可以传tradeToken，不能outTradeNo和tradeToken同时不传 |
data.tradeToken | string | No | 正向交易单的交易Token，可以传outTradeNo，也可以传tradeToken，不能outTradeNo和tradeToken同时不传 |
data.comments | string | No | 退款说明（商户退款理由） |
data.refundNotifyUrl | string(uri) | No | 退款回调地址，可后台配置【配置地址】 |
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. | 无效参数-入参字段不能为空；请参考官网字段描述 |
| RDR_REFUNDED_NOT_SUPPORT_RETRY | This transaction has been triggered by RDR. A refund has already been successfully processed by the issuing bank. Merchants are not allowed to initiate any additional refund requests for this transaction. | 订单已经发起RDR,不能再发起退款。 |
| AMOUNT_INVALID | The refund amount exceed the transaction amount. | 退款失败-退款金额超额，不能退款 |
| REFUND_FAILED | The payment method does not support partial refund. | 退款失败-支付方式不支持部分退款 |
| REFUND_FAILED | The payment method does not support refund. | 退款失败-支付方式不支持退款 |
| REFUND_FAILED | The refund amount is too small to refund. | 退款失败-退款金额太小不足以支付手续费 |
| REFUND_INSUFFICIENT_BALANCE | Insufficient Txn currency in the to be Settled Account. | 余额不足无法退款 |
| ORDER_NOT_EXIST | The orginal order does not exist. | 原订单不存在 |
| Field | Type | Required | Description |
|---|---|---|---|
code | string | Yes | 返回码，’APPLY_SUCCESS’代表成功。只代表接口请求成功，不代表订单状态。 |
msg | string | Yes | 返回描述，’Success.’。只代表接口请求成功，不代表订单状态。 |
data | object | Yes | |
data.outRefundNo | string | Yes | 商户退款申请号 |
data.tradeOrderNo | string | Yes | 交易订单号 |
data.refundTradeNo | string | Yes | PayerMax退款流水号 |
data.status | string | Yes | 退款状态：REFUND_PENDING，REFUND_FAILED |