Feat/transaction complete deferred

src/main/java/cl/transbank/webpay/example/controllers/TransaccionCompletaDiferidaController.java

@@ -0,0 +1,244 @@
+package cl.transbank.webpay.example.controllers;
+
+import cl.transbank.common.IntegrationApiKeys;
+import cl.transbank.common.IntegrationCommerceCodes;
+import cl.transbank.common.IntegrationType;
+import cl.transbank.webpay.common.WebpayOptions;
+import cl.transbank.webpay.exception.*;
+import cl.transbank.webpay.transaccioncompleta.FullTransaction;
+import jakarta.servlet.http.HttpServletRequest;
+import lombok.extern.log4j.Log4j2;
+import org.springframework.stereotype.Controller;
+import org.springframework.ui.Model;
+import org.springframework.web.bind.annotation.*;
+
+import java.io.IOException;
+import java.security.SecureRandom;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+@Log4j2
+@Controller
+@RequestMapping("/transaccion-completa-diferida")
+public class TransaccionCompletaDiferidaController extends BaseController {
+    private static final String TEMPLATE_FOLDER = "transaccion_completa_diferida";
+    private static final String BASE_URL = "/transaccion-completa-diferida";
+    private static final String PRODUCT = "Webpay Transacción Completa Diferida";
+
+    private static final String VIEW_INDEX = TEMPLATE_FOLDER + "/index";
+    private static final String VIEW_CREATE = TEMPLATE_FOLDER + "/create";
+    private static final String VIEW_INSTALLMENTS = TEMPLATE_FOLDER + "/installments";
+    private static final String VIEW_COMMIT = TEMPLATE_FOLDER + "/commit";
+    private static final String VIEW_STATUS = TEMPLATE_FOLDER + "/status";
+    private static final String VIEW_REFUND = TEMPLATE_FOLDER + "/refund";
+    private static final String VIEW_CAPTURE = TEMPLATE_FOLDER + "/capture";
+
+    private static final String NAV_LABEL_FORM = "Formulario";
+    private static final String NAV_LABEL_REQUEST = "Petición";
+    private static final String NAV_LABEL_RESPONSE = "Respuesta";
+
+    private static final String ATTR_NAVIGATION = "navigation";
+    private static final String ATTR_PRODUCT = "product";
+    private static final String ATTR_BREADCRUMBS = "breadcrumbs";
+    private static final String ATTR_RESPONSE_DATA = "response_data";
+    private static final String ATTR_RESPONSE_DATA_JSON = "response_data_json";
+    private static final String ATTR_REQUEST_TOKEN = "request_token";
+    private static final String ATTR_AMOUNT = "amount";
+    private static final String ATTR_ERROR = "error";
+
+    private static final String SESSION_AMOUNT = "transaccion_completa_diferida_amount";
+    private static final String NAV_KEY_REQUEST = "request";
+    private static final String NAV_KEY_RESPONSE = "response";
+    private static final String NAV_KEY_FORM = "form";
+
+    private static final SecureRandom SECURE_RANDOM = new SecureRandom();
+
+    private static final Map<String, String> NAV_INDEX = createNav(NAV_KEY_FORM);
+    private static final Map<String, String> NAV_CREATE = createNav(NAV_KEY_REQUEST, NAV_KEY_RESPONSE, NAV_KEY_FORM);
+    private static final Map<String, String> NAV_INSTALLMENTS = createNav(NAV_KEY_REQUEST, NAV_KEY_RESPONSE, NAV_KEY_FORM);
+    private static final Map<String, String> NAV_COMMIT = createNav(NAV_KEY_REQUEST, NAV_KEY_RESPONSE, NAV_KEY_FORM);
+    private static final Map<String, String> NAV_STATUS = createNav(NAV_KEY_REQUEST, NAV_KEY_RESPONSE);
+    private static final Map<String, String> NAV_CAPTURE = NAV_STATUS;
+    private static final Map<String, String> NAV_REFUND = NAV_STATUS;
+
+    private static Map<String, String> createNav(String... keys) {
+        Map<String, String> nav = new LinkedHashMap<>();
+        for (String key : keys) {
+            String label = getNavLabel(key);
+            if (label != null) {
+                nav.put(key, label);
+            }
+        }
+        return nav;
+    }
+
+    private static String getNavLabel(String key) {
+        return switch (key) {
+            case NAV_KEY_REQUEST -> NAV_LABEL_REQUEST;
+            case NAV_KEY_RESPONSE -> NAV_LABEL_RESPONSE;
+            case NAV_KEY_FORM -> NAV_LABEL_FORM;
+            default -> null;
+        };
+    }
+
+    private final FullTransaction tx;
+
+    public TransaccionCompletaDiferidaController() {
+        this.tx = new FullTransaction(
+                new WebpayOptions(
+                        IntegrationCommerceCodes.TRANSACCION_COMPLETA_DEFERRED,
+                        IntegrationApiKeys.WEBPAY,
+                        IntegrationType.TEST
+                )
+        );
+    }
+
+    private void addProductAndBreadcrumbs(Model model, String label, String url) {
+        var breadcrumbs = new LinkedHashMap<String, String>();
+        breadcrumbs.put("Inicio", "/");
+        breadcrumbs.put(PRODUCT, BASE_URL);
+        if (label != null) {
+            breadcrumbs.put(label, url);
+        }
+        model.addAttribute(ATTR_PRODUCT, PRODUCT);
+        model.addAttribute(ATTR_BREADCRUMBS, breadcrumbs);
+    }
+
+    @GetMapping("")
+    public String index(Model model) {
+        model.addAttribute(ATTR_NAVIGATION, NAV_INDEX);
+        addProductAndBreadcrumbs(model, null, null);
+        return VIEW_INDEX;
+    }
+
+    @PostMapping("/create")
+    public String create(
+            HttpServletRequest req,
+            @RequestParam("number") String number,
+            @RequestParam("expiry") String expiry,
+            @RequestParam("cvc") String cvc,
+            Model model
+    ) throws TransactionCreateException, IOException {
+        model.addAttribute(ATTR_NAVIGATION, NAV_CREATE);
+        addProductAndBreadcrumbs(model, "Crear transacción", BASE_URL + "/create");
+
+        String cardNumber = number.replaceAll("\\s+", "");
+        String[] expiryParts = expiry.split("/");
+        String month = expiryParts.length > 0 ? expiryParts[0] : "";
+        String year = expiryParts.length > 1 ? expiryParts[1] : "";
+        String cardExpiry = year + "/" + month;
+
+        String buyOrder = "O-" + getRandomNumber();
+        String sessionId = "S-" + getRandomNumber();
+        double amount = 1000.0 + SECURE_RANDOM.nextInt(1001);
+
+        var resp = tx.create(buyOrder, sessionId, amount, Short.parseShort(cvc), cardNumber, cardExpiry);
+        req.getSession().setAttribute(SESSION_AMOUNT, amount);
+
+        model.addAttribute(ATTR_RESPONSE_DATA, resp);
+        model.addAttribute(ATTR_RESPONSE_DATA_JSON, toJson(resp));
+
+        return VIEW_CREATE;
+    }
+
+    @PostMapping("/installments")
+    public String installments(
+            @RequestParam("token") String token,
+            @RequestParam("installments_number") byte installmentsNumber,
+            Model model
+    ) throws TransactionInstallmentException, IOException {
+        model.addAttribute(ATTR_NAVIGATION, NAV_INSTALLMENTS);
+        addProductAndBreadcrumbs(model, "Consulta de cuotas", BASE_URL + "/installments");
+
+        var resp = tx.installments(token, installmentsNumber);
+        model.addAttribute(ATTR_REQUEST_TOKEN, token);
+        model.addAttribute(ATTR_RESPONSE_DATA, resp);
+        model.addAttribute(ATTR_RESPONSE_DATA_JSON, toJson(resp));
+
+        return VIEW_INSTALLMENTS;
+    }
+
+    @GetMapping("/commit")
+    public String commit(
+            HttpServletRequest req,
+            @RequestParam("token") String token,
+            @RequestParam(value = "idQueryInstallments", required = false) Long idQueryInstallments,
+            @RequestParam(value = "deferredPeriodIndex", required = false) Byte deferredPeriodIndex,
+            @RequestParam(value = "gracePeriod", required = false) Boolean gracePeriod,
+            Model model
+    ) throws TransactionCommitException, IOException {
+        model.addAttribute(ATTR_NAVIGATION, NAV_COMMIT);
+        addProductAndBreadcrumbs(model, "Confirmar transacción", BASE_URL + "/commit");
+
+        Boolean safeGracePeriod = gracePeriod != null ? gracePeriod : Boolean.FALSE;
+        var resp = tx.commit(token, idQueryInstallments, deferredPeriodIndex, safeGracePeriod);
+        Object amount = req.getSession().getAttribute(SESSION_AMOUNT);
+        req.getSession().removeAttribute(SESSION_AMOUNT);
+
+        model.addAttribute(ATTR_AMOUNT, amount);
+        model.addAttribute(ATTR_REQUEST_TOKEN, token);
+        model.addAttribute(ATTR_RESPONSE_DATA, resp);
+        model.addAttribute(ATTR_RESPONSE_DATA_JSON, toJson(resp));
+
+        return VIEW_COMMIT;
+    }
+
+    @GetMapping("/capture")
+    public String capture(
+            @RequestParam("token") String token,
+            @RequestParam("buy_order") String buyOrder,
+            @RequestParam("authorization_code") String authorizationCode,
+            @RequestParam("amount") double amount,
+            Model model
+    ) throws TransactionCaptureException, IOException {
+        model.addAttribute(ATTR_NAVIGATION, NAV_CAPTURE);
+        addProductAndBreadcrumbs(model, "Capturar", BASE_URL + "/capture");
+
+        var resp = tx.capture(token, buyOrder, authorizationCode, amount);
+        model.addAttribute(ATTR_AMOUNT, amount);
+        model.addAttribute(ATTR_REQUEST_TOKEN, token);
+        model.addAttribute(ATTR_RESPONSE_DATA, resp);
+        model.addAttribute(ATTR_RESPONSE_DATA_JSON, toJson(resp));
+
+        return VIEW_CAPTURE;
+    }
+
+    @GetMapping("/status")
+    public String status(
+            @RequestParam("token") String token,
+            Model model
+    ) throws TransactionStatusException, IOException {
+        model.addAttribute(ATTR_NAVIGATION, NAV_STATUS);
+        addProductAndBreadcrumbs(model, "Estado de transacción", BASE_URL + "/status");
+
+        var resp = tx.status(token);
+        model.addAttribute(ATTR_RESPONSE_DATA, resp);
+        model.addAttribute(ATTR_RESPONSE_DATA_JSON, toJson(resp));
+
+        return VIEW_STATUS;
+    }
+
+    @GetMapping("/refund")
+    public String refund(
+            @RequestParam("token") String token,
+            @RequestParam("amount") double amount,
+            Model model
+    ) throws TransactionRefundException, IOException {
+        model.addAttribute(ATTR_NAVIGATION, NAV_REFUND);
+        addProductAndBreadcrumbs(model, "Reembolsar", BASE_URL + "/refund");
+
+        var resp = tx.refund(token, amount);
+        model.addAttribute(ATTR_REQUEST_TOKEN, token);
+        model.addAttribute(ATTR_RESPONSE_DATA, resp);
+        model.addAttribute(ATTR_RESPONSE_DATA_JSON, toJson(resp));
+
+        return VIEW_REFUND;
+    }
+
+    @ExceptionHandler(Exception.class)
+    public String handleException(Exception e, Model model) {
+        log.error("Error inesperado", e);
+        model.addAttribute(ATTR_ERROR, e.getMessage());
+        return VIEW_ERROR;
+    }
+}

