Manual Do Desenvolvedor Braspag - V1 0 17

Manual do desenvolvedor

Manual do desenvolvedor Braspag

Telefone: (21) 2111-4700 Email: [email protected] http://www.braspag.com.br

Pgina 1 de 15


ndiceRESUMO DO PROCESSO...........................................................................................3 QUAL MODELO DE INTEGRAO USAR?......................................................................4 Ateno! (Informaes Importantes)..........................................................................5 PASSOS TCNICOS PASSOS 1 e 2...........................................................................6 PARMETROS A SEREM ENVIADOS............................................................................ 7 Tabela 1 Parametros a serem enviados................................................................7 MODO PASSTHRU................................................................................................8 Tabela 2 Parametros a serem enviados em modo PASSTHRU..................................8 Tabela 3 Cdigos de meios de Pagamento............................................................8 PARAMETROS A SEREM RECEBIDOS PELA LOJA...........................................................9 Tabela 4 Parametros a serem recebidos pela loja.................................................. 9 PASSOS TCNICOS PASSO 3..................................................................................9 PARAMETROS A SEREM RECEBIDOS PELA LOJA......................................................... 10 Tabela 5 Parametros recebidos pela loja na mudana do Status de Pagamento....... 10 INTEGRAO COM O PAGADOR RECORRENTE........................................................... 10 Tabela 7 Dados a serem enviados para Pagador Recorrente..................................10 HOMOLOGAO.....................................................................................................11 1- Visanet.........................................................................................................11 2- Pagamento Fcil Bradesco...............................................................................11 3- MasterCard, Diners, Ita, Real, BB, American Express........................................ 11 TESTES................................................................................................................. 11 INTERFACES WEBSERVICE......................................................................................12 DESCRIO DE ARQUIVOS DE EXEMPLO...................................................................14 APENDICE A - INSTRUES PARA O REAL FINANCIAMENTO FLV............................... 15 DADOS A SEREM ENVIADOS PELA LOJA................................................................15 PARAMETROS A SEREM RECEBIDOS PELA LOJA..................................................... 15 TESTES............................................................................................................. 15


Pgina 2 de 15


RESUMO DO PROCESSOO processo de integrao com o PAGADOR muito simples. Pode ser resumido nos passos a seguir: 1. Recepo do manual tcnico e ID_LOJA para homologao. O parmetro ID_LOJA um identificador nico da loja. 2. Preparar a loja virtual para enviar a transao, por POST(Post de Envio), para o PAGADOR no momento do pagamento. Os parmetros do POST esto especificados na tabela 1. 3. Nesse momento voc j poder realizar transaes com os meios de pagamento cadastrados para sua loja. 4. Aps realizar as transaes o ideal que a loja se prepare para receber o retorno em tempo real das transaes autorizadas, para tal deve-se desenvolver uma pgina capaz de receber os dados da tabela 4. (URL de Retorno) Alm das autorizaes em tempo real a BrasPag oferece no PAGADOR alguns servios adicionais, so eles: a) POST de mudana de status de pagamento Usado para avisar quando foi conciliado um boleto e confirmar as transaes. Esse POST enviado a cada 5 minutos e muito til nos casos onde, por alguma falha de comunicao, a loja no recebeu a confirmao da transao. Ateno: A conciliao de boletos automtica s ocorre atravs de um convnio com o banco e a Braspag. Sem este convnio o sistema no identificar o pagamento dos boletos. Informe-se com seu gerente comercial. b) Componente de criptografia para dar maior segurana ao trnsito das informaes. Essa funcionalidade tem um manual especfico que poder ser solicitado. c) Interfaces (WebService) para captura dos dados das transaes a qualquer momento. i. ii. iii. iv. v. GetDadosComprador Este mtodo retorna todos GetDadosEntrega Este mtodo retorna todos GetDadosPedido Este mtodo retorna todos GetDadosCartao Este mtodo retorna todos na compra GetDadosExtras Este mtodo retorna todos os dados relativos ao comprador os dados relativos entrega os dados relativos ao pedido os dados relativos ao carto de crdito utilizado os campos extras relativos ao pedido

Observao: O uso dos servios adicionais A e B altamente recomendado.


Pgina 3 de 15


