Dalenys Hosted Fields - Paiement simple par carte bancaire

Implémentation du formulaire de paiement

Principe :

Vous affichez une page de paiement comprenant un formulaire de paiement, sauf que les champs de saisie de carte bancaire sont remplacés par des conteneurs de champs hébergés. Ces conteneurs peuvent être n’importe quelle balise HTML : DIV, P, SPAN… la bibliothèque JavaScript des champs hébergés injecte des iframes hébergés par Dalenys dans ces conteneurs, chacun contenant les champs de saisie de données de la carte.

Lors du processus de soumission, vous devrez appeler la méthode Javascript createToken de la bibliothèque de champs hébergés qui déclenchera la création de jetons des données du titulaire de la carte (numéro de carte, date d’expiration et cryptogramme). Si la création de jetons aboutit, vous devez ajouter le jeton reçu à votre demande de soumission de formulaire dans un champ <input type="hidden" />.

Création du formulaire :

Vous devez posséder un certificat TLS (voir en fin de documentation) pour héberger une page de paiement HTTPS valide, sinon le navigateur de l’utilisateur affichera des alertes de sécurité et le bloquera probablement.
La bibliothèque javascript des champs hébergés doit toujours être appelée en ligne. L’utilisation d’une version téléchargée hébergée sur votre propre serveur peut entraîner de graves dysfonctionnements, notamment dans le cas d’une mise à jour de l’API Dalenys.

1- Inclure les librairies javascript suivantes entre les balises <head>…</head>

<script type="text/javascript" src="https://js.sandbox.be2bill.com/hostedfields/v1/hosted-fields.min.js"/>  
   <script type="text/javascript" src=" https://js.sandbox.be2bill.com/branddetector/v1/brand-selector-widget.min.js "/>

2- Déclarer l’encodage UTF-8 dans les métadonnées <meta charset="UTF-8">

3- Créer un formulaire <form></form> avec trois conteneurs identifiés par un attribut id. Le choix de l’identifiant utilisé est libre mais doit être unique et seront utilisés dans le code javascript présenté dans les points suivants.

A noter que l’exemple ci-dessous est minimaliste et selon le besoin peut être complété :

<form method="post" action="URL">
   <span id="card-container"></span>
   <span id="expiry-container"></span>
   <span id="cvv-container"></span>
   <span id="brand-container"></span>
   <input type="submit" value="Pay">
</form>

L’url à renseigner dans l’attribut action est la suivante :
URL_API/psp/submitcardpayment

4- Configuration des champs hébergés

L’étape suivante consiste à désigner les conteneurs dans lesquels créer les champs hébergés sécurisés, à l’aide de JavaScript. Pour ce faire, initialisez la bibliothèque de champs hébergés avec votre clé API publique et la configuration souhaitée : S-money doit fournir les clés nécessaires au hosted fields.

<script type="text/javascript">
   // Initialize the hosted-fields library
   var hfields = be2bill.hostedFields({
       // Use your Public API Key
       key: {
           id : ‘XXX’
           value : ‘XXX’
       },
       // Link and configure each hosted input field by providing the corresponding container ID
       fields: {
           'card': {
               id: 'card-container',
 //enable the card field format auto spacing
                     enableAutospacing: true
           },
           'expiry': {
               id: 'expiry-container'
           },
           'cryptogram': {
               id: 'cvv-container'
           },
    'brand': {
               id: 'brand-container'
           }

       },
       // Choose the language for error messages
       location: "fr"
   });
</script>

Les identifiants utilisés dans le script pour désigner les champs sont ceux utilisés pour les identifiants des conteneurs créés dans le formulaire. Ceci permettant au script d’injecter les champs hébergés par Dalenys dans ces conteneurs.

5- Charger la bibliothèque des champs hébergés

<script type="text/javascript">    
   hfields.load();
</script>

À ce stade, votre navigateur Web peut afficher les champs de saisie de la carte bancaire dans leurs conteneurs.

6- Générer le jeton

A la soumission du formulaire, vous devez appeler la méthode CREATETOKEN() sur l’événement ONSUBMIT() pour déclencher le processus de création de jetons.

Cette méthode attend un paramètre de rappel qui sera déclenché une fois la demande de tokénisation terminée.

