Aprova Fácil. Integração via WebService

(1)

Aprova Fácil

(2)

Prezado Cliente,

Este é o Manual de integração do Aprova Fácil – Modo WebService, que deve ser encaminhado ao seu desenvolvedor.

O modo WebService é uma forma de integração simples, que dispensa a instalação de clientes do Aprova Fácil no servidor do Lojista.

Esperamos através desta documentação orientálo da melhor forma possível e aproveitamos a oportunidade para colocarnos à 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 é autorizada 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

(3)

ÍNDICE 1. Introdução...6 2. Integração...7 2.1. Meios de Pagamento Suportados...7 2.2. Tecnologias de Conectividade...7 2.3. Etapas da Automatização...8 2.4. Tempo de Captura de uma Transação Aprovada...8 2.5. Codificação da Resposta do Aprova Fácil...10 3. Cartão de Crédito – Pedido de Aprovação – APC...11 3.1. Descrição...11 3.2. Métodos de Envio...11 3.3. URLs Chamada...11 3.4. Parâmetros do Pedido...12 3.5. Agendamento Descrição...15 3.6. Recorrência – Descrição...16 3.7. Consulta AVS (Adress Verification Service)...18 3.8. Exemplo de Pedido ...19 3.9. Resultado do Processamento Formato XML...21 3.10. Resultados de Erros Comuns...24 4. Cartão de Crédito – Pedido de Captura – CAP ...26 4.1. Descrição...26 4.2. CAP – Métodos de Envio...26 4.3. URLs...26 4.4. Parâmetros de Requisição...27 4.5. Exemplos de Requisição GET...27 4.6. Exemplo de Resultados...28 4.7. Resultado de Captura com Sucesso...28 4.8. Resultados de Erro Comuns...28 5. Cartão de Crédito – Cancelamento de Transações – CAN...30

(4)

5.1. Descrição...30 5.2. Métodos de Envio...30 5.3. URLs...30 5.4. Parâmetros de Requisição...31 5.5. Exemplos de Requisição...31 5.6. Resultado XML...32 5.7. Resultado das Tags XML...32 5.8. Exemplos de Resultados...32 5.9. Resultado de Cancelamento com Sucesso...34 5.10. Resultados de Erros Comuns NSU Cancelamento...34 6. Cartão de Crédito – Call Back de Reembolso...35 6.1. Descrição...35 6.2. Métodos de Envio...35 6.3. URLs...35 6.4. Parâmetros de Requisição...35 6.5. Resposta a uma Solicitação de Reembolso Bem Sucedida...36 7.Cartão de Crédito – Resultado de Reembolso...37 7.1. Descrição...37 7.2. Métodos de Envio...37 7.3. Envio do Resultado de Reembolso...37 7.4. Exemplo de chamada...37 7.5. Descrição dos parâmetros...38 7.6. Confirmação de Recebimento de Retorno...38 8. Boleto Bancário – Pedido de Emissão – BOL...39 8.1. Descrição...39 8.2. Métodos de Envio...39 8.3. URL's...39 8.4. Parâmetros de Requisição...39 8.5. Exemplo de Requisição ...41 8.6. Resultados...41 8.7.Resultados de Erros Comuns...42

(5)

9. Transferências Bancárias On Line – Pedido de Aprovação...43 9.1. Descrição...43 9.2. Métodos de Envio...43 9.3. URLs...43 9.4. Parâmetros de Requisição...43 9.5. Requisição...44 9.6. Exemplo de Resultados...44 9.7. Resultados de Erros Comuns...47 10. Transferências Bancárias On Line – Retorno de Confirmação de Pedido...48 10.1. Descrição...48 10.2. Métodos de Envio...48 10.3. URL...48 10.4. Parâmetros de Retorno...48 10.5. Exemplo de Retorno...50 10.6. Resultados de Erros Comuns...50 11. Débito Automático em Conta Corrente – Pedido de Aprovação – DEB...51 11.1. Descrição...51 11.2. Métodos de Envio...51 11.3. URL...51 11.4. Parâmetros de Requisição...51 11.5. Exemplo de Requisição...53 11.6. Exemplo de Resultados...54 12. Diagrama de Funcionamento...55

(6)

1. Introdução

O WebService é 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 gateway Aprova Fácil.

(7)

2. Integração

Para iniciar este processo, o desenvolvedor deve nos informar o endereço de IP fixo do estabelecimento que estará usando o Gateway de Pagamentos Aprova Fácil. É obrigatório que o endereço de IP seja fixo para este método de integração. Se o endereço IP do comerciante não for fixo, o método de integração ideal é o STAC, em que o comprador é redirecionado para o ambiente seguro da Cobre Bem Tecnologia, onde todos os dados sensíveis serão inseridos. Por favor, solicite o manual de integração STAC se este estiver mais adequado à sua situação. Nota : Quando o ambiente de testes da Cobre Bem estiver sendo usado , não é necessário informar um endereço de IP, porque o nosso servidor de teste não valida o IP de origem da transaçã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. http://www.cobrebem.com/aprovafacil.html 2.2. Tecnologias de Conectividade Integração WebService é suportado apenas por conectividades tecnologia 2D. Esse tipo de tecnologia não redireciona o cliente para o site do adquirente, a fim de preencher as informações do cartão. Por favor, veja abaixo: TEF Buy Page Loja Komerci Web Service

(8)

2.3. Etapas da Automatização 2.3.1. Cartão de Crédito a) Requisição de aprovação; b) Requisição de captura; c) Requisição de cancelamento; d) Cancelamento de retorno nãoimediato (Reembolso); 2.3.2. Boleto Bancário a) Pedido de emissão; b) Lista de confirmação de pagamento. 2.3.3. Transferência Bancária On line (Débito On Line) a) Requisição de aprovação; b) Confirmação de recebimento de resultado; c) Retorno de confirmação de pagamento. 2.3.4. Débito em Conta Corrente a) Pedido de aprovação; b) Solicitação de Resultado de Transação. 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 envio para a Administradora da confirmação do pedido por parte da loja. A reserva de crédito estabelecida na aprovação é transformada em um débito efetivo no cartão de crédito do Cliente. A confirmação/captura pode ser realizada de forma Manual ou Automática,

