Aprova Fácil. Integração via WebService

Transcrição

1 AprovaFácil IntegraçãoviaWebService AprovaFácil WebServiceIntegração Versão

2 PrezadoCliente, EsteéoManualdeintegraçãodoAprovaFácil ModoWebService,quedeveserencaminhadoaoseu desenvolvedor. Omodo WebService éuma formade integração simples, que dispensaa instalação de clientesdo AprovaFácilnoservidordoLojista. Esperamos através desta documentação orientá lo da melhor forma possível e aproveitamos a oportunidadeparacolocar nosàsuadisposiçãoparamaioresesclarecimentos. Paraentraremcontatoconosco,utilizeoscanaisdecontatodisponibilizadosnaURLabaixo: contato.html Nota: DeacordocomasexigênciasdoPCI DSSaCobreBemTecnologianãoéautorizadaa recebernúmerosdecartãodecrédito.casonecessitedesuporteemrelaçãoaalgumatransação efetuada,nosinformeonúmerodatransação. BoascobrançaseCobreBem! EquipeCobreBem AprovaFácil WebServiceIntegração Versão

3 ÍNDICE 1.Introdução Integração MeiosdePagamentoSuportados TecnologiasdeConectividade EtapasdaAutomatização TempodeCapturadeumaTransaçãoAprovada CodificaçãodaRespostadoAprovaFácil CartãodeCrédito PedidodeAprovação APC MétodosdeEnvio URLsChamada ParâmetrosdoPedido Agendamento Recorrência ConsultaAVS(AdressVerificationService) ExemplodePedido ResultadodoProcessamentoFormatoXML ResultadosdeErrosComuns CartãodeCrédito PedidodeCaptura CAP CAP MétodosdeEnvio URLs ParâmetrosdeRequisição ExemplosdeRequisiçãoGET ExemplodeResultados ResultadodeCapturacomSucesso ResultadosdeErroComuns CartãodeCrédito CancelamentodeTransações CAN...30 AprovaFácil WebServiceIntegração Versão

4 MétodosdeEnvio URLs ParâmetrosdeRequisição ExemplosdeRequisição ResultadoXML ResultadodasTagsXML ExemplosdeResultados ResultadodeCancelamentocomSucesso ResultadosdeErrosComunsNSUCancelamento CartãodeCrédito CallBackdeReembolso MétodosdeEnvio URLs ParâmetrosdeRequisição RespostaaumaSolicitaçãodeReembolsoBemSucedida CartãodeCrédito ResultadodeReembolso MétodosdeEnvio EnviodoResultadodeReembolso Exemplodechamada dosparâmetros ConfirmaçãodeRecebimentodeRetorno BoletoBancário PedidodeEmissão BOL MétodosdeEnvio URL's ParâmetrosdeRequisição ExemplodeRequisição Resultados ResultadosdeErrosComuns...42 AprovaFácil WebServiceIntegração Versão

5 9.TransferênciasBancáriasOnLine PedidodeAprovação MétodosdeEnvio URLs ParâmetrosdeRequisição Requisição ExemplodeResultados ResultadosdeErrosComuns TransferênciasBancáriasOnLine RetornodeConfirmaçãodePedido MétodosdeEnvio URL ParâmetrosdeRetorno ExemplodeRetorno ResultadosdeErrosComuns DébitoAutomáticoemContaCorrente PedidodeAprovação DEB MétodosdeEnvio URL ParâmetrosdeRequisição ExemplodeRequisição ExemplodeResultados DiagramadeFuncionamento...55 AprovaFácil WebServiceIntegração Versão

6 1.Introdução OWebServiceéumadasformasdisponíveisparaefetuaraintegraçãodesualojavirtual/aplicativocoma soluçãodeautomatizaçãodevendasatravésdediversosmeiosdepagamento,ogatewayaprovafácil. AprovaFácil WebServiceIntegração Versão

7 2.Integração Parainiciaresteprocesso,odesenvolvedordevenosinformaroendereçodeIPfixodoestabelecimento queestaráusandoogatewaydepagamentosaprovafácil. ÉobrigatórioqueoendereçodeIPsejafixoparaestemétododeintegração. SeoendereçoIPdocomerciantenãoforfixo,ométododeintegraçãoidealéoSTAC,emqueo compradoréredirecionadoparaoambientesegurodacobrebemtecnologia,ondetodososdadossensíveis serãoinseridos. Porfavor,soliciteomanualdeintegraçãoSTACseesteestivermaisadequadoàsuasituação. Nota:QuandooambientedetestesdaCobreBemestiversendousado,nãoénecessárioinformarum endereçodeip,porqueonossoservidordetestenãovalidaoipdeorigemdatransação. 2.1.MeiosdePagamentoSuportados OAprovaFácilrealizaaautomatizaçãodediversosmeiosdepagamentosimultaneamentecomBancos eadministradorasdecartõesdecrédito,utilizandoainternetcomomeiodecaptura. aprovafacil.html 2.2.TecnologiasdeConectividade IntegraçãoWebServiceésuportadoapenasporconectividadestecnologia2D.Essetipodetecnologia nãoredirecionaoclienteparaositedoadquirente,afimdepreencherasinformaçõesdocartão.porfavor,veja abaixo: TEF BuyPageLoja KomerciWebService AprovaFácil WebServiceIntegração Versão

8 2.3.EtapasdaAutomatização CartãodeCrédito a)requisiçãodeaprovação; b)requisiçãodecaptura; c)requisiçãodecancelamento; d)cancelamentoderetornonão imediato(reembolso); BoletoBancário a)pedidodeemissão; b)listadeconfirmaçãodepagamento TransferênciaBancáriaOnline(DébitoOnLine) a)requisiçãodeaprovação; b)confirmaçãoderecebimentoderesultado; c)retornodeconfirmaçãodepagamento DébitoemContaCorrente a)pedidodeaprovação; b)solicitaçãoderesultadodetransação TempodeCapturadeumaTransaçãoAprovada NasvendasrealizadasatravésdomeiodepagamentoCartãodeCrédito,épossívelrealizarconfirmação (captura)datransaçãode02(duas)formas: Manual; Automática. Aconfirmação/capturadeumatransaçãoserefereaoenvioparaaAdministradoradaconfirmaçãodo pedidoporpartedaloja.areservadecréditoestabelecidanaaprovaçãoétransformadaemumdébitoefetivono cartão de crédito do Cliente. A confirmação/captura pode ser realizada de forma Manual ou Automática, AprovaFácil WebServiceIntegração Versão

9 dependendodaimplementaçãorealizadapelodesenvolvedor. OLojistadeterminaomododaconfirmação/capturadeacordocomotipodevenda/negócioadotado. Geralmente, o Lojista adota o modo de confirmação com captura manual, quando deseja realizar uma verificaçãodopedidoantesdeconfirmar/capturaratransaçãojuntoàadministradoradecartãodecrédito. CasoolojistanãorealizeacapturadatransaçãonoprazoestipuladopelasAdministradorasdeCartãode Crédito,deacordocomatecnologiadeconectividade,amesmaserádesfeitaautomaticamente.Nessecaso,o débitonãoserárealizadonocartãodecréditodocliente. Olojistapoderávisualizaradata/horadesseprocesso,denominado Desfazimento datransação,no campo Data/HoraCancelamento existentenoextratodoaprovafácil. Segueumquadroilustrativo,contendoosprazosdeconfirmação(captura)datransação,deacordocom atecnologiadeconectividadeeadministradoradecartãodecréditoparasuaanálise. Acquirer Cielo ConnectivityTechnology Brand ConfirmationDeadline BuyPageLoja(2D) Diners/MasterCard/Visa/Amex Até5dias BuyPageCielo(3D) Diners/MasterCard/Visa/Amex Até5dias Komerci(3D) Diners/MasterCard/Visa/Hipercard 2minutos 5minutos Rede KomerciWebService(2D) Diners/MasterCard/Visa Somenteépossívelcaptura Manual com Pré Autorização, neste caso são5dias.(*)vejanota1 47 horas por padrão, mas Santander GetNet TEF(2D) MasterCard/Visa podeserprorrogadoaté20 dias, enviar e mail para [email protected] Elavon TEF(2D) Diners/MasterCard/Visa AprovaFácil WebServiceIntegração Versão horas 9

