Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédente | ||
tutoriel:payplug:start [2020/10/25 14:02] – admin | tutoriel:payplug:start [2022/08/13 21:54] (Version actuelle) – modification externe 127.0.0.1 | ||
---|---|---|---|
Ligne 3: | Ligne 3: | ||
====== Guide rapide API PayPlug [PHP] ====== | ====== Guide rapide API PayPlug [PHP] ====== | ||
- | ====== Pré-requis | + | <WRAP center round important 60%> |
+ | PayPlug est désormais payant par abonnement | ||
+ | </ | ||
+ | |||
+ | ===== Pré-requis ===== | ||
* Installez la librairie : | * Installez la librairie : | ||
Ligne 12: | Ligne 16: | ||
\Payplug\Payplug:: | \Payplug\Payplug:: | ||
- | ====== Créer un paiement | + | ===== Créer un paiement ===== |
- | ===== Fonctionnement de la création d’un paiement | + | ==== Fonctionnement de la création d’un paiement ==== |
- | {{ :tutoriel: | + | {{ tutoriel: |
- Créez le paiement et récupérez l’URL vers la page de paiement, | - Créez le paiement et récupérez l’URL vers la page de paiement, | ||
Ligne 23: | Ligne 27: | ||
- PayPlug vous envoie une confirmation au travers de la notification (IPN). | - PayPlug vous envoie une confirmation au travers de la notification (IPN). | ||
- | ===== Le paiement | + | ==== Le paiement ==== |
L’exemple suivant permet de créer le paiement puis de rediriger directement votre client vers la page de paiement : | L’exemple suivant permet de créer le paiement puis de rediriger directement votre client vers la page de paiement : | ||
Ligne 56: | Ligne 60: | ||
Attention :tous les montants doivent être des entiers positifs en centimes (1€ = 100 centimes). | Attention :tous les montants doivent être des entiers positifs en centimes (1€ = 100 centimes). | ||
- | ===== La confirmation | + | ==== La confirmation ==== |
- | ==== Option 1 : Les notifications (IPN) : ==== | + | === Option 1 : Les notifications (IPN) : === |
Lors de la création du paiement, vous pouvez spécifier une URL de notification (IPN) : notification_url. Si la transaction est payée ou en échec, une requête POST contenant l’objet correspondant au paiement sera envoyée à votre serveur. | Lors de la création du paiement, vous pouvez spécifier une URL de notification (IPN) : notification_url. Si la transaction est payée ou en échec, une requête POST contenant l’objet correspondant au paiement sera envoyée à votre serveur. | ||
Ligne 84: | Ligne 88: | ||
L'URL de notification doit être accessible publiquement depuis Internet. Elle ne pourra pas fonctionner si vous êtes en local ou si la page est derrière un firewall ou un proxy. | L'URL de notification doit être accessible publiquement depuis Internet. Elle ne pourra pas fonctionner si vous êtes en local ou si la page est derrière un firewall ou un proxy. | ||
- | ==== Option 2 : Récupérer le détail d’un paiement | + | === Option 2 : Récupérer le détail d’un paiement === |
Si vous ne souhaitez pas utiliser les notifications (IPN), vous pouvez utiliser l’approche suivante : | Si vous ne souhaitez pas utiliser les notifications (IPN), vous pouvez utiliser l’approche suivante : | ||
- | {{ :tutoriel: | + | {{ tutoriel: |
Les étapes 1 à 3 sont identiques à celles décrites dans le premier schéma Dans l’étape 4, faites un appel vers l’API utilisant l’ID du paiement récupéré lors de sa création : | Les étapes 1 à 3 sont identiques à celles décrites dans le premier schéma Dans l’étape 4, faites un appel vers l’API utilisant l’ID du paiement récupéré lors de sa création : | ||
Ligne 97: | Ligne 101: | ||
</ | </ | ||
- | ===== Gérez les metadatas | + | ==== Gérez les metadatas ==== |
Les metadatas permettent d’ajouter des informations complémentaires lors de la création d’un paiement ou d’un remboursement. | Les metadatas permettent d’ajouter des informations complémentaires lors de la création d’un paiement ou d’un remboursement. | ||
Ligne 114: | Ligne 118: | ||
Vous pouvez ajouter 10 clés. Leur nom ne doit pas dépasser les 20 caractères et les données stockées 500 caractères. | Vous pouvez ajouter 10 clés. Leur nom ne doit pas dépasser les 20 caractères et les données stockées 500 caractères. | ||
- | ====== Créer un remboursement | + | ===== Créer un remboursement ===== |
- | ===== Fonctionnement de la création d’un remboursement | + | ==== Fonctionnement de la création d’un remboursement ==== |
- | {{ :tutoriel: | + | {{ tutoriel: |
- Créez le remboursement en utilisant l’ID du paiement à rembourser, | - Créez le remboursement en utilisant l’ID du paiement à rembourser, | ||
- PayPlug vous envoie une confirmation au travers de la notification (IPN). | - PayPlug vous envoie une confirmation au travers de la notification (IPN). | ||
- | ===== Le remboursement | + | ==== Le remboursement ==== |
- | ==== Option 1 : le remboursement complet | + | === Option 1 : le remboursement complet === |
Pour créer un remboursement, | Pour créer un remboursement, | ||
Ligne 137: | Ligne 141: | ||
</ | </ | ||
- | ==== Option 2 : le remboursement partiel | + | === Option 2 : le remboursement partiel === |
Si vous souhaitez ne pas rembourser l’intégralité de la transaction, | Si vous souhaitez ne pas rembourser l’intégralité de la transaction, | ||
Ligne 156: | Ligne 160: | ||
L’exemple ci-dessus comprend des metadata afin de faciliter le suivi du remboursement. | L’exemple ci-dessus comprend des metadata afin de faciliter le suivi du remboursement. | ||
- | ===== La confirmation | + | ==== La confirmation ==== |
- | ==== Option 1 : Les notifications (IPN) ==== | + | === Option 1 : Les notifications (IPN) === |
Si lors de la création du paiement vous pouvez spécifier une URL de notification (IPN), lors de la création du remboursement une requête POST contenant l’objet correspondant au remboursement sera envoyée à votre serveur sur cette URL. | Si lors de la création du paiement vous pouvez spécifier une URL de notification (IPN), lors de la création du remboursement une requête POST contenant l’objet correspondant au remboursement sera envoyée à votre serveur sur cette URL. | ||
Ligne 183: | Ligne 187: | ||
L’URL de notification doit être accessible publiquement depuis Internet. Elle ne pourra pas fonctionner si vous êtes en local ou si la page est derrière un firewall ou un proxy. | L’URL de notification doit être accessible publiquement depuis Internet. Elle ne pourra pas fonctionner si vous êtes en local ou si la page est derrière un firewall ou un proxy. | ||
- | ==== Option 2 : Récupérer le détail d’un paiement | + | === Option 2 : Récupérer le détail d’un paiement === |
Si vous ne souhaitez pas utiliser les notifications (IPN), vous pouvez utiliser l’approche suivante : | Si vous ne souhaitez pas utiliser les notifications (IPN), vous pouvez utiliser l’approche suivante : | ||
- | {{ :tutoriel: | + | {{ tutoriel: |
L’étape 1 est identique à celle décrite dans le premier schéma. Dans l’étape 2, faites un appel vers l’API utilisant l’ID du paiement et l’ID du remboursement : | L’étape 1 est identique à celle décrite dans le premier schéma. Dans l’étape 2, faites un appel vers l’API utilisant l’ID du paiement et l’ID du remboursement : | ||
Ligne 198: | Ligne 202: | ||
</ | </ | ||
- | ==== Gérez les metadatas | + | === Gérez les metadatas === |
Les metadatas permettent d’ajouter des informations complémentaires lors de la création d’un paiement ou d’un remboursement. | Les metadatas permettent d’ajouter des informations complémentaires lors de la création d’un paiement ou d’un remboursement. | ||
Ligne 215: | Ligne 219: | ||
Vous pouvez ajouter 10 clés. Leur nom ne doit pas dépasser les 20 caractères et les données stockées 500 caractères. | Vous pouvez ajouter 10 clés. Leur nom ne doit pas dépasser les 20 caractères et les données stockées 500 caractères. | ||
- | ====== Utiliser la prise d' | + | ===== Utiliser la prise d' |
- | ===== Fonctionnement de la prise d’empreinte | + | ==== Fonctionnement de la prise d’empreinte ==== |
- | {{ :tutoriel: | + | {{ tutoriel: |
- Créez le paiement en utilisant save_card = true et récupérez l’URL vers la page de paiement, | - Créez le paiement en utilisant save_card = true et récupérez l’URL vers la page de paiement, | ||
Ligne 226: | Ligne 230: | ||
- PayPlug vous envoie une confirmation contenant l’empreinte de la carte au travers de la notification (IPN). | - PayPlug vous envoie une confirmation contenant l’empreinte de la carte au travers de la notification (IPN). | ||
- | ===== Le paiement et la prise d’empreinte | + | ==== Le paiement et la prise d’empreinte ==== |
L’exemple suivant permet de créer le paiement qui va permettre de procéder à la prise d’empreinte puis de rediriger directement votre client vers la page de paiement : | L’exemple suivant permet de créer le paiement qui va permettre de procéder à la prise d’empreinte puis de rediriger directement votre client vers la page de paiement : | ||
Ligne 256: | Ligne 260: | ||
Tous les montants doivent être des entiers positifs en centime (1€ = 100 centimes). | Tous les montants doivent être des entiers positifs en centime (1€ = 100 centimes). | ||
- | ===== La confirmation | + | ==== La confirmation ==== |
Lors de la création du paiement, vous pouvez spécifier une URL de notification (IPN) : notification_url. Si la transaction est payée ou en échec, une requête POST contenant l’objet correspondant au paiement sera envoyée à votre serveur. | Lors de la création du paiement, vous pouvez spécifier une URL de notification (IPN) : notification_url. Si la transaction est payée ou en échec, une requête POST contenant l’objet correspondant au paiement sera envoyée à votre serveur. | ||
Ligne 286: | Ligne 290: | ||
Dans l’objet contenu dans la notification (IPN) vous pouvez maintenant récupérer l’id de la carte, c’est ce dernier que vous devrez utiliser pour les prochains paiements. Nous vous recommandons de récupérer également la date d’expiration de la carte afin de prévoir de contrôler la validité de la carte avant de créer la prochaine transaction. | Dans l’objet contenu dans la notification (IPN) vous pouvez maintenant récupérer l’id de la carte, c’est ce dernier que vous devrez utiliser pour les prochains paiements. Nous vous recommandons de récupérer également la date d’expiration de la carte afin de prévoir de contrôler la validité de la carte avant de créer la prochaine transaction. | ||
- | ===== Le paiement avec un ID de carte ===== | + | ==== Le paiement avec un ID de carte ==== |
- | {{ :tutoriel: | + | {{ tutoriel: |
- Créez le paiement en utilisant payment_method et l'ID de la carte prélablement enregistrée, | - Créez le paiement en utilisant payment_method et l'ID de la carte prélablement enregistrée, | ||
- PayPlug vous envoie une confirmation au travers de la notification (IPN). | - PayPlug vous envoie une confirmation au travers de la notification (IPN). | ||
- | ===== Créez un paiement avec l’ID d’une carte ===== | + | ==== Créez un paiement avec l’ID d’une carte ==== |
Maintenant que vous disposez de HD d’une carte, vous pouvez la débiter à nouveau sans avoir besoin de refaire passer votre client par une page de paiement : | Maintenant que vous disposez de HD d’une carte, vous pouvez la débiter à nouveau sans avoir besoin de refaire passer votre client par une page de paiement : | ||
Ligne 319: | Ligne 323: | ||
Suite au paiement votre client recevra une confirmation par e-mail. | Suite au paiement votre client recevra une confirmation par e-mail. | ||
- | ===== Les usages | + | ==== Les usages ==== |
La prise d’empreinte d’une carte permet de mettre en place les usages suivants : | La prise d’empreinte d’une carte permet de mettre en place les usages suivants : | ||
- | ==== Paiement en 1 clic ==== | + | === Paiement en 1 clic === |
Permettez à vos acheteurs de payer sans avoir besoin de saisir à chaque fois ses coordonnées bancaires. | Permettez à vos acheteurs de payer sans avoir besoin de saisir à chaque fois ses coordonnées bancaires. | ||
- | ==== Paiement récurrent | + | === Paiement récurrent === |
Proposez la possibilité de souscrire à des abonnements récurrents sur votre site web. | Proposez la possibilité de souscrire à des abonnements récurrents sur votre site web. | ||
- | ==== Paiement en plusieurs fois ==== | + | === Paiement en plusieurs fois === |
Offrez à vos clients de payer un montant en 3 ou 4 règlements sans frais (moins de 90 jours). | Offrez à vos clients de payer un montant en 3 ou 4 règlements sans frais (moins de 90 jours). | ||
Ligne 337: | Ligne 341: | ||
Pour le paiement récurrent et le paiement en plusieurs fois, vous devrez gérer les échéanciers au niveau de votre service | Pour le paiement récurrent et le paiement en plusieurs fois, vous devrez gérer les échéanciers au niveau de votre service | ||
- | ====== Conclusion | + | ===== Conclusion ===== |
- | ====== Problèmes connus | + | ===== Problèmes connus ===== |
- | ====== Voir aussi ====== | + | ===== Voir aussi ===== |
* **(fr)** [[http:// | * **(fr)** [[http:// |