Votre rappel recevra un objet de résultat contenant ces propriétés :

  • execCode : code de résultat technique de l’appel tokenization. En cas de succès, 0000 sera envoyé
  • message : la description liée à l’execCode
  • cardType : le type de carte
  • cardCode : Les 6 premiers et les 4 derniers chiffres du numéro de la carte du titulaire
  • cardValidityDate : Date d’expiration de la carte
  • hfToken : le jeton généré

En cas de succès, vous devez ajouter le jeton reçu à la demande d’envoi de formulaire dans une balise <input type="hidden" />

<form method="post" name="formName" action="URL_API/psp/submitcardpayment" onsubmit="return tokenizeHandler()">
   <!-- ... -->
   <input type="hidden" name="hftoken" id="hftoken">
   <!-- ... -->
</form>
<script type="text/javascript">
   function tokenizeHandler() {
       hfields.createToken(function (result) {
           //console.log(result); // Debug
           if (result.execCode == '0000') {
               // Set the token in an hidden input field to transmit it to the merchant submit page
               document.getElementById('hftoken').value = result.hfToken;
               // Send the form request
               document.formName.submit();
           }
       });
       // Prevents the submit of the form in case of failed tokenization request
       return false;
   }
</script>

7- 7- Inclure les propriétés Smoney OPERATIONID, PAYINTOKENID et EXTRADATA (issues du résultat de l’appel api pour créer le paiement par carte bancaire) en champs hidden en plus de celui du jeton.

<input type="hidden" name="smoperationid" value="@Model.OperationId" />
<input type="hidden" name="smpayintokenid" value="@Model.PayinTokenId" />
<input type="hidden" name="smextradata" value="@Model.ExtraData" />

Les attributs « name » des balises input hidden ne doivent pas être changés.

Paiement avec authentification 3DSecure :

Selon la carte utilisée lors du paiement, à la soumission du formulaire de paiement, une authentification 3DSecure peut être nécessaire.

Dans ce cas, en réponse à l’action du formulaire, la page HTML du formulaire 3DSecure est envoyé en contenu de la réponse accompagné d’un http status code 200 (OK).
La soumission du formulaire 3DSecure se terminera par une redirection 302 vers l’url renseignée dans le champ urlReturn de la requête initiale.

Dans le cas contraire, une réponse 302 (redirect) est directement faite et redirige le navigateur de l’utilisateur vers l’url renseignée dans le champ urlReturn de la requête initiale.

Ressources

CardPayment

Property Type Mandatory ? Description
Amount Long Yes Payment amount (in cents)
Fee Long No Fee amount (the amount value does not include the fee amount)
ThreeDSecurePreference Int Yes 0 = ask for a strong authentication
1 = ask for a frictionless authentication
2 = ask for no preference, the decision will be made by issuer ;
3 = ask for no authentication
OrderId String Yes Payment identifier in the third-party application
Id Long / Payment ID
availableCards String Yes List of cards to be displayed on the payment page.
Possible values (to separate with ’ ;’ ) :
CB
MASTERCARD
MAESTRO
VISA
VISA_ELECTRON
IsMine Bool Yes True, if the account holder is also the bank card holder (it refers to an account top-up and not a payment), False if the bank card holder is not the owner of the account holder
Message String Yes Payment message
urlReturn String Yes Url of callback client requested at the end of a card payment
urlCallback String Yes Specify url of callback server requested at the end of adding card (the domain must be the same as the one of the callback URL provided initially)
Status Int Yes Sub operation status
-1 = unknow
0 = waiting
1 = completed
2 = refunded
3 = refused
4 = Waiting for validation
5 = Cancelled
6 = Waiting to be sent
ErrorCode Int Yes 0 = 0XXX operation succeeded or still processing
10 = 1XXX operation rejected because of bad request configuration
11 = 2XXX operation rejected because of bad reference usage
12 = 3XXX operation rejected because of bad account configuration
13 = 4XXX operation rejected because of the bank or the supplier
14 = 5XXX operation rejected because of a system error
15 = 6XXX operation rejected because of anti-fraud engine
Extradata String / Data to be included in card payment form into : <input type="hidden" />
OperationId String Data to be included in card payment form into : <input type="hidden" />
TokenId String Data to be included in card payment form into : <input type="hidden" />
PaymentDate DateTime Payment date
Ex : 2013-09-10 T15:49:58.791121+02:00
Type Int / Payment types :
0 = Payment
1 = Refund

