CentralPay Documentation CentralPay Documentation
  • Informations générales
  • Documentation
  • Développeurs
CentralPay Documentation CentralPay Documentation
  • Informations générales
  • Documentation
  • Développeurs

Documentation

  • Icône de dossier fermée Icône d’ouverture de dossierGuide de démarrage rapide >
  • Icône de dossier fermée Icône d’ouverture de dossierLe compte CentralPay
    • Compte CentralPaymerchant
    • Profils clientscustomer
    • Points de ventepointOfSale
    • Comptes de paiementwallet
    • Comptes de MEwallet
  • Icône de dossier fermée Icône d’ouverture de dossierServices liés au compte
    • Notifications email/sms
    • Services anti-fraude
    • Reversement bancairepayout
    • Exports comptables
    • Exports de données
    • Webhooks
  • Icône de dossier fermée Icône d’ouverture de dossierLiens de paiement
    • Informations générales
    • Demandes de paiementpaymentRequest
    • Page de paiement (SmartForm)
    • Retours, statuts et hooks
  • Icône de dossier fermée Icône d’ouverture de dossierTransaction par carte
    • Informations générales
    • Formulaire de paiement CUSTOM
    • Authentification 3DS 2.0
    • Transaction cartetransaction
    • Transaction carte récurrentetransaction
    • Transaction carte via walletApplePay / GooglePay
    • R-transaction carterefund / credit / dispute
    • Email de confirmation
    • Libellé relevé bancaire
    • Gestion des devises
    • Gestion des cartes virtuelles (VCC)
    • Retours, statuts et hooks
  • Icône de dossier fermée Icône d’ouverture de dossierTransaction par virement
    • Informations générales
    • IBAN Virtuels
    • Transaction par virementsctTransaction
    • Rapprochement à une demande de paiementbankReconciliation
    • R-transaction SCTrefund
    • Virements internationaux
    • Retours, statuts et webhooks
  • Icône de dossier fermée Icône d’ouverture de dossierTransaction prélèvement SEPA
    • Informations générales
    • Identifiant de Créancier SEPA
    • Déclaration du compte bancaire
    • Création du mandat SEPA
    • Transaction par prélèvementsddTransaction
    • R-transaction SDDrefund / sddTransactionReversal
    • Retours, statuts et webhooks
  • Icône de dossier fermée Icône d’ouverture de dossierTransaction par initiation
    • Informations générales
    • Retours, statuts et webhooks
  • Icône de dossier fermée Icône d’ouverture de dossierPaiements récurrents
    • Abonnementsubscription
    • Fractionnéinstallment
  • Icône de dossier fermée Icône d’ouverture de dossierAuthentification 3DS 2.2
    • 3DS 2.2 BRW (paiement unitaire)
    • 3DS 2.2 3RI (paiements récurrents)
    • FAQ 3DS 2.2
  • Icône de dossier fermée Icône d’ouverture de dossierCréer des comptes
    • Informations générales
    • Liste des pays autorisés
    • Création de compte de paiement
    • Création de compte de ME
    • Documents KYC et KYB
    • Conditions générales
    • Retours, statuts et webhooks
  • Icône de dossier fermée Icône d’ouverture de dossierTransférer des paiements
    • Informations générales
    • Transfert indépendant
    • Transfert via transaction
    • Transfert via demande de paiement
    • Reversement bancaire pour tiers
    • Retours, statuts et webhooks
  • Icône de dossier fermée Icône d’ouverture de dossierCas d’usages
    • Marketplace C2C

Demandes de paiement

Temps estimé :7 minutes

1/ Introduction

La demande de paiement (ou PaymentRequest) est le service vous permettant de générer des liens de paiement. Vous pouvez créer des demandes de paiement par API ou via le Portail utilisateur. La demande de paiement peut également être couplé au service de notification de CentralPay, vous permettant d’adresser facilement un lien de paiement par email ou sms à vos clients et de programmer des relances automatisées.

2/ Création par API

2.1/ Créer une « PaymentRequest »

Vous trouverez ci-dessous les moyens de paiement disponibles et les valeurs API correspondantes dans le service PaymentRequest :

