Devolución de una venta

Permite crear una devolución de una orden paga que cumpla los siguientes requisitos:

Estado APPROVED (pago exitoso con desembolso en la cuenta de Ualá).
Que no tenga una devolución en curso.
La orden tenga menos de 90 días desde el día de pago.
La orden debe pertenecer a la v2 de API Checkout de Ualá Bis.

Diagrama de secuencia

BASE URL:

https://checkout.developers.ar.ua.la/v2/api/orders/{uuid}/refund

¡Aviso importante! Para usar este endpoint necesitas un token de autorización.

Parámetros

POST https://checkout.developers.ar.ua.la/v2/api/orders/{uuid}/refund

Path param:

Campo	Tipo	Descripción	Requerido
uuid	string	Identificador único de la orden obtenido de la URL. Este uuid debe estar asociado a una orden paga y aprobada.	Sí

Body json:

{
  "amount": "32221",
  "notification_url": "https://your-awesome-web.com/endpoint-to-notify"
}

Campo	Tipo	Descripción	Requerido
amount	string	Monto total de la orden.	Sí
notification_url	string	Link de donde se notificará via webhook el resultado de la devolución. De no proporsionarse no recibirá actualizaciones de la devolución.	No

Respuestas

Respuesta exitosa

Status 200:

{
    "status": "INITIATED"
}

Campo	Tipo	Descripción
status	string	La devolución inició y se confirmará en los próximos segundos.

Respuestas de error

Campo	Tipo	Descripción
code	string	Código de error
message	string	Descripción del error
errors	string array	Errores encontrados. Estos pueden varíar según los datos enviados.

Campos erroneos:

{
    "code": "request_error",
    "message": "Invalid request payload.",
    "errors": [
        "Invalid amount format. Amount must have only positive numbers and a single point.",
        "Check notification_url attribute value.",
        "Provide a valid token with active client_id.",
        "Provide a valid order id."
    ]
}

Orden no valida para realizar devolución:

{
    "code": "request_error",
    "message": "The order is not valid to refund.",
    "errors": [
        "The refund period has expired.",
        "The order has a refund in progress.",
        "The order must be from API Checkout v2.",
        "The order must be approved.",
        "Send a valid order amount value."
    ]
}

Casos de uso Webhook