H Honor
ZH
DiDi finanzas

文档中心

提供接入指南、接口文档、测试指引等全流程接入所需信息

2.4 Cancel Order

2.4 Cancel Order 取消订单

  • Path: /external/cancel/v1

  • Method: POST

  • API 说明:该接口用于取消订单,仅允许取消状态为待处理(PENDING)的订单。

Request Message

Request Headers

Field Name 字段描述 参数值 展示 (必填​**/选填/条件性)** 备注
Content-Type 内容类型 application/json 必填
Authorization 这是合作伙伴的身份认证值。 Bearer {ACCESS-TOKEN} 必填 详情请见 请参考"第2部分 滴滴先享后付合作伙伴配置与环境搭建"。
合作伙伴可以通过调用 ACCESS-TOKEN 令牌接口获取对应的值。
当访问令牌过期时,需要重新调用令牌接口获取新的访问令牌。
X-Paylater-Request-Id 通用唯一识别码 uuid.
Example: 550e8400-e29b-41d4-a716-446655440000
必填 必填的 UUID v4 格式字符串。若请求格式无效,滴滴将直接拒绝该请求。

Request Body

字段名称 类型 字段说明 展示 (必填​**/选填/条件性)** 备注
partnerOrderId String 商户侧支付单据ID。 必填 仅状态为“待处理”的订单可以被取消。

请求示例

{
    "partnerOrderId": "1e1e51a8-xxxx-11ef-b32d-ca3c6358d263"
}

Response Message

Response Header

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

Response Body

字段名称 类型 字段说明 展示 (必填​**/选填/条件性)** 备注
code String 返回码 必填 枚举值:
SUCCESS
FAILED
RATE_LIMIT
INVALID_TOKEN
message String 响应码说明 必填
error Object 错误 选填
errorCode String 错误码 选填
errorMessage String 错误码描述 选填

返回示例

{
  "code": "SUCCESS",
  "message": "SUCCESS",
  "error": null
}
复制成功