10 Sorocred TEF(2D) Sorocred 47horas Cetelem TEF(2D) Aura 47horas As tecnologias de conectividade Komerci e Komerci WebService da Adquirente REDE não permitem confirmação(captura)dotipomanual,somenteaautomáticacomprazodeconfirmação(captura)máximade2 e5minutos,respectivamente. Nota 1: Caso o estabelecimento esteja habilitado na tecnologia de conectividade Komerci WebServicecom Pré Autorização,juntoàAdquirenteREDE,acapturapoderáserrealizadade formamanual.nestecaso,oprazopararealizaraconfirmação(captura)éde5diascorridosa partirdadatadoprocessamentorealizadopelaadquirentedecartãodecréditorede. 2.5.CodificaçãodaRespostadoAprovaFácil Se desejar que a resposta seja codificada em UTF 8, utilize na requisição, o parâmetro ResponderEmUTF8passandoparaeleovalor S.Casocontrário,arespostaseráemISO AprovaFácil WebServiceIntegração Versão

11 3.CartãodeCrédito PedidodeAprovação APC 3.1. O pedido de aprovação deverá ser usado sempre que a aplicação do desenvolvedor precisar da aprovaçãofinanceiraparaumavendacomcartãodecrédito. Existemtrêstiposdepedidosdeaprovação:vendaúnica,vendarecorrenteevendaagendada. OpedidodevendaúnicaocorrequandoosdadossãoenviadosaoAprovaFácil,que,porsuavez,os enviaparaaadministradora,estaretornacomarespostadeaprovaçãoounãoaprovaçãodatransação. Opedidodevendarecorrenteocorrequando um IDdepedidopreviamenteprocessado éenviado ao AprovaFácil,aoinvésdainformaçãodocartãodecrédito.Assim,oAprovaFácilrecuperaasinformaçõesda transaçãopréviadocartãodecréditoeasincluinosparâmetrosrecebidosantesdeprocessá la. Opedidodevendaagendadaocorrequandoháanecessidadedeefetuardébitomensalnocartãode crédito.oaprovafácilrealizaastransaçõesdeformaautomáticaapartirdaprimeiratransaçãoaprovadano agendamento,criadodeacordocomaquantidadedemesesestipulada. 3.2.MétodosdeEnvio Comoosdadospassadosnoenviodopedidosãosigilosos,ométododeenvioaseradotadoéoPOST, atravésdehttps. 3.3.URLsChamada Servidorprincipal: AprovaFácil WebServiceIntegração Versão

12 3.3.2.Servidordeteste: Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. 3.4.ParâmetrosdoPedido Nota:Senãoquiserusarumparâmetroopcional,simplesmentedeixe oembranco. Tecnologias:TEF/BuyPageLoja/KomerciWebService Nome NumeroDocumento ValorDocumento ValorEntrada* QuantidadeParcelas NumeroCartao MesValidade AnoValidade Formatação Identificaçãodavenda Exemplo Até50caracteresalfanuméricos. 123ABC pelaloja. Numérico, sendo as casas Valordatransação decimaisseparadasporponto(.) Valor da taxa de Numérico, sendo as casas Obrigatório embarque. decimaisseparadasporponto(.) Quantidadedeparcelas 02dígitosnuméricos 01 Até19dígitosnuméricos dígitosnuméricos 11 02dígitosnuméricos 08 Número do cartão de crédito Mês em que o cartão expira Ano em que o cartão expira, se tecnologia CodigoSeguranca** CVC2/CVV2docartão Até04dígitosnuméricos 123 diferente de Komerci Web Service*** AprovaFácil WebServiceIntegração Versão

13 Nome PreAutorizacao Veja Formatação descrição abaixo**** EnderecoIPComprador IPdequemcompra NomePortadorCartao Nomequeestágravadono cartão Exemplo Obrigatório Char.S=eN= S Até50caracteresalfanuméricos JosédaSilva VISA MASTERCARD DINERS Bandeira Bandeira do cartão de AMEX crédito HIPERCARD MASTERCARD JCB SOROCRED AURA Adquirente***** CPFPortadorCartao BT BANORTE CB CREDIBANCO CE CIELO CL CETELEM ELAVON paraatransação RA AMEX RC REDE RM REDEBAN SC SOROCRED SM GETNET TB TRANSBANK 14dígitosnuméricos dígitosnuméricos aaaammdd Apenasumcaracter:S S CPFdoportadordocartão portadordocartão ParcelamentoAdministr Utilizado para acionar o adora BANCOMER Adquirentes preferidos PA DataNascimentoPortad Data de nascimento do orcartao BC parcelamentoadquirente AprovaFácil WebServiceIntegração Versão

14 Nome Formatação Exemplo Obrigatório Moedautilizadanavenda Valoresválidos:BRL,MXN, (casonãosejainformado, CLP(DemaisvaloresISOpara Moeda seráassumidoovalor definiçõesdemoeda ISO BRL) 4217) BRL *Deveserutilizadoapenasporcompanhiasaéreas.Ousodesteparâmetronecessitaserhabilitadopela CobreBemTecnologia. **ÉpossívelcontrolaroresultadonoambientedetestesdoAprovaFácil.Paraisto,utilizeoparâmetro CodigoSeguranca.Vejaabaixooresultadoesperado.EssamodalidadenãoestádisponívelparaAurae Sorocred. CodigoSegurancaInformado Retorno 555ou123 Autorizado NAOAUTORIZADA CARBLOQ1.USO RETERCARTAO CARTAOINVALIDO ValorInválido.Porfavor,ent T68TRANSACAOJAEFETUADA CARTAOVENCIDO DadoInválido.Porfavor,entr 444 N7 N7COD.SEG.INVAL T84REFACATRANS *** PordeterminaçãodaRedeoCVV2nãodevesersolicitadodocompradorquandoatecnologia utilizadaforkomerciwebservice. ****APré autorizaçãoéobloqueiotemporáriodeumaquantianocartãodecrédito,comobjetivode garantirasuareserva;éumrecursoquepodeserutilizadonatecnologiadeconectividadekomerciwebservice (REDE).Otipodevendaquecontémesserecursosomenteéutilizadoemprojetosespeciaisquetenhamessa necessidade. *****Reservadoparausofuturo(RFU). AprovaFácil WebServiceIntegração Versão

