2.7 Refund Simulation 退款试算

Path： /external/refund/trialPlan/v1
Method: POST
API 说明：合作方在发送退款请求前，可通过本接口模拟退款操作，核验相关费用信息。

Request Message

Request Headers

字段名称	字段描述	参数值	展示 (必填/选填/条件性)	备注
Content-Type	内容类型	application/json	必填
Authorization	这是合作方的身份认证值。	Bearer {ACCESS-TOKEN}	必填	详情请参阅 "第2部分 DiDi BNPL合作伙伴配置和环境设置". 合作伙伴可通过调用令牌API获取 ACCESS-TOKEN 的值。当访问凭证过期时，请重新调用令牌API以获取新的访问令牌。
X-Paylater-Request-Id	通用唯一识别码	uuid. Example: 550e8400-e29b-41d4-a716-446655440000	必填	必填的 UUID v4 字符串。滴滴将拒绝格式无效的请求。

Request Body

字段	类型	字段说明	展示 (必填/选填/条件性)	备注
partnerOrderId	String	商户侧支付单据ID	必填
refundAmount	Long	退款金额	必填	实际退款金额金额单位为分。例如，若为99.99比索，此处的值应为9999。退款金额 = 求和（退款单价 × 退款数量）
refundType	String	退款类型	必填	枚举值： PART_REFUND-部分退款 ALL_REFUND-全额退款
currency	String	货币	必填	ISO 4217 标准墨西哥墨西哥比索（MXN）
refundTime	String	退款时间	必填	格式规范：yyyy-MM-dd'T'HH:mm:ss.SSSXXX 例如：'2025-12-08T01:11:33.000+08:00'。必须携带时区偏移量。

请求示例

{
    "partnerOrderId": "1e1e51a8-8d38-11ef-b32d-ca3c6358d263",
    "refundAmount": 5000,
    "refundType":"ALL_REFUND",
    "currency": "MXN",
    "refundTime": "2024-10-11T17:10:00.000+08:00"
}

Response Message

Response Header

字段名称	字段说明	参数值	展示 (必填/选填/条件性)	备注
Content-Type	内容类型	application/json	必填

Response Body

字段名称			类型	字段描述	展示 (必填/选填/条件性)	备注
code			String	返回码	必填	枚举值： SUCCESS FAILED RATE_LIMIT INVALID_TOKEN
message			String	响应码说明	必填
data			Object	退款订单信息	选填
	originalFee	Long	原始费用	选填	原始费用 = 有效费用 + 减免费用金额单位为分。例如，若金额为99.99比索，此处的值应为9999。示例：如果退款已超出免费资金占用期——即用户必须支付资金占用费——则用户必须为该退款单支付与退款金额对应的有效费用。若用户无需支付资金占用费，则effectiveFee = 0。
	effectiveFee	Long	有效费用	选填	金额单位为分。例如，若金额为99.99比索，此处的值应为9999。退款金额等于总费用。
	chargeFee	Long	费用减免	选填	金额单位为分。例如，若金额为99.99比索，此处的值应为9999。
error			Object	错误	选填
	errorCode	String	错误码	选填	枚举： AmountNotAllowed – 退款金额不符合要求条件 AlreadyRefund – 退款请求重复 PaylaterRuleRejected – 被先用后付规则拒绝 UnpaidOrder – 订单未支付 NotExistOrder – 订单不存在
	errorMessage	String	错误码描述	选填

响应示例

{
    "code": "SUCCESS",
    "message": "SUCCESS",
    "data": {
        "effectiveFee": 0,
        "originalFee": 150,
        "chargeFee": 150
    },
    "error": null
}

文档中心

2.7 Refund Simulation 退款试算

Request Message

请求示例

Response Message

响应示例