Allied Wallet WalletPay API( 1.15版 更新日期:2012/2/20)

该手册将指导您完成集成过程,让您的网站和Allied Wallet一体化。 集成包括应用我们的API。 API,即应用程序编程接口,是基于源代码的规则,旨在被软件构件用于各组件间彼此通信。

应用Allied Wallet支付API会让您不必做乏味的收集工作就可以处理在线交易。 插入我们的API编码后,您就可以提交和处理购物车和认购交易。

我们的支付API 调用可向Allied Wallet求助的网页发布(HTTP POST)。 Allied Wallet的POST(发贴)可被应用到任何网络编程语言,甚至可被应用到简单网页。

Allied Wallet让一切变得简单。 但如果您发现API处理过程有些势不可挡,不要担心。 联系代表,我们会免费为您演示集成过程。

  1. 必要信息
  2. 订购
  3. 配置你的网站——表单示例
    1. 购买表格
    2. HTML订购表格
    3. HTML购物车表格
  4. 完成页面
  5. 确认页面
  6. 会员回发
  7. 确认回发字段
  8. 简化的集成步骤
    1. 订购
  9. 测试卡信息
  10. 祝贺您

1.必要信息

在您可向Allied Wallet提交动态交易前,您需要
为您的网站设定Allied Wallet商家帐户。 创建Allied Wallet商家帐户时,我们将向您提供一个商家编号和一个网站编号。这些编号能唯一确定您的网站、客户和付款。如果您还未申请商家帐户,您可以在此处申请:

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

顶部

2. 订购

如果您希望在您的网站上提供订购,您也会需要Allied Wallet配置订购团体。 团体配置将为您的订购设置等级、定价和条款。
例如,您可能有一个$19.95/月的标准订购和一个$99.99/季度的高级订购。 Allied Wallet会配置2个不同的团体,所以您的客户在每个期限末会自动续费。
在Allied Wallet配置您的订购团体后,您将需要发布交易的URL。 HTML表单发布的URL是

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

为了将您的客户的付款发布到Allied Wallet,您必须包括以下这些字段。 请注意必需字段、可选字段以及相应的添加:

字段

描述

类型

必需/可选

商家编号

Allied Wallet提供的商家参考编号。

字符串

必需

网站编号

Allied Wallet为每个网站提供的网站参考编号。

字符串

必需

配送金额

配送总量。
总量字段中必须包括添加到物品采购价上的金额。

必须完成该字段而且完成后,订购将是“0”。

十进制

必需

总量

交易中购物车或订购物品的总量。

该数目将在完成交易前被Allied Wallet验证。注意:
该字段必须完成,
如果您希望允许客户选择他们的订购选项,订购可能为“0”。

十进制

必需

货币编号

您正在接收的货币类型标准编号。

Allied Wallet接受的常见类型是:
• USD – 美元
• GBP – 英镑
• EUR – 欧元
• CAD – 加元

字符串

必需

返回URL

如果交易完成,您希望客户返回的URL。

字符串

必需

确认URL

从Allied Wallet将所有回发送至您的网站上的URL。

字符串

可选

货币编号

您正在接收的货币类型标准编号。

Allied Wallet接受的
常见类型:
• USD – 美元
• GBP – 英镑
• EUR – 欧元
• CAD – 加元

字符串

必需

物品金额[n]

购物车中n个产品
的总金额,
n 代表
购物车中物品数额(从0开始)。

该数额由产品单位售价乘以数量组成。 例如:如果
订购3个产品($5/个),
该字段中的值应该是$15.00。

十进制

购物车必需

物品描述[n]

购物车中n个产品的描述, n 代表购物车中物品数目(从0开始)。

字符串

购物车必需

物品名[n]

购物车中n个产品的量,
n 代表购物车中物品的数目(从0开始)。

数量必须至少为1,否则会以错误返回。

字符串

购物车必需

会员用户名

订购者用户名。

该字段允许您从个人网站控制会员帐户创建。

字符串

会员可选

商家参考

由商家生成将购买与Allied Wallet交易关联的参考。

该值被返回到商家完成页面
查询字符串 (URL)。

字符串

可选

非会员

会员或订购所必需的指标。

若该值 > 0,该用户不会被提示购买订购。

整数

必需

价格编号

由Allied Wallet
为订购价格和条款提供的定价标识。

如果不提供价格编号,Allied Wallet将
允许客户从多个可用编号中选择。

整数

会员必需

要求配送

是否需要配送的指标。

在线订购和服务购买通常无需配送。

若该值 > 0,那么客户将被提示配送信息。

整数

购物车可选

显示用户名密码

是否显示会员信息的指标。

如果该值 > 0,那么将显示该用户名和密码。 用户名和密码将默认显示。

整数

会员必需

顶部

3. 配置你的网站——表单示例

若要处理付款,您需要添加两个网页到您的网站。

首先,您需要添加购买表格页面。 该页面将启动Allied Wallet付款过程。

其次,您需要添加一个购买完成页面。 您的客户在成功完成购买后将返回到该页面。

顶部

3.1. 购买表格

您可以在您的网站页面上包括可向Allied Wallet发布信息的购买表格。 欢迎您使用任何标准网络编程语言(甚至HTML)。您可以构建可重复订购产品的购买表格。以下是一个订购和购物车表格的示例:

顶部

3.2. HTML订购表格

以下表格包括所有订购表格的必需信息。 这会让您的客户在您的网站上购买订购:

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

以上HTML表格包括可选“商家参考”字段 。 该字段可被用于将您的网站应用程序数据与Allied Wallet购买交易数据关联。

您的网站和/或程序设计员在包含合适的表格后将需要用一个匹配您的网站的前端购买表格装备您的网站。

