L’API Paiements Paysafe prend en charge le virement Interac en tant qu’instrument de paiement. Le virement Interac est un service de transfert de fonds entre institutions personnelles et commerciales qui permet aux marchands de percevoir des fonds auprès des consommateurs canadiens pour payer des marchandises.

Le virement Interac prend en charge les deux transactions suivantes :

• Paiements

  Sert à transférer de l’argent du compte bancaire du client vers le compte du marchand. Après un paiement réussi, le marchand crédite le portefeuille du client. Un flux interac de demande d’argent est mis en place pour permettre aux clients de déposer de l’argent. Le marchand sera le demandeur d’argent, et le client sera l’approbateur.

• Retrait

  Sert à transférer de l’argent du compte du client vers le compte bancaire du marchand. Le flux d’envoi d’argent Interac est mis en œuvre pour permettre aux clients de retirer de l’argent.

Lors du traitement d’une requête de paiement en argent Interac, procédez comme suit :

1. Créez un "payment handle" avec le paramètre transactionType défini sur PAYMENT et le paramètre paymentType défini sur INTERAC_ETRANSFER
   • Post : paymenthub/v1/paymenthandles
2. Comme le client doit effectuer le paiement en sélectionnant le compte bancaire sur la page Interac, Paysafe renvoie la réponse suivante :
   • Le paramètre action est défini sur REDIRECT
   • Un lien redirect_payment renvoie à l’URL de redirection Interac.
3. Redirigez le client vers l’URL de redirection Interac.
   • Lorsque le client est redirigé vers le lien de redirection, l’état du "payment handle" devient PAYABLE et vous serez informé par un webhook de l’événement PAYMENT_HANDLE_PAYABLE.
   • Sur la page de redirection, le client sélectionne la banque, fournit ses authentifiants et accepte la requête de virement d’argent.
4. Utilisez le jeton paymentHandleToken pour traiter la requête de paiement via l’API Paiements à l’aide de la clé privée. Vous devez lancer une requête POST vers le point de terminaison :
   • Post : paymenthub/v1/payments
5. Une fois que le marchand a traité le paiement via l’API Paiements, le paiement est indiqué comme étant PENDING. Lorsque le client effectue le paiement dans le délai imparti, le marchand reçoit l’événement SETTLEMENT COMPLETED/ PAYMENT COMPLETED (comme il s’agit de settlewithauth= true, nous pouvons supposer que les deux sont identiques). Vous pouvez créditer l’argent de manière sécurisée sur le compte du client/expédier les marchandises une fois que vous avez reçu ces événements.

Pour traiter une requête de paiement Interac, procédez comme suit :

1. Créez un "payment handle" dont la mode est SEND_MONEY, le type de transaction est PAYMENT, le type de paiement est INTERAC_ETRANSFER et le délai d’expiration de la transaction est fixé à la durée pendant laquelle le marchand souhaite que la transaction soit ouverte (le minimum est de 120).

   • Post: paymenthub/v1/paymenthandles

2. Comme le client a besoin d’instructions sur la manière d’effectuer le paiement, Paysafe renvoie une réponse contenant ce qui suit :

   • Le paramètre d’action est défini sur PAYABLE

   • Une référence de paiement unique est renvoyée

3. Affichez les instructions de paiement sur votre page hébergée, y compris le nom et l’adresse électronique du marchand, le montant et la note reflétant la valeur de la référence de paiement.

   • Lorsque vous redirigez un client vers un lien de redirection, l’état du "payment handle" passe à PAYABLE, et vous en serez informé par le biais d’un webhook pour l’événement PAYMENT_HANDLE_PAYABLE.

   • Sur la page de redirection, le client choisit sa banque, entre ses authentifiants et accepte la requête de virement d’argent.

4. Traitez la requête de paiement via l’API Paiements en utilisant le paymentHandleToken fourni dans la réponse et la clé privée. Une requête POST doit être envoyée au point de terminaison :

   • Post: paymenthub/v1/payments

5. Une fois que le marchand a traité le paiement à l’aide de l’API Paiements, l’état du paiement devient PENDING. Le marchand reçoit un événement SETTLEMENT_COMPLETED/PAYMENT_COMPLETED lorsque le client effectue le paiement dans le délai imparti. Comme settlewithauth=true, nous pouvons supposer que les deux sont identiques. Vous pouvez expédier les marchandises ou créditer le compte du client de manière sécurisée une fois que vous avez reçu ces événements.

Pour traiter une requête de retrait Interac, procédez comme suit :

1. Demandez au client l’identifiant d’adresse courriel pour initier un retrait.

