WalletPay API (Ver 1.15 Aktualisierung 2/20/2012)

Dieses Handbuch führt Sie durch den Integrationsprozess, der Ihre Internetseite und die Funktion von Allied Wallet vereinigt. Die Integration beinhaltet die Implementierung unserer APIs. APIs, Anwendungsprogrammierschnittstellen, sind Spezifikationen, die auf dem Quellcode basieren und von Software-Komponenten verwendet werden, die eine Kommunikation der Komponenten ermöglichen.

Die Implementierung der Zahlungs-API von Allied Wallet ermöglicht es Ihnen, Ihre Online-Transaktionen ohne mühsame Zusatzarbeit zu verarbeiten. Nachdem unsere API-Codes eingesetzt wurden, können Sie Warenkorb- und Abonnement-Transaktionen übertragen und verarbeiten.

Unsere Zahlungs-API ruft einen HTTP POST auf, der die Anfragen an Allied Wallet initiiert. Der POST von Allied Wallet kann in jede Internet-Programmiersprache oder sogar in einen einfache Internetauftritt implementiert werden.

Allied Wallet gestaltet es einfach. Aber auch wenn Sie den API-Prozess ein bisschen erdrückend finden, brauchen Sie sich keine Sorgen zu machen. Kontaktieren Sie einen Vertreter und wir führen die Integration durch, OHNE ZUSÄTZLICHE GEBÜHREN zu verlangen.

  1. Erforderliche Informationen
  2. Abonnements
  3. Konfiguration Ihrer Seite – Beispielformulare
    1. Einkaufsformular
    2. HTML-Abonnement-Formular
    3. HTML-Warenkorb-Formular
  4. Abschlussseite
  5. Bestätigungsseite
  6. Mitgliedschaft-Postback
  7. Postback-Felder bestätigen
  8. Vereinfachte Integrationsschritte
    1. Abonnement
  9. Testkarten-Informationen
  10. Herzlichen Glückwunsch

1. Erforderliche Informationen

Bevor Sie Live-Transaktionen an Allied Wallet abschicken können, benötigen Sie ein
Allied Wallet-Händlerkonto für Ihren Internetauftritt. Bei der Einrichtung eines Allied Wallet-Händlerkontos erhalten Sie eine Händler-ID und eine Seiten-ID. Diese IDs identifizieren eindeutig Ihre Internetseiten, Kunden und Zahlungen. Wenn Sie sich noch nicht für ein Händlerkonto beworben haben, können Sie dies hier tun:

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

Nach oben

2. Abonnements

Wenn Sie auf Ihrer Seite Abonnements anbieten möchten, benötigen Sie Allied Wallet ebenfalls, um Ihre Abonnement-Gruppen zu konfigurieren. Die Gruppenkonfiguration richtet die Ebenen, die Preisbildung und die Bedingungen für Ihre Abonnements ein.
Sie haben zum Beispiel ein Standard-Abonnement, das im Monat 19.95$ kostet, und ein Premium-Abonnement zum Preis von 99.99$ pro Quartal. Allied Wallet konfiguriert die beiden verschiedenen Gruppen, sodass Ihre Kunden am Ende des Zeitraums automatisch eine Abrechnung erhalten.
Nachdem Allied Wallet Ihre Abonnement-Gruppen konfiguriert hat, benötigen Sie die URL, um Transaktionen zu POSTEN. Die URL für HTML-Formular-Posts ist:

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

Um die Zahlungen Ihrer Kunden an Allied Wallet zu POSTEN, müssen Sie diese Felder hinzufügen. Bitte beachten Sie die erforderlichen und die optionalen Felder und fügen Sie diese entsprechend hinzu:

Feld

Beschreibung

Typ

Erforderlich/Optional

MerchantID

Händler-Referenz-ID, die von Allied Wallet geliefert wird.

String

Erforderlich

SiteID

Eine Seiten-Referenz-ID, die von Allied Wallet für jede Seite geliefert wird.

String

Erforderlich

AmountShipping

Die gesamten Versandkosten. Dieser Betrag muss
zum Artikelkaufpreis im Feld AmountTotal hinzugefügt werden.