(9)

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. 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. Nesse caso, o débito não será 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. 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.

Acquirer Connectivity Technology Brand Confirmation Deadline

Cielo Buy Page Loja (2D) Diners / MasterCard / Visa / Amex Até 5 dias

Buy Page Cielo (3D) Diners / MasterCard / Visa / Amex Até 5 dias

Rede

Komerci (3D) _{Diners / MasterCard / Visa / Hipercard} _2 minutos

Komerci WebService (2D) Diners / MasterCard / Visa

5 minutos

Somente é possível captura Manual com Pré Autorização, neste caso são 5 dias. (*) veja Nota 1

Santander GetNet TEF (2D) MasterCard / Visa

47 horas por padrão, mas pode ser prorrogado até 20 dias, enviar email para cadastro@cobrebem.com

(10)

Sorocred TEF (2D) Sorocred 47 horas

Cetelem TEF (2D) Aura 47 horas

As tecnologias de conectividade Komerci e Komerci WebService da Adquirente REDE não permitem confirmação (captura) do tipo manual, somente a automática com prazo de confirmação (captura) máxima de 2 e 5 minutos, respectivamente.

Nota 1: Caso o estabelecimento esteja habilitado na tecnologia de conectividade Komerci WebService com “PréAutorização”, junto à Adquirente REDE, 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 Adquirente de Cartão de Crédito REDE.

2.5. Codificação da Resposta do Aprova Fácil

Se desejar que a resposta seja codificada em UTF8, utilize na requisição, o parâmetro ResponderEmUTF8 passando para ele o valor “S”. Caso contrário, a resposta será em ISO 88591.

(11)

3. Cartão de Crédito – Pedido de Aprovação – APC

3.1. Descrição

O pedido de aprovação deverá ser usado sempre que a aplicação do desenvolvedor precisar da aprovação financeira para uma venda com cartão de crédito. Existem três tipos de pedidos de aprovação: venda única, venda recorrente e venda agendada. O pedido de venda única ocorre quando os dados são enviados ao Aprova Fácil, que, por sua vez, os envia para a Administradora, esta retorna com a resposta de aprovação ou não aprovação da transação. O pedido de venda recorrente ocorre quando um ID de pedido previamente processado é enviado ao Aprova Fácil, ao invés da informação do cartão de crédito. Assim, o Aprova Fácil recupera as informações da transação prévia do cartão de crédito e as inclui nos parâmetros recebidos antes de processála. O pedido de venda agendada ocorre quando há a necessidade de efetuar débito mensal no cartão de crédito. O Aprova Fácil realiza as transações de forma automática a partir da primeira transação aprovada no agendamento, criado de acordo com a quantidade de meses estipulada. 3.2. Métodos de Envio Como os dados passados no envio do pedido são sigilosos, o método de envio a ser adotado é o POST, através de HTTPS. 3.3. URLs Chamada 3.3.1. Servidor principal:

(12)

3.3.2. Servidor de teste:

Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.

3.4. Parâmetros do Pedido

Nota: Se não quiser usar um parâmetro opcional, simplesmente deixeo em branco. Tecnologias: TEF / Buy Page Loja / Komerci Web Service

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 ValorEntrada* Valor da taxa de

embarque.

Numérico, sendo as casas

decimais separadas por ponto (.) 123.56 Não 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***

(13)

Nome Descrição Formatação Exemplo Obrigatório PreAutorizacao Veja descrição

abaixo**** Char. S=Sim e N= Não S Não

EnderecoIPComprador IP de quem compra 000.000.000.000 200.200.200.0 Sim NomePortadorCartao Nome que está gravado no

cartão Até 50 caracteres alfanuméricos José da Silva Não

Bandeira Bandeira do cartão de crédito VISA MASTERCARD DINERS AMEX HIPERCARD JCB SOROCRED AURA MASTERCARD Não

Adquirente ***** Adquirentes preferidos para a transação BC BT CB CE CL PA RA RC RM SC SM TB BANCOMER BANORTE CREDIBANCO CIELO CETELEM ELAVON AMEX REDE REDEBAN SOROCRED GETNET TRANSBANK Não

CPFPortadorCartao CPF do portador do cartão 14 dígitos numéricos 11 dígitos numéricos

12345678123412

12345678912 Não DataNascimentoPortad

orCartao

Data de nascimento do

portador do cartão aaaammdd 20071027 Não

ParcelamentoAdministr adora

Utilizado para acionar o

(14)

Nome Descrição Formatação Exemplo Obrigatório Moeda Moeda utilizada na venda (caso não seja informado, será assumido o valor BRL) Valores válidos: BRL, MXN, CLP (Demais valores ISO para definições de moeda ISO 4217) BRL Não * Deve ser utilizado apenas por companhias aéreas. O uso deste parâmetro necessita ser habilitado pela Cobre Bem Tecnologia. ** É 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 *** Por determinação da Rede o CVV2 não deve ser solicitado do comprador quando a tecnologia utilizada for Komerci Web Service. **** A Préautorização é o bloqueio temporário de uma quantia no cartão de crédito, com objetivo de garantir a sua reserva; é um recurso que pode ser utilizado na tecnologia de conectividade Komerci WebService (REDE). O tipo de venda que contém esse recurso somente é utilizado em projetos especiais que tenham essa necessidade. ***** Reservado para uso futuro (RFU).

(15)

3.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 3.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. Caso contrário, não será realizado o agendamento. 3.5.1. Agendamento – Tecnologia de Conectividade O agendamento é suportado pelas tecnologias de conectividade listadas abaixo: – TEF , Buy Page Loja (Cielo), Komerci WebService (Rede). 3.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.

Nota: Parâmetros opcionais podem não ser informados ou informados sem valor caso não deseje utilizálos.

(16)

Nome Descrição Formatação Exemplo Obrigatório Agendamento* Utilizado Incluir ou

Excluir

Caracter: I – Incluir / E – Excluir/ A – Atualizar

I Sim

Transacao Número da Transação de Origem do Agendamento 14 caracteres numéricos 7871287987112 1 Se Agendamento= A ou E