2. Vérifiez si l’adresse courriel est enregistrée pour le dépôt automatique. Vous pouvez utiliser l’API Vérification pour faire la même chose. Vous recevez l’état de dépôt automatique et le montant maximum transférable en réponse.

3. En fonction de l’état de l’enregistrement du dépôt automatique, les étapes mentionnées ci-dessous doivent être mises en œuvre.

Inscription au flux de dépôt automatique

1. Créez un "payment handle" avec le paramètre transactionType défini sur STANDALONE_CREDIT et le paramètre paymentType défini sur INTERAC_ETRANSFER

2. Ce "payment handle" doit immédiatement avoir l’état PAYABLE.

3. Utilisez le paymentHandleToken renvoyé dans la réponse pour traiter la requête de retrait via l’API Crédit autonome à l’aide de la clé privée. Vous devez lancer une requête POST vers le point de terminaison :

   • Post: /paymenthub/v1/standalonecredits
4. Une fois la requête de retrait complétée avec succès, l’état du retrait (CREDIT STANDALONE_CREDIT) passe à PROCESSING. Les fonds sont transférés sur le compte du client et l’état passe alors à COMPLETED.

Sans inscription au flux de dépôt automatique

1. Pour les retraits sans dépôt automatique, vous devez transmettre la question de sécurité et la réponse à l’API. Vous pouvez le faire soit en demandant au client de transmettre la question et la réponse, soit en préconfigurant la question et la réponse (et en les partageant avec le client).
2. Créez un "payment handle" avec le paramètre transactionType défini sur STANDALONE_CREDIT, le paramètre paymentType défini sur INTERAC_ETRANSFER et transmettez l’ensemble de questions & réponse dans l’API.
3. Ce "payment handle" doit immédiatement avoir l’état PAYABLE.
4. Utilisez le paymentHandleToken renvoyé dans la réponse pour traiter la requête de retrait via l’API Crédit autonome à l’aide de la clé privée. Vous devez lancer une requête POST vers le point de terminaison :
   • Post: /paymenthub/v1/standalonecredits
5. Le client recevra le lien par courriel et devra répondre à la question sur la page Interac/banque.
6. Vous recevrez un webhook pour l’événement "SA_CREDIT_COMPLETED" et une fois que les fonds crédités sur le compte du client.

Paiements

Exemple de requête de "payment handle"

Vous devez transmettre l’objet virement Interac dans la requête de "payment handle" :

Pour en savoir plus sur chaque paramètre, vous pouvez consulter la rubrique Paiements.

Exemple de requête de "payment handle"

Pour en savoir plus sur chaque paramètre, vous pouvez consulter la rubrique "Payment Handles".

Dépôt non automatique

Exemple de requête de "payment handle"

Pour en savoir plus sur chaque paramètre, vous pouvez consulter la rubrique "Payment Handles".

Pour en savoir plus sur chaque paramètre, vous pouvez consulter la rubrique Crédits autonomes.

"Payment Handle"

Un "payment handle" représente des informations segmentées sur le mode de paiement que vous avez défini pour votre client. Une fois le "payment handle" créé, vous pouvez inclure le paymentHandleToken renvoyé dans la réponse à la requête de "payment handle" dans une nouvelle requête de paiement.

Flux de paiement :

1. Créer une requête API Paiements.
2. Dans la réponse de l’API Paiements, vous verrez un lien de redirection et paymentHandleToken.
   • Un "payment handle" peut être utilisé dans une requête de paiement seulement si l’état est PAYABLE.
   • PaymentHandleToken expire dans 899 secondes
3. Redirigez l’utilisateur vers le lien de redirection, fourni dans la réponse à la requête de paiement.
   • Vous recevrez un webhook avec l’état paymentHandleToken "PAYABLE".
4. Attendez 10 minutes et laissez l’utilisateur effectuer la transaction sur la page Interac.

   Interac ne redirige pas le client vers la page du marchand une fois qu’il a effectué le paiement. Il est donc conseillé d’afficher un message au client lors de la redirection vers la page Interac. Vous pouvez afficher un message « Veuillez fermer l’onglet et revenir sur cette page après avoir effectué le paiement ». En outre, vous pouvez avoir des récepteurs sur la fermeture des onglets (sur la page Interac de redirection), et une fois que l’événement de fermeture d’onglet est reçu, vous pouvez effectuer un appel API GET pour confirmer l’état.

   • Pour savoir ce que l’utilisateur a fait sur la page Interac (fermeture, annulation ou achèvement de la transaction), vous pouvez effectuer un appel API GET.
