Escolar Documentos
Profissional Documentos
Cultura Documentos
ndice
1 Introduo.........................................................................................................................................4 2 Termos e Abreviaes.......................................................................................................................4 3 Processo de Compra.........................................................................................................................5 3.1 Transaes Diretas (aprovao via WebService)......................................................................5 3.2 Transaes Indiretas (aprovao via Redirect).........................................................................5 3.3 Outros modelos sugeridos para integrao...............................................................................6 4 Funcionalidades e Diferenciais do Sistema......................................................................................7 5 Dados para a Integrao...................................................................................................................7 5.1 Integrao para realizao de Pagamento.................................................................................7 5.2 Integrao para realizao de com mltiplos cartes de crdito............................................14 5.3 Ativao de status e notificao por campainha.....................................................................21 5.4 Consulta do status do pedido..................................................................................................22 5.5 Captura de transaes.............................................................................................................24 5.6 Cancelamento de transaes...................................................................................................26 6 Anexos............................................................................................................................................27 6.1 Forma de Pagamento..............................................................................................................27 6.1.1 Cartes de Crdito...........................................................................................................27 6.1.2 Bancos e Boletos.............................................................................................................29 6.1.3 Intermedirios Financeiros..............................................................................................29 6.2 Idioma.....................................................................................................................................29 6.3 Origem Transao...................................................................................................................30 6.4 Status das transaes...............................................................................................................30 6.5 Tipo Cliente.............................................................................................................................31 6.6 Tipo Telefone..........................................................................................................................31
1 Introduo
Este documento visa estabelecer os meios de integrao com o SuperPay, via WebService, para utilizao dos servios de pagamento, cancelamento, captura e consulta de transaes.
2 Termos e Abreviaes
SuperPay: Gateway de Pagamento criado pela ERNET, com o intuito de tornar as transaes rpidas e seguras. Cielo: Adquirente de cartes de Crdito. Redecard: Adquirente de cartes de Crdito.
3 Processo de Compra
3.1 Transaes Diretas (aprovao via WebService)
Para transaes no modelo WebService (verificar meios de pagamento que possibilitam essa modalidade), o SuperPay permite o seguinte fluxo de pagamento.
Existe ainda a opo de realizao das transaes via central telefnica, essa opo permite que uma URA, via WebService, se comunique com o SuperPay para realizar transaes.
Guia de Integrao SuperPay 2.5 Abaixo so descritos os campos dos objetos acima apresentados, sugere-se preencher todos os campos antes do envio da transao. Os campos no utilizados devero ser enviados em branco.
Campo Descrio Tipo Tamanho
numeroTransacao
Valor nico que identifica cada transao dentro do SuperPay. Dever ser a referncia tambm Numrico. So aceitos dentro do sistema do cliente., Esse apenas valores inteiros valor ser devolvido em todos os neste campo eventos de consulta e atualizao de status. Valor fornecido pela ERNET para identificar o estabelecimento junto ao SuperPay
At 8 dgitos
codigoEstabelecimento
Numrico, so aceitos Seguir apenas enviado valores inteiros neste pela ERNET campo
valor
codigoFormaPagamento
Numrico. So aceitos Valor contendo o cdigo da forma de apenas os valores pagamento. Verificar tabela de inteiros constantes na cdigos tabela de formas de na Seo 6 pagamento Valor da transao. Deve ser enviado Numrico., So aceitos segundo o seguinte formato, para apenas valores inteiros transao de R$ 1,00, deve-se enviar neste campo. 100. Dessa forma, deve-se sempre Considera-se sempre enviar o valor sem vrgula ou ponto, e as duas ltimas casas os dois ltimos dgitos do valor sero decimais como considerados como centavos centavos Valor do desconto da transao. O valor total enviado para a operadora e/ou banco, considerar o desconto, ou seja, se o valor enviado for de R$ Numrico. So aceitos 10,00 e o desconto for de R$ 1,00, apenas valores inteiros ser enviado valor de cobrana de R$ neste campo. 9,00 para a instituio financeira. Considera-se sempre Esse campo obrigatrio e em caso as duas ltimas casas de no haver descontos, deve ser decimais como enviado o valor 0. Deve ser enviado centavos segundo o seguinte formato, para transao de R$ 1,00, deve-se enviar 100. Valor da taxa de embarque e/ou Numrico. So aceitos servio. O valor enviado neste campo apenas valores inteiros ser somado ao valor da transao. neste campo. Isso , se a transao possuir um Considera-se sempre valor as duas ltimas casas de R$ 10,00 e a taxa de embarque for decimais como de R$ 1,00 o valor total cobrado ser centavos R$ 11,00 Quantidade de parcelas da transao. Deve-se verificar se a forma de Numrico. So aceitos pagamento suporta parcelamento. apenas valores inteiros Caso no suporte, ser indiferente o neste campo valor enviado neste campo. Nome do titular do carto de crdito, sem acentos. Deve ser enviado Valores Alfa Numricos exatamente o nome descrito no carto de crdito.
valor
At 10 dgitos
valorDesconto
At 10 dgitos
taxaEmbarque
At 10 dgitos
parcelas
At 2 dgitos
nomeTitularCartaoCredito
At 16 caracteres
numeroCartaoCredito
At 22 caracteres
codigoSeguranca
At 4 caracteres
dataValidadeCartao
vencimentoBoleto
urlCampainha
URL da Campainha. Essa url ser sempre acionada quando o status do pedido mudar. Aps a chamada da URL de Campainha o sistema do Valores Alfa Numricos cliente dever, obrigatoriamente realizar uma consulta ao mtodo consultaTransacaoEspecifica O SuperPay redirecionar o cliente para esta URL, em caso de Valores Alfa Numricos transaes do tipo redirects, quando a transao for aprovada.
At 250 caracteres
urlRedirecionamentoPago
At 250 caracteres
O SuperPay redirecionar o cliente para est URL, em caso de urlRedirecionamentoNaoPago Valores Alfa Numricos transaes do tipo redirects, quando a transao no for aprovada IP O nmero do IP do cliente, esta Valores Alfa informao muito importante no Numricos, no formato caso de sistemas de anlise de xxx.xxx.xxx.xxx fraudes Numrico., So aceitos Valor contendo o cdigo do idioma. apenas os valores Verificar tabela de cdigos na Seo 6 inteiros constantes na tabela de idiomas
At 250 caracteres
At 15 caracteres
Idioma
origemTransacao
Numrico. So aceitos Seguir valores Valor contendo o cdigo do ambiente apenas os valores estipulados na de origem da transao. Verificar inteiros constantes na tabela de origens de tabela de cdigos na Seo 6 tabela de origens das transaes transaes Campo Livre 1 Campo Livre 2 Campo Livre 3 Campo Livre 4 Campo Livre 5 Informaes de endereos, telefones de entrega e cobrana. Essas informaes so importantes para o caso de anlise de fraudes Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico At 16 caracteres At 16 caracteres At 16 caracteres At 16 caracteres At 16 caracteres
dadosUsuarioTransacao
DadosUsuarioTransac Limitado a estrutura aoCompletaWS do objeto DadosUsuarioT Estrutura do objeto ansa descrito abaixo caoCompletaWS
itensDoPedido
Conforme descrito na tabela acima, o objeto TransacaoCompletaWS possui dois objetos complexos em sua estrutura, so eles dadosUsuarioTransacao e itensDoPedido, abaixo a estrutura desses objetos so descritas abaixo: Objeto dadosUsuarioTransacao Todos os campos deste objeto so obrigatrios quando o estabelecimento utiliza sistemas de anlise de risco / fraude.
Campo Descrio Cdigo do Cliente do estabelecimento. Deve ser um identificador nico por cliente, e deve ser reenviado o mesmo nmero caso cliente volte a comprar no sistema do estabelecimento Tipo do cliente, que identifica se pessoa fsica ou pessoa jurdica. Verificar tabela de cdigos na Seo 6 Nome do comprador Documento do comprador Documento 2 do comprador Sexo do comprador M Masculino e F Feminino Data de Nascimento do comprador, no formato dd/mm/yyyy Telefone do comprador sem espaos ou traos DDD do comprador DDI do comprador telefone telefone do do Tipo Tamanho
codigoCliente
Alfa Numrico
20 caracteres
tipoCliente
Numrico
1 dgito
Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico, considerando o formato dd/mm/yyyy
dataNascimentoComprador
10 caracteres
10
telefoneAdicionalComprador
Alfa Numrico
At 10 caracteres
dddAdicionalComprador
Alfa Numrico
At 3 caracteres
ddiAdicionalComprador
Alfa Numrico
At 3 caracteres
codigoTipoTelefoneAdicionalComprador
Numrico
1 dgito
Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico
Logradouro do Comprador Nmero do logradouro do comprador Bairro do Logradouro do comprador Complemento do Logradouro do comprador Cidade do Logradouro do comprador Estado do Logradouro do comprador CEP do comprador. Deve ser enviado sem traos ou espaos Logradouro de entrega Nmero do logradouro de entrega Bairro do Logradouro de entrega Complemento Logradouro do comprador do
cidadeEnderecoComprador
Alfa Numrico
At 50 caracteres
estadoEnderecoComprador
Alfa Numrico
At 2 caracteres
complementoEnderecoEntrega
Alfa Numrico
At 50 caracteres
cidadeEnderecoEntrega estadoEnderecoEntrega
At 50 caracteres At 2 caracteres
11
cepEnderecoEntrega
Alfa Numrico
At 10 caracteres
codigoTipoTelefoneEntrega
Numrico
1 dgito
telefoneAdicionalEntrega
Alfa Numrico
At 10 caracteres
dddAdicionalEntrega
At 3 caracteres
ddiAdicionalEntrega
At 3 caracteres
codigoTipoTelefoneAdicionalEntrega
Numrico
1 dgito
Objeto itensDoPedido Todos os campos deste objeto so obrigatrios quando o estabelecimento utiliza sistemas de anlise de risco / fraude.
Campo codigoProduto Descrio Deve ser um identificador nico por produto, e deve ser reenviado caso o produto volte a ser comprado Cdigo da Categoria. Deve ser um identificador nico por categoria, e deve ser reenviado caso o produto volte a ser comprado Nome do produto Quantidade do produto Valor unitrio do produto. Deve ser enviado segundo o seguinte formato: para transao de R$ 1,00, deve-se enviar 100. Dessa forma, devese sempre enviar o valor sem vrgula ou ponto, e os dois ltimos dgitos do valor sero Tipo Alfa Numrico Tamanho 20 caracteres
codigoCategoria
Alfa Numrico
20 caracteres
12
Aps o envio dos dados, o SuperPay retorna um objeto do tipo ResultadoPagamentoWS. Esse objeto possui todos os itens necessrios para validao e liberao de pedidos. Abaixo segue a descrio dos campos contidos neste objeto.
Campo numeroTransacao Descrio Nmero da Transao (enviado pelo estabelecimento na chamada do WebService) Tipo Numrico Tamanho 8 Caracteres
codigoEstabelecimento
Valor fornecido pela ERNET para Cdigo fornecido pela identificar o estabelecimento junto ERNET ao SuperPay Cdigo da forma de pagamento (enviado pelo estabelecimento na chamada). Verificar tabela de cdigos na Seo 6 Valor da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Valor do desconto da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Valor da taxa de servio/embarque da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Quantidade de parcelas da transao URL para redirecionamento do cliente em caso de transaes Redirects. Para transaes no Redirects essa url ser retornada em branco. Status da Transao, representado por um valor numrico. Verificar tabela na Seo 6 Cdigo de autorizao da operadora/banco/ intermedirio financeiro
codigoFormaPagamento
Alfa Numrico
100 caracteres
valor
Numrico
At 8 dgitos
valorDesconto
Numrico
At 8 dgitos
taxaEmbarque
Numrico
At 8 dgitos
parcelas
Numrico
At 2 dgitos
urlPagamento
Alfa Numrico
At 500 caracteres
statusTransacao
Numrico
At 2 dgitos
autorizacao
At 20 dgitos
13
Cdigo da transao junto a operadora / banco / intermedirio financeiro Data de aprovao na operadora Nmero do comprovante de venda Mensagem de retorno da operadora (poder ser apresentado para o cliente)
mensagemVenda
Alfa Numrico
At 50 caracteres
Abaixo so descritos os objetos utilizados no envio e recepo de transaes com mltiplos cartes de crdito. Nome do Mtodo: pagamentoTransacaoCompletaMaisCartoesCredito Dados de Entrada: TransacaoCompletaWSCartoesCredito, Usuario, Senha Dados de Sada: ResultadoPagamentoWS Abaixo so descritos os campos dos objetos acima apresentados:
14
Campo
Descrio
Tipo
Tamanho
numeroTransacao
Valor nico que identifica cada transao dentro do SuperPay. Numrico. So Dever ser a referncia tambm aceitos apenas dentro do sistema do cliente., valores inteiros neste Esse valor ser devolvido em campo todos os eventos de consulta e atualizao de status.
At 8 dgitos
codigoEstabelecimento
Numrico, so Valor fornecido pela ERNET para Seguir valor aceitos apenas identificar o estabelecimento junto enviado valores inteiros neste ao SuperPay pela ERNET campo Numrico., So Valor contendo o cdigo do aceitos apenas os idioma. Verificar tabela de cdigos valores inteiros na Seo 6 constantes na tabela de idiomas Valor do desconto da transao. O valor total enviado para a operadora e/ou banco, considerar o desconto, ou seja, Numrico. So se o valor enviado for de R$ 10,00 aceitos apenas e o desconto for de R$ 1,00, ser valores inteiros neste enviado valor de cobrana de R$ campo. Considera-se 9,00 para a instituio financeira. sempre as duas Esse campo obrigatrio e em ltimas casas caso de no haver descontos, decimais como deve ser enviado o valor 0. Deve centavos ser enviado segundo o seguinte formato, para transao de R$ 1,00, deve-se enviar 100. Valor da taxa de embarque e/ou Numrico. So servio. O valor enviado neste aceitos apenas campo ser somado ao valor da valores inteiros neste transao. Isso , se a transao campo. Considera-se possuir um valor sempre as duas de R$ 10,00 e a taxa de ltimas casas embarque for de R$ 1,00 o valor decimais como total cobrado ser R$ 11,00 centavos Data de vencimento do boleto, no formato dd/mm/yyyy URL da Campainha. Essa url ser sempre acionada quando o status do pedido mudar. Aps a chamada da URL de Campainha o sistema do cliente dever, obrigatoriamente realizar uma consulta ao mtodo consultaTransacaoEspecifica O SuperPay redirecionar o cliente para esta URL, em caso de transaes do tipo redirects, quando a transao for aprovada. O SuperPay redirecionar o Valores Alfa Numricos, considerando o formato dd/mm/yyyy Seguir valores estipulados na tabela de idiomas
Idioma
valorDesconto
At 10 dgitos
taxaEmbarque
At 10 dgitos
vencimentoBoleto
urlCampainha
At 250 caracteres
urlRedirecionamentoPago urlRedirecionamentoNaoPago
15
Numricos Numrico. So aceitos apenas os valores inteiros constantes na tabela de origens das transaes Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico
origemTransacao
Seguir valores estipulados na tabela de origens de transaes At 16 caracteres At 16 caracteres At 16 caracteres At 16 caracteres At 16 caracteres
dadosUsuarioTransacao
Informaes de endereos, DadosUsuarioTransa Limitado a telefones de entrega e cobrana. caoCompletaWS estrutura do objeto Essas informaes so DadosUsuarioT importantes para o caso de Estrutura do objeto ansa anlise de fraudes descrito abaixo caoCompletaWS Lista de itens que esto sendo comprados pelo cliente. Este campo muito importante para anlise de fraudes e para utilizao em intermedirios financeiros., Sugere-se enviar estes dados para todas as transaes O nmero do IP do cliente, esta informao muito importante no caso de sistemas de anlise de fraudes Lista de cartes, valores e parcelas a serem processados Arraylist de objetos do tipo ItemPedidoTransac oWS Estrutura do objeto descrito abaixo Valores Alfa Numricos, no formato xxx.xxx.xxx.xxx
itensDoPedido
IP
At 15 caracteres
DadosCartoesCredito
Conforme descrito na tabela acima, o objeto TransacaoCompletaWSCartoesCredito possui dois objetos complexos em sua estrutura, so eles dadosUsuarioTransacao e itensDoPedido. Abaixo a estrutura desses objetos so descritas abaixo: Objeto dadosUsuarioTransacao
Campo Descrio Cdigo do Cliente do estabelecimento. Deve ser um identificador nico por cliente, e deve ser reenviado o mesmo nmero caso cliente volte a comprar no sistema do estabelecimento Tipo do cliente, identifica se que Tipo Tamanho
codigoCliente
Alfa Numrico
20 caracteres
tipoCliente
Numrico
1 dgito
16
dataNascimentoComprador
10 caracteres
codigoTipoTelefoneComprador
Cdigo do tipo do telefone do comprador. Verificar tabela de tipos de telefone na Seo 6 Telefone adicional do comprador sem espaos ou traos DDD do telefone adicional do comprador DDI do telefone adicional do comprador Cdigo do tipo do telefone adicional do comprador. Verificar tabela de tipos de telefone na Seo 6 Endereo de comprador e-mail do
Numrico
1 dgito
telefoneAdicionalComprador
Alfa Numrico
At 10 caracteres
dddAdicionalComprador
Alfa Numrico
At 3 caracteres
ddiAdicionalComprador
Alfa Numrico
At 3 caracteres
codigoTipoTelefoneAdicionalComprador
Numrico
1 dgito
17
complementoEnderecoComprador
Alfa Numrico
At 50 caracteres
cidadeEnderecoComprador
Alfa Numrico
At 50 caracteres
estadoEnderecoComprador
Alfa Numrico
At 2 caracteres
complementoEnderecoEntrega
cidadeEnderecoEntrega estadoEnderecoEntrega
Cidade do Logradouro de entrega Estado do Logradouro de entrega CEP de entrega, deve ser enviado sem traos ou espaos Telefone de entrega sem espaos ou traos DDD do telefone de entrega DDI do telefone de entrega Cdigo do tipo do telefone de entrega. Verificar tabela de tipos de telefone na Seo 6 Telefone adicional de entrega sem espaos ou traos DDD do telefone adicional de entrega DDI do telefone adicional de entrega Cdigo do tipo do telefone adicional de
At 50 caracteres At 2 caracteres
cepEnderecoEntrega
Alfa Numrico
At 10 caracteres
codigoTipoTelefoneEntrega
Numrico
1 dgito
telefoneAdicionalEntrega
Alfa Numrico
At 10 caracteres
dddAdicionalEntrega
At 3 caracteres
ddiAdicionalEntrega codigoTipoTelefoneAdicionalEntrega
At 3 caracteres 1 dgito
18
Objeto itensDoPedido
Campo codigoProduto Descrio Deve ser um identificador nico por produto, e deve ser reenviado caso o produto volte a ser comprado Cdigo da Categoria. Deve ser um identificador nico por categoria, e deve ser reenviado caso o produto volte a ser comprado Nome do produto Quantidade do produto Valor unitrio do produto. Deve ser enviado segundo o seguinte formato: para transao de R$ 1,00, deve-se enviar 100. Dessa forma, deve-se sempre enviar o valor sem vrgula ou ponto, e os dois ltimos dgitos do valor sero considerados como centavos Nome da categoria Tipo Alfa Numrico Tamanho 20 caracteres
codigoCategoria
Alfa Numrico
20 caracteres
nomeProduto quantidadeProduto
valorUnitarioProduto
Numrico
At 10 dgitos
nomeCategoria
Alfa Numrico
100 caracteres
Objeto DadosCartoesCredito
Campo Descrio Tipo Tamanho Seguir valores estipulados na tabela de formas de pagamento
codigoFormaPagamento
Numrico. So aceitos apenas Valor contendo o cdigo da forma de os valores pagamento. Verificar tabela de cdigos inteiros na Seo 6 constantes na tabela de formas de pagamento Numrico., So Valor da transao. Deve ser enviado aceitos apenas segundo o seguinte formato, para valores inteiros transao de R$ 1,00, deve-se enviar neste campo. 100. Dessa forma, deve-se sempre enviar Considera-se o valor sem vrgula ou ponto, e os dois sempre as duas ltimos dgitos do valor sero ltimas casas considerados como centavos decimais como centavos Quantidade de parcelas da transao. Deve-se verificar se a forma de pagamento suporta parcelamento. Caso no suporte, ser indiferente o valor enviado neste campo. Nome do titular do carto de crdito, sem acentos. Deve ser enviado exatamente Numrico. So aceitos apenas valores inteiros neste campo Valores Alfa Numricos
valor
At 10 dgitos
parcelas
At 2 dgitos
nomeTitularCartaoCredito
At 16 caracteres
19
codigoSeguranca
Cdigo de Segurana do nmero do Numrico., So carto, sem pontos ou espaos. Esse aceitos apenas campo NO armazenado pelo valores inteiros SuperPay neste campo Data de validade do carto, seguindo o padro mm/yyyy Valores Alfa Numricos, considerando o formato mm/yyyy
dataValidadeCartao
Aps o envio da transao, o SuperPay retornar para o sistema de e-Commerce um objeto do tipo ResultadoPagamentoMultiplosCartoesWS, que possui as seguintes caractersticas. Objeto ResultadoPagamentoMultiplosCartoesWS
Campo Descrio Valor fornecido pela ERNET para identificar o estabelecimento junto ao SuperPay Tipo Tamanho
codigoEstabelecimento
Numrico. So aceitos apenas Seguir valor valores inteiros neste enviado pela campo ERNET
numeroTransacao
Nmero da Transao Numrico. So (enviado pelo aceitos apenas estabelecimento na valores inteiros neste chamada do WebService) campo Status da Transao, representado por um valor numrico e que descrito na seo 6
At 8 dgitos
statusTransacao
Numrico
At 2 dgitos
Lista com objetos do Lista com os dados de tipo: retorno de cada um dos DetalhesFormaPagamentoMultiplosCartoesWS cartes de crdito DetalhesFormaPaga processados mentoMultiplosCaro esWS
O objeto DetalhesFormaPagamentoMultiplosCartoesWS, que faz parte da composio do retorno do pagamento para mltiplos cartes descrito abaixo:
Campo Descrio Tipo Tamanho Seguir valores estipulados na tabela de formas de pagamento
codigoFormaPagamento
Numrico. So Valor contendo o cdigo da forma de aceitos apenas pagamento. Verificar tabela de cdigos os valores na Seo 6. Apenas formas de inteiros pagamento do tipo WebService so constantes na aceitas para tais transaes tabela de formas de pagamento
20
valor
Numrico.
At 08 dgitos
valorDesconto
Numrico.
At 08 dgitos
21
Guia de Integrao SuperPay 2.5 O acionamento da campainha se faz atravs de um POST para a URL enviada no momento do envio da transao. No acionamento do POST so enviados os seguintes campos:
Campo codigoEstabelecimento Descrio Valor fornecido pela ERNET para identificar o estabelecimento junto ao SuperPay Valor nico que identifica cada transao dentro do SuperPay. Dever ser a referncia tambm dentro do sistema do cliente., Esse valor ser devolvido em todos os eventos de consulta e atualizao de status. Campo Livre 1 Campo Livre 2 Campo Livre 3 Campo Livre 4 Campo Livre 5 Tipo Numrico, so aceitos apenas valores inteiros neste campo Numrico. So aceitos apenas valores inteiros neste campo Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico Alfa Numrico Tamanho Seguir valor enviado pela ERNET
numeroTransacao
At 8 dgitos
Aps receber o acionamento da campainha o sistema do estabelecimento dever, obrigatoriamente, realizar a consulta do status da transao atravs do mtodo consultaTransacaoEspecifica.
numero
Valor nico que identifica cada transao dentro do SuperPay. Dever ser a referncia tambm Numrico. So aceitos dentro do sistema do cliente., Esse apenas valores inteiros valor ser devolvido em todos os neste campo eventos de consulta e atualizao de status.
At 8 dgitos
22
Aps o envio dos dados, o SuperPay retorna um objeto do tipo ResultadoConsultaTransacaoWS. Esse objeto possui todos os itens necessrios para validao e liberao de pedidos. Abaixo segue a descrio dos campos contidos neste objeto.
Campo Descrio Tipo Tamanho Seguir valor enviado pela ERNET
codigoEstabelecimento
Numrico. So Valor fornecido pela ERNET para aceitos apenas identificar o estabelecimento junto valores inteiros neste ao SuperPay campo Valor nico que identifica cada transao dentro do SuperPay. Dever ser a referncia tambm Numrico. So dentro do sistema do cliente. Esse aceitos apenas valor ser devolvido em todos os valores inteiros neste eventos de consulta e atualizao campo de status. Valor contendo o cdigo da forma Numrico. So de pagamento. Verificar tabela de aceitos apenas os cdigos na Seo 6. Apenas valores inteiros formas de pagamento do tipo constantes na tabela WebService so aceitas para tais de formas de transaes pagamento Valor da transao. Ser retornado segundo o seguinte formato, para transao de R$1,00, ser enviado 100. Valor do desconto da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Valor da taxa de servio/embarque da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Quantidade de parcelas da transao URL para redirecionamento do cliente em caso de transaes Redirects. Para transaes no Redirects essa url ser retornada em branco. Status da Transao, representado por um valor numrico. Verificar tabela na Seo 6 Cdigo de autorizao da
numeroTransacao
At 8 dgitos
codigoFormaPagamento
valor
Numrico
At 8 dgitos
valorDesconto
Numrico
At 8 dgitos
taxaEmbarque
Numrico
At 8 dgitos
parcelas
Numrico
At 2 dgitos
urlPagamento
Alfa Numrico
At 500 caracteres
statusTransacao
Numrico
At 2 dgitos
autorizacao
Numrico.
At 20 dgitos
23
mensagemVenda
Alfa Numrico
At 50 caracteres
Autorizao o processo inicial da transao, onde SuperPay aciona a operadora financeira, que verifica a condio de crdito do cliente, autorizando ou no a transao. Captura a confirmao da transao. Neste passo o SuperPay aciona a operadora financeira para confirmar a transao e realizar a cobrana do cliente. Alguns estabelecimentos realizam a captura do pedido posteriormente a uma anlise de risco ou aps verificar se o produto est ou no disponvel em seu estoque. Aps essa verificao, o sistema do estabelecimento dever acionar o WebService de operaes usando o comando de captura da transao, usando o parmetro de operao = 1 O mtodo para captura da transao descrito abaixo: Nome do Mtodo: operacaoTransacao; Dados de Entrada: OperacaoVO, Usuario, Senha; Dados de Sada: ResultadoPagamentoWS. Abaixo so descritos os campos dos objetos acima apresentados:
Campo Descrio Valor fornecido pela ERNET para identificar o estabelecimento junto ao SuperPay Tipo Alfa Numricos Tamanho Seguir valor enviado pela ERNET
codigoEstabelecimento
numeroTransacao
Valor nico que identifica cada transao Numrico. So dentro do SuperPay. Dever ser a referncia aceitos apenas tambm dentro do sistema do cliente. Esse valores inteiros neste valor ser devolvido em todos os eventos de campo consulta e atualizao de status. Valor do tipo numrico. Para o processo de captura deve ser enviado o cdigo 1. Fixo para captura Valor = 1
At 8 dgitos
operacao
At 01 dgito
24
Aps o envio dos dados, o SuperPay retorna um objeto do tipo ResultadoPagamentoWS, esse objeto possui todos os itens necessrios para validao e liberao de pedidos. Abaixo segue a descrio dos campos contidos neste objeto.
Campo numeroTransacao Descrio Nmero da Transao (enviado pelo estabelecimento na chamada do WebService) Valor fornecido pela ERNET para identificar o estabelecimento junto ao SuperPay Cdigo da forma de pagamento (enviado pelo estabelecimento na chamada). Verificar tabela de cdigos na Seo 6 Valor da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Valor do desconto da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Valor da taxa de servio/embarque da transao. Ser retornado segundo o seguinte formato: para transao de R$ 1,00, ser enviado 100. Quantidade de parcelas da transao URL para redirecionamento do cliente em caso de transaes Redirects. Para transaes no Redirects essa url ser retornada em branco. Status da Transao, representado por um valor numrico. Verificar tabela na Seo 6 Tipo Numrico Tamanho 8 Caracteres
codigoEstabelecimento
codigoFormaPagamento
Alfa Numrico
100 caracteres
valor
Numrico
At 8 dgitos
valorDesconto
Numrico
At 8 dgitos
taxaEmbarque
Numrico
At 8 dgitos
parcelas
Numrico
At 2 dgitos
urlPagamento
Alfa Numrico
At 500 caracteres
statusTransacao
Numrico
At 2 dgitos
autorizacao
Numrico Cdigo de autorizao da Autorizao sempre operadora/banco/ intermedirio financeiro numrica Cdigo da transao junto a operadora / banco / intermedirio financeiro Data de aprovao na operadora Nmero do comprovante de venda Mensagem de retorno da operadora
At 20 dgitos
25
numeroTransacao
Valor nico que identifica cada transao Numrico. So dentro do SuperPay. Dever ser a referncia aceitos apenas tambm dentro do sistema do cliente. Esse valores inteiros neste valor ser devolvido em todos os eventos de campo consulta e atualizao de status. Valor do tipo numrico. Para o processo de captura deve ser enviado o cdigo 2. Fixo para captura Valor = 2
At 8 dgitos
operacao
At 01 dgito
Aps o envio dos dados, o SuperPay retorna um objeto do tipo ResultadoPagamentoWS. Esse objeto possui todos os itens necessrios para validao e liberao de pedidos. Abaixo segue a descrio dos campos contidos neste objeto.
Campo numeroTransacao Descrio Nmero da Transao (enviado pelo estabelecimento na chamada do WebService) Valor fornecido pela ERNET para identificar o estabelecimento junto ao SuperPay Cdigo da forma de pagamento (enviado pelo estabelecimento na chamada). Verificar tabela de cdigos na Seo 6 Valor da transao. Ser retornado Tipo Numrico Tamanho 8 Caracteres
codigoEstabelecimento
codigoFormaPagamento valor
26
valorDesconto
Numrico
At 8 dgitos
taxaEmbarque
Numrico
At 8 dgitos
parcelas
Numrico
At 2 dgitos
urlPagamento
Alfa Numrico
At 500 caracteres
statusTransacao
Numrico
At 2 dgitos
autorizacao
Numrico Cdigo de autorizao da Autorizao sempre operadora/banco/ intermedirio financeiro numrica Cdigo da transao junto a operadora / banco / intermedirio financeiro Data de aprovao na operadora Nmero do comprovante de venda Mensagem de retorno da operadora (poder ser apresentado para o cliente)
At 20 dgitos
6 Anexos
6.1 Forma de Pagamento
6.1.1 Cartes de Crdito
Bandeira Visa MasterCard ELO Diners Discover Tecnologia Cielo e-Commerce Cielo e-Commerce Cielo e-Commerce Cielo e-Commerce Cielo e-Commerce Adquirente Cielo Cielo Cielo Cielo Cielo Modelo WebService WebService WebService WebService WebService Cdigo 120 121 123 124 125 Status Ativo Ativo Ativo Ativo Ativo
27
61 63 70
MasterCard ELO Visa Electron Cartes Bradesco Visa MasterCard Diners Visa MasterCard Diners Hpercard American Express American Express Visa MasterCard Diners American Express Hipercard Sorocred JCB Carto Presencial Mltiplos Cartes
VBV2 VBV2 VBV2 Komerci Integrado Komerci Integrado Komerci Integrado Komerci WebService Komerci WebService Komerci WebService Komerci WebService 3party 2party TEF TEF TEF TEF TEF TEF TEF
Cielo Cielo Cielo Redecard Redecard Redecard Redecard Redecard Redecard Redecard American Express American Express TEF TEF TEF TEF TEF TEF TEF
Redirect Redirect Redirect Redirect Redirect Redirect WebService WebService WebService WebService Redirect WebService WebService WebService WebService WebService WebService WebService WebService WebService WebService
71 73 40 80 81 82 90 91 92 93 10 11 3 6 9 12 13 14 15 250 999
28
Banco Ita Ita Bradesco Bradesco Real Banco do Brasil HSBC HSBC Banrisul Banrisul Banrisul Banrisul Oi Paggo Banco do Brasil Ita Bradesco Unibanco HSBC Real Caixa Econmica Federal Bradesco
Modalidade Transferncia Boleto Online Transferncia Boleto Online Transferncia Transferncia / Boleto Transferncia Boleto Online Transferncia Parcelamento Pr Datado Boleto Transferncia Boleto Offline Boleto Offline Boleto Offline Boleto Offline Boleto Offline Boleto Offline Boleto Offline Financiamento
Tecnologia Ita Shopline Ita Shopline Bradesco Shopfacil Bradesco Shopfacil RealPague BBOnline HSBC HSBC Banricompras.com Banricompras.com Banricompras.com Banricompras.com Oi Paggo Banco do Brasil Ita Bradesco Unibanco HSBC Real Caixa Econmica Federal Bradesco Shopfacil
Intermedirio Financeiros MOIP Mercado Pago Pagamento Digital DinheiroMail PagSeguro PayPal WS PayPal POST Boleto Parcelado iVarejo
6.2 Idioma
Idioma Portugus Cdigo 1
29
Cdigo 1 2 3 4
2 3 5 6
Aguardando Pagamento
Transitrio
Falha na Operadora
Final
15
Em Anlise de Risco
Transitrio
17
Recusado Anlise de Risco Falha no envio para Anlise de Risco Boleto Pago a menor Boleto Pago a maior Operao em andamento Transao j efetuada
Final
18
Transitrio
21 22 30 31
30
2 3 4 5 6
31