Skip to content

Feature/autopay #394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
larangogon wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feature/autopay #394

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
996cfd5
fest: ad autopay en trans and update api
larangogon Dec 16, 2025
9254718
feat: refactor and update trans
larangogon Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,013 changes: 1,013 additions & 0 deletions src/assets/apis/autopay/en.yaml
View file
Open in desktop

Large diffs are not rendered by default.

188 changes: 160 additions & 28 deletions src/assets/apis/autopay/es.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,20 +114,20 @@ paths:
example: APPROVED
description: Estado del autopago. Solo se asentarán los pagos aprobados.
reason:
type: string
enum:
- '00'
description: Razón del estado de la petición. (consulte en [Códigos de razón](/autopay/codes))
example: '00'
type: string
enum:
- '00'
description: Razón del estado de la petición. (consulte en [Códigos de razón](/autopay/codes))
example: '00'
message:
type: string
description: Mensaje para aclarar el estado.
example: "Respuesta satisfactoria"
type: string
description: Mensaje para aclarar el estado.
example: "Respuesta satisfactoria"
date:
type: string
format: date-time
description: Fecha y hora en la que se generó la respuesta.
example: "2025-09-29T17:09:29-05:00"
type: string
format: date-time
description: Fecha y hora en la que se generó la respuesta.
example: "2025-09-29T17:09:29-05:00"
required:
- status
- reason
Expand Down Expand Up @@ -203,6 +203,7 @@ paths:
- "banco_bogota"
- "ebt"
- "alia"
- "deuna"
franchiseName:
type: "string"
description: "Nombre mostrado de la franquicia."
Expand Down Expand Up @@ -265,6 +266,14 @@ paths:
- "ATH-MOVIL"
- "EBUS"
- "BANCOLOMBIA"
- "PAGOEFECTIVO"
- "PROCESA"
- "TELERED"
- "AVAL"
- "DILO"
- "BANCO_BOGOTA"
- "BANET"
- "DEUNA"
discount:
type: "string"
description: "Información de descuento aplicada (si existe)."
Expand Down Expand Up @@ -352,9 +361,11 @@ paths:
maxLength: 32
id:
$ref: '#/components/schemas/AutoPayId'
nullable: true
chargeTypes:
type: array
description: Filtrar por uno o varios tipos de cargo.
example: "['FIXED', 'TOTAL_BALANCE']"
items:
$ref: '#/components/schemas/ChargeType'
status:
Expand All @@ -366,17 +377,20 @@ paths:
- FAILED
- REJECTED
- APPROVED
example: [ "APPROVED"]
example: "[ 'APPROVED' ]"
createdAt:
type: object
description: Rango de fechas de creación (ISO 8601, solo fecha).
properties:
from:
type: string
example: "2025-09-01"
format: date Y-m-d

to:
type: string
example: "2025-09-30"
format: date Y-m-d
pagination:
$ref: '#/components/schemas/PaginationRequest'
locale:
Expand Down Expand Up @@ -479,7 +493,7 @@ paths:
- REJECTED
- APPROVED
- APPROVED_PARCIAL
example: [ "APPROVED" ]
example: "[ 'APPROVED' ]"
amount:
type: "object"
description: "Estructura que contiene la información acerca del pago de la transacción."
Expand Down Expand Up @@ -516,9 +530,11 @@ paths:
from:
type: string
example: "2025-09-01"
format: date Y-m-d
to:
type: string
example: "2025-09-30"
format: date Y-m-d
pagination:
$ref: '#/components/schemas/PaginationRequest'
locale:
Expand All @@ -539,10 +555,73 @@ paths:
description: Lista de transacciones del autopago que cumplen con los criterios de búsqueda.
type: array
items:
title: Transaction
$ref: '../base/es.yaml#/components/schemas/Transaction'
pagination:
$ref: '#/components/schemas/Pagination'
/autopay/session:
post:
summary: Crear sesión (CreateRequest)
operationId: post-autopay-session
description: Solicita la creación de la sesión, retorna el identificador y la URL de procesamiento.
x-internal: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RedirectRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
status:
$ref: '#/components/schemas/Status'
requestId:
type: integer
processUrl:
type: string
'401':
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
status:
$ref: '#/components/schemas/Status'
/autopay/session/{requestId}:
parameters:
- schema:
type: string
name: requestId
in: path
required: true
post:
summary: Consultar sesión (getSessionInformation)
operationId: post-autopay-session-requestId
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/RedirectInformation'
description: |
Obtiene la información de la sesión, si en la sesión hay transacciones se muestra el detalle de las mismas.
requestBody:
content:
application/json:
schema:
type: object
required:
- auth
properties:
auth:
$ref: '#/components/schemas/Authentication'

