Skip to content

Echeqs ​

¿Que es ? ​

Un ECHEQ, o cheque electrónico, es un cheque que se emite y circula de forma totalmente digital, sin necesidad de un formato físico (BCRA, COMUNICACIÓN “A” 6578). Funciona de manera similar a un cheque tradicional, pero se gestiona a través de canales electrónicos como la banca por internet o aplicaciones móviles. Los usuarios pueden emitir, depositar, endosar y gestionar estos cheques.

La API ECHEQ es una solución tecnológica diseñada para automatizar y optimizar la gestión integral de cobranzas y pagos mediante cheques electrónicos (Echeqs).

Acciones de un echeq disponibles vía api: ​

  1. Emisión de echeq.
  2. Aceptar/Admitir un echeq o endoso.
  3. Anular echeq o endoso.
  4. Repudiar echeq o endoso.
  5. Endoso tipo “Nominal” y “Para negociación”.
  6. Custodia de un echeq.
  7. Depósito de un echeq.

Diagrama de manejo de estados ​


Atención:

Si un eCheq se encuentra en estado RECHAZADO y el atributo is_represent tiene valor true, el rechazo no debe considerarse definitivo. Este escenario puede ocurrir excepcionalmente debido a determinadas condiciones operativas, como intentos de depósito realizados en fechas no hábiles. En estos casos, el eCheq mantiene la posibilidad de ser depositado nuevamente. El cliente no debe realizar ninguna acción, ya que el redepósito será gestionado de forma centralizada por el Banco el siguiente día hábil.


Acciones de Echeqs ​


Custodia de echeqs: ​

[PUT]: /v1/echeqs/custody

Este servicio que permite poner en custodia un Echeq en Banco Comafi por parte del tenedor. El Echeq previamente debe haber sido recibido por el beneficiario.

Características de la API: ​

  • Estado Inicial requerido del echeq: ACTIVO
  • Estado Final: CUSTODIA

Una vez ejecutado el endpoint [PUT]:/v1/echeqs/custody y obtenida una respuesta con status code 200, deberán ingresar al ebanking y aprobar la custodia del Echeq.

En el entorno de QA, es necesario que nos informen el ID del Echeq para que podamos aprobarlo manualmente, permitiendo así visualizar el cambio de estado.

Posteriormente, podrán utilizar el servicio [GET]:/v2/echeqs/:id para consultar el estado actualizado del Echeq.

El servicio debería ser consultado una vez finalizada la ejecución del PUT (poner en custodia) de acuerdo con la fecha de vencimiento del Echeq.

Ante un error 500/503/504/5XX en el PUT /v1/echeqs/custody debe reportar el incidente a [email protected] ingresando y proporcionando fecha y hora de ejecución, body request enviado y trace-id enviado en el header.

Códigos de rechazos para custódia de echeqs: ​

HTTP STATUS CODE 412: Error debido a alguna condición y/o validación que no se cumple.

  • invalid_echeq
    Este error ocurre cuando el ID del Echeq proporcionado no existe o el cliente no tiene los permisos necesarios para realizar una acción sobre ese Echeq en particular.

  • invalid_echeq_status
    Este error aparece cuando se intenta realizar una acción en un Echeq que no se encuentra en el estado adecuado para permitir dicha operación. Para poder realizar la custodia de un Echeq el mismo debe encontrarse en estado ACTIVO.

  • invalid_account_key
    Este error indica que la account_key proporcionada a realizar el depósito del Echeq pasada la fecha de custodia no existe o no está habilitada para realizar la transacción solicitada.

​

Depósito de echeqs ​

[PUT]: /v1/echeqs/deposit

  • Servicio que permite depositar el monto de un Echeq en una cuenta de Banco Comafi por parte del tenedor. El Echeq previamente debe haber sido recibido por el beneficiario.

  • El Echeq no debe estar vencido (Fecha pago + 30 días)

  • La CBU no debe estar bloqueada.

  • Los plazos de acreditación son los mismos que para el cheque en papel: 48 horas.

