2.4 Cancelar pedido

Ruta: /external/cancel/V1
Método: POST
Descripción DE LA API: Esta es la API para cancelar el pedido. Solo los pedidos con estado PENDIENTE pueden ser cancelados.

Encabezados de la solicitud

Nombre del campo	Descripción del campo	Valor del parámetro	Presente(Obligatorio / Opcional / Condicional)	Observaciones
Content-Type	Tipo de contenido	application/json	Obligatorio
Authorization	Este es el valor de autenticación de la identidad del socio.	Bearer {ACCESS-TOKEN}	Obligatorio	Para más detalles, consulte la "Parte 2 Configuración de socio de DiDi BNPL y Env. Configuración". El socio puede obtener el valor del TOKEN DE ACCESO mediante la llamada a la API de tokens. Cuando caduque el acceso, vuelva a llamar a la API de tokens para obtener el nuevo token de acceso.
X-Paylater-Request-Id	UUID	uuid. Example: 550e8400-e29b-41d4-a716-446655440000	Obligatorio	Cadena UUID v4 obligatoria. DiDi rechazará las solicitudes con formato no válido.

Cuerpo de la solicitud

Nombre del campo	Tipo	Descripción del campo	Presente(Obligatorio / Opcional / Condicional)	Observaciones
partnerOrderId	Cadena	ID del documento de pago del lado del comerciante.	Obligatorio	Solo los pedidos con estado PENDIENTE pueden ser cancelados.

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

Encabezado de respuesta

Nombre del campo	Descripción del campo	Valor del parámetro	Presente(Obligatorio / Opcional / Condicional)	Observaciones
Content-Type	Tipo de contenido	application/json	Obligatorio

Cuerpo de la respuesta

Nombre del campo			Tipo	Descripción del campo	Presente(Obligatorio / Opcional / Condicional)	Observaciones
code			Cadena	Código de retorno	Obligatorio	Valor de enumeración: SUCCESS FAILED RATE_LIMIT INVALID_TOKEN
message			Cadena	Descripción del código de respuesta	Obligatorio
error			Objeto	Error	Opcional
	errorCode	Cadena	Código de error	Opcional
	errorMessage	Cadena	Descripción del código de error	Opcional

{
  "code": "SUCCESS",
  "message": "SUCCESS",
  "error": null
}

Documentos