API WalletPay (Ver 1.15 atualização de 20/02/2012)

Este manual guiará você pelo processo de integração que permite seu site e a Allied Wallet funcionem em conjunto. A integração envolve implementar nossas APIs. APIs ou interfaces de programação de aplicativo são especificações com base em código fonte destinadas a serem utilizadas por componentes de software que permitem a comunicação dos componentes.

A implementação da API de pagamento da Allied Wallet permitirá que você processe suas transações online sem muito trabalho tedioso. Depois de inserir nossos códigos de API você poderá enviar e processar transações de carrinho de compras e assinatura.

Nossa API de pagamentos evoca um HTTP POST que inicia solicitações para a Allied Wallet. As PUBLICAÇÕES da Allied Wallet podem ser implementadas em qualquer linguagem de programação da Web ou até mesmo uma página da Web simples.

A Allied Wallet facilita tudo. Se descobrir que o processo da API é muito complexo, não se preocupe. Entre em contato com um representante e executaremos a integração para você sem NENHUMA TAXA ADICIONAL.

  1. Informações obrigatórias
  2. Assinaturas
  3. Configurando seu site: formulários de exemplo
    1. Formulário de compra
    2. Formulário de assinatura em HTML
    3. Formulário de carrinho de compras em HTML
  4. Página completa
  5. Página de confirmação
  6. Postback de associação
  7. Campos de confirmação de postback
  8. Etapas de integração simplificada
    1. Assinatura
  9. Informações de cartão de teste
  10. Parabéns

1. Informações obrigatórias

Antes de poder enviar transações ao vivo para a Allied Wallet, você precisará de uma
conta de comerciante da Allied Wallet para o seu site. Depois de estabelecer uma conta de comerciante da Allied Wallet, você receberá uma ID de comerciante e uma ID do site. Essas identificações exclusivas identificam seus sites, clientes e pagamentos. Se você não tiver solicitado uma conta de comerciante, é possível fazer isso em:

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

Acima

2. Assinaturas

Se você deseja oferecer assinaturas em seu site, também será necessário o Allied Wallet para configurar seus grupos de assinatura. A configuração do grupo definirá os níveis, preços e prazos para as suas assinaturas.
Por exemplo, você pode ter uma assinatura padrão que custa $ 19,95 por mês e uma assinatura premium, que custa $ 99,99 por trimestre. A Allied Wallet configurará dois grupos diferentes, de modo que seus clientes serão cobrados automaticamente no final de cada período.
Depois da Allied Wallet configurar seus grupos de assinatura, você precisará do URL para LANÇAR transações. O URL para os lançamentos de formulário em HTML é:

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

Para LANÇAR os pagamentos de clientes na Allied Wallet, é necessário incluir estes campos. Observe os campos obrigatórios, opcionais e adicione apropriadamente:

Campo

Descrição

Tipo

Obrigatório/Opcional

IDComerciante

ID de referência do comerciante fornecida pela Allied Wallet.

Cadeia

Obrigatório

IDSite

Uma ID de referência de site fornecida pela Allied Wallet para cada site.

Cadeia

Obrigatório

QuantiaEnvio

A quantia total para envio. Esta quantia deve
ser adicionada ao preço de compra do item no campo Quantiaenvio.

Este campo deve ser preenchido e será “0″ para compras de assinaturas.

Decimal

Obrigatório

QuantiaTotal

A quantia total dos itens de carrinho de compras ou assinatura na transação.

Este número será verificado pela Allied Wallet antes da transação ser concluída. OBSERVAÇÃO: este
campo deve ser preenchido
e pode ser “0” para compras de assinatura se você deseja permitir que seus clientes selecionem sua opção de assinatura.

Decimal

Obrigatório

IDMoeda

ID padrão para o tipo de moeda coletada.

Os tipos mais comuns aceitos pela Allied Wallet são.:
• USD – dólares americanos
• GBP – libras esterlinas
• EUR – Euros
• CAD – dólares canadenses
dólares