QUAL MODELO DE INTEGRAO USAR?A Braspag oferece dois modelos de integrao, o passthru e o normal. No modelo de integrao normal o usurio escolhe o meio de pagamento no servidor da BrasPag, vide imagem abaixo:

No modelo normal possvel customizar os seguintes parmetros: 1. Imagem do header (onde est o logo da BrasPag) 2. Imagem de footer 3. Cor do fundo da tela e da barra de ttulo Selecione o meio de pagamento desejado 4. Tamanho e tipo das fontes 5. Cor das fontes.


Pgina 4 de 15

Manual do desenvolvedorJ no Modelo de integrao pass-thru o usurio escolhe a forma de pagamento no prprio site da loja, vide imagem abaixo:

Nesse modelo h maior flexibilidade com relao a lay-out uma vez que 100% do design definido pelo desenvolvedor da loja. As instrues de como optar pelo modelo passthru ou normal so enviadas junto com o ID_LOJA. Para integrar no modelo passthru o desenvolvedor dever atentar para os parmetros extras especificados na tabela 2.

Ateno!A1 - O uso de frames ou iframes na chamada s urls do Pagador extremamente NO recomendado. Esta prtica causar interferncias no funcionamento das pginas para determinadas configuraes/verses de browsers devido perda da sesso. A2 - No ser fornecido suporte a linguagens de programao, cdigos fonte ou qualquer fragmento destes, internos ao desenvolvimento de sua integrao, mesmo que fornecidos ou citados previamente. A3 - A conciliao de boletos automtica s ocorre atravs de um convnio com o banco e a Braspag. Sem este convnio o sistema no identificar o pagamento dos boletos. Informe-se com seu gerente comercial.


Pgina 5 de 15


PASSOS TCNICOS PASSOS 1 e 2

Passo 1 - Loja envia um POST (Post de Envio) para Braspag: Com a chave de identificao da loja (ID_LOJA), o nmero do pedido, valor, nome do comprador e outros campos dependendo do modelo utilizado (ver abaixo) A URL destino do POST(Post de Envio) ser enviada junto com ID_LOJA

Loja

Pagador

Passo 2 - Braspag envia um RETORNO via POST a resposta em tempo-real da transao realizada. Os dados do POST esto na tabela 4. POST dado na URL da loja cadastrada em nosso banco de dados. (URL de Retorno)


Pgina 6 de 15


PARMETROS A SEREM ENVIADOS(Post de Envio)O POST(Post de Envio) que ser enviado Braspag deve conter os seguintes parmetros de acordo com o modelo escolhido. Tabela 1 Parametros a serem enviados CAMPO ID_LOJA VENDAID VALOR NOME CPF RAZAO_PJ CNPJ LOGRADOURO ENDERECO NUMERO COMPLEMENTO BAIRRO CIDADE CEP ESTADO PAIS NASC ESTCIVIL SEXO PROF FONE FAX EMAIL LOGRADOURO_D ENDERECO_D NUMERO_D COMPLEMENTO_D BAIRRO_D CIDADE_D CEP_D ESTADO_D PAIS_D EXTRAFINANCIAMENTO

DESCRIO Identificao da loja

OBRIGATRIO Sim Sim Sim Sim No No No No No No No No No No No No No No No No No No No No No No No No No No No No No

MOEDA (Campo utilizado apenas no meio de pagamento PayPal ) EXTRA[nome que voc deseja dar ao campo] Informao adicional que queira associar a ex.: ExtraItem transao. Aparecer no admin: Item * Obrigatrio para o meio de pagamento PayPal.

Nmero do pedido valor total do pedido sem decimais (ex.: R$1,00 = 100) Nome do comprador nmero do CPF (se pessoa fsica) Nome da empresa (Se pessoa jurdica) nmero do CNPJ (se empresa) logradouro do comprador (ex: Rua, Avenida, Estrada...) endereo do comprador nmero do endereo do comprador complemento do endereo do comprador Bairro do comprador Cidade do endereo do comprador CEP Estado Pas Data de nascimento do comprador estado civil do comprador (Solteiro = S; Casado = C; Divorciado = D; Vivo = V; Outro = O) sexo do comprador Profisso comprador nmero do telefone do comprador nmero do fax do comprador e-mail do comprador logradouro do endereo de entrega (ex: Rua, Avenida, Estada...) nmero do endereo de entrega Nmero do endereo de entrega complemento do endereo de entrega Bairro de entrega Cidade de entrega CEP de entrega estado de entrega pais de entrega Descrio do objeto financiado. Obs.: No caso de carrinho de compras utilizar a descrio do produto de maior valor. Moeda utilizada na venda seguindo o ISO 4217 (USD, GBP, JPY, CAD, AUD, EUR) http://www.iso.org/iso/en/prodsservices/popstds/currencycodeslist.html