15 3.5.Agendamento Oagendamentodetransaçõeséutilizado,quandoháanecessidadedeefetuarmensalmenteodébitono cartãodecréditodoclientemantendosempreasmesmascondições: Mesmovalor; Débitomensalrealizadosemprenomesmodia. OagendamentoérealizadodeformaautomáticapeloAprovaFácil,obedecendoasregrasdedébito informadasatravésdosparâmetrosdeagendamentosdescritosnoitem3.5.2destemanual. Importante:Paraqueoagendamentosejaaceitoénecessárioqueaprimeiratransaçãotenhasido aprovada pela Administradora de Cartão de Crédito. Caso contrário, não será realizado o agendamento Agendamento TecnologiadeConectividade Oagendamentoésuportadopelastecnologiasdeconectividadelistadasabaixo: TEF,BuyPageLoja(Cielo),KomerciWebService(Rede) Agendamento ParâmetrosUtilizadosparaAgendarumaTransação Os parâmetros de requisição, exibidos na tabela abaixo, devem ser enviados na primeira solicitaçãodedébitodocartãodecréditojuntamentecomosdemaisdadosdopedido. Nestecasoo parâmetronumerodocumentopassaaserobrigatório,nãopoderásernuloedeveráserúnico. Nota:Parâmetrosopcionaispodemnãoserinformadosouinformadossemvalorcaso nãodesejeutilizá los. AprovaFácil WebServiceIntegração Versão

16 Nome Formatação Utilizado Incluir ou Caracter:I Incluir Agendamento* Excluir Exemplo I Obrigatório / E Excluir/ A Atualizar Transacao Número da Transação de 14 OrigemdoAgendamento caracteres Se numéricos 1 Agendamento= AouE DiaParaAgendar Diaqueseráfeitoodébito dd 09 Se Agendamento= I QuantidadeMesesParaAgendar Quantidade de meses a 2dígitosnuméricos 08 debitar Se Agendamento= I NumeroTentativasNaoAprovado Tentativaspara 2dígitosnuméricos 04 aprovação Se Agendamento= I QuantidadeDiasEntreTentativas Diasentrecadatentativa 2dígitosnuméricos 03 Se Agendamento= I ParcelamentoAdministradora Utilizado para acionar o Apenasum parcelamento S caracter:s administradora * Se o valor A ou E for informado para o parâmetro Agendamento, então torna se obrigatória a utilizaçãodoparâmetrotransacao. 3.6.Recorrência Arecorrênciadetransaçõeséutilizada,quandosedesejaefetuarnovosdébitosemumcartãodecrédito, sejaestadequalquerperiodicidade;épossívelalterarovalordodébitoacadacobrança,senecessário. O processo de "re cobrança" em uma recorrência, se difere do processo de "re cobrança" em um agendamento.are cobrançaemumarecorrênciaécomandadapelaaplicaçãodolojista.nestescasosdevemser AprovaFácil WebServiceIntegração Versão

17 informadosapenasosparâmetrosderequisiçãoderecorrência,conformeitem3.6.2recorrência Parâmetros derequisição. Nota:IDdatransaçãoédeterminadoautomaticamentepeloAprovaFácil,ecadanúmeroé único Recorrência TecnologiasdeConectividade Arecorrênciadetransaçõesésuportadapelastecnologiasdeconectividade:TEF,BuyPage Loja(Cielo),KomerciWebService(Rede). Existem3formasdecapturaroCVV2paraAdquirentedeCartãodeCréditoCielo(digitada, chip e trilha). Para trabalhar com recorrência utilizando a tecnologia de conectividade TEF 4.1, é necessáriodesabilitaraopçãodigitadadecvv Recorrência ParâmetrosdeRequisição Nota: Parâmetros opcionais podemnão ser informados ouinformadossemvalorcasonão desejeutilizá los. Nome TransacaoAnterior NúmerodaTransação ValorDocumento Valordatransação QuantidadeParcelas Quantidadedeparcelas Formatação 14caracteresnuméricos Exemplo Numérico, sendo as casas decimaisseparadasporponto(.) 02dígitosnuméricos ParcelamentoAdmi Utilizado para acionar o Apenasumcaracter:S nistradora Obrigatório S parcelamento administradora Nota:ONúmerodaTransaçãoécriadoautomaticamentepeloAprovaFácil,comobjetivode identificar cada transação. Esse número é único e jamais será repetido. Recomendamos que o número da última transaçãoaprovada(referenteaocartãoqueseráre cobrado)sejainformadonoparâmetro TransacaoAnterior. AprovaFácil WebServiceIntegração Versão

18 3.7.ConsultaAVS(AdressVerificationService) OAVSéumserviçooferecidopelasAdministradorasdeCartãodeCrédito,paraqueolojistapossa realizarumaconsultaparaconfirmaçãodosdadosdecpf(cadastropessoafísica)edoendereçodeentregada faturadotitulardocartãonoatodacompra. Para disponibilizar essa consulta, o estabelecimento deverá habilitar esse serviço junto às AdministradorasdeCartãodeCrédito,e,após,informaràCobreBemTecnologiaqueamesmaseráutilizada. AconsultaAVSésuportadaparaabandeiraMastercard,nastecnologiasdeconectividade,Komercie KomerciWebService,respectivamente. SeoestabelecimentodolojistapossuirhabilitaçãopararealizarvendascomAVS,nomomentoda solicitaçãodosdados,deverãoserinformadostambémosparâmetrosderequisiçãoaseguir: Nota:Sevocênãoquiserusarumparâmetroopcional,simplesmentedeixá loembranco. TecnologiaKomerci Nome AVS Valores:N realizar S Pararealizarconsulta Formatação Exemplo 01caracter S Obrigatório,casodesejaqueatransação contempleconsultaavs DemaisTecnologias Nome Formatação Exemplo Obrigatório Valores:N realizar AVS CPFPortadorCartao S Para realizar consulta 01caractermaiúsculo S CPFdoPortadordocartão 14dígitosnuméricos decrédito dígitosnuméricos AprovaFácil WebServiceIntegração Versão SeAVS=S 18

19 Nome EnderecoPortadorCartao CEPPortadorCartao Formatação Endereço do Portador do Até50caracteres cartãodecrédito Endereço+número CEPdoPortadordocartão decrédito 08dígitosnuméricos Exemplo Obrigatório Av.dasflores123 SeAVS=S SeAVS=S 3.8.ExemplodePedido VendaÚnica Nota: <usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoaprova Fácil PagamentoRecorrente Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprova Fácil. AprovaFácil WebServiceIntegração Versão

20 3.8.3.PagamentoAgendado Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprova Fácil PagamentocomConsultaAVS AprovaFácil WebServiceIntegração Versão

21 Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. 3.9.ResultadodoProcessamentoFormatoXML RespostaXMLdoprocessamentodeumatransação. <ResultadoAPC> <TransacaoAprovada>TRUE</TransacaoAprovada> <ResultadoSolicitacaoAprovacao>00 APROVADA</ResultadoSolicitacaoAprovacao> <CodigoAutorizacao>082030</CodigoAutorizacao> <Transacao> </Transacao> <CartaoMascarado>455187******0183</CartaoMascarado> <NumeroDocumento>12345</NumeroDocumento> <ComprovanteAdministradora>RETORNO,DEPENDEDATECNOLOGIA </ComprovanteAdministradora> <NacionalidadeEmissor></NacionalidadeEmissor> <ResultadoAVS></ResultadoAVS> <EnderecoAVS> <Endereco></Endereco> <Numero></Numero> <Complemento></Complemento> <Cep></Cep> </EnderecoAVS> </ResultadoAPC> dosParâmetros SeguemabaixoadescriçãoeformatodosparâmetrosretornadosnoXML AprovaFácil WebServiceIntegração Versão