Características de la API: ​

  • Estado Inicial requerido del Echeq: ACTIVO o CUSTODIA
  • Estado Final: DEPOSITADO

Códigos de rechazos para depósito de echeqs: ​

HTTP STATUS CODE 412: Error debido a alguna condición y/o validación que no se cumple.

  • invalid_echeq
    Este error ocurre cuando el ID del Echeq proporcionado no existe o el cliente no tiene los permisos necesarios para realizar una acción sobre ese Echeq en particular.

  • invalid_echeq_status
    Este error aparece cuando se intenta realizar una acción en un Echeq que no se encuentra en el estado adecuado para permitir dicha operación. Para poder realizar el depósito de un Echeq el mismo debe encontrarse en estado ACTIVO o CUSTODIA.

  • invalid_account_key
    Este error indica que la account_key proporcionada donde se desea realizar el depósito del Echeq, no existe o no está habilitada para realizar la transacción solicitada.

​

CONSULTA DE ECHEQS DISPONIBLES ​

[GET]: /v1/echeqs/available

Esta API permite conocer la cantidad de Echeqs disponibles de una cuenta indicada y muestra el total de Echeqs disponibles diferenciados por el tipo: normal (al día) o diferido.

Consulta de Echeqs disponibles mediante Ebanking:

Además de contar con la consulta vía API, también se puede consultar la cantidad disponible de Echeqs ingresando desde su Ebanking:

​

CONSULTA DE LOTE DE ECHEQS ​

[GET]: /v1/Echeqs/issuance/lot/{lot_id}

El servicio permite consultar el estado del lote de un Echeq.

  • El lot_id está asociado a las acciones:

    • EMISION

    • CUSTODIA

    • RESCATE

  • El servicio brinda información sobre los Echeqs asociados al lote.

  • De momento 1 solo Echeq, donde se devolverá información asociada al lote en el objeto “lot” y luego la información asociada al Echeq (solo si se logró emitir. Es decir, se encuentra en estado “EN PROCESO”)

  • Allí se devolverá información sobre el CMC7 asignado (en caso de que haya quitado el uso de un CMC7 en particular desde la configuración de ebanking y haya sido informado via API), el status del Echeq registrado en COELSA, y monto sobre el cual se hizo la emisión.

Una vez emitido el echeq, si desea obtener información más detallada deberá hacer uso del endpoint [GET]:/v2/echeqs/{id}, enviando el coelsa_id que devuelve esta API.

Aclaración sobre límites de consulta transaccional por estado:

  • Estados activos: La consulta transaccional queda con un límite de 396 días, en línea con la normativa vigente sobre las acciones que pueden realizarse sobre un E-CHEQ.
  • Estados definitivos (CADUCADO y RECHAZADO): Se habilita la consulta hasta 793 días, permitiendo realizar el CAC correspondiente.
  • Estado PAGADO: La consulta se habilita hasta 6 meses.

Emisión de Echeqs: ​

Este endpoint permite la emisión de un ECHEQ por parte de un cliente. La emisión requiere de validaciones de token y cabeceras de autorización, y la respuesta depende de las condiciones del request y los recursos disponibles.

  • Permite la emisión de Echeqs al día o diferido (hasta 360 días).
  • Permite emitir un Echeq mediante un CMC7 o bien eligiendo un Echeq al azar.
  • Permite emitir Echeqs a la orden y no a la orden.
  • El servicio brinda la posibilidad de enviarle un mail al beneficiario del Echeq.
  • Si al invocar la API, los parámetros fueron enviados correctamente, el Echeq iniciará el proceso de emisión pasado un lapso de tiempo.
  • Es recomendable consultar el estado del lote que realizó la emisión del Echeq (API Consulta lote de Echeqs por ID) pasados 5 minutos de la emisión, para conocer el estado de la solicitud de emisión.