5. L’appel à l’API POST "/payments" n’est possible que si l’état du paymentHandleToken est "PAYABLE".
   • Le client a terminé la transaction :
     • Si Interac a averti Paysafe, vous recevrez l’état COMPLETED en réponse de même que le webhook PAYMENT_COMPLETED.
     • Si Interac n’a pas informé Paysafe, vous recevrez l’état "PROCESSING" en réponse.

        

       • Interac prend au maximum 30 minutes pour informer Paysafe après que l’utilisateur a effectué la transaction sur la page de la banque.

       • Une fois l’appel API POST "/payments" effectué, l’état de paymentHandleToken passe de "PAYABLE" à "COMPLETED".

   • Le client a refusé ou n’a pas terminé la transaction :

     Si le marchand n’effectue pas d’appel /payments dans les 899 secondes pour obtenir un paymentHandleToken :

     • Le client a effectué la transaction via la page de la banque, Paysafe effectue le paiement pour le compte du marchand. et ce dernier reçoit a) PAYMENT_COMPLETED ou b) PAYMENT_PROCESSING suivi de PAYMENT_COMPLETED.

     • Le client a refusé la transaction ou ne l’a pas terminée, la transaction échoue, et vous recevrez l’événement PAYMENT_HANDLE_FAILED.

     • Le traitement de votre "payment handle" devient Completed et l’état du paiement est Processing.

     • Deux jours plus tard, nous marquerons l’échec de la transaction et vous recevrez la notification "PAYMENT_FAILED".

Flux de retrait

Le flux de retrait peut être mis en œuvre de deux manières :

• API Vérification + API Crédit autonome
  • Ce modèle vous permet de connaître la limite de retrait maximale et de savoir si l’utilisateur s’est enregistré pour le dépôt automatique ou non, ce qui vous permet de décider de l’expérience utilisateur.

• API Crédit autonome

API Vérification

1. Créez une requête API Paiements avec le paramètre transactionType défini sur VERIFICATION et le paramètre paymentType défini sur INTERAC_ETRANSFER.
2. Ce "payment handle" doit immédiatement avoir l’état PAYABLE.
3. Effectuez un appel API POST "/verifications" avec paymentHandleToken "PAYABLE".
   • Vous recevrez l’état du dépôt automatique et la limite maximale.

API Crédit autonome

1. Créez une requête API "Payment Handle" avec le paramètre transactionType défini sur STANDALONE_CREDIT et le paramètre paymentType défini sur INTERAC_ETRANSFER.

2. L’état de ce "payment handle" sera soit PAYABLE ou FAILED.
3. L’appel à l’API POST "/standalonecredits" n’est possible que si paymentHandleToken est "PAYABLE".
   • Dans le flux de dépôt automatique, l’argent est directement crédité sur le compte de l’utilisateur. Vous recevrez SA_CREDIT_PROCESSING immédiatement et SA_CREDIT_COMPLETED à T+1.
   • S’il s’agit d’un flux sans dépôt automatique, vous recevrez l’état "PROCESSING".
     • Une fois que le client a terminé la transaction dans les 30 jours, vous recevrez le webhook SA_CREDIT_COMPLETED.
   • PaymentHandleToken expire dans 899 secondes
   • Si le marchand n’envoie pas l’appel /standalonecredits dans les 899 secondes pour un paymentHandleToken, le paymentHandleToken expirera et vous recevrez un webhook PAYMENT_HANDLE_EXPIRED.

Webhooks

• PAYMENT_HANDLE_PAYABLE : à la réception de ce webhook, le marchand doit lancer l’appel paymenthub/v1/payments.
• PAYMENT_COMPLETED/SETTLEMENT_COMPLETED : le paiement a été effectué avec succès.
• PAYMENT_PROCESSING : le paiement est en cours. Dans certains cas, il peut s’agir d’attendre une action du client ou du marchand.
• Et les webhooks facultatifs ci-dessous
  • PAYMENT_HANDLE_EXPIRED : ce webhook est envoyé lorsque le client n’a pas effectué le paiement sur la page de la banque dans le délai TTL du jeton paymentHandle. Le marchand peut donc clore la transaction comme n’ayant pas été effectuée.
  • PAYMENT_HANDLE_COMPLETED : le jeton de "payment handle" est utilisé avant l’expiration.
  • PAYMENT_FAILED : le paiement a échoué et le PSP en aval a renvoyé une erreur (état http 402).
  • PAYMENT_ERRORED : le paiement comporte une erreur (erreur non liée à un état http 402).
  • SETTLEMENT_FAILED : à utiliser pour savoir quand l’état du règlement devient FAILED.
  • SETTLEMENT_FAILED : à utiliser pour savoir quand l’état du règlement devient ERRORED.