22 Nome TransacaoAprovada Formatação Resultado do pedido de True=Aprovado aprovação Obrigatório True vejatabelaabaixo sim False=Negado ResultadoSolicitacaoAprovac da aprovação do Textovarchar ao resultadodopedido CodigoAutorizacao Código de autorização Textode6dígitos retornado Exemplo N12345 pela se aprovado Administradoradocartãode crédito Transacao ID da transação Aprova Textode14dígitos Fácil CartaoMascarado Número mascarado do Até 19 dígitos ******111 CartãodeCrédito numéricos 1 NumeroDocumento IDdopedidodacompanhia Até50caracteres 123ABC Adquirente Adquirenteusadoparaa BC BANCOMER transação BT BANORTE CB CREDIBANCO CE CIELO CL CETELEM PA ELAVON RA AMEX RC REDE RM REDEBAN SC SOROCRED SM GETNET TB TRANSBANK 6dígitosnuméricos Textovarchar N/A Textonulo N/A NumeroSequencialUnico Númerodeaprovaçãoda Administradora ComprovanteAdministradora Textocomprovanteda Administradora NacionalidadeEmissor Paísemissor AprovaFácil WebServiceIntegração Versão

23 Nome ResultadoAVS Formatação Resultadodaverificaçãode Textonulo Exemplo Obrigatório N/A N/A endereço(vejaatabelado item3.9.2) EnderecoAVS Tag de grupo para endereço N/A verificado Endereco Endereçoderuaverificado Textonulo Numero Número de endereço Textonulo N/A N/A N/A verificado Complemento Complemento do endereço Textonulo verificado Cep CEPdoendereçoverificado Textonulo TabeladeValoresretornadosparaoparâmetroResultadoAVS AMEX Código X EndereçoeCEP9 dígitoscoincidem. Y EndereçoeCEP5 dígitoscoincidem. W SomenteoCEP9 dígitoscoincide. S Serviçonãosuportado. G EmissornãoparticipadoAVS. A Endereçocoincide.Cepnãocoincideounãoverificado. Z Cep5 dígitoscoincide.endereçonãocoincide. R Emissornãodisponível. U Endereçoindisponível. N Nadacoincide. E EndereçoeCepnãoinformado. REDE Código W,todososdígitoscoincidem. X OCEPeCPFcoincidem,endereçonãocoincide. AprovaFácil WebServiceIntegração Versão

24 REDE Código Z EndereçoeCPFcoincidem,CEPnãocoincide. Y OCEPcoincide,CPFeendereçonãocoincidem. A CPFcoincide,CEPeendereçonãocoincidem. U OCEPeCPFnãocoincidem,endereçocoincide. S OCEPeendereçocoincidem,CPFnãocoincide. N Nadacoincide ResultadosdeErrosComuns TextodoResultado Erro ValorInválido ValorInválido Erro Valordevesermaiorquezero Valordevesermaiorquezero Erro NúmeroParcelasInválido NúmeroParcelasInválido Erro NúmeroParcelasdevesermaiorquezero NúmeroParcelasdevesermaiorquezero Erro TransaçãoAnteriornãoLocalizada TransaçãoAnteriornãoLocalizada Erro Conectividadenãopermiterecorrência Conectividadenãopermiterecorrência Erro CartãoInválido CartãoInválido Erro EstabelecimentonãocadastradoparaaBandeiraXXX LojistanãopodeaceitarXXXpagamentos AdquirinteYYY Erro EstabelecimentonãohabilitadoparaaBandeiraXXX XXXdesabilitadoparaoLojista AdquirinteYYY Erro CódigodoEmissordocartãoInválido CódigodoEmissordocartãoInválido Erro Mês/AnoValidadeInválidos Mês/AnoValidadeInválidos Erro Cartãoforadoprazodevalidade Cartãoforadoprazodevalidade Erro NúmeroParcelasAgendamentoInválido NúmeroParcelasAgendamentoInválido Erro NúmeroParcelasAgendamentodevesermaiorque1 NúmeroParcelasAgendamentodevesermaiorque1 Erro DiaDébitoInválido DiaDébitoInválido Erro DiaDébitodeveestarentre1e31 DiaDébitodeveestarentre1e31 Erro NúmeroTentativasInválido NúmeroTentativasInválido Erro NúmeroTentativassermaiorque1ouigualazero NúmeroTentativassermaiorque1ouigualazero AprovaFácil WebServiceIntegração Versão

25 TextodoResultado Erro DiasentreTentativasInválido DiasentreTentativasInválido Erro DiasentreTentativassermaiorouiguala1 DiasentreTentativassermaiorouiguala1 Erro ClientesemEstabelecimentodeAprovação ClientesemEstabelecimentodeAprovação Erro ConexãonãoEstabelecida ConexãonãoEstabelecida Erro ConexãoAVSnãoEstabelecida ConexãoAVSnãoEstabelecida Erro SemServidorAprovação SemServidorAprovação Erro IPnãopermitido IPnãopermitido Erro ÚltimaAprovaçãoparaocartãotemmenosdoque5 ÚltimaAprovaçãoparaocartãotemmenosdoque5 minutos minutos Erro Cartãocom3tentativasnãoaprovadas Cartãocom3tentativasnãoaprovadas Erro ParâmetrosIncorretos ParâmetrosIncorretos Erro CódigoClienteInválido CódigoClienteInválido Erro CódigodeClienteForjado CódigodeClienteForjado Erro MododeOperaçãoInválido MododeOperaçãoInválido AprovaFácil WebServiceIntegração Versão

26 4.CartãodeCrédito PedidodeCaptura CAP 4.1. AdiretivadeexecuçãoCAPefetuaacapturadeumatransação.Entende seporcapturaoprocessode confirmaçãodeumatransação,oquecaracterizaavendaefetivada,sendorealizadoassim,odébitonocartãode créditodocliente. DeacordocomospadrõesISO8583,todasastransaçõesaprovadaspelasAdministradorasdeCartões decréditodevemsercapturadas(confirmadas)pelaaplicaçãodolojista. Casoatransaçãonãosejacapturada(confirmada)pelaaplicaçãodoLojista,noprazoestipuladopelas Administradorasde CartõesCrédito, amesmaseráautomaticamente desfeita,nãohavendoassim odébito efetivonocartãodecréditodocliente,essainformaçãoseráexibidanocampo DataHoraCancelamento do ExtratodoAprovaFácil. 4.2.MétodosdeEnvio Os métodos de envio dos parâmetros podem ser o POST ou GET, utilizando conexões HTTP ou HTTPS,jáquenãosãotrafegadosdadossigilosos. 4.3.URLs Servidorprincipal: Servidordeteste: AprovaFácil WebServiceIntegração Versão

27 Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. 4.4.ParâmetrosdeRequisição Nota:Parâmetrosopcionaispodemnãoserinformadosouinformadossemvalorcasonãodeseje utilizá los. Nome NumeroDocumento Transação Formatação Identificação da venda Até50caracteres pelaloja. Númerodatransação 14 caracteres numéricos Exemplo 123ABC Numéricocom2 Obrigatório Se NumeroDocumento for nulo casasdecimais ValorDocumento* Valorasercapturado (separador decimaléo ponto) * Utilizadoapenasquandoumvalorparcialnecessitasercapturado.Apenasalgumastecnologiasde conectividadepermitemacapturaparcial.entreemcontatoconoscoparamaioresinformações. 4.5.ExemplosdeRequisiçãoGET Capturautilizandoonúmerodocumentogeradopeloestabelecimento CapturaUtilizandoonúmerodatransaçãogeradopeloAprovaFácil AprovaFácil WebServiceIntegração Versão

28 Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. 4.6.ExemplodeResultados CapturacomSucesso <ResultadoCAP> <ResultadoSolicitacaoConfirmacao> Confirmado% </ResultadoSolicitacaoConfirmacao> <ComprovanteAdministradora></ComprovanteAdministradora> </ResultadoCAP> CapturacomErro <ResultadoCAP> <ResultadoSolicitacaoConfirmacao> Erro%20 %20Transa%E7%E3o%20a%20confirmar%20n%E3o%20encontrada%20ou %20jE1%20confirmada </ResultadoSolicitacaoConfirmacao> <ComprovanteAdministradora></ComprovanteAdministradora> </ResultadoCAP> 4.7.ResultadodeCapturacomSucesso Oresultadodeumatransaçãodecapturabemsucedidacomeçarácomapalavra Confirmado,seguida deumcarácterdeespaço,edonúmerodetransaçãoaprovafácil. 4.8.ResultadosdeErroComuns AprovaFácil WebServiceIntegração Versão

