接口说明
退款API用于为成功的付款发起退款并返还给付款人。交易可以部分或全额退款。API 将在成功从商家账户扣除待退款金额时返回 SUCCESS。
商家/合作伙伴直接向钱包提交退款请求;
钱包将根据其自身的支付状态确定退款是否成功,并回复商家/合作伙伴;
可以支持一笔成功的支付进行多次退款,但总退款金额不能超过支付金额。
请求参数
公共请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
partnerId | String | 必选 | 32 | 钱包合作商id | 6881407230000718 |
请求参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
refundRequestId | String | 必选 | 64 | 商户生成的唯一请求id。 这个字段用于检查完整性。对于使用相同退款请求ID并达到最终状态(S或F)的退款请求,付款方必须返回唯一的结果。 | |
paymentId | String | 否 | 64 | 相应的原始支付交易ID | |
paymentRequestId | String | 否 | 64 | 相应的原始支付请求ID | |
refundAmount | Amount | 必须 | 退款金额 | ||
refundReason | String | 否 | 256 | 退款原因 | |
extendInfo | String | 否 | 4096 | 扩展信息,商家想要描述的额外信息。 |
返回参数
公共返回参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
resultStatus | String | 必选 | 请求状态:
| ||
resultCode | String | 必选 | - | 网关返回码 | |
resultMessage | String | 必选 | - | 网关返回码描述 |
返回参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
refundId | String | 否 | 64 | 退款的唯一 ID,若 resultStatus 为 SUCCESS,则 ID 必须提供。 | |
refundTime | String/Datetime | 否 | 从商家成功扣款的时间,然后开始向用户退款,遵循ISO 8601标准。若 resultStatus 为 SUCCESS,则时间必须提供。 | 2023-11-27T12:01:01+08:30 | |
extendInfo | String | 否 | 4096 | 扩展信息,钱包想要描述的额外信息。 |