No*

No


Pgina 7 de 15


MODO PASSTHRUOs campos que devero ser passados para o modelo pass-thru so os campos do modelo de integrao escolhido (bsico, simples ou completo) alm de: Tabela 2 Parametros a serem enviados em modo PASSTHRU CAMPO DESCRIO CODPAGAMENTO Identificao da forma de pagamento (tabela 3) PARCELAS nmero de parcelas em que o valor total ser dividido (padro = 1) TIPOPARCELADO Com juros enviar 1. Sem juros enviar 0 OBRIGATRIO Sim No

CODPAGAMENTO dever ser um dos seguintes cdigos: Tabela 3 Cdigos de meios de Pagamento Meios de Pagamento Cdigo Visa Crdito - VBV 01 Visa Electron 02 Mastercard - Komerci 03 Diners - Komerci 04 American Express 3 Party 05 Boleto Bradesco 06 Boleto Caixa 07 Boleto HSBC 08 Boleto Banco do Brasil 09 Boleto Real 10 Dbito Bradesco (SPS) 11 Dbito Ita (Shopline) 12 Boleto Citibank 13 Boleto Ita 14 Comercio Eletrnico Banco do 15 Brasil RealPague 16 Amex 2 party 18

Meios de Pagamento WebService RedeCard Amex - VPOS Visa TEF MasterCard TEF Diners TEF Amex TEF Boleto Unibanco Real FLV Hipercard TEF Dbito Banrisul Dbito Unibanco Financiamento BBPag PayPal Visa MOSET Aura Boleto BRB Crdito Consignado

Cdigo 20 21 22 23 24 25 26 28 29 30 31 32 35 36 37 38 39


Pgina 8 de 15


PARAMETROS A SEREM RECEBIDOS PELA LOJA(URL de Retorno) Aps a concluso do pagamento, a loja receber um POST na URL cadastrada em nosso banco de dados(URL de Retorno) com os seguintes parmetros: Tabela 4 Parametros a serem recebidos pela loja DESCRIO CAMPO Meio de pagamento utilizado pelo comprador FORMAPAGTO Cdigo da forma de pagamento (Vide tabela 3) CODPAGAMENTO CODRETORNO DESRETORNO VENDAID VALOR CODAUTORIZACAO TRANSID RespostaAVS PARCELAS LINHADIGITAVELcdigo do erro da transao (vazio se no ocorreram erros. para outros casos, ver tabela de erros) descrio do erro da transao nmero do pedido valor do pedido sem decimais (R$1,00 = 100) cdigo da autorizao do carto de crdito ou o cdigo do boleto bancrio cdigo da transao (do carto de crdito) Retorno da verificao de endereo feita junto a administradora de carto Numero de parcelas da transao Linha digitvel do boleto

PASSOS TCNICOS PASSO 3Passo 3 - (Opcional) - Braspag envia um POST para loja:POST de mudana de status de pagamento

O POST ser enviado a uma URL cadastrada no nosso banco de dados. (URL de Mudana de Status). Os dados desse POST esto na tabela 5. A loja dever responder um XML informando que recebeu o POST (ver abaixo)

Loja

Pagador


Pgina 9 de 15


PARAMETROS A SEREM RECEBIDOS PELA LOJA(URL de Mudana de Status) Quando o status de pagamento do pedido mudar, a loja receber outro POST na URL cadastrada (URL de Mudana de Status) para confirmao do pagamento. Os parmetros que a loja receber sero: Tabela 5 Parametros recebidos pela loja na mudana do Status de Pagamento CAMPO DESCRIO NumPedido Numero do pedido Status Status do Pagamento CODPAGAMENTO Cdigo da forma de pagamento (Vide tabela 3) Status ser um dos seguintes cdigos: Tabela 6 Status Descrio

