Maintenant que nous avons mis en place un mandat pour notre premier client final, nous pouvons commencer à encaisser des paiements. Il existe deux moyens de configurer vos paiements - celui qui est adapté pour vous dépendra de la raison pour laquelle vous utilisez GoCardless :
- Paiements uniques : vous déclenchez un paiement dans le cadre d'un mandat quand vous voulez à l'aide de l'API. Ce moyen est idéal si vous souhaitez facturer à vos clients finaux des montants ponctuels.
- Abonnements : vous configurez un paiement récurrent automatique. Idéal si vous souhaitez prélever le même paiement régulièrement (5 £ par semaine ou 20 £ le premier de chaque mois par exemple).
Vous pouvez aussi utiliser les deux ensemble - une fois que vous avez un mandat, vous avez l'entière liberté de facturer vos clients finaux quand vous le souhaitez.
Essayons les deux. Nous vous conseillons de passer quelques minutes sur chacun d'entre eux pour comprendre tout le potentiel de l'API.
Paiements uniques
Pour créer un paiement pour un client final, les champs suivants sont obligatoires :
amount
: montant en pence (GBP), cent (AUD/EUR), öre (SEK) ou øre (DKK).
currency
: code de devise ISO 4217. Actuellement, les codes GBP, EUR, SEK et AUD sont pris en charge.
links[mandate]
: Identifiant du mandat du client final dans le cadre duquel ce paiement doit être collecté.
Vous devrez indiquer dans le champ currency
la devise appropriée pour le mandat que vous mettez en place. Cela dépend du programme de prélèvement que vous utilisez - le programme de votre mandat mis en place par le biais du flux de redirection dépendra de votre emplacement (mais vous pouvez le définir manuellement en spécifiant un programme
) :
Emplacement | Devise |
---|---|
Royaume-Uni | GBP |
Suède | SEK |
Australie | AUD |
Partout ailleurs | EUR |
En plus de ces champs, les paramètres optionnels suivants peuvent être envoyés :
app_fee
: le montant qui sera déduit du paiement comme frais de l'application OAuth, en pence/cents/öre/øre (s'applique uniquement aux partenaires)
charge_date
: date future à laquelle le paiement doit être collecté. Si elle n'est pas spécifiée, le paiement sera collecté le plus tôt possible. Il ne doit pas s'agir d'une date antérieure à celle qui est spécifiée dans le champ next_possible_charge_date du mandat, et elle sera reportée par GoCardless s'il ne s'agit pas d'un jour ouvrable.
description : description lisible du paiement. Elle sera incluse dans l'e-mail de notification que GoCardless envoie à votre client final si votre organisation n'envoie pas ses propres notifications (voir les exigences de conformité).
metadata
: stockage clé-valeur de données personnalisées. 3 clés au maximum sont autorisées, les noms des clés pouvant comporter jusqu'à 50 caractères et les valeurs jusqu'à 500 caractères.
reference
: référence de paiement facultative qui figurera sur le relevé bancaire de votre client final. Pour les paiements Bacs, elle peut comporter 10 caractères au maximum. Pour les paiements SEPA, la limite est de 140 caractères. Elle est de 30 caractères pour les paiements Betalingservice et de 11 caractères pour les paiements Autogiro. Restriction : vous pouvez spécifier une référence de paiement pour les paiements Bacs (collectés depuis le Royaume-Uni) uniquement si vous avez souscrit à l'offre GoCardless Plus ou Po.
Pour des exemples de code, reportez-vous au guide disponible ici.
Clés d'unicité
Idempotency-Key
. Si nous fournissons une chaîne unique spécifique à ce paiement (son identifiant dans notre propre base de données par exemple), l'API s'assurera que ce paiement n'est créé qu'une seule fois.Cela signifie qu'en cas d'expiration du délai d'attente d'une requête envoyée à l'API de problème de votre côté, vous ne facturerez jamais un client final accidentellement deux fois. Pour des informations plus détaillées, consultez notre article de blog . Vous pouvez utiliser des clés d'unicité à chaque fois que vous créez quelque chose avec l'API.
Abonnements
Les abonnements permettent aux paiements d'être créés en fonction d'un calendrier.
Pour créer un abonnement pour un client final, les champs suivants sont obligatoires :
amount
: montant en pence (GBP), cent (AUD/EUR), öre (SEK) ou øre (DKK).
currency
: code de devise ISO 4217. Actuellement, les codes GBP, EUR, SEK, AUD et DKK sont pris en charge.
interval_unit
: unité de temps entre les dates de prélèvement sur le compte bancaire du client final : weekly, monthly ou yearly.
links[mandate]
: Identifiant du mandat du client final dans le cadre duquel l'abonnement créera des paiements.
En plus de ces champs, les paramètres optionnels suivants peuvent être envoyés :
name
: nom facultatif de l'abonnement, qui définira également la description de chaque paiement.
interval
: nombre d'unités de temps entre chaque date de prélèvement. Il doit s'agir d'au moins un prélèvement par an, et ce paramètre sera défini par défaut sur 1 si le nombre n'est pas fourni.
count
: nombre total de paiements qui seront prélevés par l'abonnement. Si aucun nombre n'est spécifié, l'abonnement continuera indéfiniment.
day_of_month
: jour du mois (1 à 28) auquel vous souhaitez facturer votre client final. Vous pouvez aussi utiliser -1 pour indiquer le dernier jour du mois.
month
: nom du mois au cours duquel un client final sera facturé.
start_date
: date de facturation du premier paiement. Cette date doit être au cours de l'année de création de l'abonnement, et à compter du prochain jour de facturation possible ( next_possible_charge_date
) du mandat. Si ce paramètre n'est pas configuré, le premier paiement sera facturé le plus tôt possible.
payment_reference
: ce paramètre est réservé aux comptes GoCardless Pro. Il s'agit d'une référence de paiement facultative qui sera définie pour tous les paiements et qui figurera sur le relevé bancaire de votre client final.
Pour des exemples de code, reportez-vous au guide disponible ici.
Pour des informations plus détaillées sur les règles de récurrence et des conseils pour la mise en œuvre, reportez-vous à notre article plus approfondi ici.