Cadeia

Obrigatório

URLRetorno

O URL para o qual você deseja que o cliente volte depois de concluir sua compra.

Cadeia

Obrigatório

URLConfirmação

URL em seu site que pega todos os postbacks da Allied Wallet e os envia para este URL.

Cadeia

Opcional

IDMoeda

ID padrão para o tipo de moeda coletada.

Os tipos comuns
aceitos pela Allied Wallet são:
• USD – dólares americanos
• GBP – libras esterlinas
• EUR – Euros
• CAD – dólares canadenses

Cadeia

Obrigatório

QuantiaItem[n]

O valor total do produto número n
no carrinho de compras
sendo que n representa
o número de itens no carrinho de compras, começando com uma quantidade 0.

Essa quantia consiste no custo unitário do produto multiplicado pela quantidade. Por exemplo: se um produto
custa $5 e três são pedidos,
15,00 deve ser o valor nesta campo.

Decimal

Obrigatório para carrinho de compras

DescItem[n]

A descrição do produto de número n no carrinho de compras, n representa o número dos itens no carrinho de compras, começando com 0.

Cadeia

Obrigatório para carrinho de compras

NomeItem[n]

A quantidade do produto de número n
no carrinho de compras, n representa o número de itens no carrinho de compras a partir de 0.

A quantidade deve ser no mínimo 1 ou retornará um erro.

Cadeia

Obrigatório para carrinho de compras

NomedousuárioMembro

Nome de usuário do assinante.

Este campo permite que você controle a criação de conta de assinatura de seu site.

String

Opcional para associação

ReferênciaComerciante

Referência gerada pelo comerciante para correlacionar a compra à
transação da Allied Wallet.

Este valor é retornado para a cadeia de caracteres de consulta completa
do comerciante (URL).

String

Opcional

SemAssociação

Indicador se uma associação ou assinatura é necessária.

Se esse valor for > 0, o usuário não será solicitado a comprar uma assinatura.

Nº inteiro

Obrigatório

IDPreço

Identificador de preços
fornecido pela Allied Wallet por um preço e um período de assinatura.

Se a IDPreço não for fornecida, a Allied Wallet
permitirá que o cliente escolha entre as disponíveis.

Nº inteiro

Obrigatório para associação

ExigirEnvio

Indica se o transporte é necessário.

Normalmente, as compras de assinatura online e de serviços não exigem transporte.

Se este valor for > 0, então o cliente será solicitado a inserir informações de envio.

Nº inteiro

Opcional para carrinho de compras

MostrarSenhaNomeUsuário

Indica se informações de membro são exibidas.

Se este valor for > 0, então o nome de usuário e a senha serão exibidos. O nome do usuário e a senha serão exibidos por padrão.

Nº inteiro

Obrigatório para associação

Acima

3. Configurando seu site: formulários de exemplo

Para processar os pagamentos, você precisa adicionar duas páginas da Web ao seu site.

Primeiro, você precisa adicionar a página do formulário de compra. Esta página iniciará o processo de pagamento da Allied Wallet.

Em seguida, você precisa adicionar uma página de compra concluída. Seus clientes serão enviados de volta para esta página após concluir com sucesso uma compra.

Acima

3.1 Formulário de compra

Você pode incluir o formulário de compra em quaisquer páginas em seu site que é/são capazes de enviar informações à Allied Wallet. Você está convidado a usar qualquer linguagem de programação Web padrão, até mesmo HTML. Você pode construir os formulários de compra para permitir assinaturas e produtos recorrentes. Eis os exemplos de formulário de assinaturas e carrinho de compras:

Acima

3.2 Formulário de assinatura em HTML

O formulário a seguir inclui todas as informações necessárias que você vai precisar para incluir um formulário de assinatura. Isso permitirá que os clientes comprem assinaturas em seu 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>

