WalletPay API (Version 1.15, mise à jour le 20/02/2012)

Ce manuel vous guidera à travers le processus d’intégration qui fait que votre site Web et Allied Wallet ne font qu’un. L’intégration implique l’exécution de nos API. Les API, interfaces de programme d’application, sont des spécifications basées sur un code source qui sont destinées à être utilisées par des composants logiciels qui permettent aux composants de communiquer.

L’application des API de paiement d’Allied Wallet vous permettra de traiter vos transactions en ligne sans autant de travail fastidieux. Après l’insertion de nos codes API, vous pourrez envoyer et traiter des paniers d’achats et des transactions liées aux abonnements.

Notre API de paiement invoque un HTTP POST qui lance des demandes à Allied Wallet. La méthode POST d’Allied Wallet peut être exécutée dans n’importe quel langage de programmation Web ou même une simple page Web.

Allied Wallet simplifie les choses. Mais si le processus API vous pèse un peu, ne vous inquiétez pas. Contactez un représentant et nous réaliserons l’intégration pour vous SANS FRAIS SUPPLÉMENTAIRES.

  1. Informations nécessaires
  2. Abonnements
  3. Configuration de votre site – exemples de formulaires
    1. Formulaire d’achats
    2. Formulaire d’abonnement HTML
    3. Formulaire de panier d’achats HTML
  4. Page Terminer
  5. Page de confirmation
  6. Publication de l’adhésion
  7. Confirmer les champs de la publication
  8. Étapes d’intégration simplifiées
    1. Abonnement
  9. Informations de la carte de test
  10. Félicitations

1. Informations nécessaires

Avant que vous puissiez envoyer des transactions en direct à Allied Wallet, vous aurez besoin d’un
compte commerçant Allied Wallet pour votre site Web. Lors de la création du compte commerçant Allied Wallet, nous vous fournirons une ID commerçant et une ID pour le site. Ces identités identifient uniquement vos sites Web, vos clients et vos paiements. Si vous n’avez pas fait la demande d’un compte commerçant, vous pouvez le faire à l’adresse :

https://sale.alliedwallet.com/index.aspx

En haut

2. Abonnements

Si vous souhaitez proposer des abonnements sur votre site Web, vous aurez également besoin d’Allied Wallet pour configurer vos groupes d’abonnements. La configuration du groupe déterminera les niveaux, le barème des prix et les conditions de vos abonnements.
Par exemple, vous pouvez avoir un abonnement standard qui coûte 19,95 USD par mois et un abonnement premium qui coûte 99,99 USD par trimestre. Allied Wallet configurera les deux différents groupes pour que vos clients soient automatiquement refacturés à la fin de chaque fin de période.
Une fois qu’Allied Wallet a configuré vos groupes d’abonnements, vous aurez besoin de l’URL pour y PUBLIER les transactions. L’URL pour les publications du formulaire HTML est :

https://sale.alliedwallet.com/index.aspx

Afin de PUBLIER les paiements de vos clients sur Allied Wallet, vous devez inclure ces champs. Veuillez remarquer les champs obligatoires et les champs facultatifs et ajouter en conséquence :

Champ

Description

Type

Obligatoire/Facultatif

ID commerçant

L’ID de référence du commerçant est fournie par Allied Wallet.

Chaîne

Obligatoire

ID du site

L’ID de référence du site est fournie par Allied Wallet pour chaque site.

Chaîne

Obligatoire

Montant de l’expédition

Le montant total de l’expédition. Ce montant doit
être ajouté au prix d’achat de l’article dans le champ Montant total.

Ce champ doit être rempli et sera “0″ pour les achats d’abonnement.

Décimal

Obligatoire

Montant total

Le montant total du panier d’achats ou des articles liés à l’abonnement dans la transaction.

Ce chiffre sera vérifié par Allied Wallet avant de terminer la transaction. REMARQUE : ce
champ doit être rempli
et peut être “0” pour les achats d’abonnement si vous souhaitez permettre à vos clients de sélectionner leur option d’abonnement.

Décimal

Obligatoire

ID de la devise

ID standard pour le type de devise que vous encaissez.

Les types ordinaires acceptés par Allied Wallet sont :
• USD – Dollar américain
• GBP – Livre sterling
• EUR – Euro
• CAD – Dollar canadien
Dollars

Chaîne

Obligatoire