DiaParaAgendar Dia que será feito o débito dd 09 Se

Agendamento= I

QuantidadeMesesParaAgendar Quantidade de meses a debitar 2 dígitos numéricos 08 Se Agendamento= I NumeroTentativasNaoAprovado Tentativas para aprovação 2 dígitos numéricos 04 Se Agendamento= I

QuantidadeDiasEntreTentativas Dias entre cada tentativa 2 dígitos numéricos 03 Se

Agendamento= I

ParcelamentoAdministradora Utilizado para acionar o parcelamento administradora Apenas um caracter: S S Não * Se o valor A ou E for informado para o parâmetro Agendamento, então tornase obrigatória a utilização do parâmetro Transacao. 3.6. Recorrência – Descrição A recorrência de transações é utilizada, quando se deseja efetuar novos débitos em um cartão de crédito, seja esta de qualquer periodicidade; é possível alterar o valor do débito a cada cobrança, se necessário. O processo de "recobrança" em uma recorrência, se difere do processo de "recobrança" em um agendamento. A recobrança em uma recorrência é comandada pela aplicação do lojista. Nestes casos devem ser

(17)

informados apenas os parâmetros de requisição de recorrência, conforme item 3.6.2 Recorrência – Parâmetros de Requisição. Nota: ID da transação é determinado automaticamente pelo Aprova Fácil, e cada número é único. 3.6.1. Recorrência – Tecnologias de Conectividade A recorrência de transações é suportada pelas tecnologias de conectividade: TEF, Buy Page Loja (Cielo), Komerci WebService (Rede). Existem 3 formas de capturar o CVV2 para Adquirente de Cartão de Crédito Cielo (digitada, chip e trilha). Para trabalhar com recorrência utilizando a tecnologia de conectividade TEF 4.1, é necessário desabilitar a opção digitada de CVV2. 3.6.2. Recorrência – Parâmetros de Requisição Nota: Parâmetros opcionais podem não ser informados ou informados sem valor caso não deseje utilizálos.

TransacaoAnterior Número da Transação 14 caracteres numéricos 78712879871121 Sim 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 1 Sim ParcelamentoAdmi

nistradora

Utilizado para acionar o parcelamento

administradora

Apenas um caracter: S S Não

Nota: O Número da Transação é criado automaticamente pelo Aprova Fácil, com objetivo de identificar cada transação. Esse número é único e jamais será repetido. Recomendamos que o número da última transação aprovada (referente ao cartão que será recobrado) seja informado no parâmetro “TransacaoAnterior”.

(18)

3.7. 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 a bandeira Mastercard, nas tecnologias de conectividade , Komerci e Komerci WebService, respectivamente. Se o estabelecimento do lojista possuir habilitação para realizar vendas com AVS, no momento da solicitação dos dados, deverão ser informados também os parâmetros de requisição a seguir: Nota: Se você não quiser usar um parâmetro opcional, simplesmente deixálo em branco. Tecnologia Komerci

AVS Valores: N – Não realizar

S – Para realizar consulta 01 caracter S

Sim, caso deseja que a transação contemple consulta AVS

Demais Tecnologias

AVS

Valores: N – Não realizar

S – Para realizar consulta 01 caracter maiúsculo 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

(19)

Nome Descrição Formatação Exemplo Obrigatório 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

3.8. Exemplo de Pedido 3.8.1. Venda Única Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 3.8.2. Pagamento Recorrente Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.

(20)

3.8.3. Pagamento Agendado

(21)

3.9. Resultado do Processamento Formato XML

Resposta XML do processamento de uma transação.

<ResultadoSolicitacaoAprovacao>00 APROVADA</ResultadoSolicitacaoAprovacao>

<CodigoAutorizacao>082030</CodigoAutorizacao> <Transacao>73314072604262</Transacao> <CartaoMascarado>455187******0183</CartaoMascarado> <NumeroDocumento>12345</NumeroDocumento> <ComprovanteAdministradora>RETORNO, DEPENDE DA TECNOLOGIA </ComprovanteAdministradora> <NacionalidadeEmissor> </NacionalidadeEmissor> <ResultadoAVS> </ResultadoAVS> <EnderecoAVS> <Endereco> </Endereco> <Numero> </Numero> <Complemento> </Complemento> <Cep> </Cep> </EnderecoAVS> </ResultadoAPC> 3.9.1. Descrição dos Parâmetros Seguem abaixo a descrição e formato dos parâmetros retornados no XML

(22)

Nome Descrição Formatação Exemplo Obrigatório TransacaoAprovada Resultado do pedido de

aprovação True = Aprovado False = Negado True Sim ResultadoSolicitacaoAprovac ao

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 ID da transação Aprova Fácil

Texto de 14 dígitos 73263868827369 Sim CartaoMascarado Número mascarado do

Cartão de Crédito Até 19 dígitos numéricos 444433******111 1 Sim NumeroDocumento ID do pedido da companhia Até 50 caracteres 123ABC Sim Adquirente Adquirente usado para a transação BC BT CB CE CL PA RA RC RM SC SM TB BANCOMER BANORTE CREDIBANCO CIELO CETELEM ELAVON AMEX REDE REDEBAN SOROCRED GETNET TRANSBANK Não 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

(23)

Nome Descrição Formatação Exemplo Obrigatório ResultadoAVS Resultado da verificação de

endereço (Veja a tabela do item 3.9.2)

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

Cep CEP do endereço verificado Texto nulo N/A Não

3.9.2. Tabela de Valores retornados para o parâmetro ResultadoAVS AMEX Código Descrição X Endereço e CEP 9 dígitos coincidem. Y Endereço e CEP 5 dígitos coincidem. W Somente o CEP 9 dígitos 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 dígitos coincide. Endereço não coincide. R Emissor não disponível. U Endereço indisponível. N Nada coincide. E Endereço e Cep não informado. REDE Código Descrição W Sim, todos os dígitos coincidem. X O CEP e CPF coincidem, endereço não coincide.

(24)