0

pago

A loja dever responder um XML dizendo que recebeu o status, caso contrrio, a Braspag tentar mais 2 vezes, enviando um POST a cada uma hora. O formato do XML dever ser: OK Ateno: Havendo uma url cadastrada para POST mudana de status de pagamento e caso a loja no envie como resposta OK, o servidor da Braspag far mais 3 tentativas. No recebendo OK como resposta, um e-mail de alerta ser enviado ao administrador da loja.

INTEGRAO COM O PAGADOR RECORRENTEPara que uma transao do PAGADOR RECORRENTE tenha a sua primeira resposta em tempo real basta que voc envie as transaes via POST seguindo os dados das Tabelas 1 e 2, alm dos campos: Tabela 7 Dados a serem enviados para Pagador Recorrente CAMPO DESCRIODATAINICIO DATAFIM INTERVALORECORRENCIA NOMEPORTADOR NUMEROCARTAO VALIDADE CODIGOSEGURANCA Data programada para a primeira cobrana. Pode ser data atual. Data programada para ltima cobrana. De quantos em quanto meses haver dbito Nome do portador do carto Numero do carto de crdito Validade do carto Cdigo de segurana do carto

OBRIGATRIOSim Sim Sim No No No No

* O POST de integrao com o PAGADOR RECORRENTE dever ser dado na URL passthruR.asp


Pgina 10 de 15


HOMOLOGAOCada meio de pagamento tem suas respectivas regras para homologao. Para tornar o processo de homologao mais gil relacionamos todos os requisitos de cada um dos meios para que o processo de homologao seja breve e a loja possa entrar no ar rapidamente. Qualquer um dos meios de pagamento pode alterar a qualquer hora as exigncias para a homologao, sem aviso prvio, e este manual no necessariamente ir acompanhar estas mudanas em tempo real. Requisitos para homologao: 1- Visanet a) Exibir todos os campos do POST retornado pelo PAGADOR. Nenhum campo pode ser ocultado. b) Apenas para VISA, quando o CODRETORNO enviado pelo PAGADOR for , substituir por 00. 2- Pagamento Fcil Bradesco a) O cdigo de autorizao deve ser exibido da seguinte forma:J34JK20K0AL0L10L 09649KSDO01899ID Z12X3CV6B78N9M09 JD873JS8J20KSH74JF I88S710ALGNDI875 OK99008877GG6FTS 019283IDM95JD86DE JD8J398O5KDF8J39D 0987HH658910J56D 0L9K8J7H6G5F4D3S ODKU876309OISJH3 JD739JD7834JDF9H2 94KA84LP84JF8209 P01Q9OW23E4R9OI8 859OOK0192873JSH7 JDYJ28DH38YHD832

b) O Bradesco tambm exige que seja mostrado um telefone para contato. c) Deve constar a data e hora da compra. d) Deve constar o prazo para pagamento. Deve ser um texto assim: Prazo para pagamento: 1 dia. e) O prazo de entrega deve estar explicito. No caso de servio, prazo para liberao do servio. f) No rodap deve constar a frase "Qualquer dvida quanto a qualidade e entrega deste(s) produto(s)/servio, ligar para o telefone acima" 3- MasterCard, Diners, Ita, Real, BB, American Express Seguir os pontos acima suficiente para homologar os meios de pagamento desse item.

TESTESAs lojas de homologao so criadas com as seguintes opes de pagamento:

Visa, Visa Electron, MasterCard, Diners, Amex, Bradesco e Boleto Bancrio.

Cada opo de pagamento tem suas caractersticas. Para efetuar testes da melhor forma possvel, ateno as caractersticas abaixo:


Pgina 11 de 15

Manual do desenvolvedor1- Visa H como efetuar testes. Para tal voc poder usar um carto de testes: N do carto: 4073 0200 0000 0002 Cd de segurana 123 validade 08/11 2- Visa Eletron No h ambiente de testes. Voc dever testar VISA. Se VISA CRDITO funcionar sinal de que VISA ELETRON est ok. 3- MasterCard e Diners No h ambiente de testes. Voc poder testar em ambiente de produo. Para tal sugerimos gerar transaes de R$ 0,01. 4- Amex H como efetuar testes. Para tal voc poder usar um carto de testes: N do carto: 345678901234564 Cd de segurana 1234 validade 08/11 5- Pagamento Fcil Bradesco H como efetuar testes. Para tal voc deve preencher todos os campos com o numero 1. 6- Boleto H como efetuar testes. Basta escolher a forma de pagamento boleto bancrio.