URL de réponse

L’URL à laquelle vous souhaitez que vos clients répondent après avoir terminé leurs achats.

Chaîne

Obligatoire

URL de confirmation

L’URL sur votre site qui accepte toutes les publications d’Allied Wallet et les envoie à cette URL.

Chaîne

Facultatif

ID de la devise

ID standard pour le type de devise que vous encaissez.

Les types ordinaires
acceptés par Allied Wallet sont :
• USD – Dollar américain
• GBP – Livre sterling
• EUR – Euro
• CAD – Dollar canadien

Chaîne

Obligatoire

Montant de l’article[n]

Le montant TOTAL des
produits n dans le panier d’achats,
n représentant
le nombre d’articles dans le panier d’achats, à commencer par 0.

Ce montant est composé du coût unitaire du produit, multiplié par la quantité. Par exemple : si un produit
coûte 5 USD et que trois sont
commandés, 15,00 devrait être la valeur dans ce champ.

Décimal

Obligatoire pour le panier d’achats

Description de l’article[n]

La description des produits n dans le panier d’achats, n représentant le nombre d’articles dans le panier d’achats à commencer par 0.

Chaîne

Obligatoire pour le panier d’achats

Nom de l’article[n]

La quantité des produits n
dans le panier d’achats, n représentant le nombre d’articles dans le panier d’achats, à commencer par 0.

La quantité doit être au moins de 1 ou une erreur sera renvoyée.

Chaîne

Obligatoire pour le panier d’achats

Nom d’utilisateur du membre

Nom d’utilisateur de l’abonné.

Ce champ vous permet de contrôler la création du compte d’adhésion depuis votre propre site.

Chaîne

Facultatif pour l’adhésion

Référence du commerçant

La référence produite par le commerçant pour associer l’achat à la
transaction d’Allied Wallet.

Cette valeur est renvoyée à la page Terminer du commerçant.
chaîne de requête (URL).

Chaîne

Facultatif

Pas d’adhésion

Indique si une adhésion ou un abonnement sont nécessaires.

Si cette valeur est > 0, l’utilisateur NE sera PAS prié d’acheter un abonnement.

Nombre entier

Obligatoire

ID du prix

L’identifiant du barème
est fourni par Allied Wallet pour le prix et la période d’un abonnement.

Si l’ID du prix n’est pas fournie, Allied Wallet
permettra au client de choisir à partir de celles qui sont disponibles.

Nombre entier

Obligatoire pour l’adhésion

Nécessité d’expédition

Indique si l’expédition est obligatoire.

Les achats de services et d’abonnements en ligne ne nécessitent pas, en général, d’expédition.

Si cette valeur est > 0, le client sera alors prié de donner des renseignements sur l’expédition.

Nombre entier

Facultatif pour le panier d’achats

Afficher mot de passe et nom d’utilisateur

Indique si les renseignements sur un membre sont affichés.

Si cette valeur est > 0, alors le nom d’utilisateur et le mot de passe seront affichés. Le nom d’utilisateur et le mot de passe seront affichés par défaut.

Nombre entier

Obligatoire pour l’adhésion

En haut

3. Configuration de votre site – Exemple de formulaires

Pour traiter les paiements, vous aurez besoin d’ajouter deux pages Web à votre site.

Tout d’abord, vous aurez besoin d’ajouter la page du formulaire d’achat. Cette page permettra de lancer le processus de paiement d’Allied Wallet.

Ensuite, vous aurez besoin d’ajouter une page Achat terminé. Vos clients seront renvoyés à cette page après avoir terminé, avec succès, un achat.

En haut

3.1 Formulaire d’achat

Vous pouvez inclure le formulaire d’achat dans toute page sur votre site qui est susceptible de publier des informations sur Allied Wallet. Vous pouvez utiliser tout langage de programmation Web standard, même HTML. Vous pouvez réaliser les formulaires d’achat pour permettre des abonnements et des produits récurrents. Ci-après des exemples de formulaires d’abonnement et de panier d’achats :

En haut

3.2 Formulaire d’abonnement HTML

Le formulaire suivant inclut tous les renseignements nécessaires dont vous avez besoin pour inclure un formulaire d’abonnement. Cela permettra à vos clients d’acheter des abonnements sur votre site :