Dieses Feld muss ausgefüllt werden und ist für Abonnement-Käufe “0”.

Dezimalzahl

Erforderlich

AmountTotal

Gesamtbetrag des Warenkorbs oder der Abonnement-Artikel in der Transaktion.

Diese Zahl wird von Allied Wallet verifiziert, bevor die Transaktion abgeschlossen werden kann. HINWEIS: Dieses
Feld muss ausgefüllt werden
und kann für den Erwerb von Abonnements “0” sein, wenn Sie Ihren Kunden ermöglichen möchten, ihre Abonnement-Option auszuwählen.

Dezimalzahl

Erforderlich

CurrencyID

Standard-ID für die Währungsart, die Sie kassieren.

Allied Wallet akzeptiert normalerweise folgende Arten:
• USD – US-Dollar
• GBP – Britische Pfund
• EUR – Euro
• CAD – Kanadische
Dollar

String

Erforderlich

ReturnURL

Die URL, zu der Ihre Kunden zurückkehren sollen, nachdem sie ihre Einkäufe abgeschlossen haben.

String

Erforderlich

ConfirmURL

URL auf Ihrer Seite, die alle Postbacks von Allied Wallet annimmt und an diese URL sendet.

String

Optional

CurrencyID

Standard-ID für die Währungsart, die Sie kassieren.

Allied Wallet
akzeptiert normalerweise folgende Arten:
• USD – US-Dollar
• GBP – Britische Pfund
• EUR – Euros
• CAD – Kanadische Dollar

String

Erforderlich

ItemAmount[n]

Der GESAMTbetrag des n-ten
Produkts im Waren-
korb, n repräsentiert
die Anzahl von Artikeln im Warenkorb, beginnend mit 0.

Dieser Betrag besteht aus dem Einzelpreis des Produkts, multipliziert mit der Menge. Zum Beispiel: Wenn ein Produkt
$5 kostet und drei
bestellt werden, muss der Wert in diesem Feld 15.00 sein.

Dezimalzahl

Erforderlich für Warenkorb

ItemDesc[n]

Die Beschreibung des n-ten Produkts im Warenkorb, n repräsentiert die Anzahl von Artikeln im Warenkorb, beginnend mit 0.

String

Erforderlich für Warenkorb

ItemName[n]

Die Menge des n-ten Produkts
im Warenkorb, n repräsentiert die Anzahl von Artikeln im Warenkorb, beginnend mit 0.

Die Menge muss mindestens 1 betragen, oder eine Fehlermeldung erscheint.

String

Erforderlich für Warenkorb

MemberUsername

Benutzername des Abonnenten.

Dieses Feld ermöglicht Ihnen, die Erstellung eines Mitgliedskontos von Ihrer eigenen Seite aus zu steuern.

String

Optional für Mitgliedschaft

MerchantReference

Referenz, generiert vom Händler, um den Einkauf auf eine
Allied Wallet-Transaktion zu beziehen.

Dieser Wert wird an den Abfrage-String der Händlerseite
zurückgesendet (URL).

String

Optional

NoMembership

Anzeige, ob eine Mitgliedschaft oder ein Abonnement erforderlich sind.

Wenn dieser Wert > 0 ist, wird der Nutzer NICHT aufgefordert, ein Abonnement zu kaufen.

Ganzzahl

Erforderlich

PriceID

Preisbildungskennung,
von Allied Wallet für einen Bezugspreis und eine Laufzeit geliefert.

Wenn die PriceID nicht geliefert wird, gestattet Allied Wallet
dem Kunden, aus den verfügbaren Möglichkeiten auszuwählen.

Ganzzahl

Erforderlich für Mitgliedschaft

RequireShipping

Anzeige, ob ein Versand erforderlich ist.

Online-Abonnements und der Kauf einer Dienstleistung erfordern normalerweise keinen Versand.

Wenn der Wert > 0 ist, wird der Kunde zu den Versandinformationen weitergeleitet.

Ganzzahl

Optional für Warenkorb