Moyen ou mode de paiement souhaitéValeurs API à renseigner
Paiements unitaires
Transaction par cartepaymentMethod[]=TRANSACTION
Pré-autorisation sur carte (réservé aux activités de locations)paymentMethod[]=TRANSACTION
transaction[source]=DP
Vérification carte (transaction à 0 €)paymentMethod[]=TRANSACTION
transaction[source]=RI
Transaction par virement bancairepaymentMethod[]=SCT_TRANSACTION
Transaction par prélèvement SEPApaymentMethod[]=SDD
sdd[remittanceInformation]
Transaction par initiation de paiementProchainement
Paiements récurrents
Abonnement par cartepaymentMethod[]=SUBSCRIPTION
subscriptionModel[subscriptionModelId]
Abonnement par prélèvement SEPApaymentMethod[]=SUBSCRIPTION
subscription[source]=SDD
subscriptionModel[subscriptionModelId]
Paiement fractionné par cartepaymentMethod[]=INSTALLMENT
intallment[intervalUnit]
installment[intervalCount]
installment [iterationCount]
Paiement fractionné par prélèvement SEPApaymentMethod[]=INSTALLMENT
installment[source]=SDD
intallment[intervalUnit]
installment[intervalCount]
installment [iterationCount]

Si vous souhaitez autoriser plusieurs moyens ou modes de paiement dans votre PaymentRequest, vous devez renseigner plusieurs fois l’objet paymentMethod[].

Exemple :
paymentMethod[]=TRANSACTION
paymentMethod[]=SCT_TRANSACTION

Attention, certaines combinaisons de moyens ou modes de paiement peuvent rentrer en conflits et votre PaymentRequest pourra retourner une erreur. Par exemple, vous ne pouvez pas autoriser une TRANSACTION et une SUBSCRIPTION, cependant vous pouvez autoriser une TRANSACTION et un INSTALLMENT.

Voici les informations principales concernant d’autres valeurs à renseigner lors de la création d’une PaymentRequest :

DésignationDéfinition
amountMontant de la demande de paiement en centimes
merchantPaymentRequestIdRéférence personnalisée (votre numéro de commande ou facture par exemple) que vous pourrez utiliser pour rapprocher le paiement. Cette valeur sera visible par votre client dans la page de paiement.
descriptionDescription personnalisée (nom du produit ou du service vendu). Cette valeur sera visible par votre client dans la page de paiement.
additionalData[*]Donnée clé-valeur libre, vous permettant de transiter une ou plusieurs données (références de factures, numéro client etc…). N’est pas visible par votre client dans la page de paiement.
createCustomerCréation TRUE / FALSE d’un compte Customer (permet notamment l’enregistrement du moyen de paiement client : carte, mandat SEPA, et création d’un IBAN virtuel dédié au Customer)
breakdown[customerId]Sélection d’un Customer déjà existant

NOTE : pour les transactions par virement SEPA, vous pouvez définir si vous souhaitez afficher l’IBAN Virtuel dédié au Customer ou générer un IBAN Virtuel à usage unique (SCT) depuis les paramètres de vos Points de Vente.

2.2/ Envoyer une PaymentRequest par email / sms

Lors de sa création, vous pouvez demander à CentralPay d’adresser la demande de paiement à votre client. Il existe deux méthodes d’envoi :

  • Via le mailer par défaut des PaymentRequest : CentralPay adresse la demande de paiement depuis un modèle d’email/sms standardisé et depuis l’email expéditeur renseigné dans votre point de vente (ou à défaut l’email expéditeur de CentralPay « no-reply@centralpay.eu »).
    • Pour cela vous devez [à compléter]
  • Via le service de notification email/sms de CentralPay : CentralPay adresse la demande de paiement selon le scénario et les modèles de communication que vous avez paramétrés. Ce service permet notamment l’automatisation de relances clients, basés sur les paramètres de la demande de paiement (délais de paiement, avancement du paiement…).
    • Pour cela vous devez [à compléter]

2.3/ Fonctions spécifiques

Demande de paiement à montant libre (multi-moyens de paiements)

Il est possible d’autoriser la modification du montant à régler (avec pour maximum le montant initial), afin que vos payeurs puissent régler la somme due depuis plusieurs moyens de paiements ou à des moments différents.

Par exemple sur une demande de paiement de 500€ :

  • Régler 250€ en virement puis 250€ en carte
  • Ou 300€ avec une première carte puis 200€ avec une autre.
  • Ou régler 350€ avec une carte, puis revenir plus tard pour régler les 150€ restants avec cette même carte.

Pour ce faire vous devez [à compléter]

Envoyer une demande de paiement à plusieurs destinataires