REDE Código Descrição 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. 3.10. Resultados de Erros Comuns Texto do Resultado Descrição Erro Valor Inválido Valor Inválido Erro Valor deve ser maior que zero Valor deve ser maior que zero Erro Número Parcelas Inválido Número Parcelas Inválido Erro Número Parcelas deve ser maior que zero Número Parcelas deve ser maior que zero Erro Transação Anterior não Localizada Transação Anterior não Localizada Erro Conectividade não permite recorrência Conectividade não permite recorrência Erro Cartão Inválido Cartão Inválido Erro Estabelecimento não cadastrado para a Bandeira XXX Adquirinte YYY Lojista não pode aceitar XXX pagamentos Erro Estabelecimento não habilitado para a Bandeira XXX Adquirinte YYY XXX desabilitado para o Lojista Erro Código do Emissor do cartão Inválido Código do Emissor do cartão Inválido Erro Mês/Ano Validade Inválidos Mês/Ano Validade Inválidos Erro Cartão fora do prazo de validade Cartão fora do prazo de validade Erro Número Parcelas Agendamento Inválido Número Parcelas Agendamento Inválido Erro Número Parcelas Agendamento deve ser maior que 1 Número Parcelas Agendamento deve ser maior que 1 Erro Dia Débito Inválido Dia Débito Inválido Erro Dia Débito deve estar entre 1 e 31 Dia Débito deve estar entre 1 e 31 Erro Número Tentativas Inválido Número Tentativas Inválido Erro Número Tentativas ser maior que 1 ou igual a zero Número Tentativas ser maior que 1 ou igual a zero

(25)

Texto do Resultado Descrição Erro Dias entre Tentativas Inválido Dias entre Tentativas Inválido Erro Dias entre Tentativas ser maior ou igual a 1 Dias entre Tentativas ser maior ou igual a 1 Erro Cliente sem Estabelecimento de Aprovação Cliente sem Estabelecimento de Aprovação Erro Conexão não Estabelecida Conexão não Estabelecida Erro Conexão AVS não Estabelecida Conexão AVS não Estabelecida Erro Sem Servidor Aprovação Sem Servidor Aprovação Erro IP não permitido IP não permitido Erro Última Aprovação para o cartão tem menos do que 5 minutos Última Aprovação para o cartão tem menos do que 5 minutos Erro Cartão com 3 tentativas não aprovadas Cartão com 3 tentativas não aprovadas 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

(26)

4. Cartão de Crédito – Pedido de Captura – CAP

4.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 realizado 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 Crédito, a mesma será automaticamente desfeita, não havendo assim o débito efetivo no cartão de crédito do cliente, essa informação será exibida no campo “Data Hora Cancelamento”do Extrato do Aprova Fácil. 4.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. 4.3. URLs 4.3.1. Servidor principal: 4.3.2. Servidor de teste:

(27)

4.4. Parâmetros de Requisição

NumeroDocumento Identificação da venda pela loja.

Até 50 caracteres

123ABC Não

Transação Número da transação 14 caracteres

numéricos 73263500055432 Se NumeroDocumento for nulo ValorDocumento* Valor a ser capturado Numérico com 2 casas decimais (separador decimal é o ponto) 123.56 Não * Utilizado apenas quando um valor parcial necessita ser capturado. Apenas algumas tecnologias de conectividade permitem a captura parcial. Entre em contato conosco para maiores informações. 4.5. Exemplos de Requisição GET 4.5.1. Captura utilizando o número documento gerado pelo estabelecimento 4.5.2. Captura Utilizando o número da transação gerado pelo Aprova Fácil

(28)

Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 4.6. Exemplo de Resultados 4.6.1. Captura com Sucesso <ResultadoCAP> <ResultadoSolicitacaoConfirmacao> Confirmado%2073263500055432 </ResultadoSolicitacaoConfirmacao> <ComprovanteAdministradora></ComprovanteAdministradora> </ResultadoCAP> 4.6.2. Captura com Erro <ResultadoCAP> <ResultadoSolicitacaoConfirmacao> Erro%20%20Transa%E7%E3o%20a%20confirmar%20n%E3o%20encontrada%20ou %20jE1%20confirmada </ResultadoSolicitacaoConfirmacao> <ComprovanteAdministradora></ComprovanteAdministradora> </ResultadoCAP> 4.7. 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. 4.8. Resultados de Erro Comuns

(29)

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

(30)

5. Cartão de Crédito – Cancelamento de Transações – CAN

5.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 confirmada pela Administradora. 5.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. 5.3. URLs 5.3.1. Servidor principal: 5.3.2. Servidor de teste: Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.

(31)

5.4. Parâmetros de Requisição

Até 50 caracteres

alfanuméricos. 123ABC Não Transacao Número da transação 14 caracteres

numéricos 73263500055432 Se NumeroDocumento for nulo ValorDocumento* Valor a ser cancelado numérico com 2 dígitos decimais (separador decimal é o ponto) 123.56 Não * Utilizado apenas quando um valor parcial necessita ser cancelado. Apenas algumas tecnologias de conectividade permitem o cancelamento parcial. Entre em contato conosco para maiores informações. 5.5. Exemplos de Requisição 5.5.1. Cancelamento utilizando o número do documento gerado pelo estabelecimento 5.5.2. Cancelamento Utilizando o ID da Transação Aprova Fácil Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil.

(32)

5.6. Resultado XML <ResultadoCAN> <ResultadoSolicitacaoCancelamento></ResultadoSolicitacaoCancelamento> <NSUCancelamento></NSUCancelamento> </ResultadoCAN> 5.7. Resultado das Tags XML

Nome Descrição Formatação Amostra Obrigatório

ResultadoCAN Tag Raiz XML N/A N/A sim

ResultadoSolicitacaoCancelamento Descrição do resultado do pedido de cancelamento texto varchar veja tabela abaixo sim NSUCancelamento Número de cancelamento da Administradora 6 dígitos numéricos 123456 não 5.8. Exemplos de Resultados 5.8.1. Cancelamento Online Com Sucesso <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Cancelado%2073263500055432 </ResultadoSolicitacaoCancelamento> <NSUCancelamento> 123456 </NSUCancelamento> </ResultadoCAN>

(33)