src/main/resources/templates/transaccion_completa_diferida/capture.html

@@ -0,0 +1,67 @@
+<div th:replace="~{layout :: layout(~{::content})}">
+  <div th:fragment="content">
+    <h1>Transacción Completa Diferida - Capturar transacción</h1>
+    <p class="mb-32">
+      En este paso debemos capturar la transacción para realmente capturar el dinero que habia sido previamente
+      reservado al hacer la transacción.
+    </p>
+
+    <h2 id="request">Paso 1: Petición</h2>
+    <p class="mb-32">
+      Para capturar una transacción, necesitaremos el Token, la Orden de compra, el Código de autorización y el monto
+      a capturar.
+    </p>
+
+    <pre class="mb-16"><code class="language-java">
+import cl.transbank.common.IntegrationApiKeys;
+import cl.transbank.common.IntegrationCommerceCodes;
+import cl.transbank.common.IntegrationType;
+import cl.transbank.webpay.common.WebpayOptions;
+import cl.transbank.webpay.transaccioncompleta.FullTransaction;
+
+FullTransaction tx = new FullTransaction(
+  new WebpayOptions(
+    IntegrationCommerceCodes.TRANSACCION_COMPLETA_DEFERRED,
+    IntegrationApiKeys.WEBPAY,
+    IntegrationType.TEST
+  )
+);
+var resp = tx.capture(token, buyOrder, authorizationCode, amount);
+    </code></pre>
+
+    <h2 id="response">Paso 2: Respuesta</h2>
+    <p>Una vez capturada la transacción, recibirás los siguientes datos de respuesta.</p>
+
+    <pre class="mb-16"><code class="language-json" th:text="${response_data_json}"></code></pre>
+
+    <h2 id="form">¡Listo!</h2>
+    <p class="mb-16">
+      Con la transacción capturada, puedes mostrar al usuario una página de éxito de la transacción, proporcionándole
+      la confirmación de que el proceso se ha completado con éxito.
+    </p>
+
+    <p>Después de capturar la transacción, podrás realizar otras operaciones útiles:</p>
+    <ul class="bullet-list">
+      <li><span class="fw-700">Reembolsar:</span> Puedes reversar o anular el pago según ciertas condiciones
+        comerciales.</li>
+      <li><span class="fw-700">Consultar Estado:</span> Hasta 7 días después de realizada la transacción, podrás
+        consultar el estado de la transacción.</li>
+    </ul>
+
+    <form th:action="@{/transaccion-completa-diferida/refund}" method="GET">
+      <div class="tbk-card">
+        <div class="input-container mb-32">
+          <label for="amount" class="tbk-label">Monto a reembolsar</label>
+          <input type="text" id="amount" name="amount" class="tbk-input-text" th:value="${amount}" />
+          <input type="hidden" name="token" th:value="${request_token}" />
+        </div>
+
+        <div class="tbk-card-footer">
+          <button class="tbk-button primary">REEMBOLSAR</button>
+        </div>
+      </div>
+    </form>
+
+    <a th:href="@{/transaccion-completa-diferida/status(token=${request_token})}" class="tbk-button primary mb-32">CONSULTAR ESTADO</a>
+  </div>
+</div>

