Aprova Fácil
Prezado Cliente, Apresentamos a seguir o Manual de integração do Aprova Fácil – Modo STAC. O modo STAC é uma forma de integração simples, e que dispensa a instalação da solução Aprova Fácil no servidor do Lojista. Ao optar pelo modo de integração STAC, a tela de digitação dos dados do cartão de crédito será hospedada no ambiente seguro da Cobre Bem Tecnologia. Esperamos através desta documentação orientálo da melhor forma possível e aproveitamos a oportunidade para colocarmonos inteiramente à sua disposição para maiores esclarecimentos. Para entrar em contato conosco utilize os canais de contato disponibilizados na URL abaixo: http://www.cobrebem.com/contato.html Nota: De acordo com as exigências do PCIDSS a Cobre Bem Tecnologia não é autotizada a receber números de cartão de crédito. Caso necessite de suporte em relação a alguma transação efetuada, nos informe o número da transação.
Boas cobranças e Cobre Bem! Equipe Cobre Bem
ÍNDICE 1. Introdução...5 2. Integração...6 2.1. Meios de Pagamento Suportados...6 2.2. Tecnologias de Conectividade...7 2.3. Etapas da Automatização...7 2.4. Tempo de Captura de uma Transação Aprovada...7 2.5. Desfazimento de uma Transação Aprovada...9 3. Página de Digitação de Dados...10 3.1. Imagens...10 4. Envio dos Dados do Pedido para o STAC...11 4.1. Método de Envio ...11 4.2. TokenID...12 5. Cartão de Crédito – Pedido de Aprovação – APC...15 5.1. Descrição...15 5.2. Métodos de Envio...15 5.3. URL Chamada...15 5.4. Parâmetros do Pedido...16 5.5. Agendamento Descrição...19 5.6. Consulta AVS (Adress Verification Service)...20 5.7. Exemplo de Pedido...21 5.8. Resultado do Processamento...22 6. Cartão de Crédito – Pedido de Captura – CAP ...24 6.1. Descrição...24 6.2. Métodos de Envio...24 6.3. URL...24 6.4. Parâmetros de Requisição...25 6.5. Exemplos de Requisição GET...25 6.6. Resultado de Captura com Sucesso...25
6.7. Resultados de Erro Comuns...26 7. Cartão de Crédito – Cancelamento de Transações – CAN...27 7.1. Descrição...27 7.2. Métodos de Envio...27 7.3. URL...27 7.4. Parâmetros de Requisição...28 7.5. Exemplos de Requisição...28 7.6. Resultado de Cancelamento com Sucesso...28 8. Transferências Bancárias On Line – Pedido de Aprovação...29 8.1. Descrição...29 8.2. Métodos de Envio...29 8.3. URL...29 8.4. Parâmetros de Requisição...29 8.5. Exemplo de Requisição...30 9. Transferências Bancárias On Line – Retorno de Confirmação de Pedido...31 9.1. Descrição...31 9.2. Métodos de Envio...31 9.3. URL...31 9.4. Parâmetros de Envio...31 9.5. Exemplo de Retorno...31 9.6. Resultados de Erros Comuns...32
1. Introdução
O STAC é uma das formas disponíveis para efetuar a integração de sua loja virtual/aplicativo com a solução de automatização de vendas através de diversos meios de pagamento, o Aprova Fácil. Este, tem como objetivo suprir a necessidade da instalação do CGIAprovaFacil ou CobreBemX.dll em seu servidor, bem como, prover um certificado SSL para os estabelecimentos (lojas virtuais) que não possuem e/ou não desejam adquirílo. Ressaltamos que o STAC é utilizado somente para a página onde serão digitados os dados sensíveis informados no momento da compra. Nota: O certificado SSL (128 bits) é exigido pelas Administradoras de Cartões de Crédito na tela/página onde serão digitados os dados do cartão de crédito. Nesta forma de implementação, o consumidor após ter realizado o pedido na loja, será redirecionado para o ambiente seguro da Cobre Bem Tecnologia denominado STAC, onde informará os seus dados do cartão de crédito para finalizar o processo de compra.2. Integração
2.1. Meios de Pagamento Suportados O Aprova Fácil realiza a automatização de diversos meios de pagamento simultaneamente com Bancos e Administradoras de Cartões de Crédito utilizando a internet como meio de captura. Veja abaixo os meios de pagamento e a lista de instituições financeiras suportados no Aprova Fácil para esta forma de integração. 2.1.1. Cartão de CréditoVeja na URL abaixo a lista de todas as Administradoras e suas respectivas Bandeiras e Tecnologias de Conectividade suportadas pelo Aprova Fácil: http://www.cobrebem.com/administradoras.html 2.1.2. Cartão de Débito O Aprova Fácil suporta o Visa Electron através da tecnologia de conectividade Verified by Visa. É importante ressaltar que em situações de venda à distância como Comércio Eletrônico as compras somente poderão ser realizadas por portadores de cartões emitidos pelo Banco Bradesco. 2.1.3. Transferência On Line (Débito On Line) Consulte através da URL abaixo a lista de todos os bancos suportados pelo Aprova Fácil para esse meio de pagamento: http://www.cobrebem.com/bancostransferencia.html
2.2. Tecnologias de Conectividade TEF Dedicado (Cielo, Amex, Hipercard, Sorocred, JCB, Aura) Verified By Visa, MoSet (Cielo) Komerci, Komerci Web Service (Redecard) WebPos (Amex) 2.3. Etapas da Automatização 2.3.1. Cartão de Crédito a) Envio dos dados do pedido para o STAC; b) Requisição de aprovação; c) Requisição de captura; d) Requisição de cancelamento. 2.3.2. Transferência Bancária On line (Débito On Line) a) Requisição de aprovação; b) Retorno de confirmação de pagamento. 2.4. Tempo de Captura de uma Transação Aprovada Nas vendas realizadas através do meio de pagamento Cartão de Crédito é possível realizar confirmação (captura) da transação de 02 (duas) formas:
– Manual; – Automática.
A confirmação/captura de uma transação se refere ao processo entre a aprovação da transação e o débito efetivo no cartão do cliente. A confirmação/captura pode ser realizada de forma manual ou automática, dependendo da implementação realizada pelo desenvolvedor. O lojista determina o modo da confirmação/captura de acordo com o tipo de venda/negócio adotado. Geralmente, o lojista adota o modo de confirmação com captura manual, quando deseja realizar uma verificação do pedido antes de confirmar/capturar a transação junto à Administradora de Cartão de Crédito. Abaixo segue um quadro ilustrativo, contendo os prazos de confirmação (captura) da transação de acordo com a tecnologia de conectividade e Administradora de Cartão de Crédito para sua análise.
Adm. de Cartão de Crédito Tecnologia de Conectividade Prazo de Confirmação Cielo TEF Dedicado 47 horas Verified By Visa MoSet até 5 dias Redecard Komerci 2 minutos Komerci WebService 5 minutos Somente é possível captura Manual com PréAutorização, neste caso são 5 dias. (*) veja Nota 1 American Express TEF Dedicado WebPos 23 horas 5 dias Hipercard
Aura TEF Dedicado 47 horas
As tecnologias de conectividade Komerci e Komerci WebService da Redecard não permitem a confirmação (captura) do tipo manual, somente automática com prazo de confirmação (captura) máximo de 2 e 5 minutos, respectivamente.
Nota 1: Caso o estabelecimento esteja habilitado na tecnologia de conectividade Komerci WebService com “PréAutorização”, junto à Administradora Redecard, a captura poderá ser realizada de forma manual. Neste caso, o prazo para realizar a confirmação (captura) é de 5 dias corridos a partir da data do processamento realizado pela Administradora de Cartão de Crédito Redecard. 2.5. Desfazimento de uma Transação Aprovada Caso o lojista não realize a captura da transação no prazo estipulado pelas Administradoras de Cartão de Crédito, de acordo com a tecnologia de conectividade, a mesma será desfeita automaticamente. Neste caso, o débito não é realizado no cartão de crédito do cliente. O lojista poderá visualizar a data/hora desse processo, denominado “Desfazimento” da transação no campo “Data/Hora Cancelamento” existente no extrato do Aprova Fácil.
3. Página de Digitação de Dados
Todo cliente que utiliza a forma de integração via STAC já possui uma página de digitação de dados padrão, que deve ser personalizada. Ela pode ser acessada através da url abaixo. Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. Para personalizar sua página de digitação de dados, utilize como base a página exemplo que pode ser baixada através da url abaixo e enviea para a nossa equipe através de um dos nossos emails de contato. Ao realizar a personalização, devese requisitar as informações de acordo com o que exigido pelas administradoras de cartão de crédito conforme tecnologia de conectividade utilizada. http://www.cobrebem.com/downloads/apf/PaginaSTAC.zip Importante: Para que a página STAC enviada para nós seja cadastrada para o seu estabelecimento, a mesma deve ter o tamanho máximo de 50KB, estar compactada em formato .zip ou .rar. e o email do remetente necessita estar cadastrado em nosso sistema como responsável pelo estabelecimento ou desenvolvedor.3.1. Imagens
É possível colocar imagens na página de digitação de dados, como por exemplo, o logo da sua empresa. Para fazer isso envienos as imagens e, no código da página, a referência a cada imagem deve ser feita conforme segue abaixo. Se a extensão do arquivo for omitida será assumido o tipo JPEG.
4. Envio dos Dados do Pedido para o STAC
O envio dos dados do pedido ocorre após o cliente selecionar o meio de pagamento na loja virtual. Esta passagem de parâmetros pode ocorrer de duas formas, através de GET/POST ou através do TokenID. 4.1. Método de Envio Nesta forma, os parâmetros serão passados da loja para o STAC diretamente através de GET ou POST. Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. Importante: O código de usuário STAC identifica a loja perante o sistema Aprova Fácil e sempre deverá ser escrito com letras minúsculas. 4.1.1. Parâmetros Todos os parâmetros de requisição enviados para a página STAC e que serão utilizados no processamento devem ser resgatados através da sintaxe <#NomeParametro>, onde NomeParametro será substituído pelo nome do parâmetro proveniente da loja virtual. Supondo que a sua loja virtual envie um parâmetro de requisição denominado UsuarioID, o qual será exibido na página do STAC, será necessário acrescentar no local desejado do código HTML desta página a tag <#UsuarioID>. Uma outra maneira de resgatar todos os parâmetros de requisição da loja é utilizar uma única tag denominada <#ParametrosCliente>, neste caso, todos os parâmetros de requisição serão automaticamente resgatados e inclusos como input do form, exceto os parâmetros que são utilizados internamente pelo STAC que estão listados abaixo:<#ValorDocumento > <#ValorDocumentoExibicao > <#QuantidadeParcelas > <#NumeroDocumento > <#NumeroCartao> <#MesValidade > <#AnoValidade > <#CodigoSeguranca > <#ParcelamentoAdministradora> <#Moeda > <#TransacaoAnterior > <#Bandeira > <#AVS > <#NomePortadorCartao > <#CPFPortadorCartao> <#EnderecoPortadorCartao > <#CEPPortadorCartao > <#URLImagemSuperior> <#FrameRetorno> <#Idioma > <#VisaElectron > <#BancoEmissor> <#PreAutorizacao > <#ValorEntrada > <#ParametrosCliente> <#URLAprovacao > <#AnosValidos> 4.2. TokenID Nesta forma de envio de dados para o STAC os parâmetros serão subtituidos por um identificador denominado TokenID.
Diferente do formato GET/POST nesta forma há duas chamadas ao STAC, a primeira passando os parâmetros, para que o TokenID seja gerado (invisivel ao cliente da loja virtual) e uma segunda chamada passando o TokenID para o STAC (visivel ao cliente da loja virtual).
4.2.1. Gerando o TokenID
O TokenID é gerado quando há uma chamada ao STAC com o parâmetro /TOKEN.
Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. Importante: O código de usuário STAC identifica a loja perante o sistema Aprova Fácil e sempre deverá ser escrito com letras minúsculas. A resposta dessa chamada será uma string (TokenID) contendo números e letras. Exemplo: O6S1SPVwcADHd7Id43u3pI7E0Ws1wl83idU7JXmiA8iZz1Gtwx 4.2.2. Enviando o TokenID para o STAC Neste passo o TokenID gerado deverá ser passado ao STAC como único parâmetro já que este é o identificador de todos os parâmetros passados anteriormente. O único parâmetro então denominado TokenID deverá ser resgatado pela página do STAC através da sintaxe <#TokenID>. Exemplo:
Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.
5. Cartão de Crédito – Pedido de Aprovação – APC
5.1. Descrição A diretiva de execução, o APC, deverá ser utilizado toda vez que o estabelecimento necessitar solicitar a aprovação financeira para uma venda realizada através de cartão de crédito. O pedido de aprovação ocorre após a digitação dos dados do cartão de crédito na página do STAC, nessa solicitação serão utilizados também os dados provenientes da loja, tais como, valor e quantidade de parcelas. 5.2. Métodos de Envio Como os dados passados no envio do pedido são sigilosos, então o método de envio a ser adotado é o POST, através de HTTPS. 5.3. URL Chamada 5.3.1. Servidor principal: 5.3.2. Servidor de teste: Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.5.4. Parâmetros do Pedido
Os parâmetros de requisição a serem utilizados na página do STAC dependem da tecnologia de conectividade habilitada para seu estabelecimento em cada Administradora de Cartão de Crédito. Sendo assim, seguem abaixo 03 tabelas que ilustram os parâmetros a serem adotados em cada tecnologia de conectividade:
Tecnologias: TEF Dedicado / MoSet / WebPos / Komerci WebService
Nome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pela
loja. Até 50 caracteres alfanuméricos. 123ABC Não
ValorDocumento* Valor da transação Numérico, sendo as casas
decimais separadas por ponto (.) 123.56 Sim
QuantidadeParcelas Quantidade de parcelas 02 dígitos numéricos 01 Sim
NumeroCartao Número do cartão de crédito Até 19 dígitos numéricos 4551870000000183 Sim
MesValidade Mês em que o cartão expira 02 dígitos numéricos 11 Sim
AnoValidade Ano em que o cartão expira 02 dígitos numéricos 08 Sim
CodigoSeguranca** CVC2/CVV2 do cartão Até 04 dígitos numéricos 123 Sim, se tecnologia diferente de Komerci Web Service Bandeira Bandeira do Cartão de Crédito VISA MASTERCARD DINERS AMEX HIPERCARD JCB SOROCRED AURA VISA Sim ParcelamentoAdmini stradora Utilizado para acionar o parcelamento administradora Apenas um caracter: S S Não
Nome Descrição Formatação Exemplo Obrigatório NomePortadorCartao Nome que está gravado no
cartão
Até 50 caracteres alfanuméricos José da Silva Não DataNascimentoPort adorCartao Data de nascimento do portador do cartão AAAAMMDD 20071027 Não Moeda Moneda utilizada en la venta (caso no sea informada, se asumirá el valor BRL) Valores válidos: BRL, MXN, CLP (Otros valores ISO para definiciones de moneda ISO 4217) BRL Não * O Aprova Fácil não efetua nenhum tipo de conversão de moedas. Sendo assim, o valor da transação informado ao Aprova Fácil deverá sempre ser em Real. ** É possível controlar o resultado no ambiente de testes do Aprova Fácil. Para isto, utilize o parâmetro “CodigoSeguranca”. Veja abaixo o resultado esperado. Essa modalidade não está disponível para Aura e Sorocred. CodigoSeguranca Informado Retorno 555 ou 123 Autorizado 501 05 05NAO AUTORIZADA 502 78 78CAR BLOQ1.USO 503 41 41 RETER CARTAO 504 14 14CARTAOINVALIDO 506 60 Valor Inválido. Por favor, ent 507 68 T68TRANSACAO JA EFETUADA 508 54 54CARTAO VENCIDO 509 56 Dado Inválido. Por favor, entr 444 N7 N7COD.SEG.INVAL 333 84 T84REFACA TRANS
Nota: Por determinação da Redecard o CVV2 não deve ser solicitado do comprador quando a tecnologia utilizada for Komerci Web Service.
Tecnologia: Verified By Visa
Nome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pela loja. Até 50 caracteres alfanuméricos. 123ABC Não ValorDocumento* Valor da transação Numérico, sendo as casas decimais
separadas por ponto (.) 123.56 Sim
QuantidadeParcelas Quantidade de parcelas 2 dígitos numéricos 01 Sim
NumeroCartao Bin do cartão de crédito 6 dígitos numéricos 455187 Sim
Idioma Define o idioma da janela da Cielo PTB=Português ENG=Inglês ESP=Espanhol ESP Não VisaElectron Informa se o cartão a ser debitado é Visa Electron S ou N N Não
Bandeira Bandeira do Cartão de Crédito VISA VISA Não
* O Aprova Fácil não efetua nenhum tipo de conversão de moedas. Sendo assim, o valor da transação informado ao Aprova Fácil deverá sempre ser em Real.
Tecnologia: Komerci
Nome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pela
loja. Até 50 caracteres alfanuméricos. 123ABC Não
ValorDocumento* Valor da transação Numérico, sendo as casas
decimais separadas por ponto (.) 123.56 Sim
QuantidadeParcelas Quantidade de parcelas 2 dígitos numéricos 01 Sim
Bandeira Bandeira do cartão de crédito Caracteres em maiúsculo Preechimento: DINERS ou MASTERCARD MASTERCARD Sim Idioma Define o idioma da janela da Redecard PTB=Português ENG=Inglês ESP=Espanhol ESP Não AVS Valores: N – Não realizar S – Para realizar consulta 1 caracter N Não
Nome Descrição Formatação Exemplo Obrigatório UrlImagemSuperior Define a imagem a ser exibida na Redecard. URL http://www.seusite .com.br/imagem.j pg Não
PreAutorizacao **Veja descrição abaixo Char. S=Sim e N= Não S Não
* O Aprova Fácil não efetua nenhum tipo de conversão de moedas. Sendo assim, o valor da transação informado ao Aprova Fácil deverá sempre ser em Real. ** A Préautorização é o bloqueio temporário de uma quantia no cartão de crédito com objetivo de garantir a sua reserva sendo um recurso utilizado na tecnologia de conectividade Komerci WebService (Redecard). Note que este tipo de venda que contém o recurso de PréAutorização somente é utilizada em projetos especiais que tenham esta necessidade. 5.5. Agendamento Descrição O agendamento de transações é utilizado, quando há a necessidade de efetuar mensalmente o débito no cartão de crédito do cliente mantendo sempre as mesmas condições: – Mesmo valor; – Débito mensal realizado sempre no mesmo dia. O agendamento é realizado de forma automática pelo Aprova Fácil, obedecendo as regras de débito informadas através dos parâmetros de agendamentos descritos no item 5.5.2 deste manual. Importante: Para que o agendamento seja aceito é necessário que a primeira transação tenha sido aprovada pela Administradora de Cartão de Crédito e confirmada pelo Lojita. Caso contrário, não será realizado o agendamento. 5.5.1. Agendamento – Tecnologia de Conectividade O agendamento é suportado nas tecnologias de conectividade TEF Dedicado, MoSet (Cielo), Komerci WebService (Redecard) e WebPos (Amex).
5.5.2. Agendamento Parâmetros Utilizados para Agendar uma Transação
Os parâmetros de requisição exibidos na tabela abaixo, devem ser enviados na primeira solicitação de débito do cartão de crédito juntamente com os demais dados do pedido. Neste caso o parâmetro NumeroDocumento passa a ser obrigatório, não poderá ser nulo e deverá ser único.
Nome Descrição Formatação Exemplo Obrigatório
Agendamento Utilizado para incluir, excluir ou alterar um agendamento Apenas um caracter: I (Incluir), E (Excluir) ou A (Atualizar) I Sim DiaParaAgendar Dia de cada mês em que será feito o débito dd 09 Se Agendamento ≠ E QuantidadeMesesParaAgendar Quantidade de meses para agendar 2 dígitos numéricos 08 Se Agendamento ≠ E NumeroTentativasNaoAprovado Número de tentativas para a transação ser aprovada 2 dígitos numéricos 04 Se Agendamento ≠ E QuantidadeDiasEntreTentativas Quantidade de dias entre cada tentativa 2 dígitos numéricos 03 Se Agendamento ≠ E 5.6. Consulta AVS (Adress Verification Service) O AVS é um serviço oferecido pelas Administradoras de Cartão de Crédito para que o lojista possa realizar uma consulta para confirmação dos dados de CPF (Cadastro Pessoa Física) e do endereço de entrega da fatura do titular do cartão no ato da compra .
Para disponibilizar essa consulta, o estabelecimento deverá habilitar esse serviço junto às Administradoras de Cartão de Crédito e, após, informar à Cobre Bem Tecnologia que a mesma será utilizada.
A consulta AVS é suportada para as bandeiras Amex e Mastercard, nas tecnologias de conectividade WebPos, Komerci e Komerci WebService, respectivamente.
Tecnologia:
KomerciNome Descrição Formatação Exemplo Obrigatório
AVS Valores: N – Não realizar
S – Para realizar consulta 1 caracter S
Sim, caso deseja que a transação complete consulta AVS
Tecnologia:
Komerci Web ServiceNome Descrição Formatação Exemplo Obrigatório
AVS Valores: N – Não realizar
S – Para realizar consulta 1 caracter S Sim
CPFPortadorCartao CPF do Portador do cartão de crédito 14 dígitos numéricos 11 dígitos numéricos 12345678123412 12345678912 Se AVS = S EnderecoPortadorCartao Endereço do portador do cartão de crédito Até 50 caracteres
Endereço + número Av. das flores 123 Se AVS = S CEPPortadorCartao CEP do Portador do cartão
de crédito 08 dígitos numéricos 20555000 Se AVS = S
5.7. Exemplo de Pedido
Segue abaixo um trecho de código de exemplo do envio dos dados, para solicitar a aprovação de uma transação:
5.8. Resultado do Processamento
5.8.1. Parâmetros de Retorno via POST / GET
A resposta do processamento de uma transação também pode ocorrer através de parâmetros através dos métodos GET e POST.
Nome Descrição Formatação Exemplo Obrigatório
TransacaoAprovada Resultado do pedido de aprovação True = Aprovado False = Negado True Sim ResultadoSolicitacaoAprovacao Descrição da aprovação do resultado do pedido Texto varchar veja tabela abaixo Sim CodigoAutorizacao Código de autorização retornado pela administradora do cartão de crédito Texto de 6 dígitos N12345 Sim se aprovado Transacao Número da trasação no Aprova Fácil 14 dígitos
numéricos 73263868827 369 Sim CartaoMascarado Número mascarado do cartão de crédito Até 19 dígitos numéricos 444433***** *1111 Sim NumeroDocumento Identificação da venda pela loja Até 50 caracteres
alfanuméricos
123ABC Sim
NumeroSequencialUnico Número de aprovação da Administradora
6 dígitos numéricos 123456 não ComprovanteAdministradora Texto comprovante da administradora Texto varchar N/A Não
NacionalidadeEmissor País emissor Texto nulo N/A Não
ResultadoAVS Resultado da verificação de endereço (Veja a tabela do item 4.8.3)
Texto nulo N/A Não
EnderecoAVS Tag de grupo para endereço verificado N/A N/A Não
Endereco Endereço de rua verificado Texto nulo Não
Numero Número de endereço verificado Texto nulo N/A Não
Complemento Complemento do endereço verificado Texto nulo N/A Não
5.8.2. Tabela de Valores retornados para o parâmetro ResultadoAVS Amex Código Descrição X Endereço e CEP 9 digitos coincidem. Y Endereço e CEP 5 digitos coincidem. W Somente o CEP 9 Digitos coincide. S Serviço não suportado. G Emissor não participa do AVS. A Endereço coincide. Cep não coincide ou não verificado. Z Cep 5 digitos coincide. Endereço não coincide. R Emissor não disponivel. U Endereço indisponivel. N Nada coincide. E Endereço e Cep não informado. Redecard Código Descrição W Sim, todos os dígitos coincidem. X O CEP e CPF coincidem, endereço não coincide. Z Endereço e CPF coincidem, CEP não coincide. Y O CEP coincide, CPF e endereço não coincidem. A CPF coincide, CEP e endereço não coincidem. U O CEP e CPF não coincidem, endereço coincide. S O CEP e endereço coincidem, CPF não coincide. N Nada coincide.
6. Cartão de Crédito – Pedido de Captura – CAP
6.1. Descrição A diretiva de execução CAP efetua a captura de uma transação. Entendese por captura o processo de confirmação de uma transação, o que caracteriza a venda efetivada, sendo realizada assim, o débito no cartão de crédito do cliente. De acordo com os padrões ISO 8583 todas as transações aprovadas pelas Administradoras de Cartões de Crédito devem ser capturadas (confirmadas) pela aplicação do lojista. Caso a transação não seja capturada (confirmada) pela aplicação do lojista, no prazo estipulado pelas Administradoras de Cartões de Crédito, a mesma será automaticamente desfeita, não havendo assim o débito efetivo no cartão de crédito do cliente, sendo esta informação exibida no campo “Data Hora Cancelamento”do extrato do Aprova Fácil. 6.2. Métodos de Envio Os métodos de envio dos parâmetros podem ser o POST ou GET utilizando conexões HTTP ou HTTPS, já que não são trafegados dados sigilosos. 6.3. URL 6.3.1. Servidor principal: 6.3.2. Servidor de teste:Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 6.4. Parâmetros de Requisição
Nome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pela loja.
Até 50 caracteres
alfanuméricos 123ABC Não
Transação Número da transação no Aprova Fácil 14 dígitos numéricos 73263500055432 Se NumeroDocumento for nulo 6.5. Exemplos de Requisição GET 6.5.1. Captura utilizando o número documento gerado pelo estabelecimento 6.5.2. Captura Utilizando o número da transação gerado pelo Aprova Fácil Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 6.6. Resultado de Captura com Sucesso O resultado de uma transação de captura bem sucedida começará com a palavra “Confirmado”, seguida de um carácter de espaço, e do número de transação Aprova Fácil.
6.7. Resultados de Erro Comuns Texto do Resultado Descrição Erro Transação Inválida Transação Inválida Erro Transação a confirmar não encontrada ou já confirmada Transação a confirmar não encontrada ou já confirmada Erro IP não permitido IP não permitido Erro Estabelecimento não cadastrado para a Bandeira XXX Adquirinte YYY Estabelecimento não cadastrado para a Bandeira XXX Adquirinte YYY Erro Estabelecimento não habilitado para a Bandeira XXX Adquirinte YYY XXX não habilitada para o estabelecimento Erro Captura Já Efetuada Captura já efetuada Erro Parâmetros Incorretos Parâmetros incorretos Erro Código Cliente Inválido Código cliente inválido Erro Código de Cliente Forjado Código de cliente forjado Erro Modo de Operação Inválido Modo de operação inválido Erro Conexão para confirmação não Estabelecida Conexão para confirmação não estabelecida
7. Cartão de Crédito – Cancelamento de Transações – CAN
7.1. Descrição A diretiva de execução CAN é utilizada no processo de cancelamento da transação. O cancelamento de uma transação somente poderá ser realizado quando a mesma for aprovada pela administradora e confirmada pelo lojista. Por isso para que o Aprova Fácil possa realizar o cancelamento, este deve ser solicitado no mesmo dia em que a transação foi processada, ou seja, foi aprovada pela administradora. 7.2. Métodos de Envio O método de envio utilizado pode ser o POST ou GET e as informações podem ser enviadas através de HTTP ou HTTPS, já que não são trafegados dados sigilosos. 7.3. URL 7.3.1. Servidor principal: 7.3.2. Servidor de teste: Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.7.4. Parâmetros de Requisição
Nome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pela loja.
Até 50 caracteres
alfanuméricos. 123ABC Não
Transacao Número da transação no Aprova Fácil 14 dígitos numéricos 73263500055432 Se NumeroDocumento for nulo 7.5. Exemplos de Requisição 7.5.1. Cancelamento utilizando o número do documento gerado pelo estabelecimento 7.5.2. Cancelamento utilizando o número da Transação gerado pelo Aprova Fácil Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 7.6. Resultado de Cancelamento com Sucesso O resultado de uma requisição de cancelamento bem sucedida começará com a palavra “Cancelado OK”, seguida de um carácter de espaço, e do número de transação Aprova Fácil.
8. Transferências Bancárias On Line – Pedido de Aprovação
8.1. Descrição O pedido de aprovação será realizado toda vez que a aplicação do lojista necessitar obter aprovação financeira de uma venda por meio de transferência eletrônica on line. O pedido de transferência eletrônica on line retornará um código HTML que redicionará o navegador do cliente para o site do banco selecionado. 8.2. Métodos de Envio O método utilizado pode ser o POST ou GET e as informações devem ser enviadas através de HTTPS, já que serão trafegados dados sigilosos. 8.3. URL Segue um exemplo: Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 8.4. Parâmetros de RequisiçãoNome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pela loja.
Até 50 caracteres
alfanuméricos. 123ABC Não
ValorDocumento* Valor da transação
Numérico, sendo as casas decimais separadas por ponto (.)
Nome Descrição Formatação Exemplo Obrigatório Bandeira Nome do banco Valores válidos são: ABNREAL /BBRASIL BANRISUL/ BRADESCO HSBC / ITAU/UNIBANCO BRADESCO Sim
QuantidadeParcelas Quantidade de parcelas 02 dígitos numéricos 01 Sim
CNPJCPFSacado CNPJ ou CPF do sacado 14 dígitos numéricos 11 dígitos numéricos 12345678123412 12345678912 Não * O Aprova Fácil não efetua nenhum tipo de conversão de moedas. Sendo assim, o valor da transação informado ao Aprova Fácil deverá sempre ser em Real. 8.5. Exemplo de Requisição Nota: <usuariostac> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.
9. Transferências Bancárias On Line – Retorno de Confirmação de Pedido
9.1. Descrição O retorno de uma transferência será feita do Aprova Fácil para o site do lojista. O desenvolvedor deverá fornecer uma URL para receber o POST ou GET dos servidores do Aprova Fácil, esta conterá a informação de confirmação de pagamento do pedido de transferência bancária on line. 9.2. Métodos de Envio O método pode ser o POST ou GET e as informações podem ser enviadas através de HTTP ou HTTPS. 9.3. URL Segue um exemplo: https://pagamento.lojacliente.com/RetornoTransacao.php 9.4. Parâmetros de EnvioNome Descrição Formatação Exemplo Obrigatório
NumeroDocumento Identificação da venda pelo loja Até 50 caracteres alfanuméricos 123ABC Não TransacaoAprovada Resultado do pedido de aprovação True = Aprovado False = Negado True Sim CodigoAutorizacao Código de autorização retornado
pelo banco Texto de 6 dígitos N12345 Sim se aprovada
Transacao Número da trasação no Aprova Fácil 14 dígitos numéricos 73263868827369 Sim 9.5. Exemplo de Retorno https://pagamento.lojacliente.com/RetornoTransacao.php? NumeroDocumento=123ABC&TransacaoAprovada=True&CodigoAutorizacao=123456&Transacao=73561234567898
9.6. Resultados de Erros Comuns Texto Resultante Descrição Erro Transação Inválida Transação inválida Erro Transação a cancelar não encontrada ou já cancelada Transação a cancelar não encontrada ou já cancelada Erro Cancelamento Já Efetuado Cancelamento já efetuado Erro Conexão para cancelamento não Estabelecida Conexão para cancelamento não estabelecida