ShowUserNamePassword

Anzeige, ob die Mitglieder-Information angezeigt wird.

Wenn dieser Wert > 0 ist, werden der Benutzername und das Passwort angezeigt. Der Benutzername und das Passwort werden standardmäßig angezeigt.

Ganzzahl

Erforderlich für Mitgliedschaft

Nach oben

3. Konfiguration Ihrer Seite – Beispielformulare

Um Zahlungen zu verarbeiten, müssen Sie zwei Seiten zu Ihrem Internetauftritt hinzufügen.

Zuerst müssen Sie die Einkaufsformular-Seite hinzufügen. Diese Seite initiiert den Allied Wallet-Zahlungsvorgang.

Als nächstes müssen Sie eine Seite für abgeschlossene Verkäufe hinzufügen. Ihr Kunde wird nach erfolgreichem Abschluss eines Kaufvorgangs auf diese Seite zurückgeleitet.

Nach oben

3.1 Einkaufsformular

Sie können das Einkaufsformular zu jeder Seite/allen Seiten Ihres Internetauftritts hinzufügen, die in der Lage ist/sind, Informationen an Allied Wallet zu posten. Gern können Sie eine Standard-Internet-Programmiersprache verwenden, sogar HTML. Sie können das Einkaufsformular bauen, um wiederkehrende Abonnements und Produkte zu erlauben. Hier sind Beispiele eines Abonnement- und Warenkorbformulars:

Nach oben

3.2 HTML-Abonnement-Formular

Das folgende Formular beinhaltet alle notwendigen Informationen, die Sie zum Abonnement-Formular hinzufügen müssen. Das gestattet Ihrem Kunden, auf Ihrer Seite Abonnements zu erwerben:

<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>

Das HTML-Formular oben beinhaltet das Feld “MerchantReference”, das optional ist. Dieses Feld kann verwendet werden, um die Einkaufstransaktionsdaten von Allied Wallet mit Daten von Ihrer Internetseiten-Anwendung zu verbinden.

Nach Hinzufügen der passenden Formulare müssen Ihre Internetseite und/oder Ihr Programmierer Ihre Seite mit einem Front-End-Einkaufsformular ausstatten, das zu Ihrer Seite passt.

Sie können zum Formular zusätzliche Felder hinzufügen, um Gruppen-IDs für Mitgliedschaft-Abonnements und Preisbildungs-IDs hinzuzufügen. Siehe Referenzfeld im letzten Abschnitt.

Nach oben

3.3. HTML-Warenkorb-Formular

Ihr Warenkorb-Formular kann in einfachem HTML für Käufe von nur einem Artikel zu Ihrem Internetauftritt hinzugefügt werden. Das folgende Formular umfasst das Skript, das für den Kauf einzelner Artikel benötigt wird:

<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>

Das Formular oben überträgt eine Transaktion für den Kauf eines einzelnen Artikels für 10,00$ plus 7,99$ für den Versand. Sie sehen, dass der Gesamtbetrag (AmountTotal) gleich dem Betrag für den Artikel (ItemAmount) + dem Betrag für den Versand (AmountShipping) ist.

Nach oben

4. Abschlussseite

Die ‘Abschlussseite’ kann jede Seite Ihres Internetauftritts sein. Diese Seite begrüßt den Kunden nach Abschluss des Einkaufsvorgangs. Hier können Sie zusätzliche Informationen hinsichtlich des Produkts oder der Abonnement-Käufe liefern (d.h. Versandinformationen, Abonnement-Aktivierung usw.).

Die URL der ‘Abschlussseite’ wird von Ihrer Seite oder der Anwendung im Feld ReturnURL geliefert.

Nachdem ein Kunde seine Einkäufe abgeschlossen hat, lädt Allied Wallet die zugewiesene Seite und stellt die Transaktions-ID und die Händlerreferenz, die im Einkaufsformular geliefert wurden, zur Verfügung. Wenn Sie zum Beispiel in Ihrem Einkaufsformular die folgende ReturnURL bereitgestellt haben:

http://oursite.com/complete.html