O formulário em HTML acima inclui o campo “ReferênciaComerciante”, que é opcional. Este campo pode ser usado para correlacionar dados de transações de compra da Allied Wallet com os dados de seu aplicativo de site.

Depois de incluir os formulários apropriados, o seu site e/ou o programador terá de fornecer o seu site com um formulário de compra de front-end compatível ao seu site.

Você pode incluir campos adicionais no formulário para fornecer IDs grupo e IDs de preços de assinatura. Consulte a referência de campo na última seção.

Acima

3.3. Formulário de carrinho de compras em HTML

Seu formulário de carrinho de compras pode ser incluído em compras simples em HTML para compras de único item em seu site. O formulário a seguir inclui o script necessário para compras de um item:

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

O formulário acima enviará uma transação para comprar um único item por $ 10,00 mais $ 7,99 de envio. Consulte como QuantiaTotal é igual a QuantiaItem + QuantiaEnvio.

Acima

4. Página completa

A “Página completa” pode ser qualquer página em seu site. A página vai acolher o cliente de volta depois de completar a sua compra. Aqui você pode fornecer qualquer informação adicional sobre o produto ou compra de assinatura (ou seja, informações de envio, ativação da assinatura etc.).

O URL da “Página completa” fornecido pela sua página ou aplicativo no campo URLRetorno.

Depois de um cliente finalizar a compra, a Allied Wallet carregará a “Página completa” designada, além de fornecer uma ID de transação e referência de comerciante fornecida no formulário de compra. Por exemplo, se você forneceu o seguinte URLRetorno em seu formulário de compra:

http://oursite.com/complete.html

A Allied Wallet completaria a transação e retornaria o cliente para o
seguinte URL:

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

Acima

5. Página de confirmação

Após um cliente concluir com êxito uma transação, a Allied Wallet publicará os detalhes da transação em uma página designada em seu site. Esta página deve validar e armazenar as informações de transação em seu banco de dados. A “Página de confirmação” deve fornecer comunicação entre a Allied Wallet e seu aplicativo. A página não precisa fornecer funcionalidade ao usuário.

Allied Wallet 7 Rev. 1.14

O URL da “Página de confirmação” deve ser uma página válida em seu site ou aplicativo, em seguida, deve ser colocado no campo URLConfirmação. Se um URL não é fornecido ou não apontar para uma página válida em seu site, a transação não será concluída com êxito. Se você não deseja salvar os detalhes e as informações da transação, a página pode ser uma página HTML em branco.

As informações publicadas na “Página de confirmação” são publicadas como pares de nome-valor (NVP) de publicação em HTTP separados por E comercial (&). Um exemplo de uma mensagem de confirmação exibe:

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

Acima

6. Postback de associação

Se o seu site é um site de inscrição ou a adesão, você pode optar por ter informações de publicação de evento de assinatura/associação da Allied Wallet em uma página designada de seu site. Se você deseja receber eventos de postback de associação, é necessário fornecer suporte de comerciante da Allied Wallet com um URL de postback. Depois de receber o URL de publicação, a Allied Wallet fornecerá uma chave de postback para validar eventos de postback da Allied Wallet.

