office
Pour rechercher dans la page utiliser Ctrl+F sur votre clavier
Les pages de paiements sont hébergées chez le commerçant. Cela permet une grande liberté de personnalisation. Ce connecteur permet également d’effectuer des opérations de gestion de caisse en mode machine to machine.
Méthodes
-
Notification de mise à jour Scheme TokenNotification de mise à jour Scheme Token, contient les informations à jour concernant le Scheme Token et la carte associée.
-
acceptChallengeCette fonction vous permet d’accepter le risque de fraude sur des transactions ayant un score de fraude orange. Une fois la transaction acceptée, elle reprend son cycle de vie normal.
interfaceVersion recommandée : CR_WS_2.58
-
addCardCette opération permet d’ajouter une carte à un wallet. Ce dernier est créé en même temps que l’ajout de la carte, s’il n’existe pas.
Les informations sensibles (numéro de carte) peuvent être gérées via le champ panType, chiffrement par l’utilisation du mode CSE (voir la documentation concernée).
Si la carte est déjà enregistrée dans le wallet, un code de réponse 94 est retourné.
Si la création a réussi, un code de réponse 00 est retourné ainsi que de nombreuses informations sur le compte et la carte associée
- identifiant wallet
- date de création
- identifiant externe du moyen de paiement créé pour le wallet
- numéro de carte partiellement masqué (seuls les 4 premiers chiffres et 2 derniers sont affichés).
interfaceVersion recommandée : WR_WS_2.58
-
addDirectDebitCette opération permet d’ajouter un mandat au wallet. Si le mandat est déjà enregistré dans le wallet, un code de réponse 94 est retourné.
Si la création a réussi, un code de réponse 00 est retourné, ainsi que de nombreuses informations sur le compte et le mandat associé
- date de création
- identifiant externe du moyen de paiement créé pour le wallet
- numéro international de compte bancaire (IBAN) partiellement masqué (seuls les 4 premiers chiffres et 2 derniers sont affichés).
interfaceVersion recommandée : WR_WS_2.58
-
addToFraudListCette opération permet d’ajouter un numéro de carte, de token ou de transaction (via le couple transactionIid/transactionDate ou transactionReference) à différents types de liste fraude.
interfaceVersion recommandée : FR_WS_2.58
-
cancelCette fonction permet d’annuler une transaction avant l’envoi en banque ou de modifier son montant. Une opération d’annulation ne peut pas être annulée et on ne peut pas annuler un montant supérieur au montant d’origine de la transaction.
interfaceVersion recommandée : CR_WS_2.58
-
cardCheckEnrollmentCette opération permet d’initialiser un paiement par carte avec processus 3-D Secure.
Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey).
Cette requête initialise une transaction sur la plateforme “Worldline Sips et contrôle l’inscription de la carte. Si la carte est inscrite à 3-D Secure, vous recevez comme réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre son authentification. Cette redirection doit être réalisée par le biais d’un formulaire POST, voir la partie “Formulaire POST vers l’ACS”. Dans le cas contraire, vous avez la possibilité de poursuivre le paiement sans effectuer de redirection en appelant directement la méthode cardValidateAuthenticationAndOrder.” Les informations sensibles (numéro de carte, cryptogramme visuel) peuvent être gérées selon trois possibilités, via le champ panType
- chiffrement par l’utilisation du mode CSE ;
- tokenisation du numéro de carte ;
- numéro de carte en clair (forte contrainte PCI).
interfaceVersion recommandée : IR_WS_2.58
-
cardOrderCette fonction vous permet d’effectuer un paiement carte avec les informations bancaires d’un client.
Les informations sensibles (numéro de carte, cryptogramme visuel) peuvent être gérées selon trois possibilités, via le champ panType :
- chiffrement par l’utilisation du mode CSE (voir la documentation concernée) ;
- tokenisation du numéro de carte ;
- numéro de carte en clair (forte contrainte PCI).
interfaceVersion recommandée : IR_WS_2.58
-
cardValidateAuthenticationRequêtes de validation d’authentification 3-D Secure :
Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey).
Cette requête est obligatoire pour vérifier l’ensemble de l’authentification 3-D Secure (avec un message PARes). Elle doit être effectuée une fois que vous avez reçu le formulaire POST de l’ACS (Access Control Server) (voir “Envoi du formulaire POST à l’ACS”).
interfaceVersion recommandée : IR_WS_2.58
-
cardValidateAuthenticationAndOrderCette opération permet de finaliser un ordre de paiement avec un processus 3-D Secure.
Sauf mention contraire, toute référence à 3-D Secure dans le présent document inclut Visa (Verified by Visa), MasterCard (SecureCode) et American Express (SafeKey).
Cette requête est obligatoire pour l’exécution d’un ordre de paiement dans un contexte 3-D Secure (message PARes). Elle doit être effectuée une fois que vous avez reçu le formulaire POST de l’ACS (Access Control Server) (voir « Envoi du formulaire POST à l’ACS »).
interfaceVersion recommandée : IR_WS_2.58
-
creditHolderCette fonction vous permet de créditer le compte d’un client sans transaction d’origine référencée. Il est donc nécessaire de détenir les informations du moyen de paiement de votre client ou le token associé.
interfaceVersion recommandée : CR_WS_2.58
-
creditTransferFinalizeAndOrderCette opération est actuellement disponible pour les moyens de paiement iDEAL et Sofortüberweisung.
Cette requête est obligatoire pour connaître le résultat d’un virement bancaire. Elle doit être appelée une fois que vous avez reçu le formulaire POST du service de virement bancaire via merchantReturnUrl (voir requête creditTransferInitialize).
interfaceVersion recommandée : IR_WS_2.58
-
creditTransferInitializeCette opération est actuellement disponible pour les moyens de paiement iDEAL et Sofortüberweisung.
Cette requête initialise une session pour un virement bancaire. Si l’étape d’initialisation a réussi, vous recevez en retour une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre le virement. Cette redirection doit être réalisée par le biais d’un formulaire POST, voir la partie “Formulaire POST vers des fournisseurs externes”.
Dans la requête, vous devez également indiquer l’URL (merchantReturnUrl) vers laquelle le client sera redirigé à la fin du virement bancaire externe. Vous devez ensuite appeler le service creditTransferFinalizeAndOrder afin de finaliser la transaction.
interfaceVersion recommandée : IR_WS_2.58
-
creditTransferInquireCette opération permet de récupérer la liste des banques émettrices disponibles. Actuellement, ce service n’est disponible que pour le moyen de paiement iDEAL.
Cette requête permet d’obtenir une liste des banques émettrices. Si la requête a réussi, vous recevez en retour une liste de banques avec leur nom et leur code. Ces informations doivent être utilisées pour l’étape d’initialisation (creditTransferInitialize).
interfaceVersion recommandée : IR_WS_2.58
-
deletePaymentMeanCette fonction vous permet de supprimer définitivement l’un des moyens de paiement de son wallet.
Si le compte ou la carte n’existe pas, un code de réponse 01 est retourné. Si la suppression a fonctionné, le code de réponse 00 est retourné avec la date de suppression.
interfaceVersion recommandée : WR_WS_2.58
-
directDebitOrderCette fonction vous permet, si vous possédez les informations bancaires d’un client, d’effectuer des paiements de type prélèvement (ex : SDD).
interfaceVersion recommandée : IR_WS_2.58
-
duplicateCette fonction permet de créer une nouvelle transaction à partir des données d’une transaction précédente. À titre d’exemple, si une transaction n’a - par erreur ou omission - pu être validée dans le délai de capture que vous avez renseigné, elle a expiré et ne sera donc pas envoyée en remise en paiement. Vous pouvez alors rattraper cette transaction en la dupliquant.
interfaceVersion recommandée : CR_WS_2.58
-
finalizeMandateCette opération permet de finaliser le processus de signature de mandat et de connnaître le résultat. Elle doit être appelée après que vous ayez reçu le formulaire POST sur l’url merchantReturnUrl (voir les paramètres de la requête initializeMandate).
interfaceVersion recommandée : MR_WS_2.58
-
getCardDataCette opération permet de consulter les informations associées à un numéro ou IIN de carte.
Si le numéro ou l’IIN de la carte n’existe pas, un code de réponse 05 est retourné. Si la requête a réussi, le code de réponse 00 est retourné, ainsi que les informations relatives à la carte.
interfaceVersion recommandée : PMR_WS_2.58
-
getCardMetaDataCette fonction vous permet de récupérer les informations liées à un scheme token à l’aide de la référence de celui-ci.
-
getFraudDataCette opéraiton permet de récupérer des informations relatives au contrôle anti-fraude d’une transaction créée préalablement à l’aide de “Worldline Sips et stockée dans la base de données Worldline Sips.”
interfaceVersion recommandée : DR_WS_2.58
-
getMandateDataCette opération permet d’obtenir des informations concernant un mandat existant. La réponse contient des informations propres au mandat telles que le statut, l’IBAN, etc… mais aussi la liste des transactions « SEPA direct debit » associées aux mandats (s’il y en a).
interfaceVersion recommandée : MR_WS_2.58
-
getPaymentMeanDataCette fonction permet de consulter un wallet et les informations de ses moyens de paiement.
Si le compte ou le moyen de paiement n’existe pas, un code de réponse 01 est retourné. Si la requête a réussi, le code de réponse 00 est retourné, ainsi que les informations relatives au moyen de paiement.
interfaceVersion recommandée : WR_WS_2.58
-
getPdfMandateCette fonction permet de récupérer le PDF d’un mandat existant. Le PDF est sérialisé en Base64. La chaîne de caractères doit être décodée et convertie en fichier PDF pour permettre la lecture ou le téléchargement.
interfaceVersion recommandée : MR_WS_2.58
-
getTransactionDataCette opération permet de récupérer des informations relatives à une transaction créée préalablement à l’aide de Worldline Sips et stockée dans la base de données Worldline Sips.
interfaceVersion recommandée : DR_WS_2.58
-
getVelocityDataCette opération permet de contrôler l’activité d’un champ de données spécifique au cours d’une période déterminée.
interfaceVersion recommandée : FR_WS_2.58
-
getWalletDataCette opération permet de consulter un wallet et les moyens de paiement associés.
Si le compte n’existe pas, un code de réponse 01 est retourné. Si la requête a réussi, le code de réponse 00 est retourné, ainsi que les informations relatives aux moyens de paiement.
interfaceVersion recommandée : WR_WS_2.58
-
hostedFieldsInitializeInitialise une session Hosted Fields.
interfaceVersion recommandée : AUT_WS_2.58
-
initializeMandateCette opération permet d’initialiser un processus de signature de mandat. Si l’étape d’initialisation réussit, vous recevez en réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour continuer le processus de signature. La redirection doit être faite via un formulaire POST, voir la partie “Formulaire POST vers des fournisseurs externes”.
Parmi les paramètres de la requête, vous devez également renseigner l’URL (merchantReturnUrl) vers laquelle le client sera redirigé à la fin du processus de signature du mandat. Vous devez ensuite appeler le service finalizeMandate pour obtenir le résultat du processus de signature.
interfaceVersion recommandée : MR_WS_2.58
-
panToTokenCette opération permet de tokéniser un numéro de carte.
interfaceVersion recommandée : TR_WS_2.58
-
paymentDataProviderCheckCette fonction permet à Worldline Sips de déchiffrer des données issues d’un OEM (ex: GooglePay) et de procéder au paiement.
interfaceVersion recommandée : IR_WS_2.58
-
paymentProviderFinalizeCette opération permet de finaliser un paiement pour les wallets externes.
Une telle requête est obligatoire pour connaître le résultat d’un ordre de paiement effectué par le biais d’un wallet externe. Elle doit être appelée une fois que vous avez reçu le formulaire POST du wallet externe via la merchantReturnUrl (voir requête paymentProviderInitialize).
interfaceVersion recommandée : IR_WS_2.58
-
paymentProviderGetContextCette requête est facultative et vous permet de connaître l’identité et l’adresse de livraison du payeur pour les afficher avant la confirmation de la transaction lors d’une transaction PayPal.
interfaceVersion recommandée : IR_WS_2.58
-
paymentProviderInitializeCette opération permet d’initialiser un paiement pour les wallets externes.
Une telle requête initie une session pour le passage d’ordre de paiement par wallet externe. S’il s’agit d’une transaction non initiée sur mobile et que l’étape d’initialisation a réussi, vous recevez en réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre la procédure de paiement. Cette redirection doit être réalisée par le biais d’un formulaire POST, voir la partie “Formulaire POST vers des fournisseurs externes”. Vous devez également spécifier dans la requête l’URL (merchantReturnUrl) vers laquelle le client sera redirigé à la fin du paiement par wallet externe. Vous devez ensuite appeler le service paymentProviderFinalize afin de finaliser la transaction.
interfaceVersion recommandée : IR_WS_2.58
-
paymentTokenGenerateGénère un token de paiement pour un paiement avec hosted fields.
interfaceVersion recommandée : TR_WS_2.58
-
refundCette opération vous permet de rembourser une transaction en créditant le compte du client et en débitant votre compte.
interfaceVersion recommandée : CR_WS_2.58
-
refuseChallengeCette fonction vous permet de refuser le risque de fraude sur des transactions ayant un score de fraude orange. Une fois le challenge refusé, la transaction est refusée.
interfaceVersion recommandée : CR_WS_2.58
-
removeFromFraudListCette opération permet de supprimer un numéro de carte, de token, de transaction (via le couple transactionIid/transactionDate ou transactionReference) de différents types de liste fraude.
interfaceVersion recommandée : FR_WS_2.58
-
searchMandateCette opération permet de rechercher les mandats existants d’un client. Les mandats sont liés à un client donné seulement si le champ customerId a été fourni dans les paramètres de la requête initializeMandate.
interfaceVersion recommandée : MR_WS_2.58
-
signOffCette opération permet de supprimer un wallet et les moyens de paiements associés. Si le compte n’existe pas, un code de réponse 01 est retourné. Si la suppression a fonctionné, le code de réponse 00 est retourné avec la date de suppression.
interfaceVersion recommandée : WR_WS_2.58
-
tokenToPanCette fonction permet de transformer un token en PAN.
interfaceVersion recommandée : TR_WS_2.58
-
transactionToTokenCette fonction permet de transformer le PAN d’une transaction existante en token.
interfaceVersion recommandée : TR_WS_2.58
-
updateCette fonction permet de mettre à jour une liste de PAN.
-
updatePaymentMeanCette opération vous permet de mettre à jour l’un des moyens de paiement contenu dans le wallet d’un client. Si le compte ou le moyen de paiement n’existe pas, un code de réponse 01 est retourné. Si la mise à jour a fonctionné, le code de réponse 00 est retourné avec la date de la mise à jour.
interfaceVersion recommandée : WR_WS_2.58
-
validateCette fonction permet de déclencher la remise en paiement d’une transaction. Elle vous permet de faire du paiement différé en débitant votre client à l’expédition des produits achetés.
interfaceVersion recommandée : CR_WS_2.58
-
walletCheckEnrollmentCette opération permet d’initialiser un paiement par wallet avec le processus 3-D Secure.
Cette requête initialise une transaction sur la plateforme Worldline Sips et vérifie si la carte récupérée à partir du wallet est inscrite au programme 3-D Secure. Si la carte est inscrite à 3-D Secure, vous recevez comme réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre son authentification. Cette redirection doit être réalisée par le biais d’un formulaire POST, voir la partie “Formulaire POST vers l’ACS”. Dans le cas contraire, vous avez la possibilité de poursuivre le paiement sans effectuer de redirection en appelant directement la méthode cardValidateAuthenticationAndOrder.
interfaceVersion recommandée : IR_WS_2.58
-
walletCreditHolderCette fonction vous permet de créditer vos clients via leur wallet sans transaction préalable.
interfaceVersion recommandée : CR_WS_2.58
-
walletIssuerWalletFinalizeCette opération permet de finaliser un paiement wallet pour les wallets externes.
Une telle requête est obligatoire pour connaître le résultat d’un ordre de paiement wallet effectué par le biais d’un wallet externe. Elle doit être appelée une fois que vous avez reçu le formulaire POST du wallet externe via la merchantReturnUrl (voir requête walletIssuerWalletInitialize).
interfaceVersion recommandée : IR_WS_2.58
-
walletIssuerWalletInitializeCette requête permet d’initialiser un paiement one-click avec un wallet externe :
Une telle requête est obligatoire pour récupérer les données de redirection et l’url vers laquelle rediriger l’acheteur vers les pages d’authentification du wallet externe enrôlé dans un wallet Worldline Sips. Si l’étape d’initialisation a réussi, vous recevez en réponse une URL sécurisée (redirectionUrl) vers laquelle le client doit être redirigé pour poursuivre la procédure de paiement one-click. Cette redirection doit être réalisée par le biais d’un formulaire POST, voir la partie “Formulaire POST vers des fournisseurs externes”. Vous devez également spécifier dans la requête l’URL (merchantReturnUrl) vers laquelle le client sera redirigé à la fin du paiement one-click avec un wallet externe. Vous devez ensuite appeler le service walletIssuerWalletFinalize afin de finaliser la transaction.
interfaceVersion recommandée : IR_WS_2.58
-
walletOrderCette fonction permet de créer un paiement avec une carte enrôlée dans le wallet “Worldline Sips.”
interfaceVersion recommandée : IR_WS_2.58