Pre-requisitos para emisión de Echeqs ​

  • Tener al menos una cuenta origen habilitada para realizar emisión de Echeqs. Se debe comunicar con el asesor comercial asignado para conocer este proceso.
  • Las cuentas para operar tienen que ser Cuenta Corriente (CC) en pesos argentinos.
  • Tener al menos una Echequera con al menos un Echeq disponible del tipo que se va a emitir (Diferido o Al Día), se puede consultar en (API Consulta cantidad de echeqs disponibles por cuenta).
  • Conocer los firmantes del Echeq. Los mismos deben ser configurados en el portal de Ebanking. Se debe comunicar con el asesor comercial asignado para conocer este proceso.
  • Activar las opciones necesarias en el Ebanking (se muestra a continuación).

Configuraciones requeridas desde Ebanking ​

IMPORTANTE: En caso de presentar algún problema con el uso de Ebanking en relación a las configuraciones mencionadas en esta documentación, deberá comunicarse con su oficial/responsable comercial para que le brinde soporte sobre estas configuraciones. Todas las capturas son desde un ambiente de pruebas de Ebanking.

  1. Activar las opciones necesarias para Echeqs

  1. Sección de Emisión

    Permite seleccionar que cuentas pertenecientes a la empresa van a ser habilitadas para Emitir Echeqs. Para poder consumir el servicio API de emisión [POST]:/v1/echeqs debe tener en cuenta que debe tener habilitadas las cuentas en este punto.

  1. Asignación de CMC7

    Al estar habilitada esta opción, se deberá informar en el campo CMC7 en el body request (detallado más abajo) del Echeq a utilizar. (Los CMC7 disponibles para utilizar con esta opción, deben ser visualizados desde Ebanking)

  1. Sección E-Chequeras

Deberá tener una cuenta habilitada con Echeqs para poder hacer emisiones. Estos Echeqs se diferencian por Echeqs al día o Echeqs diferidos.

Servicio opcional de envío de mail al beneficiario:

El servicio brinda la posibilidad de enviarle un mail al beneficiario del Echeq. Para ello deberá completar los campos del body request “notification”. En caso de enviarlo el beneficiario recibirá un mail como este:

Estados de autorización de un Echeq emitido:

  1. BORRADOR
  2. PENDIENTE AUTORIZACION
  3. EN PROCESO

¿Qué sucede si no envío uno de los firmantes faltantes o lo envío mal?

La solicitud de emisión, en la API de consulta de Lote, quedará reflejada como “PENDIENTE-AUTORIZACION”. Para ello deberá completar la autorización desde el Ebanking.

Diagrama flujo de Emisión.

En caso de respuestas >= 500, se recomienda consultar en e-banking si el lote fue creado. Para esto debe ir a la sección de Echeqs y hacer una búsqueda por fecha:

Allí se listarán todos los Echeqs, donde podrá encontrar una lista de todos los Echeqs y podrá visualizar haciendo clic en el icono del ojo el estado del Echeq.

Aclaración sobre algunos códigos de errores:

http status code 412: Error debido a alguna condición y/o validación que no se cumple.Puede devolver las siguientes error_code.

  • cmc7_not_available: este error ocurre cuando el CMC7 proporcionado ya ha sido procesado anteriormente y no está disponible para su uso.

  • cmc7_invalid_type: este error ocurre cuando el tipo de CMC7 proporcionado no corresponde con la fecha de pago ingresada.

  • cmc7_invalid_account: este error ocurre cuando el CMC7 proporcionado no pertenece a la cuenta seleccionada para la emisión del ECHEQ.

  • invalid_cmc7: este error ocurre cuando el CMC7 proporcionado no existe o no es válido.

  • invalid_amount: este error ocurre cuando el monto del ECHEQ supera el límite permitido. Por ejemplo, cuando el monto es mayor a 999,999,999.99.

  • cmc7_required: este error ocurre cuando el campo CMC7 es obligatorio ya que se configuro como requerido en ebanking, pero no ha sido proporcionado en la solicitud.