Card

Property Type Mandatory ? Description
Id Long / Card ID
AppCardId String Yes Card identifier in the third-party application
Network Long / UNKNOWN = -1,
CB = 1,
MASTERCARD = 2,
VISA = 3
Hint String / Hide the card number.
6XXXX4 format
Name String Yes Card name
Country String / ISO country code of the card
ExpiryDate Date / Card expiration date

Beneficiary

Property Type Mandatory ? Description
Id Long / Account identifier.
AppAccountId String Yes Account identifier provided by the third-party application.
DisplayName Long / Account display name
Email String / Account email
Phonenumber String / Account phone number
Href Uri / Uri for the account details

PayerInfo

Property Type Mandatory ? Description
Name String Yes The holder’s full name (as described on the payment method).
mail String Yes The user’s email.

Extraparameters

Property Type Mandatory ? Description
ProfilName String Yes Value “3DSV2” to call 3D-Secure 2.0
By default, without profil, 3DS V1 will be called

Billing

Property Type Mandatory ? Description
City String Yes The billing city.
Country String Yes The country code (ISO_3166-1_alpha-2).
Address String Yes The billing address. Be careful not to integrate any line breaks.
PostalCode String Yes The billing postal code.
Billingaddressstate String No The billing address state.

ShipTo

Property Type Mandatory ? Description
City String Yes* The shipping city.
Mandatory if AdresseType is not EDELIVERY
Country String Yes* The country code (ISO_3166-1_alpha-2 format)
Mandatory if AdresseType is not EDELIVERY
Address String Yes* The shipping address.
Mandatory if AdresseType is not EDELIVERY
PostalCode String Yes* The shipping postal code.
Mandatory if AdresseType is not EDELIVERY
AddressType Int Yes Shipping indicator.
0 = eDelivery
1 = Verified
2 = New
3 = Billing
4 = Store Pickup
5 = Travel Pickup
6 = Other
The parameter DELIVERYEMAIL is mandatory when EDELIVERY mode is set. The other ship to address fields are optional when ‘storepickup’, travelpickup or other is set.
AddressState String No The shipping address state.
AddressDate String No Date when the shipping address used for this transaction was first used with the 3DS Requestor.

Delivery

Property Type Mandatory ? Description
email String Yes* Mandatory if ShipToAddressType value is eDelivery
For Electronic delivery, the email address to which the merchandise was delivered.
timeframe String No Possible values : electronic, sameday, overnight, longer

ClientScreen

Property Type Mandatory ? Description
ColorDepth Int Yes Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property.
Ex : 32
ScreenHeight Int Yes Total height of the Cardholder’s screen in pixels. Value is returned from the screen.height property.
Ex : 1280
ScreenWidth Int Yes Total width of the cardholder’s screen in pixels. Value is returned from the screen.width property.
Ex : 1024

ThreeDsOptData

Property Type Mandatory ? Description
ClientAuthMethod String No guest : No merchant authentication occurred (i.e. cardholder “logged in” as guest) ;
credentials : Login to the cardholder account at the merchant system using merchant’s own credentials ;
federated : Login to the cardholder account at the merchant system using federated ID ;
issuer : Login to the cardholder account at the merchant system using issuer credentials ;
thirdparty : Login to the cardholder account at the merchant system using third-party authentication ;
fido : Login to the cardholder account at the merchant system using FIDO Authenticator ;
AccountChangeDate Date No Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added.
AccountCreationDate Date No Date that the cardholder opened the account with the 3DS Requestor.
Passwordchangedate Date No Date that cardholder’s account with the 3DS Requestor had a password change or account reset.
Last6MonthsPurchaseCount Int No Number of purchases with this cardholder account during the previous six months.
Last24hoursaddcardattempts Int No Number of “Add Card” attempts in the last 24 hours.
Last24hourstransactioncount Int No Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours.
Last12Monthstransactioncount Int No Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year.
Cardenrolldate date No Date that the payment account was enrolled in the cardholder’s account with the 3DS Requestor.
Suspiciousaccountactivity Boolean No Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account.
Homephone string(max 32) No The home phone number provided by the Cardholder in international (E.164) format.
Mobilephone string(max 32) No The mobile phone number provided by the Cardholder in international (E.164) format.
Workphone string(max 32) No The work phone number provided by the Cardholder in international (E.164) format.
Preorderdate date No For a pre-ordered purchase, the expected date that the merchandise will be available.
Itemavailability Boolean No Indicates whether Cardholder is placing an order for merchandise with a future availability or release date.
Reorderingitem Boolean No Indicates whether the cardholder is reordering previously purchased merchandise.
Recurringexpiry date No Date after which no further authorisations shall be performed in a recurring payment workwlow.
recurringfrequency Int No Indicates the minimum number of days between authorisations.
Ex : 10