<html>
<head>
<title>Subscribe to Our Website</title>
</head>
<body>
<h1>Subscribe to Our Website</h1>
<p>Buy a subscription to our site.</p>
<form name="test" method="post"  action="https://sale.alliedwallet.com/quickpay.aspx">
<input name="MerchantID" type="hidden"  value="0000000-0000-0000-0000-00000000000">
<input name="SiteId" type="hidden"   value="0000000-0000-0000-0000-00000000000">
<input name="AmountTotal" type="hidden"  value="0.00" >
<input name="Address" type="hidden"  value="8100 E Indian School" >
<input name="CurrencyID" type="hidden"  value="USD">              
   <input name="AmountShipping" type="hidden"  value="0">
<input name="NoMembership" type="hidden"  value="0">
<input name="GroupID" type="hidden"  value="107">
<innput name="ReturnURL" type="hidden"  value="http://www.yoursite.com/success.html" /> 
<input name="MerchantReference"  type="hidden" value="PBI">
<input type="hidden"  name="ShowUserNamePassword" value="0" />
<input type="hidden" name="MemberUserName"  value="UniqueName123456489" />
<input type="hidden" name="MemberPassword"  value="UniquePassword123456789" />
<input type="submit" value="Buy Now -  Subscription">
</form>
</body>
</html>

Le formulaire HTML ci-dessus inclut le champ “Référence du commerçant” qui est facultatif. Ce champ peut être utilisé pour associer les données sur la transaction d’achat d’Allied Wallet aux données de votre demande de site Web.

Après avoir inclus les formulaires adéquats, votre site Web et/ou le programmateur devront insérer dans votre site un formulaire d’achat frontal adapté à votre site.

Vous pouvez inclure des champs supplémentaires dans le formulaire pour fournir des ID de groupes et de barème des prix des cotisations. Voir la référence du champ dans le dernier paragraphe.

En haut

3.3. Formulaire de panier d’achats HTML

Votre formulaire de panier d’achats peut être inclus dans un simple fichier HTML pour les achats d’un seul produit sur votre site Web. Le formulaire suivant inclut le texte nécessaire pour les achats d’un seul article :

<html>
<head>
<title>Buy our T-Shirt</title>
</head>
<body>
<h1>Buy Our T-Shirt</h1>
<p>Single item purchase form.</p>
<form method="post"
       action="https://sale.alliedwallet.com/quickpay.aspx">
<!-- *** Required fields for AlliedWallet -->
<input name="MerchantID" type="hidden"
       value="0000000-0000-0000-0000-00000000000" />
<input name="SiteID" type="hidden"
       value="0000000-0000-0000-0000-00000000000" />
<input name="AmountTotal" type="hidden"  value="17.99" />
<input name="CurrencyID" type="hidden"  value="USD" />
<input name="AmountShipping" type="hidden"  value="7.99" />
<input name="ShippingRequired"  type="hidden" value="1" />
<input name="ItemName[0]" type="hidden"  value="T-Shirt" />
<input name="ItemQuantity[0]" type="hidden"  value="1" />
<input name="ItemAmount[0]" type="hidden"  value="10.00" />
<input name="ItemDesc[0]" type="hidden"  value="Our T-Shirt" />
<input name="NoMembership" type="hidden"  value="1" />
<input name="ReturnURL" type="hidden"
       value="http://oursite.com/complete.htm" />
<input name="ConfirmURL" type="hidden"
       value="http://oursite.com/confirm.htm" />
<!-- *** Optional fields for AlliedWallet -->
<input name="MerchantReference"  type="hidden" value="abc123" />
<input name="submit" type="submit" />
</form></body>
</html>

Le formulaire ci-dessus enverra une transaction pour acheter un seul article d’une valeur de 10 USD plus 7,99 USD pour l’expédition. Voyez comment le Montant total est égal au Montant de l’article + le Montant de l’expédition.

En haut

4. Page Terminer

La ‘Page Terminer’ peut être une page quelconque sur votre site Web. La page accueillera de nouveau le client après qu’il a terminé ses achats. Ici, vous pouvez fournir des renseignements supplémentaires sur le produit ou l’abonnement achetés (par exemple, les renseignements sur l’expédition, l’activation de l’abonnement, etc.).

L’adresse URL de la ‘Page Terminer’ est fournie par votre page ou votre demande dans le champ URL de réponse.