vervollständigt Allied Wallet die Transaktion und leitet den Kunden an die
folgende URL zurück:

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

Nach oben

5. Bestätigungsseite

Nachdem der Kunde die Transaktion erfolgreich abgeschlossen hat, postet Allied Wallet die Transaktionsdetails auf der Seite, die Sie auf Ihrer Seite zugewiesen haben. Diese Seite muss die Transaktionsinformationen validieren und in Ihrer Datenbank speichern. Die ‘Bestätigungsseite’ übernimmt die Kommunikation zwischen Allied Wallet und Ihrer Anwendung. Die Seite muss keine Nutzer-Funktionalität aufweisen.

Allied Wallet 7 Rev. 1.14

Die URL der ‘Bestätigungsseite’ muss eine gültige Seite Ihres Internetauftritts oder Ihrer Anwendung sein, die dann im Feld ConfirmURL platziert wird. Wenn keine URL geliefert wird oder nicht auf eine gültige Seite Ihres Internetauftritts verweist, wird die Transaktion nicht erfolgreich abgeschlossen. Wenn Sie die Transaktionsdetails und -informationen nicht speichern möchten, kann die Seite eine leere HTML-Seite sein.

Informationen, die auf der ‘Bestätigungsseite’ gepostet werden, sind Standard-HTTP-Post-Name-Wert-Paare (NVP), die durch ein kaufmännisches Und (&) voneinander getrennt werden. Ein Beispiel für einen Bestätigungs-Post sieht folgendermaßen aus:

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

Nach oben

6. Mitgliedschaft-Postback

Wenn Ihr Internetauftritt eine Mitgliedschaft- oder Abonnement-Seite ist, können Sie auswählen, dass Allied Wallet eine Abonnent-/Mitgliedschaft-Ereignisinformation auf eine zugewiesene Seite Ihres Internetauftritts postet. Wenn Sie Mitgliedschaft-Postback-Ereignisse erhalten möchten, müssen Sie dem Allied Wallet-Händlersupport eine Postback-URL zur Verfügung stellen. Nach Erhalt der Postback-URL liefert Allied Wallet Ihnen einen Postback-Schlüssel zur Validierung der Allied Wallet-Postback-Ereignisse.