5.8.2. Cancelamento Marcado para Processamento com Sucesso <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Cancelamento%20marcado%20para%20envio%2073263500055432 </ResultadoSolicitacaoCancelamento> <NSUCancelamento> 123456 </NSUCancelamento> </ResultadoCAN> 5.8.3. Erro de Cancelamento OnLine <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Erro%20%20Transa%E7%E3o%20inv%E1lida </ResultadoSolicitacaoCancelamento> <NSUCancelamento></NSUCancelamento> </ResultadoCAN> 5.8.4. Erro na Marcação do Cancelamento para Processamento <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Erro%20%20Transa%E7%E3o%20inv%E1lida </ResultadoSolicitacaoCancelamento> <NSUCancelamento></NSUCancelamento> </ResultadoCAN>

(34)

5.9. Resultado de Cancelamento com Sucesso O resultado de uma transação cancelada com sucesso será a mensagem “Cancelamento OK”. 5.10. Resultados de Erros Comuns NSU Cancelamento Texto do Resultado 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 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 – Cancelamento Já Efetuado Cancelamento já efetuado 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 cancelamento não Estabelecida Conexão para cancelamento não estabelecida

(35)

6. Cartão de Crédito – Call Back de Reembolso

6.1. Descrição

Reembolso é um cancelamento feito em dias posteriores à aprovação da transação.

A funcionalidade “Reembolso” requer prévio cadastro, pois não é ativada por default quando o estabelecimento é cadastrado em nosso sistema. É necessário enviar email para cadastro@cobrebem.com

informando que deseja ativar o reembolso. Não há reembolso sem que a transação tenha sido Aprovada e Confirmada pelo estabelecimento. 6.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. 6.3. URLs 6.3.1 Servidor de Produção: 6.4. Parâmetros de Requisição

NumeroDocumento* Identificação da venda pela loja.

Até 50 caracteres alfanuméricos.

123ABC Não

Transacao Número da transação 14 caracteres numéricos 73263500055432 Sim, se o NumeroDocumento não for enviado

(36)

Nome Descrição Formatação Exemplo Obrigatório ValorDocumento** Valor a ser

reembolsado Numérico, sendo as casas decimais separadas por ponto (.) 123.56 Sim *Se o valor informado ao parametro NumeroDocumento for diferente do valor informado na solicitação de aprovação, este novo valor será devolvido dentro do parâmetro NumeroDocumento no retorno do reembolso.

Em caso de múltiplos reembolsos para a mesma transação o parâmetro NumeroDocumento será utilizado como identificador de cada solicitação de reembolso, tornandoo obrigatório. ** Ao solicitar um reembolso parcial, informe o valor desejado ao parâmetro ValorDocumento. Para uma mesma transação, pode ser efetuado mais do que um reembolso parcial. O valor total dos reembolsos parcias não pode ultrapassar o valor da transação original. 6.5.Resposta a uma Solicitação de Reembolso Bem Sucedida A mensagem "Cancelamento marcado para envio XXXXXXXXXXXXXX" aparecerá, designando uma solicitação de reembolso bem sucedida, segundos após a requisição deste. Exemplo: <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Cancelamento marcado para envio XXXXXXXXXXXXXX </ResultadoSolicitacaoCancelamento> <NSUCancelamento> XXXXXXXXXXXXXX </NSUCancelamento> </ResultadoCAN> XXXXXXXXXXXXXX = Número da Transação

(37)

7.Cartão de Crédito – Resultado de Reembolso

7.1. Descrição O resultado de um reembolso não é síncrono. O resultado de um reembolso é enviado para uma URL de retorno. 7.2. Métodos de Envio O método de envio utilizado será o GET e as informações podem ser enviadas através de HTTP ou HTTPS. 7.3. Envio do Resultado de Reembolso O resultado do processamento de um reembolso será enviado pelo gateway de pagamentos para a URL de retorno de reembolso do estabelecimento. O lojista deverá ter um script apto a receber o resultado de reembolso. A URL deste script deverá ser informada a Cobre Bem Tecnologia no momento em que a habilitação de reembolso for solicitada, através de e mail para cadastro@cobrebem.com. 7.4. Exemplo de chamada http://www.seusite.com.br/callbackcancelamento.asp? Transacao=98765432109876&NumeroDocumento=12345678&ResultadoSolicitacaoCancelamento=Mensagem+da+A dministradora&NSUCancelamento=56789012345678

(38)

7.5. Descrição dos parâmetros

Transacao Número da transação 14 caracteres numéricos 73263500055432 Sim NumeroDocumento Identificação da venda pela loja. Até 50 caracteres alfanumérico s 123ABC Sim ResultadoSolicitaca oCancelamento Resultado do processamento do reembolso Texto varchar Sucesso “Cancelado XXXXXXXXXXXXXX” onde XXXXXXXXXXXXXX é o número da transação na Cobre Bem Tecnologia.

Falha “Erro YYYYYYYYYYYYYYYYYY” onde YYYYYYYYYYYYYYYYYY é a mensagem de erro retornada pela administradora Sim NSUCancelamento Número de cancelamento da administradora 6 dígitos numéricos 123456 Não* * O NSU de cancelamento é enviado para a URL de retorno do estabelecimento somente quando esse dado é retornado para a Cobre Bem pelo adquirente. 7.6. Confirmação de Recebimento de Retorno A URL de retorno de reembolso do estabelecimento deverá responder com o string “OK”, sem as aspas, para indicar que recebeu o resultado. Caso contrário, o resultado continuará a ser enviado pelo gateway de pagamentos, pois ele considerará que os dados não foram recebidos pelo aplicativo do estabelecimento.

(39)

8. Boleto Bancário – Pedido de Emissão – BOL

8.1. Descrição O pedido de emissão irá retornar um boleto bancário em PDF para o script do cliente. Nosso retorno padrão é em PDF. 8.2. Métodos de Envio O método de envio utilizado pode ser POST ou GET por HTTPS. 8.3. URL's 8.3.1. Servidor principal: 8.3.2. Servidor teste: Nota: <usuario> deverá ser substituído pelo nome do usuário do Aprova Fácil. 8.4. Parâmetros de Requisição Nota: Parâmetros opcionais podem não ser informados ou informados sem valor caso não deseje utilizálos.

