En algunos casos, también es posible que los usuarios ya tengan mandatos de domiciliación bancaria existentes configurados fuera de GoCardless y deseen gestionarlos junto con sus mandatos de GoCardless. La API de importación de mandato existe para permitir que los integradores automaticen este proceso sin problemas.
Configurar la importación de mandatos
Si deseas utilizar esta funcionalidad, primero debes habilitarla en tu cuenta. Para solicitar esto, ponte en contacto con el ejecutivo de tu cuenta o con nuestro equipo de ayuda y responderemos a tu solicitud tan pronto como sea posible.
Una vez que la funcionalidad está habilitada en la cuenta, puedes empezar a crear importaciones de mandatos. El procedimiento para utilizar esta funcionalidad es el siguiente:
- Crea un recurso de importación de mandatos
- Añade un conjunto de datos (un registro de importación de mandatos), para cada mandato que desees importar
- Envía la importación para revisión
Creación de una importación de mandatos
El primer paso es sencillo. El único dato necesario para crear una importación de mandatos es el esquema de domiciliación bancaria que los mandatos utilizan. Ten en cuenta que una importación de mandatos solo puede incluir mandatos provenientes de un solo esquema de domiciliación bancaria. Si deseas transferir mandatos en varios esquemas, necesitarás una importación de mandatos por cada esquema.
Para obtener ejemplos de código, consulta aquí.
Agregar registros de importación de mandatos
Una vez que hemos creado la importación de mandatos en sí, el siguiente paso es agregar registros de importación de mandatos para cada mandato que deseamos importar. Para crear un registro de importación de mandatos, debemos proporcionar:
- el identificador de la importación del mandato que estamos completando
- un subrecurso
customer
, que contenga datos de identificación del cliente al que se le realizará el cargo a través del mandato (los campos obligatorios varían de un esquema a otro; para obtener más información, consulta la referencia de la API) - un subrecurso
bank_account
, que contenga la información bancaria del nombre del titular de la cuenta (ya sea un IBAN o datos locales)
Para los mandatos del esquema SEPA, también debes proporcionar los datos de la modificación, que determinan el estado actual del mandato. Para obtener más información, consulta los siguientes enlaces con ejemplos de código y la referencia de la API.
También se puede (y se recomienda) proporcionar un valor record_identifier
, una cadena que debe ser exclusiva para cada mandato de la importación. De este modo, resultará más fácil conciliar las importaciones con los registros de tu propio sistema más adelante.
Para obtener ejemplos de código, consulta aquí.
Si los datos que proporcionas no son válidos, aparecerá un error descriptivo para que puedas hacer correcciones.
Ten en cuenta que todas las importaciones de mandatos tienen un límite máximo de 30.000 registros, así que te recomendamos dividir la importación en varias importaciones más pequeñas si piensas superar este límite.
Envío de la importación de mandatos para revisión
Una vez agregados todos los registros a la importación de mandatos, es el momento de enviarla para su revisión.
Como medida de protección contra posibles usos fraudulentos o perjudiciales de esta funcionalidad, todas las importaciones enviadas se someten a una revisión por parte del personal de GoCardless. Intentamos llevar esto a cabo lo antes posible.
Para obtener ejemplos de código, consulta aquí.
Creación de enlaces de recursos
Después de la aprobación, se procesará la importación de mandatos. A medida que se migran los mandatos, recibirás webhooks, como si hubieran sido creados mediante la API de mandatos.
Si necesitas conciliar los nuevos recursos con tu sistema, revisa periódicamente la importación de mandatos. Si el estado es procesado
, al generar un listado de los registros de la importación de mandatos obtendrás los identificadores del cliente, cuenta bancaria y recursos del mandato que se crearon para cada registro de importación de mandatos.
Para obtener ejemplos de código, consulta aquí.
También cabe señalar que si tienes que cancelar una importación de mandatos por cualquier motivo, puedes utilizar la API de cancelación proporcionada. Ten en cuenta que una vez que nuestro equipo ha aprobado una importación de mandatos enviada, ya no se puede cancelar ni revertir.