Dans certains cas, vos utilisateurs peuvent également détenir des mandats de prélèvement en dehors de GoCardless et souhaiter les gérer conjointement avec leurs mandats GoCardless. Une API d'importation de mandats existe pour permettre aux intégrateurs d'automatiser facilement ce processus.
Configuration pour l'importation de mandats
Si vous souhaitez utiliser cette fonctionnalité, vous devez l'activer au préalable dans votre compte. Pour demander l'activation, contactez votre responsable de compte ou notreéquipe d'assistance . Nous répondrons à votre demande dans les plus brefs délais.
Une fois la fonctionnalité activée dans votre compte, vous pourrez commencer à créer des importations de mandats. La procédure d'utilisation de cette fonctionnalité est la suivante :
- Créer une ressource d'importation de mandats
- Ajouter une collecte de données — une entrée d'importation de mandat — pour chaque mandat que vous souhaitez importer
- Soumettre l'importation à des fins de vérification
Créer une importation de mandats
La première étape est simple. Les seules données nécessaires pour créer une importation de mandats sont le programme de prélèvement que les mandats utilisent. Notez qu'une importation de mandats ne peut inclure que les mandats d'un seul programme de prélèvement. Si vous souhaitez transférer des mandats dans plusieurs programmes, une importation de mandats par programme sera nécessaire.
Cliquez ici pour consulter des exemples de codes.
Ajouter des entrées d'importation de mandats
Une fois l'importation de mandats créée, l'étape suivante consiste à ajouter des entrées d'importation de mandats pour chaque mandat que vous souhaitez importer. Pour créer une entrée d'importation de mandats, les éléments suivants sont requis :
- l'ID de l'importation de mandats généré
- une sous-ressource
customer
, contenant les données d'identification du client final qui sera prélevé dans le cadre du mandat (les champs obligatoires diffèrent selon les programmes ; reportez-vous à la section Référence de l'API pour plus d'informations) - une sous-ressource
bank_account
, contenant les coordonnées bancaires du titulaire du compte (un IBAN ou des coordonnées locales)
Pour les mandats du programme SEPA, vous devez également fournir les données de rectification qui identifient le statut actuel du mandat. Reportez-vous aux exemples de codes associés ci-dessous et à la section Référence de l'API pour plus d'informations.
Il est également possible - et recommandé - de fournir une valeur record_identifier
, une chaîne qui doit être unique par importation de mandats. Le processus de rapprochement des importations et des registres dans votre propre système sera ainsi facilité.
Cliquez ici pour consulter des exemples de codes.
Si vous fournissez des données non valides, vous recevrez un message d'erreur détaillé pour vous permettre de les corriger.
Veuillez également noter que les importations de mandats sont limitées à 30 000 entrées maximum. Si vous prévoyez de dépasser ce plafond, nous vous recommandons d'effectuer plusieurs importations moins volumineuses.
Soumettre l'importation de mandats pour vérification
Lorsque toutes les entrées ont été ajoutées à l'importation de mandats, vous pouvez la soumettre pour vérification.
À des fins de protection contre une éventuelle utilisation frauduleuse ou préjudiciable de cette fonctionnalité, toutes les importations soumises font l'objet d'une vérification par le personnel de GoCardless. Nous effectuerons cette vérification le plus rapidement possible.
Cliquez ici pour consulter des exemples de codes.
Relier les ressources
Une fois approuvée, l'importation de mandats sera traitée. Les mandats étant migrés, vous recevrez des webhooks, comme s'ils avaient été créés à l'aide de l'API de mandats.
Si vous devez rapprocher les nouvelles ressources dans votre système, vérifiez régulièrement votre importation de mandats. Lorsqu'elle est au statut processed
, la liste des entrées de l'importation de mandats indique les identifiants du client final, le compte bancaire et les ressources de mandat qui ont été créées pour chaque entrée de l'importation de mandats.
Cliquez ici pour consulter des exemples de codes.
Il convient également de noter que si vous souhaitez annuler une importation de mandats pour une raison ou une autre, vous pouvez utiliser l'API d'annulation fournie. Notez enfin que lorsqu'une importation de mandats soumise a été approuvée par notre équipe, elle ne peut plus être annulée ni révoquée.