29 TextodoResultado Erro TransaçãoInválida TransaçãoInválida Erro Transaçãoaconfirmarnãoencontradaoujáconfirmada Transaçãoaconfirmarnãoencontradaoujáconfirmada Erro IPnãopermitido IPnãopermitido Erro EstabelecimentonãocadastradoparaaBandeiraXXX EstabelecimentonãocadastradoparaaBandeiraXXX AdquirinteYYY AdquirinteYYY Erro EstabelecimentonãohabilitadoparaaBandeiraXXX XXXnãohabilitadaparaoestabelecimento AdquirinteYYY Erro CapturaJáEfetuada Capturajáefetuada Erro ParâmetrosIncorretos Parâmetrosincorretos Erro CódigoClienteInválido Códigoclienteinválido Erro CódigodeClienteForjado Códigodeclienteforjado Erro MododeOperaçãoInválido Mododeoperaçãoinválido Erro ConexãoparaconfirmaçãonãoEstabelecida Conexãoparaconfirmaçãonãoestabelecida AprovaFácil WebServiceIntegração Versão

30 5.CartãodeCrédito CancelamentodeTransações CAN 5.1. AdiretivadeexecuçãoCANéutilizadanoprocessodecancelamentodatransação.Ocancelamentode umatransaçãosomentepoderáserrealizadoquandoamesmaforaprovadapelaadministradoraeconfirmada pelolojista. Porisso,paraqueoAprovaFácilpossarealizarocancelamento,estedevesersolicitadonomesmodia emqueatransaçãofoiprocessada,ouseja,foiconfirmadapelaadministradora. 5.2.MétodosdeEnvio OmétododeenvioutilizadopodeseroPOSTouGETeasinformaçõespodemserenviadasatravésde HTTPouHTTPS,jáquenãosãotrafegadosdadossigilosos. 5.3.URLs Servidorprincipal: Servidordeteste: Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. AprovaFácil WebServiceIntegração Versão

31 5.4.ParâmetrosdeRequisição Nota:Parâmetrosopcionaispodemnãoserinformadosouinformadossemvalorcasonãodeseje utilizá los. Nome NumeroDocumento Transacao Formatação Identificação da venda Até 50 caracteres pelaloja. alfanuméricos. Númerodatransação 14 caracteres numéricos Exemplo 123ABC numérico com 2 ValorDocumento* Valorasercancelado dígitos decimais (separador decimal Obrigatório Se NumeroDocumento fornulo éoponto) * Utilizadoapenasquandoumvalorparcialnecessitasercancelado.Apenasalgumastecnologiasde conectividadepermitemocancelamentoparcial.entreemcontatoconoscoparamaioresinformações. 5.5.ExemplosdeRequisição Cancelamentoutilizandoonúmerododocumentogeradopeloestabelecimento CancelamentoUtilizandooIDdaTransaçãoAprovaFácil Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. AprovaFácil WebServiceIntegração Versão

32 5.6.ResultadoXML <ResultadoCAN> <ResultadoSolicitacaoCancelamento></ResultadoSolicitacaoCancelamento> <NSUCancelamento></NSUCancelamento> </ResultadoCAN> 5.7.ResultadodasTagsXML Nome ResultadoCAN TagRaizXML ResultadoSolicitacaoCancelamento doresultadodo Formatação Númerodecancelamentoda Obrigatório N/A N/A sim textovarchar vejatabela sim pedidodecancelamento NSUCancelamento Amostra abaixo 6dígitosnuméricos não Administradora 5.8.ExemplosdeResultados CancelamentoOnlineComSucesso <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Cancelado% </ResultadoSolicitacaoCancelamento> <NSUCancelamento> </NSUCancelamento> </ResultadoCAN> AprovaFácil WebServiceIntegração Versão

33 5.8.2.CancelamentoMarcadoparaProcessamentocomSucesso <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Cancelamento%20marcado%20para%20envio% </ResultadoSolicitacaoCancelamento> <NSUCancelamento> </NSUCancelamento> </ResultadoCAN> ErrodeCancelamentoOn Line <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Erro%20 %20Transa%E7%E3o%20inv%E1lida </ResultadoSolicitacaoCancelamento> <NSUCancelamento></NSUCancelamento> </ResultadoCAN> ErronaMarcaçãodoCancelamentoparaProcessamento <ResultadoCAN> <ResultadoSolicitacaoCancelamento> Erro%20 %20Transa%E7%E3o%20inv%E1lida </ResultadoSolicitacaoCancelamento> <NSUCancelamento></NSUCancelamento> </ResultadoCAN> AprovaFácil WebServiceIntegração Versão

34 5.9.ResultadodeCancelamentocomSucesso Oresultadodeumatransaçãocanceladacomsucessoseráamensagem CancelamentoOK ResultadosdeErrosComunsNSUCancelamento TextodoResultado Erro TransaçãoInválida TransaçãoInválida Erro Transaçãoacancelarnãoencontradaoujácancelada Transaçãoacancelarnãoencontradaoujácancelada Erro IPnãopermitido IPnãopermitido Erro EstabelecimentonãocadastradoparaaBandeiraXXX EstabelecimentonãocadastradoparaaBandeiraXXX AdquirinteYYY AdquirinteYYY Erro EstabelecimentonãohabilitadoparaaBandeiraXXX XXXnãohabilitadaparaoestabelecimento AdquirinteYYY Erro CancelamentoJáEfetuado Cancelamentojáefetuado Erro ParâmetrosIncorretos Parâmetrosincorretos Erro CódigoClienteInválido Códigoclienteinválido Erro CódigodeClienteForjado Códigodeclienteforjado Erro MododeOperaçãoInválido Mododeoperaçãoinválido Erro ConexãoparacancelamentonãoEstabelecida Conexãoparacancelamentonãoestabelecida AprovaFácil WebServiceIntegração Versão

35 6.CartãodeCrédito CallBackdeReembolso 6.1. Reembolsoéumcancelamentofeitoemdiasposterioresàaprovaçãodatransação. A funcionalidade Reembolso requer prévio cadastro, pois não é ativada por default quando o estabelecimento é cadastrado em nosso sistema. É necessário enviar e mail para [email protected] informandoquedesejaativaroreembolso. háreembolsosemqueatransaçãotenhasidoaprovadaeconfirmadapeloestabelecimento. 6.2.MétodosdeEnvio OmétododeenvioutilizadopodeseroPOSTouGETeasinformaçõespodemserenviadasatravésde HTTPouHTTPS. 6.3.URLs 6.3.1ServidordeProdução: 6.4.ParâmetrosdeRequisição Nome NumeroDocumento* Transacao Formatação Identificação da Até50caracteresalfanuméricos. vendapelaloja. Número da Exemplo 123ABC 14caracteresnuméricos Obrigatório,seo NumeroDocumento transação nãoforenviado AprovaFácil WebServiceIntegração Versão

