Documentación Collectar

Documentación Collectar

Documentación técnica de integración

Integración SEPA

Estimated reading: 4 minutes 51 views

Gestoría Virtual permite a sus clientes la presentación automatizada de remesas de pagos mediante EDITRAN e integra el flujo de aquellas impagadas dentro de la estrategia de gestión de la plataforma.

La aportación de órdenes de cobro a Gestoría Virtual se realizará mediante invocaciones POST a servicios REST implementados en la plataforma que permitirán la aportación masiva de documentos. Gestoría Virtual también implementa servicios para consultar el estado de las órdenes de pago.

Dado que SEPA únicamente notifica aquellos recibos que no han podido ser aplicados (rechazados), no habrá información positiva acerca de la presentación de ninguno de los recibos. Gestoría Virtual recogerá los rechazos e iniciará el proceso de recobro vía digital a partir de ellos.

Por este motivo, la información a aportar para la presentación de órdenes de pago mediante este servicio tiene que incluir toda la información necesaria para la presentación vía SEPA y la que se vaya a incluir durante el posible proceso posterior de recobro

Consideraciones generales
Para todas las invocaciones a este servicio se realizará una validación completa de cada una de las solicitudes. Esto quiere decir que, si algún elemento del mensaje no está correctamente formado, todo el mensaje será rechazado de manera atómica.

Por otra parte, Gestoría Virtual no validará el contenido de la información intercambiada a través de los servicios. Por lo tanto, será responsabilidad del cliente la validación de toda la información contenida en los mensajes, como, por ejemplo:

Cuenta IBAN
Detalles del mandato SEPA

Todos los mensajes se intercambiarán en formato JSON, con codificación UTF-8 e irán firmados para validar el contenido de los mismos.

Configuración del servicio

El servicio SEPA de Gestoría Virtual requiere una configuración interna del servicio para la integración bancaria que debe ser realizada independientemente, pero además permite la parametrización de una serie de valores que facilitarán la integración del servicio con el software del cliente.

Ubicación del servicio

El método se ubica en el path:

/api/sepa/setup

Estructura del mensaje
El método aceptará una petición JSON que se utilizará para configurar los siguientes atributos de la integración:

URL Callback: Gestoría Virtual notificará al cliente de modo reactivo sobre todos los rechazos recibidos

Rechazos en mensaje: Gestoría virtual permite la notificación de respuestas online o mediante la generación de un fichero de respuesta y facilitando una URL de descarga al cliente

Activar reclamaciones: indicará a Gestoría Virtual si las devoluciones SEPA recibidas deben de ser gestionadas automáticamente o si por el contrario no deben tramitarse y el proceso termina en el rechazo.
Campos para la petición

  • El idCliente corresponde al identificador API que CollectAR proporciona por cada cliente.
Respuesta del servicio

El servicio devolverá un código con un valor numérico que informará sobre el resultado de la petición:

Los códigos que podrán ser devueltos son los siguientes:

El campo firma contendrá una marca de validación del mensaje. La composición del mismo se realizará de la siguiente manera:

Se concatenan todos los campos de la petición, en el siguiente orden:

idCliente
urlCallback
rechazosEnMensaje
activarReclamaciones

Se añade también, al final, la clave privada del cliente.

Se aplicará una función SHA-256 sobre la cadena anterior. El resultado será codificado en una cadena hexadecimal y convertido a una cadena en mayúsculas

Ejemplo de petición

				
					{
 "idCliente": "KNX",
 "urlCallback": "https://demo.kineox.com/api/paymentrejections",
 "rechazosEnMensaje": 0,
 "activarReclamaciones": 1,
 "firma": "A212425465EFAABCD5679029122EEBCDD1"
}

				
			
CONTENTS
es_ESEspañol