(40)

Nome Descrição Formatação Exemplo Obrigatório CCID Identifica a conta corrente a ser

utilizada para a geração do boleto

Até 15 caracteres

alfanuméricos. 1234 Sim NumeroDocumento Identificação da venda pela loja. Até 50 caracteres

alfanuméricos. 123ABC Sim ValorDocumento Valor da transação Numérico, sendo as casas decimais separadas por ponto (.) 123.56 Sim DataVencimento Data de vencimento desejada para o

boleto aaaammdd 20130412 Não

PrazoVencimento

Número de dias a serem adicionados a data corrente e gerar uma data de validade

Até 04 dígitos

numéricos 3 Não

VencimentoDiaUtil Altera o vencimento para o proximo

dia util S Alterar S Não

CNPJCPFSacado CPF ou CNPJ do cliente

14 dígitos numéricos 11 dígitos numéricos

12345678123412 12345678912 Não NomeSacado Nome do cliente Até 40 caracteres Fulano de Tal Não EnderecoSacado Endereço do cliente Até 40 caracteres Rua do

cliente,123 Não CEPSacado CEP do cliente 05 dígitos numéricos + travessão + 3 dígitos numéricos 12345008 Não CidadeSacado Nome da cidade do cliente Até 30 caracteres Rio de Janeiro Não EstadoSacado Estado do cliente 02 caracteres RJ Não EnderecoEmailSac

ado Endereço de email do sacado até 64 caracteres

fulano@teste.com .br Não PercentualJurosDia Percentual de juros a ser cobrado por dia de atraso no pagamento Numérico, sendo as casas decimais separadas por ponto (.) 0.99 Não PercentualMulta Percentual de multa a ser cobrado por atraso no pagamento Numérico, sendo as casas decimais separadas por ponto (.) 1.39 Não

(41)

Nome Descrição Formatação Exemplo Obrigatório InstrucoesCaixa Código HTML que será exibido nas instruções para o caixa código HTML <b>não receber após vencimento </b> Não

Demonstrativo Código HTML que será exibido no

demonstrativo do recibo do sacado código HTML

Referente a compra de produtos X

Não SacadorAvalista Nome do avalista quando este existir Caracteres Fulano de Tal Não ValorDesconto Valor do desconto a ser concedido

sobre o valor do documento Numérico, sendo as casas decimais separadas por ponto (.) 0.99 Não ValorOutrosAcresc imos

Valor dos acréscimos a serem somados ao valor do documento Numérico, sendo as casas decimais separadas por ponto (.) 10 Não EspecieDocumento Tipo de documento a ser impresso no boleto. Se não for informado, assumirá o valor padrão “RC” Caracteres RC Não 8.5. Exemplo de Requisição O pedido de emissão (/ BOL) deve ser originado no servidor do cliente. A fim de evitar requisições de emissões de Boletos não autorizadas apenas o IP do servidor do cliente será habilitado para essa funcionalidade. Nota: Se um pedido não autorizado de emissão de Boleto for identificado, a seguinte mensagem de erro será retornada: "IP Localidade: Não Autorizado", conforme indicado nos itens: 8.6.2 e 8.7 8.6. Resultados 8.6.1. Resultados Bem Sucedidos É retornado o PDF do boleto para a loja.

(42)

8.6.2. Resultados Erro na Transação

É retornada para o navegador do cliente uma string (HTML) tag <font color="#FF0000"> <b>. Abaixo está um exemplo genérico:

<html><title>Cobre Bem Tecnologia Aprova Fácil</title>

<body><table><tr><td colspan=2><center><font color="#FF0000"><b>Cliente não encontrado.</b></font></center></td></tr></table>

</body></html> 8.7. Resultados de Erros Comuns

Resultado Descrição Ação Sugerida

Cliente não encontrado. Cliente não encontrado Confira nome de usuário na URL CCID não informado. CCID não informado Verifique o parâmetro CCID Conta corrente boleto não

encontrado.

Conta corrente boleto não encontrado Verifique o parâmetro CCID Conta corrente boleto sem licença. Conta corrente boleto sem licença Contate nosso suporte IP Não Autorizado. IP Não Autorizado Contate nosso suporte Cliente boleto não encontrado. Estabelecimento não habilitado para

boleto

Contate nosso suporte

* Por favor, informenos se você receber uma mensagem de erro diferente das listadas acima, através do email suporte@cobrebem.com e relate a mensagem de erro exatamente como a recebeu.

(43)

9. Transferências Bancárias On Line – Pedido de Aprovação TRX

9.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 XML contendo um HTML que redicionará o navegador do cliente para o site do banco selecionado. 9.2. Métodos de Envio O método de envio de dados deve ser via POST para um link em protocolo HTTPS. 9.3. URLs 9.3.1. Servidor principal: Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 9.4. Parâmetros de Requisição Nota: Parâmetros opcionais podem não ser informados ou informados sem valor caso não deseje utilizálos.

Até 50 caracteres alfanuméricos.

123ABC Não

(44)

Nome Descrição Formatação Exemplo Obrigatório ValorDocumento Valor da transação Numérico, sendo as casas

decimais separadas por ponto (.) 123.56 Sim Bandeira Nome do banco Valores válidos são: BBRASIL / BANRISUL / BRADESCO / HSBC / ITAU BRADESCO Sim

CNPJCPFSacado CNPJ ou CPF do sacado 14 dígitos numéricos 11 dígitos numéricos 12345678123412 12345678912 Não Glossário para o item 9.4 da tabela: BBRASIL = Banco do Brasil BANRISUL = Banco do Estado do Rio Grande do Sul 9.5. Requisição O pedido de aprovação Transferência Bancária Online (/ TRX) devem ser originados de servidor do cliente. A fim de evitar bancários online pedidos de aprovação de transferência não autorizada, IP apenas do servidor cliente será habilitado para essa funcionalidade. Nota: No caso de um pedido de aprovação não autorizado Transferência Bancária Online ser identificado, a seguinte mensagem de erro será retornada: "IP Localidade: Não Autorizado", conforme indicado nos itens: 9.6.2.2 e 9.7.2. 9.6. Exemplo de Resultados 9.6.1. Chamada de inicialização bem sucessida

