Merge pull request #97 from placetopay-org/feature/checkout-expiration

Feature/checkout expiration

src/assets/apis/checkout/en.yaml

@@ -3100,8 +3100,8 @@ components:
       format: date-time
       description: |
         Expiration date of a session. The user must finish the process before this date.
-        The expiration time must be at least 5 minutes from the time of creation.
-        e.g.: `2023-07-17T13:12:44-05:00`
+        The expiration time must be at least 5 minutes from the time of creation. See more in [Expiration date](/en/checkout/expiration)   
+        e.g.: `2024-09-03T12:23:39-05:00`
     IpAddress:
       type:
         - string

src/assets/apis/checkout/es.yaml

@@ -3101,8 +3101,8 @@ components:
       format: date-time
       description: |
         Fecha de expiración de una sesión. El usuario debe terminar el proceso antes de esta fecha.
-        El tiempo de expiración debe ser de al menos 5 minutos desde el momento de la creación.   
-        EJ: `2023-07-17T13:12:44-05:00`
+        El tiempo de expiración debe ser de al menos 5 minutos desde el momento de la creación. Ver más en [Fecha de expiración](/checkout/expiration)   
+        EJ: `2024-09-03T12:23:39-05:00`
     IpAddress:
       type:
         - string

src/constants/navigations.js

@@ -46,6 +46,10 @@ export const TAB_NAVIGATION = {
                 title: 'Campos de procesamiento',
                 href: '/checkout/processor-fields',
               },
+              {
+                title: 'Fecha de expiración',
+                href: '/checkout/expiration',
+              },
             ],
           },
         ],
@@ -123,6 +127,10 @@ export const TAB_NAVIGATION = {
                 title: 'Processor Fields',
                 href: '/checkout/processor-fields',
               },
+              {
+                title: 'Expiration Date',
+                href: '/checkout/expiration',
+              },
             ],
           },
         ],

src/pages/checkout/api/changelog.mdx

@@ -10,6 +10,12 @@ Este archivo contiene las mejoras y actualizaciones que se hagan en Checkout API
 
 ...
 
+## `2.22.0` 2024-09-10
+
+### Nuevo:
+
+  - La propiedad `CreateSessionRequest.expiration` en el endpoint de creación de sesión ` /api/session` cambia de ser requerida a **opcional**. Si la fecha de expiración no se envía, se asignará automáticamente un valor predeterminado de `30 minutos` a partir de la fecha de creación de la sesión. [Fecha de expiración](/checkout/expiration)
+
 ## `2.21.9` 2024-07-26
 
 ### Cambió:

src/pages/checkout/expiration.mdx

@@ -0,0 +1,26 @@
+export const description =
+   'La propiedad expiration se utiliza para definir el período durante el cual una sesión puede ser procesada'
+
+# Fecha de expiración
+
+Cuando se envía la propiedad `CreateSessionRequest.expiration` en la creación de una sesión esta define la fecha límite en la que una sesión debe completarse.
+
+- **Formato Requerido**: La propiedad expiration debe ser un string en formato de timestamp válido conforme al estándar `ISO 8601`.   
+Ejemplo: 2023-07-17T13:12:44-05:00.
+- **Tiempo Mínimo**: La fecha y hora establecidas en expiration deben estar al menos a **5 minutos** después del momento en que se crea la sesión.
+
+<Note>
+La propiedad expiration es opcional. Si no se proporciona, el sistema asignará automáticamente un tiempo de expiración predeterminado de **30 minutes** desde la creación de la sesión.
+</Note>
+
+```json
+{
+      "locale": "es_CO",
+      "auth": ...
+      "payment": {
+        ...
+      }
+      "expiration": "2024-09-03T12:23:39-05:00",
+      ...
+  }
+```

src/pages/en/checkout/api/changelog.mdx

@@ -10,6 +10,12 @@ This file contains the improvements and updates made to the Checkout API.
 
 ...
 
+## `2.22.0` 2024-09-10
+
+### Added:
+
+- The `CreateSessionRequest.expiratio` property in the `/api/session` creation endpoint changes from being required to **optional**. If the expiration date is not provided, a default value of `30 minutes` from the session creation time will be automatically assigned. [Expiration date](/en/checkout/expiration)
+
 ## `2.21.9` 2024-07-25
 
 ### Changed:

src/pages/en/checkout/expiration.mdx

@@ -0,0 +1,25 @@
+export const description =
+   'The expiration property is used to define the period during which a session can be processed'
+
+# Expiration Date
+When the `CreateSessionRequest.expiration` property is sent during session creation, it defines the deadline by which a session must be completed.
+
+- **Required Format**: The expiration property must be a string in a valid timestamp format according to the `ISO 8601` standard.   
+Example: 2023-07-17T13:12:44-05:00.
+- **Minimum Time**: The date and time specified in expiration must be at least **5 minutes** after the session is created.
+
+<Note> 
+The `expiration` property is optional. If not provided, the system will automatically assign a default expiration time of **30 minutes** from the session creation. 
+</Note>
+
+```json
+{
+      "locale": "es_CO",
+      "auth": ...
+      "payment": {
+        ...
+      }
+      "expiration": "2024-09-03T12:23:39-05:00",
+      ...
+  }
+```