GiftCard

Property Type Mandatory ? Description
Amount Int No For prepaid or gift card purchase, the purchase amount total of prepaid or gift card(s) in minor units (cents).
Count Int No For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased.
Currency String No For prepaid or gift card purchase, the currency code of the card as defined in ISO 4217.

ExtraResults

Property Type Mandatory ? Description
threedsecure Boolean / True / False
threedsecureauthstatus Int / 0 = Yes
1 = No
2 = unavaible
3 = Attempted
threedsecuresignaturestatus Int / 0 = Yes
1 = No
threedsecureglobalstatus Int / 0 = Yes
1 = Not_enrolled
2 = unavaible
3 = Not_required
ThreeDsCardEnrolled Int / 0 = Yes
1 = No
2 = unavaible
ExecCode String (4) / The operation result code
ExecMessage String / The operation result description linked to EXECCODE
warrantyresult String / Yes / no
3dsecureversion Int / The kind of 3-D Secure protocol version.
Ex : 1
3dsecuremode String / Applied authentification mode :
0 = ask for a strong authentication
1 = ask for a frictionless authentication
bankauthresult Int / Return code of the authorisation request returned by the issuing bank

Créer un paiement par carte bancaire avec 3DS V1

Evolutions entre Systempay et Dalenys

Cette requête est similaire à Systempay - Paiement simple par carte bancaire, avec quelques ajustements :

HEADER
Le header des requêtes Dalenys est en V3.

REQUETE
Dans la requête de création de paiement par carte, les champs payerInfo (name, email) deviennent obligatoires, le reste de la requête reste inchangé.

REPONSE
Dans la réponse, le champ réponse HREF est remplacé par OperationId, PayInTokenId et ExtraData.
Ces champs seront à inclure dans le formulaire de paiement dans des balises
HTML <input type="hidden" />

Les valeurs du champ ErrorCode sont complétées de nouvelles valeurs suivantes :
0 = succès (correspond à l’ExecCode 0000)
10 = erreur requête Dalenys (correspond aux ExecCodes de type 1XXX)
11 = erreur de référence Dalenys (correspond aux ExecCodes de type 2XXX)
12 = erreur configuration boutique Dalenys (correspond aux ExecCodes de type 3XXX)
13 = erreur banque porteur carte (correspond aux ExecCodes de type 4XXX)
14 = erreur système Dalenys (correspond aux ExecCodes de type 5XXX)
15 = erreur moteur anti-fraude Dalenys (correspond aux ExecCodes de type 6XXX)

Dans les ExtraResults :
les champs riskcontrolresult et threedsresult ne sont plus disponibles
Ils sont remplacés par threedsecure, threedsecureauthstatus, threedsecuresignaturestatus, threedsecureglobalstatus et ThreeDsCardEnrolled alimentés par les valeurs suivantes :

threedsecure True False
threedsecureauthstatus 0 = yes 1 = no 2 = unavailable 3 = attempted
threedsecuresignaturestatus 0 = yes 1 = no
threedsecureglobalstatus 0 = ok 1 = not_enrolled 2 = unavailable 3 = not_required
ThreeDsCardEnrolled 0 = yes 1 = no 2 = unavailable

Créer un paiement par carte bancaire avec 3DS V2

Récupérer un paiement entrant

Si les données détaillées de la carte sont à la valeur "null", c’est qu’elles n’ont pas encore été mises à jour côté Dalenys. Il est nécessaire de relancer l’appel pour avoir la mise à jour de ces données.