36 Nome ValorDocumento** Formatação Valor a ser Numérico,sendoascasas reembolsado decimaisseparadasporponto(.) Exemplo Obrigatório *SeovalorinformadoaoparametroNumeroDocumentofordiferentedovalorinformadonasolicitação deaprovação,estenovovalorserádevolvidodentrodoparâmetronumerodocumentonoretornodoreembolso. Em caso de múltiplos reembolsos para a mesma transação o parâmetro NumeroDocumento será utilizadocomoidentificadordecadasolicitaçãodereembolso,tornando oobrigatório. **Aosolicitarumreembolsoparcial,informeovalordesejadoaoparâmetroValorDocumento.Para umamesmatransação,podeserefetuadomaisdoqueumreembolsoparcial.ovalortotaldosreembolsos parciasnãopodeultrapassarovalordatransaçãooriginal. 6.5.RespostaaumaSolicitaçãodeReembolsoBemSucedida Amensagem"CancelamentomarcadoparaenvioXXXXXXXXXXXXXX"aparecerá,designandouma solicitaçãodereembolsobemsucedida,segundosapósarequisiçãodeste. Exemplo: <ResultadoCAN> <ResultadoSolicitacaoCancelamento> CancelamentomarcadoparaenvioXXXXXXXXXXXXXX </ResultadoSolicitacaoCancelamento> <NSUCancelamento> XXXXXXXXXXXXXX </NSUCancelamento> </ResultadoCAN> XXXXXXXXXXXXXX=NúmerodaTransação AprovaFácil WebServiceIntegração Versão

37 7.CartãodeCrédito ResultadodeReembolso 7.1. Oresultadodeumreembolsonãoésíncrono.OresultadodeumreembolsoéenviadoparaumaURLde retorno. 7.2.MétodosdeEnvio OmétododeenvioutilizadoseráoGETeasinformaçõespodemserenviadasatravésdeHTTPou HTTPS. 7.3.EnviodoResultadodeReembolso OresultadodoprocessamentodeumreembolsoseráenviadopelogatewaydepagamentosparaaURL deretornodereembolsodoestabelecimento. Olojistadeveráterumscriptaptoareceberoresultadodereembolso.AURLdestescriptdeveráser informadaacobrebemtecnologianomomentoemqueahabilitaçãodereembolsoforsolicitada,atravésdee 7.4.Exemplodechamada Transacao= &NumeroDocumento= &ResultadoSolicitacaoCancelamento=Mensagem+da+A dministradora&nsucancelamento= AprovaFácil WebServiceIntegração Versão

38 7.5.dosparâmetros Nome Formatação Número da 14 caracteres Transacao transação numéricos Identificação NumeroDocumento da venda pela loja. Até Exemplo caracteres alfanumérico Obrigatório 123ABC s ResultadoSolicitaca Resultado do Texto Sucesso Cancelado XXXXXXXXXXXXXX ocancelamento processamento varchar onde XXXXXXXXXXXXXX é o número da doreembolso transaçãonacobrebemtecnologia. Falha ErroYYYYYYYYYYYYYYYYYY onde YYYYYYYYYYYYYYYYYY é a mensagem de erroretornadapelaadministradora Número de 6 NSUCancelamento dígitos * cancelamento numéricos da administradora *ONSUdecancelamentoéenviadoparaaURLderetornodoestabelecimentosomentequandoesse dadoéretornadoparaacobrebempeloadquirente. 7.6.ConfirmaçãodeRecebimentodeRetorno AURLderetornodereembolsodoestabelecimentodeverárespondercomostring OK,semasaspas, paraindicarquerecebeuoresultado.casocontrário,oresultadocontinuaráaserenviadopelogatewayde pagamentos,poiseleconsideraráqueosdadosnãoforamrecebidospeloaplicativodoestabelecimento. AprovaFácil WebServiceIntegração Versão

39 8.BoletoBancário PedidodeEmissão BOL 8.1. OpedidodeemissãoiráretornarumboletobancárioemPDFparaoscriptdocliente.Nossoretorno padrãoéempdf. 8.2.MétodosdeEnvio OmétododeenvioutilizadopodeserPOSTouGETporHTTPS. 8.3.URL's Servidorprincipal: Servidorteste: Nota:<usuario>deverásersubstituídopelonomedousuáriodoAprovaFácil. 8.4.ParâmetrosdeRequisição Nota:Parâmetrosopcionaispodemnãoserinformadosouinformadossemvalorcasonãodeseje utilizá los. AprovaFácil WebServiceIntegração Versão

40 Nome CCID Formatação Identifica a conta corrente a ser Até15caracteres utilizadaparaageraçãodoboleto NumeroDocumento Identificaçãodavendapelaloja. Exemplo Obrigatório ABC S Alterar S 14dígitosnuméricos dígitosnuméricos FulanodeTal alfanuméricos. Até50caracteres alfanuméricos. Numérico,sendoas ValorDocumento Valordatransação casasdecimais separadasporponto(.) DataVencimento Data de vencimento desejada para o boleto Númerodediasaseremadicionadosa PrazoVencimento data corrente e gerar uma data de validade VencimentoDiaUtil CNPJCPFSacado Altera o vencimento para o proximo diautil CPFouCNPJdocliente aaaammdd Até04dígitos numéricos NomeSacado Nomedocliente Até40caracteres EnderecoSacado Endereçodocliente Até40caracteres Rua do cliente,123 05dígitosnuméricos+ CEPSacado CEPdocliente travessão+3dígitos numéricos CidadeSacado Nomedacidadedocliente Até30caracteres RiodeJaneiro EstadoSacado Estadodocliente 02caracteres RJ Endereçodee maildosacado até64caracteres Endereco Sac ado PercentualJurosDia PercentualMulta Percentualdejurosasercobradopor diadeatrasonopagamento Percentualdemultaasercobradopor atrasonopagamento [email protected] Numérico,sendoas casasdecimais separadasporponto(.) Numérico,sendoas casasdecimais separadasporponto(.) AprovaFácil WebServiceIntegração Versão

41 Nome Código HTML que será exibido nas InstrucoesCaixa instruçõesparaocaixa demonstrativodorecibodosacado SacadorAvalista Nomedoavalistaquandoesteexistir Valor do desconto a ser concedido sobreovalordodocumento ValorOutrosAcresc Valor dos acréscimos a serem imos Exemplo Obrigatório <b>não receber códigohtml após vencimento </b> Código HTML que será exibido no Demonstrativo ValorDesconto Formatação somadosaovalordodocumento Referente códigohtml compra a de produtosx Caracteres FulanodeTal RC Numérico,sendoas casasdecimais separadasporponto(.) Numérico,sendoas casasdecimais separadasporponto(.) Tipodedocumentoaserimpressono EspecieDocumento boleto. Se não for informado, Caracteres assumiráovalorpadrão RC 8.5.ExemplodeRequisição Opedidodeemissão(/BOL)deveseroriginadonoservidordocliente.Afimdeevitarrequisiçõesde emissõesdeboletosnãoautorizadasapenasoipdoservidordoclienteseráhabilitadoparaessafuncionalidade. Nota:SeumpedidonãoautorizadodeemissãodeBoletoforidentificado,aseguintemensagem deerroseráretornada:"iplocalidade:autorizado",conformeindicadonositens:8.6.2e Resultados Resultados BemSucedidos ÉretornadooPDFdoboletoparaaloja. AprovaFácil WebServiceIntegração Versão

