Integração de Pagamento


Este manual possui instruções básicas para a integração das lojas virtuais ao Oxipag. O entendimento deste documento requer algum conhecimento sobre HTML e lógica de programação. Integrar uma loja virtual ao Oxipag não requer a utilização de uma linguagem de programação específica, visto que toda a comunicação entre o integrador e o Oxipag ocorre via POST e XML. Para processar os pagamentos, o site parceiro deve redirecionar o fluxo HTTP ao Oxipag através de um simples POST contendo parâmetros para o processamento do pedido.


Exemplo de código HTML de formulário POST para venda de 1 produto, somente com campos obrigatórios:


<form action="https://www.oxipag.com/checkout/" method="post">
<input name="vendedor_email" type="hidden" value="[email protected]">
<input name="vendedor_token" type="hidden" value="seu_token_de_integracao">
<input name="item_titulo_1" type="hidden" value="GPS veicular">
<input name="item_quantidade_1" type="hidden" value="1">
<input name="item_preco_1" type="hidden" value="18000" >
<input name="item_titulo_2" type="hidden" value="Televisor LCD 23 Polegadas">
<input name="item_quantidade_2" type="hidden" value="1">
<input name="item_preco_2" type="hidden" value="56000" >
<input name="frete" type="hidden" value="6000">
</form>

 

Tabela de parâmetros obrigatórios:

Importante: A letra "X" nos parâmetros que contém o prefixo "item" representa o índice do produto, ou seja, para o primeiro produto do pedido, "X" seria substituído por 1, o segundo por 2 e assim sucessivamente.

 

NomeFormatoDescrição
vendedor_email Texto E-mail da loja cadastrada no Pagamento Digital.
vendedor_token Texto Token de integração, que pode ser obtido na página de visualização dos seus dados cadastrais no Oxipag.
item_codigo_X Texto Código que identifica o produto em sua loja.
item_titulo_X Texto Descrição ou nome do(s) produto comprado. Será visualizada pelo cliente.
item_quantidade_X Número inteiro Quantidade comprada deste produto.
item_precoBRL_X Preço Valor unitário do produto, representado por um número inteiro cujos dois ultimos digitos são considerados como os centavos. Exemplo 1.286,87 é representado como 128687; 1,00 é representado como 100
frete Numérico Valor total do frete.

 

Informando o preço BIZ no POST

Caso um item possua um preço em moeda BIZ, o mesmo deve ser informado no post acrescentando-se o seguinte parâmetro ao item:

item_precoBIZ_X

Produtos que aceitem somente a moeda Real(R$) como pagamento devem omitir tal parâmetro. A exemplo do que ocorre com a moeda Real(R$), o preço em moeda Biz deve ser informado como um valor inteiro, cujos dois ultimos digitos são considerados centavos. Exemplo 1.286,87 é representado como 128687; 1,00 é representado como 100.

Confira abaixo um exemplo de POST contendo itens que aceitem a moeda biz como forma de pagamento:

<input name="vendedor_email" type="hidden" value="[email protected]">
<input name="vendedor_token" type="hidden" value="seu_token_de_integracao">
<input name="item_titulo_1" type="hidden" value="GPS veicular">
<input name="item_quantidade_1" type="hidden" value="1">
<input name="item_precoBRL_1" type="hidden" value="18000" >
<input name="item_precoBIZ_1" type="hidden" value="17000" >
<input name="frete" type="hidden" value="6000">

 

 

Campos opcionais do POST

Os campos opcionais referentes aos dados de seu cliente (prefixo "cliente_") serão informados pelo próprio, no ambiente do Oxipag, através de um formulário de cadastro, no momento em que estiver sendo efetuado o pagamento. Caso tais parâmetros sejam informados no post pela loja virtual, o formulário de cadastro do comprador no Oxipag será automaticamente preenchido.

 

Veja na tabela abaixo a descrição dos campos opcionais.

 

NomeFormatoDescrição
referencia_pedido Texto Código do pedido atribuído pela loja.
cliente_email Texto contendo e-mail valido E-mail do cliente que fez a compra.
cliente_nome Texto Primeiro nome do cliente
cliente_sobrenome Texto Sobrenome do cliente
cliente_cpf Texto contendo CPF valido CPF do cliente que fez a compra, sem hífens ou pontos.
cliente_sexo Texto M ou F para representar o sexo do cliente
cliente_nascimento Texto Data de nascimento do cliente
cliente_telefone_res Texto Telefone do cliente que fez a compra.
cliente_telefone_cel Texto Telefone celular do cliente
cilente_logradouro Texto Rua do cliente
cliente_numero_res Texto Numero da residencia do cliente
cliente_complemento Texto Complementado do endereço do cliente
cliente_bairro Texto Bairro do cliente
cliente_cidade Texto Cidade do cliente
cliente_uf Texto Estado do cliente, representado pela sigla do estado
cliente_cep Alfa-Numérico CEP do cliente que fez a compra.
url_retorno Alfa-Numérico URL completa para onde seu cliente será direcionado depois da finalização do pedido no Pagamento Digital.
cliente_razao_social Alfa-Numérico Razão social do cliente.
cliente_cnpj Numérico CNPJ do cliente.

 

 Confira abaixo um exemplo de POST com todos os parâmetros:

<input name="vendedor_email" type="hidden" value="[email protected]">
<input name="vendedor_token" type="hidden" value="seu_token_de_integracao">
<input name="item_titulo_1" type="hidden" value="GPS veicular">
<input name="item_quantidade_1" type="hidden" value="1">
<input name="item_precoBRL_1" type="hidden" value="18000" >
<input name="item_precoBIZ_1" type="hidden" value="17000" >
<input name="frete" type="hidden" value="6000">
<input name="vendedor_email" type="hidden" value="[email protected]seuemail.com.br">
<input name="vendedor_token" type="hidden" value="seu_token_de_integracao">
<input name="item_titulo_1" type="hidden" value="GPS veicular">
<input name="item_quantidade_1" type="hidden" value="1">
<input name="item_precoBRL_1" type="hidden" value="18000" >
<input name="item_precoBIZ_1" type="hidden" value="17000" >
<input name="frete" type="hidden" value="6000">
<input name="cliente_email" type="hidden" value="cliente[email protected]">
<input name="cliente_nome" type="hidden" value="João">
<input name="cliente_sobrenome" type="hidden" value="Comprador">
<input name="cliente_cpf" type="hidden" value="58452485422">
<input name="client_sexo" type="hidden" value="M" >
<input name="cliente_nascimento" type="hidden" value="12/10/1985" >
<input name="cliente_telefone_res" type="hidden" value="48-54854584">
<input name="cliente_telefone_cel" type="hidden" value="48-99934584">
<input name="cliente_logradouro" type="hidden" value="Rua Francisco de Paula Seára">
<input name="cliente_numero_res" type="hidden" value="487">
<input name="cliente_complemento" type="hidden" value="casa">
<input name="cliente_bairro" type="hidden" value="Centro">
<input name="cliente_cidade" type="hidden" value="Balneário Camboriu" >
<input name="cliente_uf" type="hidden" value="SC" >
<input name="cliente_cep" type="hidden" value="88300000">
<input name="url_retorno" type="hidden" value="http://www.sualoja.com.br/retorno">