Finanzas

PagosWebhook

Este webhook se utiliza para notificar eventos relacionados con los pagos realizados en Algebraix.
Los eventos incluyen:

Pagos nuevos: Cuando se registra un nuevo pago.
Pagos actualizados: Cuando un pago existente es modificado.
Pagos eliminados: Cuando un pago es eliminado.

El payload enviado en cada evento incluye información detallada del Pago

Este webhook es ideal para mantener sincronizados los datos de pagos en sistemas externos, proporcionando actualizaciones en tiempo real.

Request

header Parameters

Content-Type

required

string

Tipo de contenido

Example: application/json

Content-Length

required

string

indica el tamaño del cuerpo de la solicitud HTTP

Example: 655

x-algebraix-webhook_type

required

string

Indica el tipo de webhook que se está procesando

Example: PAYMENTS

x-algebraix-payment_mean

required

string

Medio de pago

Enum Value	Description
ONLINE	Pago por internet
SCHOOL	Pagos por ventanilla
BANK	Pago por entidad bancaria
RECURRING	Pago recurrente con tarjeta

x-algebraix-created_at

required

string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000

x-algebraix-charge_id

required

string

Identificador único del cargo

Example: AEDFERF3

x-algebraix-bank_account_id

required

string

Identificador único de la cuenta de banco

Example: KADFERF3

x-algebraix-operation

required

string

Tipo de operación efectuada en base de datos

Enum Value	Description
INSERT	Valor insertado
UPDATE	Valor actualizado
DELETE	Valor eliminado

Example: INSERT

x-algebraix-student_id

required

string

Identificador único del estudiante

Example: WADFERF3

authorization

string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0

ADDITIONAL-PROPERTIES

string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value

Request Body schema: application/json

id	string Identificador único del pago
	object Transacción relacionada con el pago
submit_date	string Fecha del pago
has_refund	boolean Indica si tiene reembolso
is_payed_from_prepay	boolean Indica si se ha pagado desde prepago
amount	string Monto del pago
	object Series de folios relacionadas con el pago
	object Factura o Recibo relacionado con el pago

Responses

200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples

Payload
HTTP request

application/json

{"id": "Z6OASXRM",
"transaction": {"id": "AXDCS23W",
"document_type": "INVOICE",
"payment_method_code": "CASH"
},
"submit_date": "19/09/2023",
"has_refund": false,
"is_payed_from_prepay": false,
"amount": "4500.00",
"series": {"id": "MY2VQLG3",
"name": "FUNO"
},
"receipt": {"id": "FUNO100",
"number": "100"
}
}

CargosWebhook

Este webhook se utiliza para notificar eventos relacionados con los cargos realizados en Algebraix.
Los eventos incluyen:

Cargos nuevos: Cuando se registra un nuevo cargo.
Cargos actualizados: Cuando un cargo existente es modificado.
Cargos eliminados: Cuando un cargo es eliminado.

Request

header Parameters

Content-Type

required

string

Tipo de contenido

Example: application/json

Content-Length

required

string

indica el tamaño del cuerpo de la solicitud HTTP

Example: 655

x-algebraix-webhook_type

required

string

Indica el tipo de webhook que se está procesando

Example: CHARGES

x-algebraix-created_at

required

string

Fecha y hora de creación del evento

Example: 2025/01/01 12:00:00.000000

x-algebraix-student_id

required

string

Identificador único del estudiante

Example: AEDFERF3

x-algebraix-operation

required

string

Tipo de operación efectuada en base de datos

Enum Value	Description
INSERT	Valor insertado
UPDATE	Valor actualizado
DELETE	Valor eliminado

Example: INSERT

authorization

string

Autorización de usuario

Nota: Esta es una propiedad configurable, la cual puede ser definida al momento de dar de alta un webhook, dentro del apartado de autenticación por HTTP. Esta será incluida en los headers de la petición y será compuesta por el username y password del usuario previamente dado de alta en dicho webhook.

Example: Basic YWRtaW46c2VjcmV0

ADDITIONAL-PROPERTIES

string

Este encabezado permite agregar una propiedad personalizada cuyo nombre será definido dinámicamente por el requerimiento deseado. Reemplace ADDITIONAL-PROPERTIES con el nombre deseado y asigne un valor como string.

Example: custom-value

Request Body schema: application/json

id	string Identificador único del cargo
name	string Nombre del cargo
concept	string Concepto del cargo
code	string Códigos de cargos AGREEMENT
total_payed	string Total pagado
original_amount	string Monto original
sub_amount	string Subtotal del cargo
unit_price	string Precio unitario
total_discount	string Monto total del descuento
total_to_pay	string Monto total a pagar
total_scholarships	string Monto total de las becas
balance	string Saldo
submit_date	string Fecha de creación
last_payment_time	string Última fecha de pago
last_modification_time	string Última fecha de modificación
has_disable_automatic_payments	boolean Indica si tiene desactivada la opción de "pagos automáticos"
is_divided	boolean Indica si el cargo está dividido
has_agreement	boolean Si está bajo un convenio
	object Información de Contpaq
	object Información referente al IVA
	object Información referente a las claves de servicio
	object Información del usuario creador
	object Periodo del estudiante
	Array of objects Datos de las cuentas bancarias

Responses

200

Devuelve un estado 200 para indicar que los datos se han recibido correctamente

Request samples

Payload
HTTP request

application/json

{"id": "string",
"name": "string",
"concept": "string",
"code": "AGREEMENT",
"total_payed": "string",
"original_amount": "string",
"sub_amount": "string",
"unit_price": "string",
"total_discount": "string",
"total_to_pay": "string",
"total_scholarships": "string",
"balance": "string",
"submit_date": "string",
"last_payment_time": "string",
"last_modification_time": "string",
"has_disable_automatic_payments": true,
"is_divided": true,
"has_agreement": true,
"contpaq": {"code": "string",
"contra_code": "string"
},
"tax": {"amount": "string",
"percentage": "string"
},
"tax_account": {"account": "string",
"contra_account": "string"
},
"creator": {"id": "string",
"name": "string"
},
"period": {"id": "string",
"name": "string"
},
"bank_data": [{"id": "string",
"name": "string",
"number": "string",
"code": "string",
"type_code": "string"
}
]
}