1. Crear Acuerdo de Pago:
El primer endpoint permite a la empresa iniciar el proceso de cobro recurrente mediante la creación de un nuevo acuerdo. En este punto se envían los datos fundamentales, como la cuenta de destino de la compañía donde se recibirán los fondos, el UUID del tercero al que se le aplicarán los débitos, y los conceptos o detalles que definen el contrato. Este paso sienta las bases para el resto de la operación. Ir a
2. Consultar Estado del Acuerdo:
Una vez creado el acuerdo, se dispone de un endpoint que permite consultar su estado actual. Inicialmente, el acuerdo se encuentra en estado pendiente, esperando la validación necesaria por parte del tercero. Esta consulta es esencial para verificar que el acuerdo se ha registrado correctamente y se encuentra en la etapa esperada del proceso. Ir a
3. Enviar OTP de Confirmación al Tercero:
El tercer endpoint se encarga de enviar un código OTP de confirmación al tercero. Este código es clave para que el tercero pueda validar su consentimiento y proceder con la activación del acuerdo, asegurando así que la autorización de los débitos se realiza de forma segura. Ir a
4. Listar Métodos de Pago del Tercero:
En este punto se dispone de un endpoint que permite listar todos los métodos de pago que el tercero tiene registrados. Ir a
5. Validar Acuerdo / Registrar Método de Pago con OTP:
El quinto endpoint cumple una doble función. Por un lado, permite validar el acuerdo de pago utilizando uno de los métodos registrados del tercero junto con el OTP enviado. Por otro lado, en el caso de que el tercero no tenga ningún método de pago registrado, este endpoint posibilita el registro de uno nuevo, siempre acompañado del OTP de confirmación. Con esta operación se completa la validación necesaria por parte del tercero, dejando el acuerdo listo para la ejecución de débitos. Ir a
Aquí finalizaría el flujo del tercero. Una vez completado este proceso de validación y confirmación, el sistema queda preparado para ejecutar débitos de forma automatizada. Con el acuerdo de pago validado, se pueden programar y realizar los cobros recurrentes según la periodicidad establecida por la empresa, garantizando el cumplimiento de los parámetros definidos en el contrato. Puedes consultar el detalle del acuerdo en el punto 2 de esta guía
6. Listar Acuerdos de Pago de la Compañía:
Una vez que los acuerdos han sido validados, la empresa puede acceder a un endpoint que permite listar todos los acuerdos de pago existentes, sin importar si se encuentran en estado pendiente o ya han sido activados. Esto facilita la visualización global y el seguimiento de todos los contratos vigentes. Ir a
7. Crear un Débito:
Con el acuerdo validado, el siguiente endpoint permite a la empresa ejecutar un débito. En este punto, se envía el monto a pagar junto con el identificador del contrato seleccionado. Este proceso automatizado se encarga de debitar los fondos estipulados según los parámetros definidos en el acuerdo. Ir a
8. Consultar Estado de un Débito:
Después de ejecutar un débito, es posible utilizar otro endpoint para detallar el estado de dicha transacción. Este recurso es fundamental para el seguimiento y auditoría, ya que permite conocer si el débito se ha procesado correctamente o si ha presentado algún inconveniente. Ir a
9. Actualizar Ítems del Contrato:
El noveno endpoint está diseñado para permitir la actualización de los ítems del contrato, tales como los detalles o conceptos de cobro. Es importante resaltar que esta operación no afecta ni el tercero ni la cuenta de destino. Al ejecutar la actualización, se envía un OTP para garantizar que la modificación se realiza de forma segura y autorizada. Ir a
10. Validar la Actualización del Contrato:
Finalmente, el décimo endpoint permite validar la actualización del contrato. Este paso confirma que los cambios solicitados en los ítems del contrato han sido correctamente registrados y autorizados, asegurando que la información reflejada en el acuerdo es la definitiva y aprobada por el tercero. Ir a