Cancelar alquiler

Envía una solicitud GET y comprueba status incluso con HTTP 200: 1 indica éxito, 0 fallo y 2 que no había buzones al crear el alquiler. Consulta los detalles en msg, errormsg y errorid.

Esta solicitud puede modificar un alquiler o generar cargos. Si pierdes la respuesta, comprueba los pedidos y el historial antes de repetir: el cambio puede haberse realizado. Los ejemplos no reintentan automáticamente.

AutenticaciónCopiar enlace

Envía apikey como parámetro obligatorio de consulta.

ParámetrosCopiar enlace

Cómo usar este métodoCopiar enlace

Cancela un alquiler de la cuenta asociada a tu clave API. Usa el ID de Pedidos activos. La cancelación no garantiza un reembolso.

Ejemplos de solicitudCopiar enlace

Entorno y dependencias. Los ejemplos codifican los parámetros y esperan hasta 30 segundos. Comprueba HTTP y status antes de usar data. cURL muestra el JSON para que lo revises; Java usa Jackson para leerlo.

• SMSPVA_EMAIL_ORDER_ID: orderid.

: "${SMSPVA_API_KEY:?Set SMSPVA_API_KEY}"
: "${SMSPVA_EMAIL_ORDER_ID:?Set SMSPVA_EMAIL_ORDER_ID}"
curl --get --fail-with-body --max-time 30 "https://smspva.com/api/rent_email.php" \
  --data-urlencode "method=cancel_order" \
  --data-urlencode "apikey=$SMSPVA_API_KEY" \
  --data-urlencode "orderid=$SMSPVA_EMAIL_ORDER_ID"

RespuestasCopiar enlace

Consulta la respuesta correspondiente a tu solicitud. Los valores y las fechas son orientativos. Los campos opcionales pueden variar según el resultado o el formato elegido.

HTTP 200Copiar enlace

Comprueba status aunque HTTP sea 200. Los valores de los ejemplos son orientativos.

application/json

Ejemplo de respuesta correcta

{
  "status": 1,
  "data": true
}

Error

{
  "status": 0,
  "msg": "Incorrect apikey"
}

Correcto

Obligatorios: status, data

Error

Algunos errores incluyen errorid y errormsg; otros solo msg. Comprueba todos los campos presentes.

Guías relacionadasCopiar enlace

• Private Email Rental API
• Proveedores y servicios
• Flujo de alquiler de email
• Errores
• Esquema OpenAPI