A resposta irá retornar um XML com o código HTML embutido na tag <ResultadoSolicitacaoAprovacao> . O HTML irá variar de acordo com o Banco selecionado.

Desenvolvedor: Este HTML irá redirecionar automaticamente o comprador para o ambiente do Banco. Abaixo está um exemplo genérico:

(45)

<ResultadoAPC> <TransacaoAprovada>False</TransacaoAprovada> <ResultadoSolicitacaoAprovacao> <html><body onLoad="document.forms[0].submit();"><p> </p><p> </p><p><center>Aguarde um instante...</center></p><form action=https://www.bancoselecionado.com.br method=post><input type=hidden name=TRANSACAO value=1><input type=hidden name=FILIACAO value=123><input type=hidden name=NUMPEDIDO value=123456></form></body></html> </ResultadoSolicitacaoAprovacao> <CodigoAutorizacao></CodigoAutorizacao> <Transacao>73314072604262</Transacao>

<CartaoMascarado>Cartao Nao Informado</CartaoMascarado>

<ComprovanteAdministradora></ComprovanteAdministradora> <NacionalidadeEmissor></NacionalidadeEmissor> <ResultadoAVS></ResultadoAVS> <EnderecoAVS> <Endereco></Endereco> <Numero></Numero> <Complemento></Complemento> <Cep></Cep> </EnderecoAVS> </ResultadoAPC> 9.6.2. Erro de inicialização de Chamadas 9.6.2.1. Em XML A mensagem de erro aparecerá na tag XML <ResultadoSolicitacaoAprovacao>.

(46)

Abaixo um exemplo genérico:

<TransacaoAprovada>False</TransacaoAprovada> <ResultadoSolicitacaoAprovacao>Erro Numero Parcelas Invalido</ResultadoSolicitacaoAprovacao>

<CartaoMascarado>Cartao Nao Informado</CartaoMascarado>

<ComprovanteAdministradora></ComprovanteAdministradora> <NacionalidadeEmissor></NacionalidadeEmissor> <ResultadoAVS></ResultadoAVS> <EnderecoAVS> <Endereco></Endereco> <Numero></Numero> <Complemento></Complemento> <Cep></Cep> </EnderecoAVS> </ResultadoAPC> 9.6.2.2. Em HTML A mensagem de erro irá aparecer no HTML tag <font color="#FF0000"> <b>. Abaixo um exemplo genérico:

<html><title>Cobre Bem Tecnologia Aprova Fácil</title>

<body><table><tr><td colspan=2><center><font color="#FF0000"><b>Cliente não encontrado.</b></font></center></td></tr></table>

(47)

9.7. Resultados de Erros Comuns

9.7.1. Em XML con Tag: <ResultadoSolicitacaoAprovacao>

Erro Conexão não Estabelecida [XXXXXX][IP XXXXXX] Conexão não estabelecida Tente novamente Erro Estabelecimento não cadastrado para a Bandeira XXXXXX Bandeira não habilitada no usuário do Aprova Fácil Contate nossa equipe de suporte Erro Numero Parcelas Invalido Número Parcelas Invalido Verificar parâmetro

QuantidadeParcelas Erro Read Timeout Tempo Expirado Tente novamente Erro Valor deve ser maior que zero Valor> 0 Verificar parametro

ValorDocumento Erro YYYYYY Mensagem de Erro Variável Notifique o suporte *

Glossário para o item 9.7.1 da Tabela:

XXXXXX = Texto Variável YYYYYY = Messagem Não Mapeada

9.7.2. Em HTML on Tag: <font color="#FF0000"><b>

Cliente não encontrado. Cliente não encontrado Confira nome de usuário na URL IP Não Autorizado. IP Não Autorizado Contate nossa equipe de suporte Método não suportado. Método não suportado Confira método de envio

* Por favor, informenos se você suspeitar que a mensagem de erro recebida não foi gerada pelo adquirente, mas a partir de nosso sistema, através do email suporte@cobrebem.com e informe a mensagem de erro recebida com exatidão.

(48)

10. Transferências Bancárias On Line – Retorno de Confirmação de Pedido

10.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. 10.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. 10.3. URL Segue um exemplo: https://pagamento.lojacliente.com/RetornoTransacao.php 10.4. Parâmetros de Retorno Nota: A ordem de envio dos parâmetros é aleatória evitando assim, possíveis vulnerabilidades na aplicação do lojista. Mais informações sobre este assunto podem ser obtidas em: https://media.blackhat.com/bheu11/Marco_Balduzzi/BlackHat_EU_2011_Balduzzi_HTTP_ParameterSlides.pdf (Última data de acesso: 29/09/2011)

NumeroDocumento Identificação da venda do Lojista Até 50 caracteres 123ABC Não TransacaoAprovad

a

Resultado da transação True ou False True Sim CodigoAutorizacao Código de autorização devolvido pelo banco Texto varchar N12345 Sim se aprovada ResultadoSolicitaca oAprovacao

Descrição do resultado da requisição

Texto varchar Autoriza%E7%E3o %20

%2073433262195404

(49)

Nome Descrição Formatação Exemplo Obrigatório Transacao ID da transacao Aprova Fácil Texto de 14 dígitos 73263868827369 Sim CartaoMascarado Número do Cartão de Crédito

Mascarado. Nos retornos de transferência, o resultado será sempre “Cartao%20Nao %20Informado” Até 19 dígitos numéricos Cartao%20Nao %20Informado Não

ValorDocumento Valor da transação informado pelo lojista no momento da requisição de aprovação numérico com 2 dígitos decimais (separador decimal é o ponto) 123.56 Não

QuantidadeParcelas Quantidade de parcelas informada pelo lojista no momento da solicitação de aprovação.

2 dígitos numéricos 01 Não

Bandeira Nome do banco informado pelo lojista no momento da solicitação de aprovação. Válores válidos são: BBRASIL BANRISUL BRADESCO HSBC ITAU BRADESCO Não MesValidade Mês em que o cartão expira. Nos retornos de transferência, seu valor será sempre igual a “00”