Abonnenten-Ereignisse, die auf Ihrem Internetauftritt gepostet werden, können Folgendes umfassen:

  • Hinzufügen
  • Ein neuer Kunde hat einen Abonnement-Kauf abgeschlossen
  • Ein Konto für Ihre Internetseite wurde erstellt
  • Kündigen

    • Ein Kunde hat das Abonnement zu Ihrer Seite gekündigt
  • Deaktivieren
    • Sie haben das Abonnement eines Kunden über das Händler-Terminal deaktiviert
  • Passwort
    • Das Passwort eines Kunden-Abonnementkontos wurde geändert.
  • Die folgenden Felder werden bei einem Mitgliedschaft-Postback-Ereignis von Allied Wallet übertragen.

    Feld

    Beschreibung

    Typ

    Postback-Ereignisse

    Username

    Benutzername des Abonnenten

    String

    Hinzufügen, Kündigen, Deaktivieren, Passwort

    Email

    E-Mail-Adresse des Abonnenten

    String

    Hinzufügen, Kündigen, Deaktivieren, Passwort

    FirstName

    Vorname des Abonnenten

    String

    Hinzufügen, Kündigen, Deaktivieren

    LastName

    Nachname des Abonnenten

    String

    Hinzufügen, Kündigen, Deaktivieren

    MemberID

    Spezifische Abonnenten-ID, die von Allied Wallet zugewiesen wurde

    String

    Hinzufügen, Kündigen, Deaktivieren, Passwort

    TransactionID

    Transaktion, die die Abonnenten-Änderung ausgelöst hat

    String

    Hinzufügen, Kündigen

    Password

    Passwort des Abonnenten

    String

    Hinzufügen, Kündigen

    GroupID

    ID für die Zahlungsgruppe, die der Seite zugewiesen wurde

    Ganzzahl

    Hinzufügen

    PriceID

    ID für die Zahlung, die der Seite zugewiesen wurde

    Ganzzahl

    Hinzufügen

    Action

    Art des Anfrage-Posts.  Die Werte sind “Hinzufügen”, “Kündigen”, “Deaktivieren”, “Passwort”

    String

    Hinzufügen, Kündigen, Deaktivieren, Passwort

    Key

    Durch Allied Wallet zugewiesener Kodierungsschlüssel

    String

    Hinzufügen, Kündigen, Deaktivieren, Passwort

    Die Felder werden in Name-Wert-Paaren (NVP) übertragen.

    Wenn Ihre Mitgliedschaft-Seite einen Post von Allied Wallet erhält, muss Ihre Seite eine bestätigende Antwort übertragen. Die Antwort ist ein mit Doppelpunkt abgegrenzter String, der den Status und eine Nachricht enthält. Der Status muss “0” sein, wenn der Post fehlgeschlagen ist, und “1”, wenn er erfolgreich war. Wenn er fehlgeschlagen ist, muss die Nachricht eine Fehlerbeschreibung enthalten. Ein Beispiel für einen erfolgreichen Bestätigungsstring sieht folgendermaßen aus:

    1:success

    Ein Beispiel für einen erfolglosen Bestätigungsstring sieht folgendermaßen aus:

    0:user does not exist

    Nach oben

    7. Bestätigung der Postback-Felder

    Bei erfolgreichem Abschluss einer Transaktion und wenn die ConfirmURL geliefert wird, wird ein HTTP POST auf der Seite durchgeführt.

    Feld

    Beschreibung

    Typ

    Amount

    Gesamtbetrag des Warenkorbs oder der Abonnement-Artikel in der Transaktion

    Dezimalzahl

    MerchantReference

    Referenz, die vom
    Händler generiert wurde, um
    den Einkauf auf die
    Allied Wallet-Transaktion zu beziehen.

    String

    PayReferenceID

    Die ID der Transaktion im
    Allied Wallet-Händler-
    system.

    String

    TransactionID

    Die Transaktions-ID in der Allied Wallet-Verkaufsanwendung

    String

    Extra1

    Zusätzliches Formularfeld

    String

    8. Vereinfachte Integrationsschritte

    Um die Integration zu komplettieren, erstellen Sie einfach ein Abonnement- oder ein Warenkorb-Formular, wie nachfolgend veranschaulicht:

    Nach oben

    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>

    Bitte achten Sie darauf, dass die folgenden Werte in die von Allied Wallet gelieferten Werte geändert werden:

    • Merchant ID
    • Site ID
    • Price ID

    Mitgliederverwaltungs-URL

    Sie müssen auf Ihrer Seite eine URL erstellen, die Allied Wallet Postback-Ereignisse annimmt und in Ihrem Mitgliederverwaltungssystem (d.h. .htaccess-Datei oder Datenbank) verarbeitet.

    Erstellen Sie eine Seite, die jeden Wert in einen HTTP-Post übernimmt:

    PHP-Beispiel:

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

    ASP-Beispiel:

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

    Nach oben

    9. Testkarten-Informationen

    Sie können die folgenden Informationen verwenden, um Testtransaktionen auf Ihrer Seite laufen zu lassen, und um Ihren Einkauf in Ihrem Zahlungsgateway zu prüfen. Das ist ein großartiges Werkzeug, um Ihre selbst-integrierte “Fassade” zu prüfen und Ihre Seite vor Fehlern zu bewahren.

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

    Nach oben

    10. Herzlichen Glückwunsch

    Nachdem Sie den in diesem Handbuch detailliert beschriebenen Prozess komplettiert haben, kann Ihre Integration geprüft werden, und Sie sind einen Schritt näher an der Verarbeitung von Zahlungen mit Allied Wallet. Bitte füllen Sie das nachfolgende Formular aus, um die Allied Wallet-Compliance darauf aufmerksam zu machen, dass Sie die Integration Ihrer Allied Wallet WalletPay-APIs abgeschlossen haben.

    [contact-form-7 id="578" title="Integration Status"]

    Nach oben