Algebraix logo
Powered by Redocly

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-charge_id
required
string

Identificador único del cargo

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
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
application/json
{
  • "id": "Z6OASXRM",
  • "transaction": {
    },
  • "submit_date": "19/09/2023",
  • "has_refund": false,
  • "is_payed_from_prepay": false,
  • "amount": "4500.00",
  • "series": {
    },
  • "receipt": {
    }
}
➔ Next to Usuarios