INTERFACES WEBSERVICE

Todas so acionadas com apenas dois parmetros: LOJA (ID_Loja) e numeropedido(numero do pedido enviado no primeiro POST)

1. GetDadosComprador Dados retornados string string string string string string string string string string 2. GetDadosEntrega Dados retornados string string string string string


Pgina 12 de 15

Manual do desenvolvedorstring string string BR 3. GetDadosPedido Dados retornados string string string string string string string string string string string string string string 4) GetDadosCarto Dados retornados string string string string string string string string 5) GetDadosExtras Dados retornados string string string string string string


Pgina 13 de 15


DESCRIO DE ARQUIVOS DE EXEMPLOJunto com este manual h alguns arquivos na linguagem ASP de exemplo. Se sua loja no usa o modo pass-thru, voc deve olhar os arquivos index.asp, formapgto.asp, recebe.asp e confirmacao.asp Caso contrrio, index-passthru.asp, forma-passthru.asp, recebe.asp e confirmacao.asp index.asp Contm o catlogo dos produtos da loja. Ao clicar no produto que deseja comprar, o comprador ser redirecionado para a tela de cadastro. formapgto.asp O comprador digita seus dados e confirma a compra. Aps esta tela, o comprador ser redirecionado para a tela da Braspag, onde escolher qual a forma de pagamento. Aps a finalizao da compra, o comprador redirecionado novamente para a pgina da loja (pgina cadastrada em nosso banco de dados). index-passthru.asp Este o arquivo de exemplo para o modo pass-thru. Contm o catlogo dos produtos da loja. Ao clicar no produto que deseja comprar, o comprador ser redirecionado para a tela de cadastro. A nica diferena entre este arquivo e o index.asp a pgina que ser chamada em seguida. formapgto-passthru.asp O comprador digita seus dados, escolhe a forma de pagamento que utilizar e confirma a compra. Aps a finalizao da compra, o comprador redirecionado novamente para a pgina da loja (pgina cadastrada em nosso banco de dados). recebe.asp Esta pgina informa ao comprador se a compra foi efetuada com sucesso ou se houve algum erro. Ela recebe os dados da compra: forma de pagamento utilizada, cdigo e descrio do erro, se houve algum, nmero do pedido, valor, cdigo da autorizao e da transao. confirmacao.asp Esta pgina recebe o POST de confirmao de pagamento e informa Braspag o recebimento do mesmo. Ela recebe o nmero do pedido e o status de pagamento e retorna um XML dizendo OK


Pgina 14 de 15

Manual do desenvolvedorAPENDICE A - INSTRUES PARA O REAL FINANCIAMENTO FLV

DADOS A SEREM ENVIADOS PELA LOJAComplemento Tabela 1 CAMPOEXTRAFINANCIAMENTO

TIPOFINANCIAMENTO

DESCRIO Descrio do objeto financiado. Obs.: No caso de carrinho de compras utilizar a descrio do produto de maior valor. Produto do financiamento / Forma de pagamento. 1 : CDC Carn 2 : CDC Depsito 5 : CSC Carn 6 : CSC Depsito 7 : Leasing 8 : CDC Dbito em conta corrente

OBRIGATRIO Sim

Sim

PARAMETROS A SEREM RECEBIDOS PELA LOJAComplemento - TABELA 4 CAMPO CODRETORNODESCRIO cdigo do erro da transao (vazio se no ocorreram erros. para outros casos, ver tabela de erros)

Tabela 4.1 - ERROSCDIGO DESCRIO

BP_997

Proposta em anlise (para atualizao do status na loja, necessita da implementao do segundo POST).

TESTES1- Real FLV H como efetuar testes. Basta entrar com o cdigo de afiliao 4 no rea administrativa de homologao .


Pgina 15 de 15

Documents

Manual Do Desenvolvedor Braspag - V1 0 17