Il est possible d’adresser une demande de paiement à plusieurs destinataires avec un montant différent à régler pour chacun d’entre eux. Ainsi :

  • Chaque participant reçoit une notification e-mail ou SMS détaillant l’objet du service à régler
  • Les montants sont fixés par l’initiateur ou laissé libre à chaque participant qui règle le montant souhaité
  • Les dates paramétrées à la demande (création, expiration…) permettent de générer des notifications vers chaque participant

Pour ce faire vous devez [à compléter]

3/ Création depuis le Portail utilisateur

3.1/ Création et types de demandes de paiement

  • Accès Demandes de paiement – Portail utilisateur de recette
  • Accès Demandes de paiement – Portail utilisateur de production

Vous pouvez créer une demande de paiement depuis le Portail utilisateur > Demandes de paiement > Liens de paiement > Créer. Les demandes de paiement créées depuis le Portail utilisateur sont obligatoirement adressées à vos clients par CentralPay. En fonction de vos besoins, vous devrez choisir l’un des types de demandes suivant :

  • Demande instantanée : une demande simple, envoyée depuis les expéditeurs et les templates emails / sms standards de CentralPay.
  • Demande programmée : une demande avancée, utilisant les modèles de communication, scénarios et règles d’envoi/de relance que vous aurez préalablement paramétrés depuis le service de notifications email/sms de CentralPay. Une demande programmée adressée sans avoir sélectionné de scénario de notification sera automatiquement requalifiée en demande instantanée.

Une fois créée, vous pouvez accéder à la page de paiement en cliquant sur le détail de la demande de paiement > Formulaire de paiement. Ainsi, vous pourrez retransmettre à votre client l’URL de la page en cas d’erreur d’envoi.

3.2/ Les profils de demandes de paiement

Afin de faciliter la création de demandes de paiement, vous avez la possibilité de créer des profils prédéfinis intégrant les principaux paramétrages de la demande :

  • Point de vente
  • Devise
  • Langue
  • Moyens de paiement autorisés
  • Limite de paiement (délais de paiement contractuel)
  • Expiration du lien (délais avant expiration du lien)
  • Scénarios de notification
  • Reroutage de l’email de confirmation de paiement
  • Règles d’affichage (paramètres de la page de paiement)
  • Création de Customer
  • Pièces jointes

Vous pouvez ensuite utiliser ce profil lors de la création de vos demandes de paiement programmées via le Portail utilisateur, ou via import de fichiers plats.

3.3/ Création de demandes de paiements par import de fichiers plats

Depuis le Portail utilisateur > Demandes de paiement > Liens de paiement > Importer, vous pouvez déposer un fichier d’importation de demandes de paiement. Cette utilisation peut être recommandée pour les entreprises souhaitant adresser en fin de mois et relancer automatiquement une liste de créanciers.

Vous pouvez télécharger le modèle de fichier ci-après :

  • Modèle au format CSV
  • Modèle au format JSON

Quelques informations importantes :

DésginationDéfinition
profil_uuid*UUID du profil de demande de paiement
merchant_payment_request_idRéférence personnalisée (votre numéro de commande ou facture par exemple) que vous pourrez utiliser pour rapprocher le paiement. Cette valeur sera visible par le payeur dans la page de paiement.
descriptionDescription personnalisée (nom du produit ou du service vendu). Cette valeur sera visible par votre client dans la page de paiement.
total_amount*Montant de la demande de paiement. À renseigner en doubles décimales avec un séparateur « . » (ex : 500.00 pour 500€).
last_nameNom de famille
first_namePrénom
email*Email du destinataire
phoneTéléphone du destinataire au format international (ex : 33612345678).
create_customerCréation d’un profil client « Customer » : renseigner « O » pour OUI ou « N » pour NON
link_expiration_dateDate d’expiration de la demande de paiement (date à laquelle le client ne pourra plus vous régler)
deadlineDate limite de paiement (date à laquelle votre client doit vous avoir réglé, et à partir de laquelle il est en retard de paiement).
receipt_emailEmail sur lequel vous souhaitez rerouter l’email de confirmation de paiement
language*Langue de la communication et de la page de paiement (FRE pour français, ENG pour anglais…)
Les champs avec un * sont obligatoires.
Liens de paiement -Précédent Informations générales Prochain- Liens de paiement Page de paiement (SmartForm)
CONTENU

Doc Contents

Doc Footnotes

Doc Elements

  • Mentions légales
  • Politique de confidentialité

© 2024 CentralPay