components:
schemas:
AutoPay:
Expand Down Expand Up @@ -573,9 +652,11 @@ components:
type: "string"
minLength: 1
maxLength: 32
description: Referencia
description:
type: "string"
maxLength: 250
description: Descripción
amount:
$ref: "../base/es.yaml#/components/schemas/Amount"
description: |
Expand All @@ -595,12 +676,8 @@ components:
properties:
customerAccountNumber:
type: string
description: Identificador único que el comercio asigna a un cliente para identificar su cuenta interna
example: "12345"
acceptedAt:
type: string
format: date-time
description: Fecha en la que el usuario aceptó el AutoPago.
example: "2021-09-24T10:02:17-05:00"
createdAt:
type: string
format: date-time
Expand All @@ -617,6 +694,7 @@ components:
- TOTAL_BALANCE
- MINIMUM_BALANCE
- FIXED
example: TOTAL_BALANCE
description: Tipo de cargo del autopago. Ver más en [Tipos de cargo](/autopay/charge-types).
AutoPayId:
type: string
Expand Down Expand Up @@ -648,20 +726,15 @@ components:
description: Número máximo de períodos a cobrar.
minimum: 1
example: 12
startDate:
type: string
format: date-time
description: Fecha en la iniciará o inició la recurrencia.
example: "2021-09-24"
dueDate:
type: string
format: date
format: date Y-m-d
description: Fecha de vencimiento de la recurrencia
example: '2019-09-24'
nextPayment:
type: string
description: Fecha a partir de la cual inicia el cobro.
format: date
format: date Y-m-d
example: "2025-11-30"
WebhookEvent:
type: object
Expand Down Expand Up @@ -867,4 +940,63 @@ components:
type: "string"
description: Fecha **actual**, la cual se genera en formato **ISO 8601**.
description: "Estructura que contiene la información de autenticación del *sitio* generada de acuerdo al WSSE
UsernameToken Profile 1.1. Ver más en [Autenticación](/autopay/authentication)."
UsernameToken Profile 1.1. Ver más en [Autenticación](/autopay/authentication)."
RedirectRequest:
title: CreateSessionRequest
type: object
description: |
Información para crear una sesión.
required:
- auth
- ipAddress
- userAgent
- returnUrl
properties:
auth:
$ref: '#/components/schemas/Authentication'
type:
type: string
description: |
Parámetro usado para sesiones de tipos adicionales
Usar `autopay` para generar una sesión de Autopago.
enum:
- autopay
example: autopay
autopay:
$ref: '../checkout/es.yaml#/components/schemas/AutopayRequest'
x-conditional:
- id
ipAddress:
$ref: '../checkout/es.yaml#/components/schemas/IpAddress'
userAgent:
$ref: '../checkout/es.yaml#/components/schemas/UserAgent'
returnUrl:
$ref: '../checkout/es.yaml#/components/schemas/ReturnUrl'
locale:
$ref: '../checkout/es.yaml#/components/schemas/Locale'
RedirectInformation:
title: RedirectInformation
type: object
description: |
Estructura de respuesta a una solicitud para una información de transacción.
properties:
status:
$ref: '#/components/schemas/Status'
requestId:
type: string
example: 1
description: Id de la petición
request:
$ref: '../checkout/es.yaml#/components/schemas/RedirectRequest'
autopay:
oneOf:
- type: array
title: "array[Autopay]"
items:
$ref: '../checkout/es.yaml#/components/schemas/Autopay'
payment:
type: array
items:
$ref: '../checkout/es.yaml#/components/schemas/Transaction'
subscription:
$ref: '../checkout/es.yaml#/components/schemas/SubscriptionResponse'
15 changes: 15 additions & 0 deletions src/assets/apis/base/es.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,11 @@ components:
- "banco_bogota"
- "ebt"
- "alia"
- "dilo"
- "banco_bogota"
- "ebt"
- "alia"
- "deuna"
franchiseName:
type: "string"
description: "Nombre mostrado de la franquicia."
Expand Down Expand Up @@ -294,6 +299,7 @@ components:
refunded:
type: "boolean"
description: "Indicador reembolsada."
example: false
lastDigits:
type: "string"
description: "Últimos dígitos de cuenta."
Expand Down Expand Up @@ -324,6 +330,14 @@ components:
- "ATH-MOVIL"
- "EBUS"
- "BANCOLOMBIA"
- "PAGOEFECTIVO"
- "PROCESA"
- "TELERED"
- "AVAL"
- "DILO"
- "BANCO_BOGOTA"
- "BANET"
- "DEUNA"
discount:
type: "string"
description: "Información de descuento aplicada (si existe)."
Expand Down Expand Up @@ -403,6 +417,7 @@ components:
refunded:
type: "boolean"
description: "Dispersión reembolsada."
example: false
paymentMethod:
type: "string"
description: "Código del método de pago."
Expand Down
Loading