42 8.6.2.Resultados ErronaTransação Éretornadaparaonavegadordoclienteumastring(HTML)tag<fontcolor="#FF0000"><b>. Abaixoestáumexemplogenérico: <html><title>cobrebemtecnologia AprovaFácil</title> <body><table><tr><tdcolspan=2><center><fontcolor="#ff0000"><b>cliente nãoencontrado.</b></font></center></td></tr></table> </body></html> 8.7.ResultadosdeErrosComuns Resultado AçãoSugerida Clientenãoencontrado. Clientenãoencontrado ConfiranomedeusuárionaURL CCIDnãoinformado. CCIDnãoinformado VerifiqueoparâmetroCCID Contacorrenteboletonão Contacorrenteboletonãoencontrado VerifiqueoparâmetroCCID encontrado. Contacorrenteboletosemlicença. Contacorrenteboletosemlicença Contatenossosuporte IPNãoAutorizado. IPAutorizado Contatenossosuporte Clienteboletonãoencontrado. Estabelecimentonãohabilitadopara Contatenossosuporte boleto *Porfavor,informe nossevocêreceberumamensagemdeerrodiferentedaslistadasacima,atravésdo AprovaFácil WebServiceIntegração Versão

43 9.TransferênciasBancáriasOnLine PedidodeAprovação TRX 9.1. OpedidodeaprovaçãoserárealizadotodavezqueaaplicaçãodoLojistanecessitarobteraprovação financeiradeumavenda,pormeiodetransferênciaeletrônicaonline.opedidodetransferênciaeletrônicaon lineretornaráumcódigoxmlcontendoumhtmlqueredicionaráonavegadordoclienteparaositedobanco selecionado. 9.2.MétodosdeEnvio OmétododeenviodedadosdeveserviaPOSTparaumlinkemprotocoloHTTPS. 9.3.URLs Servidorprincipal: Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil. 9.4.ParâmetrosdeRequisição Nota:Parâmetrosopcionaispodemnãoserinformadosouinformadossemvalorcasonãodeseje utilizá los. Nome NumeroDocumento Formatação Identificação da venda pela Até50caracteresalfanuméricos. loja. QuantidadeParcelas Quantidadedeparcelas Valorválido:01 Exemplo 123ABC 01 AprovaFácil WebServiceIntegração Versão Obrigatório 43

44 Nome ValorDocumento Valordatransação Formatação Numérico, sendo as casas decimaisseparadasporponto(.) Exemplo Obrigatório BRADESCO Valoresválidossão: Bandeira Nomedobanco BBRASIL/BANRISUL/ BRADESCO/HSBC/ITAU CNPJCPFSacado CNPJouCPFdosacado 14dígitosnuméricos dígitosnuméricos Glossárioparaoitem9.4databela: BBRASIL=BancodoBrasil BANRISUL=BancodoEstadodoRioGrandedoSul 9.5.Requisição OpedidodeaprovaçãoTransferênciaBancáriaOnline(/TRX)devemseroriginadosde servidordocliente.afimdeevitarbancárioson linepedidosdeaprovaçãodetransferêncianão autorizada,ipapenasdoservidorclienteseráhabilitadoparaessafuncionalidade. Nota:NocasodeumpedidodeaprovaçãonãoautorizadoTransferênciaBancáriaOnlineser identificado,aseguintemensagemdeerroseráretornada: "IPLocalidade:Autorizado",conformeindicadonositens: e ExemplodeResultados Chamadadeinicializaçãobemsucessida A resposta irá retornar um XML com o código HTML embutido na tag <ResultadoSolicitacaoAprovacao>.OHTMLirávariardeacordocomoBancoselecionado. Desenvolvedor:EsteHTMLiráredirecionarautomaticamenteocompradorparaoambientedo Banco.Abaixoestáumexemplogenérico: AprovaFácil WebServiceIntegração Versão

45 <ResultadoAPC> <TransacaoAprovada>False</TransacaoAprovada> <ResultadoSolicitacaoAprovacao> <html><body onload="document.forms[0].submit();"><p> </p><p> </p><p><center>aguarde uminstante...</center></p><formaction= method=post><inputtype=hiddenname=transacaovalue=1><inputtype=hidden name=filiacaovalue=123><inputtype=hiddenname=numpedido value=123456></form></body></html> </ResultadoSolicitacaoAprovacao> <CodigoAutorizacao></CodigoAutorizacao> <Transacao> </Transacao> <CartaoMascarado>CartaoNaoInformado</CartaoMascarado> <NumeroDocumento>123ABC</NumeroDocumento> <ComprovanteAdministradora></ComprovanteAdministradora> <NacionalidadeEmissor></NacionalidadeEmissor> <ResultadoAVS></ResultadoAVS> <EnderecoAVS> <Endereco></Endereco> <Numero></Numero> <Complemento></Complemento> <Cep></Cep> </EnderecoAVS> </ResultadoAPC> ErrodeinicializaçãodeChamadas EmXML AmensagemdeerroapareceránatagXML<ResultadoSolicitacaoAprovacao>. AprovaFácil WebServiceIntegração Versão

46 Abaixoumexemplogenérico: <ResultadoAPC> <TransacaoAprovada>False</TransacaoAprovada> <ResultadoSolicitacaoAprovacao>Erro NumeroParcelas Invalido</ResultadoSolicitacaoAprovacao> <CodigoAutorizacao></CodigoAutorizacao> <Transacao></Transacao> <CartaoMascarado>CartaoNaoInformado</CartaoMascarado> <NumeroDocumento>123ABC</NumeroDocumento> <ComprovanteAdministradora></ComprovanteAdministradora> <NacionalidadeEmissor></NacionalidadeEmissor> <ResultadoAVS></ResultadoAVS> <EnderecoAVS> <Endereco></Endereco> <Numero></Numero> <Complemento></Complemento> <Cep></Cep> </EnderecoAVS> </ResultadoAPC> EmHTML AmensagemdeerroiráaparecernoHTMLtag<fontcolor="#FF0000"><b>. Abaixoumexemplogenérico: <html><title>cobrebemtecnologia AprovaFácil</title> <body><table><tr><tdcolspan=2><center><fontcolor="#ff0000"><b>cliente nãoencontrado.</b></font></center></td></tr></table> </body></html> AprovaFácil WebServiceIntegração Versão

47 9.7.ResultadosdeErrosComuns EmXMLconTag:<ResultadoSolicitacaoAprovacao> Resultado Erro ConexãonãoEstabelecida AçãoSugerida Conexãonãoestabelecida Tentenovamente [XXXXXX][IPXXXXXX] Erro Estabelecimentonãocadastradopara Bandeiranãohabilitadanousuáriodo abandeiraxxxxxx AprovaFácil Erro NumeroParcelasInvalido NúmeroParcelasInvalido Contatenossaequipedesuporte Verificarparâmetro QuantidadeParcelas Erro ReadTimeout TempoExpirado Tentenovamente Erro Valordevesermaiorquezero Valor>0 Verificarparametro ValorDocumento ErroYYYYYY MensagemdeErroVariável Notifiqueosuporte* Glossárioparaoitem9.7.1daTabela: XXXXXX=TextoVariável YYYYYY=MessagemMapeada EmHTMLonTag:<fontcolor="#FF0000"><b> Resultado AçãoSugerida Clientenãoencontrado. Clientenãoencontrado ConfiranomedeusuárionaURL IPNãoAutorizado. IPAutorizado Contatenossaequipedesuporte Métodonãosuportado. Métodonãosuportado Confiramétododeenvio * Por favor, informe nos se você suspeitar que a mensagem de erro recebida não foi gerada pelo adquirente,masapartirdenossosistema,atravésdo [email protected] errorecebidacomexatidão. AprovaFácil WebServiceIntegração Versão