AnoValidade Ano em que o cartão expira. Nos retornos de transferência, seu valor será sempre igual a “00”

NumeroSequencial Unico

N /A Sempre em branco Não

NumeroControleRe de

(50)

Nome Descrição Formatação Exemplo Obrigatório ResultadoAVS Resultado da verificação de

endereço. Nos retornos de transferência, seu valor será sempre “F”

01 caracter maiúsculo F Não

NUMPEDIDO Número que bancos utilizam para identificar a transação. 14 caracteres 73263868827369 Não 10.5. Exemplo de Retorno https://pagamento.lojacliente.com/RetornoTransacao.php? NumeroDocumento=123ABC&TransacaoAprovada=True&CodigoAutorizacao=123456&ResultadoSolicitacao Aprovacao=Autoriza%E7%E3o%20 %2073433262195404&Transacao=73561234567898&CartaoMascarado=Cartao%20Nao %20Informado&ValorDocumento=123.56&QuantidadeParcelas=01&Bandeira=BRADESCO&MesValidade=0 0&AnoValidade=00&NumeroSequencialUnico=&NumeroControleRede=&ResultadoAVS=F&NUMPEDIDO= 73561234567898 10.6. Resultados de Erros Comuns Texto 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

(51)

11. Débito Automático em Conta Corrente – Pedido de Aprovação – DEB

11.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 débito automático em conta corrente. O Aprova Fácil envia um arquivo de remessa ao Banco, para que este realize o processamento dos débitos. 11.2. Métodos de Envio O método utilizado deve ser o POST ou GET, e as informações devem ser enviadas através de HTTPS, já que serão trafegados dados sigilosos. 11.3. URL 11.3.1. Servidor principal: 11.3.2. Servidor teste: Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 11.4. Parâmetros de Requisição Nota: Parâmetros opcionais podem não ser informados ou informados sem valor caso não deseje utilizálos.

(52)

Nome Descrição Formatação Exemplo Obrigatório NumeroDocumento Identificação da venda

pela loja.

Até 50 caracteres

alfanuméricos. 123ABC Sim ValorDocumento Valor da transação

Numérico, sendo as casas decimais separadas por ponto (.)

123.56 Sim

NumeroBanco Identifica o Banco 3 digitos 001 Sim

CodigoAgencia

Código da agência da conta corrente a ser debitada

Somente dígitos de 0 a 9, P

ou X 12707 Sim

ContaCorrente Número da conta corrente a ser debitada

Somente dígitos de 0 a 9, P

ou X 56749 Sim

TitularContaCorrente Nome do titular da conta

corrente a ser debitada Até 40 caracteres Cliente da Loja Sim

CNPJCPFSacado CPF ou CNPJ do Sacado 11 digitos se CPF 14 digitos se CNPJ12345678123412 12345678912 12345678123412 12345678912 Sim

DataNascimentoSacado Data de nascimento do

sacado aaaammdd 20071027 Não

Agendamento Utilizado para incluir ou excluir um agendamento Apenas um caracter: I – Incluir/ E – Excluir/ A Atualizar I Não

TransacaoAnterior ID transação Aprova

Facil 14 digitos numéricos 78712879871121 Se Agendamento=A ou E DiaParaAgendar Dia de cada mês em que será feito o débito dd 09 Se Agendamento=I QuantidadeMesesParaA gendar Quantidade de meses para agendar 2 dígitos inteiros 08 Se Agendamento=I

(53)

Nome Descrição Formatação Exemplo Obrigatório NumeroTentativasNao

Aprovado

Número de tentativas para a transação ser aprovada 2 dígitos inteiros 04 Se Agendamento=I QuantidadeDiasEntreTe ntativas Quantidade de dias entre cada tentativa 2 dígitos inteiros 03 Se Agendamento=I DataVencimento Data para qual o débito deve ser programado. Esta data deve ser maior ou igual ao prazo mínimo permitido para o convênio em cada Banco. aaaammdd 20080820 Não * Se os valores de A ou E forem informados para o parâmetro marcado Agendamento, o parâmetro marcado TransacaoAnterior deve ser usado. Nota: O parâmetro NumeroDocumento não pode ter valores repetidos.

Nota: Cada banco possui um formato diferente para as propriedades CodigoAgencia e ContaCorrente. Entre em contato conosco para saber como serão preenchidas.

11.5. Exemplo de Requisição

(54)

Nota: <usuario> deverá ser substituído pelo seu usuário de acesso ao extrato do Aprova Fácil. 11.6. Exemplo de Resultados 11.6.1. Dados Corretos <Resposta><Transacao>XXXXXXXXXX</Transacao></Resposta> Onde: XXXXXXXXXX é um número único gerado para identificar a transação. 11.6.2. Dados Incorretos

<Resposta><Erro> YYYYYYYYYY</Erro></Resposta>

Onde: YYYYYYYYYY é a descrição do erro.

11.6.3. Exemplos de resposta

<Resposta><Transacao>73127890046539</Transacao></Resposta> <Resposta><Erro>Conta Corrente Inválida</Erro></Resposta> <Resposta><Erro>Banco não Suportado</Erro></Resposta> <Resposta><Erro>Agência Inválida</Erro></Resposta>

(55)

(56)

Aprova Fácil. Integração via WebService

Aprova Fácil

1. Introdução

2. Integração

3. Cartão de Crédito – Pedido de Aprovação – APC

4. Cartão de Crédito – Pedido de Captura – CAP

5. Cartão de Crédito – Cancelamento de Transações – CAN

6. Cartão de Crédito – Call Back de Reembolso

7.Cartão de Crédito – Resultado de Reembolso

8. Boleto Bancário – Pedido de Emissão – BOL

9. Transferências Bancárias On Line – Pedido de Aprovação ­ TRX

10. Transferências Bancárias On Line – Retorno de Confirmação de Pedido

11. Débito Automático em Conta Corrente – Pedido de Aprovação – DEB

9. Transferências Bancárias On Line – Pedido de Aprovação TRX