Crear reembolso para un pago

POST /payments/{payment_id}/refunds

Permite crear un reembolso (total o parcial) sobre un pago existente. El reembolso puede ser solicitado por un usuario autorizado y requiere especificar el tipo de reembolso, el responsable (blame) y, en el caso de reembolsos parciales, el monto.

Parámetros de URL

Cuerpo de la solicitud (Request Body)

El cuerpo debe ser un objeto JSON que discrimina por el campo refund_type:

Reembolso Total

{
	"refund_type": "FULL",
	"blame": {
		"team_id": "string",
		"mail": "string"
	},
	"user_id": "string"
}

Reembolso Parcial

{
	"refund_type": "PARTIAL",
	"amount": "string", // Monto a reembolsar, en formato string (ej: "1000.00")
	"currency": "ARS",
	"blame": {
		"team_id": "string",
		"mail": "string"
	},
	"user_id": "string"
}

• refund_type: "FULL" para reembolso total, "PARTIAL" para parcial.
• amount: Solo requerido para reembolsos parciales. Monto a reembolsar.
• currency: Solo "ARS" soportado actualmente.
• blame: Información del equipo/responsable que solicita el reembolso.
• user_id: ID del usuario que solicita el reembolso.

Respuestas

200 OK

{
	"status": "ok",
	"data": {
		/* Información del reembolso creado */
	},
	"code": 200
}

4XX/5XX Error

{
	"status": "error",
	"message": "Descripción del error",
	"code": 400 // o el código correspondiente
}

Ejemplo de uso

Solicitud

POST /payments/123456/refunds
Content-Type: application/json
 
{
  "refund_type": "PARTIAL",
  "amount": "500.00",
  "currency": "ARS",
  "blame": {
    "team_id": "soporte",
    "mail": "soporte@talo.com.ar"
  },
  "user_id": "usuario_789"
}

Respuesta exitosa

{
	"status": "ok",
	"data": {
		"refund_id": "abc123",
		"payment_id": "123456",
		"amount": "500.00",
		"currency": "ARS",
		"status": "CREATED",
		"created_at": "2024-06-07T12:34:56Z"
	},
	"code": 200
}

Notas

• Solo usuarios autenticados y autorizados pueden crear reembolsos.
• El campo blame es obligatorio y debe identificar al responsable del reembolso.
• El endpoint valida que el monto para reembolsos parciales no exceda el monto original del pago.
• Actualmente solo se soporta la moneda ARS.