48 10.TransferênciasBancáriasOnLine RetornodeConfirmaçãodePedido OretornodeumaTransferênciaseráfeitadoAprovaFácilparaositedoLojista. Odesenvolvedor deverá fornecer uma URL para receber o POST ou GET dos servidores do Aprova Fácil, esta conterá a informaçãodeconfirmaçãodepagamentodopedidodetransferênciabancáriaonline MétodosdeEnvio OmétodopodeseroPOSTouGET,easinformaçõespodemserenviadasatravésdeHTTPouHTTPS URL Segueumexemplo: ParâmetrosdeRetorno Nota:Aordemdeenviodosparâmetroséaleatóriaevitandoassim,possíveisvulnerabilidadesna aplicaçãodolojista.maisinformaçõessobreesteassuntopodemserobtidasem: eu 11/Marco_Balduzzi/BlackHat_EU_2011_Balduzzi_HTTP_Parameter Slides.pdf (Últimadatadeacesso:29/09/2011) Nome Formatação Exemplo Obrigatório NumeroDocumento IdentificaçãodavendadoLojista Até50caracteres 123ABC TransacaoAprovad Resultadodatransação TrueouFalse True Textovarchar N12345 a CodigoAutorizacao Códigodeautorizaçãodevolvido pelobanco ResultadoSolicitaca do resultado da Textovarchar Autoriza%E7%E3o oaprovacao %20 requisição se aprovada % AprovaFácil WebServiceIntegração Versão

49 Nome Formatação Textode14dígitos Exemplo Transacao IDdatransacaoAprovaFácil CartaoMascarado Número do Cartão de Crédito Até 19 dígitos Cartao%20Nao Mascarado. Nos retornos de numéricos Obrigatório %20Informado transferência, o resultado será sempre Cartao%20Nao %20Informado ValorDocumento Valor da transação informado numéricocom BRADESCO pelo lojista no momento da dígitosdecimais requisiçãodeaprovação (separadordecimaléo ponto) QuantidadeParcelas Quantidade de parcelas 2dígitosnuméricos informada pelo lojista no momento da solicitação de aprovação. Bandeira Nomedobancoinformadopelo Váloresválidossão: lojista no momento da BBRASIL solicitaçãodeaprovação. BANRISUL BRADESCO HSBC ITAU MesValidade Mêsemqueocartãoexpira.Nos 2dígitosnuméricos retornos de transferência, seu valorserásempreiguala 00 AnoValidade Anoemqueocartãoexpira.Nos 2dígitosnuméricos retornos de transferência, seu valorserásempreiguala 00 NumeroSequencial N/A Sempreembranco Sempreembranco Unico NumeroControleRe N/A de AprovaFácil WebServiceIntegração Versão

50 Nome ResultadoAVS Formatação Exemplo Obrigatório Resultado da verificação de 01caractermaiúsculo F endereço. Nos retornos de transferência, seu valor será sempre F NUMPEDIDO Número que bancos utilizam 14caracteres paraidentificaratransação ExemplodeRetorno NumeroDocumento=123ABC&TransacaoAprovada=True&CodigoAutorizacao=123456&ResultadoSolicitacao Aprovacao=Autoriza%E7%E3o%20 % &Transacao= &CartaoMascarado=Cartao%20Nao %20Informado&ValorDocumento=123.56&QuantidadeParcelas=01&Bandeira=BRADESCO&MesValidade=0 0&AnoValidade=00&NumeroSequencialUnico=&NumeroControleRede=&ResultadoAVS=F&NUMPEDIDO= ResultadosdeErrosComuns Texto Erro TransaçãoInválida Transaçãoinválida Erro Transaçãoacancelarnãoencontradaoujácancelada Transaçãoacancelarnãoencontradaoujácancelada Erro CancelamentoJáEfetuado Cancelamentojáefetuado Erro ConexãoparacancelamentonãoEstabelecida Conexãoparacancelamentonãoestabelecida AprovaFácil WebServiceIntegração Versão

51 11.DébitoAutomáticoemContaCorrente PedidodeAprovação DEB OpedidodeaprovaçãoserárealizadotodavezqueaaplicaçãodoLojistanecessitarobteraprovação financeiradeumavenda,pormeiodedébitoautomáticoemcontacorrente. OAprovaFácilenviaumarquivoderemessaaoBanco,paraqueesterealizeoprocessamentodos débitos MétodosdeEnvio OmétodoutilizadodeveseroPOSTouGET,easinformaçõesdevemserenviadasatravésdeHTTPS, jáqueserãotrafegadosdadossigilosos URL Servidorprincipal: Servidorteste: Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil ParâmetrosdeRequisição Nota:Parâmetrosopcionaispodemnãoserinformadosouinformadossemvalorcasonãodeseje utilizá los. AprovaFácil WebServiceIntegração Versão

52 Nome NumeroDocumento Formatação Identificação da venda Até pelaloja. 50 Exemplo caracteres alfanuméricos. 123ABC Obrigatório Numérico, sendo as casas ValorDocumento Valordatransação decimais separadas por ponto(.) NumeroBanco IdentificaoBanco 3digitos Código da agência da CodigoAgencia conta corrente a ser debitada ContaCorrente TitularContaCorrente Somentedígitosde0a9,P oux Número da conta Somentedígitosde0a9,P correnteaserdebitada Nomedotitulardaconta correnteaserdebitada oux Até40caracteres ClientedaLoja 11digitosseCPF CNPJCPFSacado CPFouCNPJdoSacado 14 digitos se CNPJ DataNascimentoSacado Agendamento TransacaoAnterior DiaParaAgendar Data de nascimento do sacado Utilizadoparaincluirou excluirumagendamento ID transação Aprova Facil Apenas um caracter: I Incluir/ E Excluir/ A I Atualizar Se 14digitosnuméricos Agendamento=A oue Diadecadamêsemque seráfeitoodébito QuantidadeMesesParaA Quantidade de meses gendar aaaammdd paraagendar dd 09 2dígitosinteiros 08 AprovaFácil WebServiceIntegração Versão Se Agendamento=I Se Agendamento=I 52

53 Nome NumeroTentativasNao Aprovado Formatação Exemplo Número de tentativas para a transação ser 2dígitosinteiros 04 aprovada QuantidadeDiasEntreTe Quantidadedediasentre ntativas cadatentativa 2dígitosinteiros 03 Obrigatório Se Agendamento=I Se Agendamento=I Data para qual o débito deve ser programado. Estadatadevesermaior DataVencimento ou igual ao prazo aaaammdd mínimopermitidoparao convênio em cada Banco. *SeosvaloresdeAouEforeminformadosparaoparâmetromarcadoAgendamento,o parâmetromarcadotransacaoanteriordeveserusado. Nota:OparâmetroNumeroDocumentonãopodetervaloresrepetidos. Nota: Cada banco possui um formato diferente para as propriedades CodigoAgencia e ContaCorrente.Entreemcontatoconoscoparasabercomoserãopreenchidas ExemplodeRequisição Visualizeotrechodecódigoabaixo: AprovaFácil WebServiceIntegração Versão

54 Nota:<usuario>deverásersubstituídopeloseuusuáriodeacessoaoextratodoAprovaFácil ExemplodeResultados DadosCorretos <Resposta><Transacao>XXXXXXXXXX</Transacao></Resposta> Onde:XXXXXXXXXXéumnúmeroúnicogeradoparaidentificaratransação DadosIncorretos <Resposta><Erro>YYYYYYYYYY</Erro></Resposta> Onde:YYYYYYYYYYéadescriçãodoerro Exemplosderesposta <Resposta><Transacao> </Transacao></Resposta> <Resposta><Erro>ContaCorrenteInválida</Erro></Resposta> <Resposta><Erro>BanconãoSuportado</Erro></Resposta> <Resposta><Erro>AgênciaInválida</Erro></Resposta> AprovaFácil WebServiceIntegração Versão

55 12.DiagramadeFuncionamento AprovaFácil WebServiceIntegração Versão

56 AprovaFácil WebServiceIntegração Versão