Une fois qu’un client a terminé ses achats, Allied Wallet chargera la page désignée et fournira l’ID de la transaction et la référence du commerçant fournie dans le formulaire d’achat. Par exemple, si vous avez fourni l’adresse URL de réponse suivante dans votre formulaire d’achat :

http://oursite.com/complete.html

Allied Wallet terminera la transaction et renverra le client à
l’adresse URL suivante :

http://oursite.com/complete.html?TransactionID=67890123-cdef&MerchantReference=abc123

En haut

5. Page de confirmation

Une fois que le client a terminé, avec succès, sa transaction, Allied Wallet publiera les détails de la transaction sur une page que vous avez désignée sur votre site. Cette page devrait valider et stocker les renseignements sur la transaction dans votre base de données. La ‘Page de confirmation’ devrait fournir une communication entre Allied Wallet et votre demande. La page n’a pas besoin de fournir une fonctionnalité utilisateur.

Allied Wallet 7 Rév. 1.14

L’adresse URL de la ‘Page de confirmation’ doit être une page valide sur votre site Web ou votre demande, puis placée dans le champ URL de confirmation. Si une adresse URL n’est pas fournie ou n’indique pas une page valide sur votre site, la transaction ne sera pas terminée avec succès. Si vous ne souhaitez pas enregistrer les détails et les renseignements sur la transaction, la page peut être une page HTML vierge.

Les renseignements publiés sur la ‘Page de confirmation’ sont publiés sous forme de paires nom/valeur HTTP Post (NVP) séparées par des perluètes (&). Un exemple de lectures de publication de confirmation :

Amount=17.99&MerchantReference=abc123&PayReferenceID=b9ab260b-d690-4507-8d56-8bd92c4c132a&TransactionID=4cfdefc3-6ad2-49de-a25b-5d0f41e8cd1a

En haut

6. Publication de l’adhésion

Si votre site Web est un site d’abonnement ou d’adhésion, vous pouvez choisir qu’Allied Wallet publie des informations abonné/adhésion dans une page désignée sur votre site Web. Si vous souhaitez recevoir des opérations de publication d’adhésion, vous devez fournir au support du commerçant d’Allied Wallet une URL de publication. Après avoir reçu l’URL de publication, Allied Wallet vous fournira une clé de publication pour valider les opérations de publication d’Allied Wallet.