您可在表格中包括附加字段以提供会员订购团体编号和定价编号。 查看最后部分的字段参考。

顶部

3.3.HTML购物车表格

您的购物车表单可被包括在简单HTML中用于您的网站上单个物品的购买。 下列表格包括购买单个物品必需的脚本:

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

以上表格将提交一个购买单个物品(定价$10.00+ 配送费$7.99)的交易。 查看总量=物品数额+配送数额的实现方式。

顶部

4. 完成页面

‘完成页面’可成为您网站上的任何一页。 该页面会欢迎客户在完成购买后返回。 在这里,您可以根据他们的产品或订购提供任何附加信息(即配送信息、订购激活等等)。

‘完成页面’的URL由您的页面或返回URL字段中的应用程序供应。

在客户完成购买后, Allied Wallet会载入将包含交易编号和商家参考的指定 ‘完成页面’ 。 例如,如果您在购买表格中提供了以下返回URL:

http://oursite.com/complete.html

Allied Wallet会完成交易并让客户返回至
以下URL:

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

顶部

5. 确认页面

在客户成功完成了交易后,Allied Wallet会将交易明细公布到您网站上的指定页面。 该页面应验证并在您的数据库中存储交易信息。 ‘确定页面’应提供Allied Wallet和您的应用程序之间的交流。 该页面不必提供用户功能。

Allied Wallet 7 版本. 1.14

‘确定页面’的URL在您的网站或应用程序上必须是有效页面,然后才被置于确定URL字段中。 如果在您的网站上URL未被提供或未指向一个有效页面,那么将无法成功完成交易。 如果您不希望保存交易明细和信息,该页面可能是一个空白HTML页面。

发布到 ‘确认页面’ 的信息被发布为由和号(&)分开的标准网页发布名值对(NVP) 。确认公告的一个示例为:

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

顶部

6. 会员回发

如果您的网站是一个订购或会员网站,那么您可选择将Allied Wallet公告订购者/会员事件信息登在您网站上的指定页面。 如果您希望收到会员回发事件,您必须用回发URL提供Allied Wallet商家支持。Allied Wallet在收到回发URL后会向您提供回发密匙以验证Allied Wallet回发事件。

发布到您的网站的订购者事件可包括:

  • 添加
  • 一个新客户已完成一个订购
  • 已为您的网站创建了一个帐户
  • 取消

    • 一个客户已取消了您的网站的订购
  • 停用
    • 您可通过商家终端使客户订购无效
  • 密码
    • 一个客户的订购帐户密码已更改。
  • 下列字段由Allied Wallet在一个会员回发事件中发送。

    字段

    描述

    类型

    回发事件

    用户名

    订购者用户名

    字符串

    添加, 取消,停用, 密码

    电子邮件

    订购者电子邮件地址

    字符串

    添加, 取消,停用, 密码

    订购者名

    字符串

    添加,取消,停用

    订购者姓

    字符串

    添加,取消,停用

    会员编号

    Allied Wallet指定的订购者唯一编号

    字符串

    添加, 取消,停用, 密码

    交易编码

    提示订购者更改的交易

    字符串

    添加,取消

    密码

    订购者密码

    字符串

    添加,取消

    团体编号

    被指向该网站的支付团体编号

    整数

    添加

    价格编号

    指向该网站的付款编号

    整数

    添加

    操作

    请求公告类型。值为: “添加”、 “取消l”、 “停用”、 “密码”

    字符串

    添加, 取消,停用, 密码

    密匙

    Allied Wallet指定的密匙

    字符串

    添加, 取消,停用, 密码

    字段在名值对(NVP)中被传送。

    在您的会员页面收到来自Allied Wallet的公告后,您的页面必须传送一则确认回复。 该回复是一则由冒号界定的字符串,其中包含状态和一则消息。 如果发布失败,状态一定为 “0” ;如果成功,则为 “1” 。 如果失败,消息一定包含错误描述。 一个成功确认字符串示例为:

    1:success

    一个失败确认字符串示例为:

    0:user does not exist

    顶部

    7. 确认回发字段

    成功完成交易且提供确认URL后, 会执行HTTP POST至页面。

    字段

    描述

    类型

    数量

    交易中购物车或订购物品总量

    十进制

    商家参考

    由商家生成
    将购买与
    Allied Wallet交易
    关联的参考。

    字符串

    支付参考编号

    Allied Wallet商家系统中
    的交易编号。

    字符串

    交易编号

    Allied Wallet销售应用程序中的交易编号。

    字符串

    其它1

    其它表格字段

    字符串

    8. 简化的集成步骤

    若要完成集成,仅需创建一个订购表或一个购物车表,示例如下:

    顶部

    8.1. 订购

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

    请注意将以下值更改为由Allied Wallet提供的值:

    • 商家编号
    • 网站编号
    • 价格编号

    会员管理URL

    您必须在您的网站上创建一个URL,这可以送去Allied Wallet回发事件并在您的会员管理系统上处理。(即 .htaccess文件或数据库)。

    在一个http公告中取每个值创建一个页面:

    PHP示例:

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

    ASP示例:

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

    顶部

    9. 测试卡信息

    您可使用以下信息在您的网站上运行测试交易并在您的支付网关内评价您的购买。 这是一款评价您自己整合的店面来避免网站出错的极好工具。

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

    顶部

    10. 祝贺您

    在您完成该手册中详细论述的过程后,您的集成已准备好评价,您离用Allied Wallet处理付款仅有一步之遥。 填写下方表格以提醒Allied Wallet您已遵从Allied Wallet完成个人Allied Wallet QuickPay(快捷付款) API的集成。

    [contact-form-7 id="578" title="集成状态"]

    顶部