sendRefundResult
当支付处理达到成功或失败的终态时,使用此接口向蚂蚁集团通知交易的退款结果(可以是全额退款也可以是部分退款)。该接口用于未来的风险评估。
结构
报文由报文头和报文体构成,下文主要介绍报文体结构。
注意:将每个字段的数据类型设置为 String (数组类型的字段除外) 。这意味着您必须使用双引号 (" ") 将字段值括起来。例如:
- 如果某个字段的数据类型为 Integer 且值为 20,则将其设置为 “20”。
- 如果某个字段的数据类型为 Boolean 且值为 true,则将其设置为 “true ”。
Request parameters
referenceTransactionId String REQUIRED
直接向买家提供服务或商品的商户分配的唯一ID,用于识别交易。该字段的值与 referenceOrderId 的值相同。
More information:
- Maximum length: 64 characters
referenceRefundId String REQUIRED
由直接向买家提供服务或商品的商户分配的识别退款的唯一ID 。
More information:
- Maximum length: 64 characters
actualRefundAmount Amount REQUIRED
本次交易的退款总额。
refundRecords Array<RefundRecord> REQUIRED
本次交易的退款记录。
More information:
- Maximum size: 100 elements
Response parameters
result Result REQUIRED
接口调用的结果。
API Explorer
Sample CodesRun in Sandbox
Request
URL
Request Body
Response
Response Body
Result/Error codes
Code | Value | Message | Further action |
---|---|---|---|
SUCCESS | S | 成功 | 接口调用成功,无需执行任何操作。 |
ACCESS_DENIED | F | 访问被拒绝。 | 详细原因请联系蚂蚁集团技术支持。 |
INVALID_API | F | 调用的接口无效或未激活。 | 请联系蚂蚁集团技术支持解决问题。 |
INVALID_CONTRACT | F | 合约中的参数值与当前交易中的参数值不匹配。 | 检查合约中的参数值是否与当前交易中的参数值匹配。如果匹配,请联系蚂蚁集团技术支持排查问题。 |
KEY_NOT_FOUND | F | 未找到蚂蚁集团或商户的私钥或公钥。 | 检查私钥或公钥是否存在。如果不存在,请在蚂蚁集团开发者中心上传私钥。 |
MERCHANT_KYB_NOT_QUALIFIED | F | 由于商家的 KYB 状态,支付失败。该商户可能不符合 KYB 标准,或者 KYB 状态不符合此交易的条件。 | 详细原因请联系蚂蚁集团技术支持。 |
MERCHANT_NOT_REGISTERED | F | 商户未注册。 | 请通过注册接口注册商户。如果调用注册接口失败,请联系蚂蚁集团技术支持。 |
NO_INTERFACE_DEF | F | 接口未定义 | 检查 URL 是否正确。请参见接口文档中的端点。 |
REQUEST_TRAFFIC_EXCEED_LIMIT | U | 请求流量超出限制。 | 再次调用该接口解决问题。若未解决,请联系蚂蚁集团技术支持。 |
PARAM_ILLEGAL | F | 没有传递必传参数,或者存在非法参数。例如,非数字输入、无效日期或参数的长度和类型错误。 | 检查并验证当前接口所需的请求字段(包括请求头字段和请求体字段)是否正确传递且有效。 |
SYSTEM_ERROR | F | 发生系统错误。 | 请勿重试,请联系蚂蚁集团技术支持了解更多详情。 |
UNKNOWN_EXCEPTION | U | 接口调用失败,原因未知。 | 再次调用接口解决问题。如仍未解决,请联系蚂蚁集团技术支持。 |