Les opérations d’abonné publiées sur votre site Web peuvent inclure :

  • Ajouter
  • Un nouveau client a terminé un achat d’abonnement
  • Un compte est créé pour votre site Web
  • Annuler

    • Un client a annulé son abonnement à votre site
  • Désactiver
    • Vous avez désactivé l’abonnement d’un client via le terminal du commerçant
  • Mot de passe
    • Le mot de passe du compte de l’abonnement du client a changé.
  • Les champs suivants sont transmis par Allied Wallet dans une opération de publication d’une adhésion.

    Champ

    Description

    Type

    Opérations de publication

    Nom d’utilisateur

    Nom d’utilisateur de l’abonné

    Chaîne

    Ajouter. Annuler. Désactiver. Mot de passe

    E-mail

    Adresse e-mail de l’abonné

    Chaîne

    Ajouter. Annuler. Désactiver. Mot de passe

    Prénom

    Prénom de l’abonné

    Chaîne

    Ajouter. Annuler. Désactiver

    Nom

    Nom de l’abonné

    Chaîne

    Ajouter. Annuler. Désactiver

    ID du membre

    ID unique de l’abonné attribuée par AlliedWallet

    Chaîne

    Ajouter. Annuler. Désactiver. Mot de passe

    ID de la transaction

    Transaction qui a incité le changement de l’abonné

    Chaîne

    Ajouter. Annuler

    Mot de passe

    Mot de passe de l’abonné

    Chaîne

    Ajouter. Annuler

    ID du groupe

    ID pour le groupe de paiement attribué au site

    Nombre entier

    Ajouter

    ID du prix

    ID pour le paiement attribué au site

    Nombre entier

    Ajouter

    Action

    Type de message de demande. Les valeurs sont “Ajouter”, “Annuler”, “Désactiver”, “Mot de passe”

    Chaîne

    Ajouter. Annuler. Désactiver. Mot de passe

    Clé

    Clé de chiffrement attribuée par Allied Wallet

    Chaîne

    Ajouter. Annuler. Désactiver. Mot de passe

    Les champs sont transmis sous forme de paires nom/valeur (NVP).

    Dès que votre page d’adhésion reçoit un message d’Allied Wallet, votre page doit transmettre un accusé de réception. La réponse est une chaîne délimitée par deux points contenant le statut et un message. Le statut doit être “0”si le message a échoué et “1” s’il a réussi. En cas d’échec, le message doit contenir une description de l’erreur. Un exemple d’une chaîne d’accusé de réception réussie :

    1:success

    Un exemple d’une chaîne d’accusé de réception qui a échoué :

    0:user does not exist

    En haut

    7. Champs de publication de confirmation

    Après la fin de la transaction et l’envoi de l’URL de confirmation, un HTTP POST est réalisé sur la page.

    Champ

    Description

    Type

    Montant

    Le montant total du panier d’achats ou des articles d’abonnement dans la transaction

    Décimal

    Référence du commerçant

    Référence produite par
    le commerçant pour associer
    l’achat à la
    transaction d’Allied Wallet.

    Chaîne

    ID de la référence de paiement

    L’ID de la transaction dans
    le système du commerçant
    d’Allied Wallet.

    Chaîne

    ID de la transaction

    L’ID de la transaction dans la demande de vente d’Allied Wallet

    Chaîne

    Extra1

    Champ d’un formulaire supplémentaire

    Chaîne

    8. Étapes d’intégration simplifiées

    Pour terminer l’intégration, il suffit de créer un formulaire d’abonnement ou un formulaire de panier d’achats tel que décrit ci-après :

    En haut

    8.1.Abonnement :

    <html>
    <head>
    <title>Subscribe to Our Website</title>
    </head>
    <body>
    <h1>Subscribe to Our Website</h1>
    <p>Buy a subscription to our site.</p>
    <form name="test" method="post"  action="https://sale.alliedwallet.com/quickpay.aspx">
    <input name="MerchantID" type="hidden"  value="0000000-0000-0000-0000-00000000000">
    <input name="SiteId" type="hidden"   value="0000000-0000-0000-0000-00000000000">
    <input name="AmountTotal" type="hidden"  value="0.00" >
    <input name="CurrencyID" type="hidden"  value="USD">              
       <input name="AmountShipping" type="hidden"  value="0">
    <input name="NoMembership" type="hidden"  value="0">
    <input name="PriceID" type="hidden"  value="107">
    <innput name="ReturnURL" type="hidden"  value="http://www.yoursite.com/success.html" /> 
    <input name="MerchantReference" type="hidden"  value="PBI">
    <input type="hidden"  name="ShowUserNamePassword" value="0" />
    <input type="hidden" name="MemberUserName"  value="UniqueName123456489" />
    <input type="hidden" name="MemberPassword"  value="UniquePassword123456789" />
    <input type="submit" value="Buy Now -  Subscription">
    </form>
    </body>
    </html>

    Veuillez noter de changer les valeurs suivantes par les valeurs fournies par Allied Wallet :

    • ID du commerçant
    • ID du site
    • ID du prix

    URL de gestion des membres

    Vous devez créer une adresse URL sur votre site qui prend les opérations de publication d’Allied Wallet et les traite sur votre système de gestion des membres (par exemple, .fichier htaccess ou base de données).

    Créer une page qui prend chaque valeur dans un http post :

    Exemple PHP :

    <?php
    $yourvalue=$_POST(“MerchantReference”);//etc for all values you want
    ?>

    Exemple ASP :

    <%response.write(request.form("MerchantReference"))%>

    En haut

    9. Informations de la carte de test

    Vous pouvez utiliser les informations suivantes pour procéder à des transactions tests sur votre site et passer en revue vos achats dans votre passerelle de paiement. Il s’agit d’un outil formidable permettant de passer en revue votre devanture auto-intégrée pour protéger votre site contre les erreurs.

    • CC# 4242424242424242
    • EXP 10/14
    • CVV : 123

    En haut

    10. Félicitations

    Une fois que vous avez terminé le processus tel que décrit dans ce manuel, votre intégration est prête à être examinée et vous n’êtes qu’à un pas du traitement des paiements avec Allied Wallet. Remplissez le formulaire ci-dessous pour informer la conformité d’Allied Wallet que vous avez terminé l’intégration de vos API WalletPay d’Allied Wallet.

    [contact-form-7 id="578" title="Statut de l'intégration"]

    En haut