Os eventos de assinante publicados em seu site podem incluir:

  • Adicionar
  • Um novo cliente completou uma compra de assinatura
  • Uma conta é criada para seu site
  • Cancelar

    • Um cliente cancelou sua inscrição do seu site
  • Desativar
    • Você desativou uma assinatura do cliente por terminal de comerciante
  • Senha
    • Uma senha da conta de assinatura do cliente foi alterada.
  • Os seguintes campos são transmitidos pela Allied Wallet em um evento de postback de associação.

    Campo

    Descrição

    Tipo

    Eventos de postback

    Nomedousuário

    Nome do assinante

    Cadeia

    Adicionar, Cancelar, Desativar, Senha

    Email

    Endereço de e-mail do assinante

    Cadeia

    Adicionar, Cancelar, Desativar, Senha

    PrimeiroNome

    Nome do assinante

    Cadeia

    Adicionar, Cancelar, Desativar

    Sobrenome

    Sobrenome do assinante

    Cadeia

    Adicionar, Cancelar, Desativar

    IDMembro

    ID exclusiva do assinante designada pela Allied Wallet

    Cadeia

    Adicionar, Cancelar, Desativar, Senha

    IDTransação

    A transação que solicitou a alteração do assinante

    Cadeia

    Adicionar, Cancelar

    Senha

    Senha do assinante

    Cadeia

    Adicionar, Cancelar

    IDGrupo

    ID de grupo de pagamentos designada para o site

    Nº inteiro

    Adicionar

    IDPreço

    ID do pagamento designada para o site

    Nº inteiro

    Adicionar

    Ação

    Tipo de publicação de solicitação. Os valores são “Adicionar”, “Cancelar”, “Desativar”, “Senha”

    Cadeia

    Adicionar, Cancelar, Desativar, Senha

    Chave

    Chave de criptografia designada pela Allied Wallet

    Cadeia

    Adicionar, Cancelar, Desativar, Senha

    Os campos são transmitidos em pares de nome-valor (NVP).

    Depois que sua página de associação recebe uma publicação da Allied Wallet, sua página deve transmitir uma resposta de reconhecimento. A resposta é uma cadeia de caracteres delimitada por vírgulas, com um status e uma mensagem. O estado deve ser “0″ se o post falhou e “1″ se ele foi bem sucedido. Em caso de falha, a mensagem deve conter uma descrição do erro. Um exemplo de uma cadeia de caracteres confirmada apresenta:

    1:success

    Um exemplo de cadeia de caracteres não confirmada apresenta:

    0:user does not exist

    Acima

    7. Campos de confirmação de postback

    Após a conclusão de uma transação e se o URLConfirmação for fornecido, uma publicação em HTTP é efetuada na página.

    Campo

    Descrição

    Tipo

    Quantia

    Quantia total do carrinho de compras ou de itens de assinatura na transação

    Decimal

    ReferênciaComerciante

    Referência gerada pelo
    comerciante para correlacionar
    a compra à transação
    da Allied Wallet.

    Cadeia

    IDReferênciaPagamento

    A ID da transação no
    sistema de comerciante da
    Allied Wallet.

    Cadeia

    IDTransação

    A ID da transação no aplicativo de vendas da Allied Wallet

    Cadeia

    Extra1

    Campo de formulário extra

    Cadeia

    8. Etapas de integração simplificadas

    Para completar a integração, crie um formulário de inscrição ou um formulário de assinatura ou de carrinho de compras, como exemplificado abaixo:

    Acima

    8.1.Assinatura:

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

    Altere os seguintes valores para os valores fornecidos pela Allied Wallet:

    • ID de comerciante
    • ID do site
    • ID de preço

    URL de gerenciamento de membro

    Você deve criar um URL em seu site que pega eventos de postback da Allied Wallet e os processa em seu sistema de gerenciamento de membro (ou seja, o arquivo .htaccess ou o banco de dados).

    Crie uma página que pega cada valor em uma publicação em http:

    Exemplo em PHP:

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

    Exemplo em ASP:

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

    Acima

    9. Integração com carrinho de compras

    Você pode usar as seguintes informações para executar transações de teste em seu site e analisar sua compra no portal de pagamento. Esta é uma ótima ferramenta para analisar sua frente de loja autointegrada para proteger seu site de erros.

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

    Acima

    10. Parabéns

    Depois de concluir o processo conforme detalhado neste manual, a sua integração está pronta para revisão e você está a um passo do processamento de pagamentos com a Allied Wallet. Preencha o formulário abaixo para alertar a Allied Wallet que você concluiu a integração de suas APIs de QuickPay da Allied Wallet.

    [contact-form-7 id="578" title="Status da integração"]

    Acima