src/main/resources/templates/transaccion_completa_diferida/commit.html

@@ -0,0 +1,74 @@
+<div th:replace="~{layout :: layout(~{::content})}">
+  <div th:fragment="content">
+    <h1>Transacción Completa Diferida - Confirmar transacción</h1>
+    <p class="mb-32">
+      En este paso crucial, procederemos a confirmar la transacción con el objetivo de notificar a
+      Transbank que hemos recibido la transacción de manera exitosa. Es fundamental destacar que si no se confirma la
+      transacción, esta será caducada.
+    </p>
+
+    <h2 id="request">Paso 1: Petición</h2>
+    <p class="mb-32">
+      Para confirmar la transacción, debes enviar el token correspondiente. En el caso de pagos a
+      plazos, también debes incluir el ID de la consulta de cuotas. En algunos casos, será necesario proporcionar el
+      índice del periodo diferido y un valor boolean indicando si se tomará el periodo de gracia.
+    </p>
+
+    <pre class="mb-16"><code class="language-java">
+import cl.transbank.common.IntegrationApiKeys;
+import cl.transbank.common.IntegrationCommerceCodes;
+import cl.transbank.common.IntegrationType;
+import cl.transbank.webpay.common.WebpayOptions;
+import cl.transbank.webpay.transaccioncompleta.FullTransaction;
+
+FullTransaction tx = new FullTransaction(
+  new WebpayOptions(
+    IntegrationCommerceCodes.TRANSACCION_COMPLETA_DEFERRED,
+    IntegrationApiKeys.WEBPAY,
+    IntegrationType.TEST
+  )
+);
+var resp = tx.commit(token, idQueryInstallments, deferredPeriodIndex, gracePeriod);
+    </code></pre>
+
+    <h2 id="response">Paso 2: Respuesta</h2>
+    <p>
+      Una vez que la transacción ha sido confirmada Transbank proporcionará la siguiente información. Es fundamental
+      conservar esta respuesta y verificar que el campo "response_code" tenga un valor de cero y que el campo "status"
+      sea "AUTHORIZED".
+    </p>
+
+    <pre class="mb-16"><code class="language-json" th:text="${response_data_json}"></code></pre>
+
+    <h2 id="form">¡Transacción confirmada!</h2>
+    <p class="mb-16">
+      Ahora que se ha confirmado la transacción, puedes capturar el monto previamente autorizado. El monto a capturar
+      puede ser igual o menor al monto autorizado. La captura debe efectuarse dentro de un plazo máximo de 7 días
+      calendario.
+    </p>
+
+    <ul class="bullet-list">
+      <li><span class="fw-700">Capturar:</span> Captura un monto igual o menor al previamente autorizado.</li>
+      <li><span class="fw-700">Consultar Estado:</span> Hasta 7 días después de realizada la transacción, podrás
+        consultar el estado de la transacción.</li>
+    </ul>
+
+    <form th:action="@{/transaccion-completa-diferida/capture}" method="GET">
+      <div class="tbk-card">
+        <div class="input-container mb-32">
+          <label for="amount" class="tbk-label">Monto a Capturar</label>
+          <input type="text" id="amount" name="amount" class="tbk-input-text" th:value="${amount}" />
+          <input type="hidden" name="buy_order" th:value="${response_data.buyOrder}" />
+          <input type="hidden" name="authorization_code" th:value="${response_data.authorizationCode}" />
+          <input type="hidden" name="token" th:value="${request_token}" />
+        </div>
+
+        <div class="tbk-card-footer">
+          <button class="tbk-button primary">CAPTURAR</button>
+        </div>
+      </div>
+    </form>
+
+    <a th:href="@{/transaccion-completa-diferida/status(token=${request_token})}" class="tbk-button primary mb-32">CONSULTAR ESTADO</a>
+  </div>
+</div>