GUIA DE INTEGRAÇÃO PADRÃO - leje.com.br · Métodos de Integração Uma das vantagens de...
Transcript of GUIA DE INTEGRAÇÃO PADRÃO - leje.com.br · Métodos de Integração Uma das vantagens de...
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
2 UOLDIVEO – Guia de Integração Padrão
DETALHES DO DOCUMENTO
Documento: Guia de Integração Padrão
Versão: 2.3.2
Data: 26/10/2011
Autores: Paulo Roberto Rodrigues da Silva Filho
Clelson Flâmia Diniz
Bruno Stemposki
Flávio Silva
Gisele Lopes
PÚBLICO ALVO
Este manual foi elaborado para ser utilizado por desenvolvedores para integração com o UOLDIVEO
Gateway de Pagamentos 2.52.
REQUISITOS
Para compreender o conteúdo deste guia, é necessário estar familiarizado com os itens abaixo:
XML (Veja W3 Schools XML Tutorial: http://www.w3schools.com/xml/)
Entendimento básico de webservices (Veja W3 Schools Web Services Tutorial: http://www.w3schools.com/webservices/)
Linguagem de programação e ferramentas de desenvolvimento capazes de consumer web services e parsear XML.
CONTATO
E-mail: [email protected]
Telefone: +55 (11) 3038-1997
Endereço: CEV – Centro Empresarial do Vale
Rod. Presidente Dutra, km 154,7 – Rio Comprido, São José dos Campos, SP, Brazil 12240-420
AVISO
Sem autorização é proibido publicar, compartilhar ou apresentar este documento em seu todo ou em parte.
Copyright © 2012 UOLDIVEO. Todos os direitos reservados.
Este documento é fornecido pelo UOLDIVEO considerando que será tratado como confidencial. Nenhuma
parte deste documento pode ser reproduzido ou copiado em qualquer forma sem permissão escrita da
UODIVEO. A não ser por acordo expressamente escrito, as informações contidas neste documento estão
sujeitas a mudanças sem aviso prévio e a UODIVEO não assume responsabilidade por qualquer alteração
ou erro ou deficiência neste documento.
Todos direito de propriedade intelectual sobre este documento e em qualquer coisa derivada dele são
pertencentes ao UOLDIVEO e devem ser atribuídas a ele. Você deverá proteger a propriedade intelectual
relativa a este documento da mesma forma que protege as suas próprias. Você deverá notificar o
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
3 UOLDIVEO – Guia de Integração Padrão
UOLDIVEO imediatamente quando ficar ciente de algo que possa colocar em risco a propriedade intelectual
do UOLDIVEO em relação a este documento.
O nome e marcas da UODIVEO (“BoldCron”)., a assinatura “Transações Eletrônicas Seguras”, a marca
UOLDIVEO Gateway de Pagamentos e o logo do UOLDIVEO Gateway de Pagamentos são marcas
registradas do UODIVEO (“BoldCron”) e não devem ser copiadas sem prévia autorização. Todos os direitos
sobre outras marcas, tecnologias e sistemas apresentados neste guia são propriedade de seus
registradores.
O UODIVEO (“BoldCron”) pode, por decisão unilateral, terminar a cessão de direitos relativos a este
documento com efeito imediato e solicitar por escrito a devolução ou destruição de todas as cópias sob sua
posse ou controle.
O UODIVEO (“BoldCron”) não garante a exatidão e completeza do documento ou seu conteúdo ou sua
utilidade. Pela extensão permitida por lei, todas as condições e garantias implicadas por lei estão excluídas.
Dados utilizados em exemplos têm a pretensão de serem ilustrativos e qualquer semelhante com pessoal
real é mera coincidência.
Menção a qualquer produto que não seja de propriedade do UODIVEO (“BoldCron”) não constitui uma
recomendação deste produto.
Este documento é regido por leis brasileiras.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
4 UOLDIVEO – Guia de Integração Padrão
REVISIONS HISTORY
DATE VERSION DESCRIPTION AUTHORS/REVISORS
31/10/2007 1.3 Alterações devidas a primeira tradução do "Guia de Integração 1.3"
Flavio Silva
19/02/2008 1.3.1 Atualização dos métodos de pagamento listados no apêndice B
Bruno Stemposki
11/08/2008 1.4 Revisão de todas as tabelas de dados refletindo em revisão dos webservices do BPag.
Bruno Stemposki
Clelson Diniz Flavio Silva
18/08/2008 1.4.1 Página 11 – multiplicidade de fi_data mudada para 0-*. Página 11 – fdm_data.status mudado para tipo alfanumérico.
Bruno Stemposki
20/08/2008 2.1 Página 11 – bpag_payment_id adicionado em fi_data Página 6 – order_data.merch_ref mudado para tipo afanumérico. Página 11 – Mudanças na especificação da Campainha (Bell).
Bruno Stemposki
23/08/2008 2.1.1 Página 10 – Campos payment_method, normalized_payment_method, cc_number_hash e cc_number_masked foram adicionados em BjFIData. Página 10 – Campos settlement_status, settlement_type, settlement_msg e settlement_credit_data foram adicionados em BjFIData. Seção 3 – Adicionados os nomes normalizados dos métodos de pagamento. Seção 3 – Status Conciliado removido.
Bruno Stemposki
25/08/2008 2.1.2 Página 5 – Campos Merchant, User e Password foram removidos do XML e adicionados como parâmetros do webservice. Página 10 – Campos Merchant, User e Password foram removidos do XML e adicionados como parâmetros do webservice. Apêndice C - Adicionado
Bruno Stemposki
10/09/2008 2.1.3 Página 2 – Nova figura e texto sobre as opções de integração. Página 4 – Figuras 4, 5 e 6 foram modificadas Página 12 – Campos Installments e value adicionados no retorno do payOrder Página 15 – Campos Installments e value adicionados no retorno do probe
Bruno Stemposki Flavio Silva
30/09/2008 2.1.4 Página 12 – trn_type, Cc_card_holder e cc_brand adicionados a BjFIData Página 15 – Billing_data adicionado a BjOrderData Página 16 – trn_type, Cc_card_holder e
Bruno Stemposki
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
5 UOLDIVEO – Guia de Integração Padrão
cc_brand adicionados a BjFIData Página 17 – Adicionado BjBillingData
11/12/2008 2.2.0 Retorno do PayOrder Página 12 – Original_value adicionado. Página 13 – Expiration_data adicionado. Página 13 – Last_attempt adicionado. Página 14 – Fdm_bureau_data adicionado. Retorno do Probe Página 17 – Original_value adicionado. Página 18 – Expiration_data adicionado. Página 18 – Last_attempt adicionado. Página 19 – Fdm_bureau_data adicionado.
Bruno Stemposki
19/12/2008 2.2.1 Imagens foram trocadas por outras de melhor qualidade.
Bruno Stemposki
22/04/2009 2.3.0 Adicionadas interfaces para captura e cancelamento de pedidos e pagamentos.
Bruno Stemposki
12/05/2011 2.3.1 Atualização da URL do ambiente de produção Atualização dos métodos de pagamento apêndice A Atualização do código de status do pedido apêndice B Atualização dos códigos de resposta apêndice C
Gisele Lopes
26/10/2011 2.3.2 Atualização dos métodos de pagamento apêndice A Atualização dos códigos de resposta apêndice C
Gisele Lopes
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
6 UOLDIVEO – Guia de Integração Padrão
Conteúdo
Seção 1: Introdução ........................................................................................................................................ 9
SEÇÃO 2: Visão Geral do UOLDIVEO Gateway ............................................................................................ 9
Métodos de Integração .................................................................................................................................. 9
Fluxo Padrão de Integração ........................................................................................................................ 11
Requisição Webservice ............................................................................................................................... 11
Campainha (Bell) ......................................................................................................................................... 11
Sonda (Probe) ............................................................................................................................................. 12
Redirecionamento do Comprador ............................................................................................................... 12
Métodos de Pagamento............................................................................................................................... 12
Métodos de Pagamento do Lado do Lojista ................................................................................................ 13
Ciclo de Vida do Pedido .............................................................................................................................. 13
Transações de Cartão de Crédito ........................................................................................................... 13
Transações de Débito Online .................................................................................................................. 14
Transações de Boleto .............................................................................................................................. 14
SEÇÃO 3: Descrição dos WebServices....................................................................................................... 15
PayOrder - Requisição ................................................................................................................................ 15
Parâmetros de Entrada............................................................................................................................ 15
Objeto BjOrderData ................................................................................................................................. 16
Objeto BjOrderItem .................................................................................................................................. 16
Objeto BehaviorData ............................................................................................................................... 17
Objeto BjPaymentData ............................................................................................................................ 17
Objeto BjCustomerData ........................................................................................................................... 18
Objeto BjCustomerItem ........................................................................................................................... 18
Objeto BjPhone ........................................................................................................................................ 19
Objeto BjAirlineData ................................................................................................................................ 19
Objeto BjPaxData .................................................................................................................................... 19
Objeto BjAirlineRoute .............................................................................................................................. 19
Objeto BjExtraFields ................................................................................................................................ 20
PayOrder - Retorno ..................................................................................................................................... 20
Retorno XML ............................................................................................................................................ 20
Objeto BjBPagData .................................................................................................................................. 20
Objeto BjFIData ....................................................................................................................................... 20
Objeto BjFILastAttemptData .................................................................................................................... 22
Objeto BjFDMData ................................................................................................................................... 23
Objeto BjFDMBureauData ....................................................................................................................... 23
Campainha (Bell) ......................................................................................................................................... 24
Parâmetros de Entrada:........................................................................................................................... 24
Return XML .............................................................................................................................................. 24
Sonda (Probe) ............................................................................................................................................. 25
Parâmetros de Entrada:........................................................................................................................... 25
Retorno XML ............................................................................................................................................ 25
Objeto BjOrderData ................................................................................................................................. 25
Objeto BjBPagData .................................................................................................................................. 26
Objeto BjFIData ....................................................................................................................................... 26
Objeto BjFILastAttemptData .................................................................................................................... 27
Objeto BjFDMData ................................................................................................................................... 28
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
7 UOLDIVEO – Guia de Integração Padrão
Objeto BjFDMBureauData ....................................................................................................................... 28
Objeto BjBillingData ................................................................................................................................. 29
Objeto BjPhone ........................................................................................................................................ 29
Captura ........................................................................................................................................................ 30
Parâmetros de Entrada:........................................................................................................................... 30
Objeto BjCreditCardData ......................................................................................................................... 31
Retorno XML ............................................................................................................................................ 31
Objeto BjBPagData .................................................................................................................................. 31
Objeto BjFIData ....................................................................................................................................... 31
Objeto BjFILastAttemptData .................................................................................................................... 33
Cancelamento .............................................................................................................................................. 34
Parâmetros de Entrada:........................................................................................................................... 34
Objeto BjCreditCardData ......................................................................................................................... 35
Retorno XML ............................................................................................................................................ 35
Objeto BjBPagData .................................................................................................................................. 35
Objeto BjFIData ....................................................................................................................................... 35
Objeto BjFILastAttemptData .................................................................................................................... 37
Apêndice A: Métodos de Pagamento .......................................................................................................... 38
CARTÕES DE CRÉDITO ............................................................................................................................ 38
American Express .................................................................................................................................... 38
Aura ......................................................................................................................................................... 38
Diners Club .............................................................................................................................................. 38
MasterCard .............................................................................................................................................. 38
Visa .......................................................................................................................................................... 38
Hipercard ................................................................................................................................................. 39
Elo ............................................................................................................................................................ 39
Goodcard ................................................................................................................................................. 39
Private Label ............................................................................................................................................ 39
DÉBITO ONLINE ......................................................................................................................................... 39
Banco do Brasil ........................................................................................................................................ 39
Banrisul .................................................................................................................................................... 39
Bradesco .................................................................................................................................................. 39
BV ............................................................................................................................................................ 39
Itaú ........................................................................................................................................................... 39
HSBC ....................................................................................................................................................... 40
Visa Electron ............................................................................................................................................ 40
Maestro .................................................................................................................................................... 40
OUTROS ..................................................................................................................................................... 40
BOLETOS .................................................................................................................................................... 40
INTERNACIONAIS ...................................................................................................................................... 40
Estados Unidos ........................................................................................................................................ 40
Europa ..................................................................................................................................................... 40
Argentina ................................................................................................................................................. 41
Bolívia ...................................................................................................................................................... 41
Caribe ...................................................................................................................................................... 41
Chile ......................................................................................................................................................... 41
Colômbia .................................................................................................................................................. 42
México...................................................................................................................................................... 45
Peru ......................................................................................................................................................... 45
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
8 UOLDIVEO – Guia de Integração Padrão
Paraguai .................................................................................................................................................. 45
Uruguai .................................................................................................................................................... 45
Venezuela ................................................................................................................................................ 45
APÊNDICE B: Código de Status do Pedido ................................................................................................ 46
APÊNDICE C: Códigos de Resposta ........................................................................................................... 46
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
9 UOLDIVEO – Guia de Integração Padrão
Seção 1: Introdução
Gateways de pagamento permitem aos lojistas aceitarem uma variedade de métodos de pagamento para
seus produtos ou serviços vendidos online ou por meio de call Center. Estas transações, também chamadas
de Cartão Não Presente, estão tornando-se mais comuns conforme o e-commerce evolui e torna-se um
canal de venda cada vez mais importante.
Ao mesmo tempo em que o e-commerce cresce sua participação na economia, a indústria de pagamentos
eletrônicos torna-se cada vez mais complexa, com novas soluções, práticas e interfaces sendo lançadas
regularmente. Isto, associado aos desafios de escalabilidade, prevenção à fraude e outras preocupações
justificam a adoção de um gateway de pagamentos para simplificar o processamento de pagamentos.
O gateway age como uma ponte entre o sistema do lojista e as instituições financeiras que processam
(autenticam e autorizam) e conciliam as transações de pagamento. Dados de pagamento são coletados
online do comprador e submetidos ao gateway para autorização em tempo real.
Autenticação é adotada por vários métodos de pagamento para verificar, utilizando senhas ou outras
medidas, a identidade do comprador. Considerando que muitos métodos de pagamento não contemplam
autenticação forte para inibir a ação de fraudadores e que a responsabilidade pelas perdas financeiras é do
lojista, uma plataforma de Antifraude associadas ao processamento do pagamento é recomendada.
Autorização é o processo de verificar a validade e a disponibilidade de crédito na conta do comprador antes
que a transação seja aceita. Para autorizar uma transação de cartão de crédito, o gateway transmite as
informações da transação para a instituição financeira para validação e aguarda a resposta (aprovação ou
rejeição). Então padroniza a resposta e encaminha para lojista e para o comprador.
Em muitos métodos de pagamento, o processamento acontece em tempo real. Mas para alguns métodos, a
resposta da instituição financeira demora de alguns minutos a dias.
Este documento descreve algumas funcionalidades básicas e apresenta o processo de integração padrão
com o Gateway de Pagamentos.
SEÇÃO 2: Visão Geral do UOLDIVEO Gateway
Métodos de Integração
Uma das vantagens de utilizar UODIVEO (“BoldCron”)está na gama de métodos de integração disponíveis,
o que satisfaz qualquer tipo de necessidade para processamento e conciliação de transações com cartão
não presente. O gateway de pagamentos pode ser utilizado tanto para processar transações on-line feitas
pela web por um e-commerce, como aquelas provenientes por sistema de atendimento (call center) ou
sistema de catálogos. Os clientes do UOLDIVEO Gateway de Pagamentos contam com uma plataforma
extremamente flexível para agendar, processar, retentar ou configurar parâmetros recorrentes (veja o Guia
de Integração do Módulo de Recorrência),
Na figura 1, abaixo, é possível identificar uma diversidade de métodos de integração e qual é o melhor para
a sua operação:
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
10 UOLDIVEO – Guia de Integração Padrão
Figura 1: Métodos de integração atualmente disponíveis no UOLDIVEO Gateway de Pagamentos.
Método de
Integração
Tipo de
Operação
Descrição
A E-commerce Usando o webservice descrito neste guia, o lojista envia os dados básicos do
pedido no momento da finalização da compra, como resposta, o UOLDIVEO
Gateway de Pagamentos envia uma URL para a qual o e-commerce deve
redirecionar o usuário. Nesta página, previamente customizada para parecer igual
a página do e-commerce, o comprador escolhe o método de pagamento e
preenche as informações necessárias. No final, a página de sucesso pode estar
tanto do lado do BPag, como do lado do sistema do lojista.
B E-commerce Semelhante a integração A, entretanto, neste método o lojista permite que o
usuário escolha o método de pagamento do seu lado. Então redireciona o usuário
diretamente para a página na qual as informações necessárias para aquele
método de pagamento serão coletadas.
C ou D E-commerce / Call
Center
Neste método de integração, o lojista envia todas as informações na requisição
WebService. Para os métodos de pagamento que requerem a coleta das
informações do lado da instituição financeira (débitos online, etc), o UOLDIVEO
Gateway de Pagamentos retornará a URL para a qual o usuário deve ser
redirecionado. Para aqueles métodos de pagamento que permitem que todas as
informações sejam enviadas e que a autorização seja processada de forma
síncrona (cartão de crédito via TEF, etc), a autorização será enviada como
resposta ao WebService. Neste caso, o lojista deve observar os requerimentos do
PCI/DSS.
E Call Center Neste método, os atendentes preenchem os dados do pagamento num formulário
no painel de controle do UOLDIVEO Gateway de Pagamentos. Este método de
integração é adequado somente para métodos de pagamento que não requerem
qualquer tipo de autenticação do comprador.
F Cobrança
Recorrente
O atendente do lojista preenche os dados de um plano de cobrança recorrente no
painel de controle do UOLDIVEO Gateway de Pagamentos. Esta inscrição
começa uma série de cobranças segundo o agendamento desejado e os dados de
pagamento fornecidos.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
11 UOLDIVEO – Guia de Integração Padrão
Método de
Integração
Tipo de
Operação
Descrição
G Cobrança
Recorrente
O lojista pode criar cobranças recorrentes a partir de uma chamada WebService.
Fluxo Padrão de Integração
UOLDIVEO Gateway de Pagamentos tem um fluxo padrão de integração que é adequado para os métodos
de integração A e B descritos acima. É a solução básica para todos os tipos de e-commerces. Este fluxo é
apresentado na Figura 2 abaixo:
Figura 2: Método Padrão de Integração
Requisição Webservice
Considerando a Figura 2, você pode notar que a primeira comunicação entre o sistema da loja e o
UOLDIVEO Gateway de Pagamentos é uma requisição WebService. Esta requisição geralmente acontece
quando o comprador termina de preencher seu carrinho de compras e vai para o pagamento. Neste
momento, o lojista envia os dados do pedido e do comprador para o UOLDIVEO Gateway de Pagamentos.
Por questões de segurança, neste tipo de integração, o navegador do comprador não faz a chamada ao
UOLDIVEO Gateway de Pagamentos. Toda a comunicação ocorre entre os servidores do sistema do lojista
e os servidores do UOLDIVEO Gateway de Pagamentos. Esta comunicação deve ser encriptada utilizando
SSL e, como você poderá notar na descrição da requisição autenticada.
Os dados enviados são armazenados no banco de dados do UOLDIVEO Gateway de Pagamentos e um
código é calculado com base neles.
O retorno desta chamada webservice conterá uma URL para a qual o sistema do lojista deve redirecionar o
comprador para continuar o processo de compra. Esta URL contém o código calculado. Este código será
utilizado para identificar a loja e o pedido enviado anteriormente. Por meio deste mecanismo, os dados
enviados previamente via WebService estão seguros de ações mal intencionadas dos compradores.
Uma vez que o sistema do lojista tenha direcionado o comprador, o processamento do pagamento continua
sob controle do UOLDIVEO Gateway de Pagamentos. A aprovação de diferentes métodos de pagamento
disponíveis é feita pelo UOLDIVEO Gateway de Pagamentos de forma transparente para o lojista.
Campainha (Bell)
Após processar o pagamento, o UOLDIVEO Gateway de Pagamentos informará o sistema do lojista, por
meio de uma campainha, toda vez que o pedido mudar de status. A campainha do UOLDIVEO Gateway de
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
12 UOLDIVEO – Guia de Integração Padrão
Pagamentos é uma chamada POST a URL informada pelo lojista (veja o objeto BehaviorData da Bell) para
notificar que o status de um pedido específico foi mudado. Este mecanismo é especialmente útil para os
lojistas utilizando métodos de pagamento com respostas assíncronas ou àqueles que utilizam análise
Antifraude com captura automática.
Considerando que o ciclo de vida de um pedido pode ser bastante complexo em alguns métodos de
pagamento, várias alterações de status podem ocorrer (veja o ciclo de status do pedido abaixo). Nestes
casos, o UOLDIVEO Gateway de Pagamentos enviará várias campainhas.
Para cada transição de status, o UOLDIVEO Gateway de Pagamentos enviará uma campainha. Caso o
UOLDIVEO Gateway de Pagamentos não obtenha confirmação de recebimento da campainha pelo sistema
do lojista, novas tentativas de envio da campainha serão agendadas. Há um limite para o número de
tentativas de comunicação.
Sonda (Probe)
Uma vez que o lojista foi notificado sobre a mudança de status por meio da Campainha, seu sistema deve
ativamente sondar o UOLDIVEO Gateway de Pagamentos para obter o status atual do pedido. A interface
para esta comunicação é a Sonda, que é uma comunicação via WebService. A Sonda envia o ID do pedido
e as credenciais da loja, e obtém o status atual do pedido.
Esta comunicação ocorre entre os servidores do lojista e do UOLDIVEO Gateway de Pagamentos utilizando
criptografia via SSL.
Redirecionamento do Comprador
Uma vez que o processamento do pagamento tenha terminado no ambiente do UOLDIVEO Gateway de
Pagamentos, é enviada uma Campainha para os servidores do lojista e o usuário é redirecionado
novamente para o e-commerce para a URL enviada na primeira requisição WebService. Este
redirecionamento pode ter os seguintes comportamentos:
UOLDIVEO Gateway de Pagamentos mostra uma tela de resumo da compra com um link para
retornar ao e-commerce
UOLDIVEO Gateway de Pagamentos redireciona o usuário para o site do lojista (a URL deve ser
enviada via url_redirect_error e url_redirect_success);
UOLDIVEO Gateway de Pagamentos fecha a janela (no caso do e-commerce ter redirecionado o
comprador para o UOLDIVEO Gateway de Pagamentos numa janela pop-up).
Métodos de Pagamento
UOLDIVEO Gateway de Pagamentos tem 142 meios de pagamento agrupados em:
25 métodos de pagamento de cartão de crédito
86 métodos de pagamento de cartão de crédito internacional
15 métodos de pagamento de débito online
08 tipos de boletos bancários
08 outros tipos
Para utilizar estes métodos de pagamento, o lojista deve ter uma conta ativa na instituição financeira
correspondente. Este processo de afiliação é feito diretamente entre o lojista e a instituição financeira (veja
o Guia de Meios de Pagamento). Uma vez que o contrato tenha sido assinado, o banco irá fornecer o
código de afiliação apropriado que deverá ser enviado para a equipe de suporte para configurar os meios de
pagamento da sua loja.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
13 UOLDIVEO – Guia de Integração Padrão
Nas tabelas do Apêndice A: Métodos de Pagamento, todos os métodos de pagamento estão organizados
por banco e adquirente. Para cada um, há uma descrição curta.
Métodos de Pagamento do Lado do Lojista
Quando o lojista opta por oferecer a escolha do método de pagamento em seu ambiente (método de
integração B), a requisição via WebService deve enviar o parâmetro “paymentMethod” preenchido com um
método de pagamento válido (veja o Apêndice A: Métodos de Pagamento). O restante do fluxo de
integração continuará praticamente o mesmo, apenas com a diferença que o UOLDIVEO Gateway de
Pagamentos não mostrar a página de escolha do método de pagamento.
Um comportamento particular ocorre para métodos de pagamento do tipo boleto. Neste caso, o UOLDIVEO
Gateway de Pagamentos retorna diretamente a URL para impressão do boleto ao invés de retornar a URL
com o código calculado para redirecionamento do usuário. A Figura 3 abaixo mostra este caso particular.
O parâmetro “paymentMethod” deve também ser enviado quando a loja optar pelos métodos de integração
nos quais todos os dados são coletados do seu lado (métodos de integração C e D).
Figura 3: Modelo de Integração para Métodos de Pagamento do tipo Boleto.
Ciclo de Vida do Pedido
Abaixo, são mostrados os diagramas de status com as transições que um pedido pode ter durante seu ciclo
de vida. O sistema do lojista deve estar preparado para lidar com estas transições.
Transações de Cartão de Crédito
Não Efetivado Não Capturado PagoEm Análise
Inválido
Cancelado
Figura 4: Status Possíveis para Transações de Cartão de Crédito
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
14 UOLDIVEO – Guia de Integração Padrão
Transações de Débito Online
Figura 5: Status Possíveis para Transações de Débito Online
Transações de Boleto
Figura 6: Status Possíveis para Transações de Boleto
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
15 UOLDIVEO – Guia de Integração Padrão
SEÇÃO 3: Descrição dos WebServices
Considerando o fluxo descrito nas seções anteriores, pode-se verificar a necessidade de três interfaces
principais nas quais haverá troca de informações entre o UOLDIVEO Gateway de Pagamentos e o sistema
do lojista:
Requisição WebService (PayOrder);
Campainha (Bell);
Sonda (Probe).
A primeira e a terceira interfaces são requisições webservices (PayOrder e Probe), enquanto a Campainha
é uma chamada HTTPS POST.
As outras interfaces são redirecionamentos HTTP, feitos utilizando os retornos das chamadas apresentadas
acima. O primeiro redirecionamento (do e-commerce para o UOLDIVEO Gateway de Pagamentos) é para a
URL retornada pelo PayOrder.
O segundo redirecionamento (a volta do comprador para o ambiente do e-commerce) é feito para os
endereços preenchidos nos campos url_redirect_success e url_redirect_error descrito no objeto
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
16 UOLDIVEO – Guia de Integração Padrão
Objeto BehaviorData.
Além das três interfaces acima, há também os webservices de Captura e Cancelamento de pagamentos
que são utilizados por lojas que necessitam maior controle do fluxo de pagamento.
PayOrder - Requisição
Esta requisição é o começo do processo de pagamento. Esta chamada e seu retorno são apresentados
abaixo:
[Webservices: web site da loja => Servidores do BPag]
Nome do método: doService
Parâmetros:
Version: 1.1.0
Action: payOrder
Merchant: código da loja no ambiente do BPag
User: login do usuário cadastrado no ambiente administrativo do BPag
Password: senha do usuário cadastrado no ambiente administrativo do
BPag
Data: xml segundo especificado na seção 3.1.1
Return: xml segundo especificado na seção 3.1.2
URL do ambiente de testes:
http://www.boldcron.com.br/homologa/bpag2/services/BPagWS?wsdl
URL do ambiente de produção:
https://bpag.uol.com.br/bpag2/services/BPagWS?wsdl
Parâmetros de Entrada
Campo Qtd Descrição Tipo Tamanho Comentário
order_data 1 Dados gerais do pedido Objeto do tipo
BjOrderData
behavior_data 0..1 Dados de comportamento de
processamento
Objeto do tipo
BjBehaviorData
payment_data 0..* Dados de pagamentos Lista de objetos
BjPaymentData
Permite múltiplos registros para que no
futuro o BPag possa aceitar mais de
uma forma de pagamento por pedido.
customer_data 0..1 Dados do usuário Objeto do tipo
BjCustomerData
airline_data 0..1 Campos adicionais para companhias
aéreas
Objeto do tipo
BjAirlineData
additional_fda_data 0..* Dados adicionais para análise anti-
fraude
Lista de objetos
BjExtraFields
additional_
merchant_data
0..* Dados adicionais úteis para
gerenciamento da loja.
Lista de objetos
BjExtraFields
Não influencia no processamento do
pedido.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
17 UOLDIVEO – Guia de Integração Padrão
Objeto BjOrderData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjOrderData
merch_ref 1 Id do pedido segundo o sistema da loja String
Alfanumérico
20
origin 0..1 Origem da compra String
Alfanumérico
20 Ex: e-commerce, call center, mail order, etc.
currency 0..1 Moeda String
Alfanumérico
3 ISO Code Alpha 3
Valor Padrão: BRL
tax_boarding 0..1 Taxa de embarque Long
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
tax_freight 0..1 Frete Long
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
tax_others 0..1 Outras taxas Long
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
discount_plus 0..1 Descontos e acréscimos Long
Numérico
18 Valores positivos serão adicionados ao valor
dos itens. Valores negativos serão subtraídos
do valor dos itens.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
order_subtotal 1 Valor total dos itens do pedido Long
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
interests_value 0..1 Valor dos juros aplicados pela loja Long
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
order_total 1 Valor total = taxas + discount_plus +
subtotal + interests_value
Long
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
order_items 1..* Itens do pedido Lista de objetos
BjOrderItem
O primeiro item representa o primeiro item
comprado neste pedido o segundo item
representa o segundo item comprador neste
pedido e assim por diante.
Objeto BjOrderItem
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjOrderItem
code 1 Código do item na loja String
Alfanumérico
18
description 0..1 Descrição do item String
Alfanumérico
300
units 1 Quantidade de unidades deste item Integer
Numérico
9
unit_value 1 Valor unitário do item Integer
Numérico
18 Somente valores positivos são aceitos.
Valor sem formatação.
Os dois últimos dígitos são centavos:
Ex. 1234 = 12.34.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
18 UOLDIVEO – Guia de Integração Padrão
Objeto BehaviorData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BehaviorData
profile 0..1 Perfil a ser utilizado para o
processamento deste pagamento
String
Alfanumérico
18
language 0..1 Idioma a ser utilizado na interface com
o usuário
String
Alfanumérico
4 Opções:
ptbr – Português (valor padrão)
enus – Inglês
eses – Espanhol
itit – Italiano
frfr – Francês
dede – Alemão
nlnl – Holandês
url_post_bell 0..1 URL para envio do post de aviso de
mudança de status
String
Alfanumérico
256
url_skin 0..1 URL da skin a ser utilizada na interface
com o usuário (funcionalidade futura)
String
Alfanumérico
256
url_redirect_succes
s
0..1 URL de redirecionamento em caso de
termino de processamento com
sucesso.
String
Alfanumérico
256
url_redirect_error 0..1 URL de redirecionamento em caso de
termino de processamento com erro.
String
Alfanumérico
256 Usada quando algum erro ocorre durante o
processamento do pagamento ou quando o
pagamento não é autorizado.
Objeto BjPaymentData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjPaymentData
payment_method 1 Código do método de pagamento String
Alfanumérico
50 Veja o apêndice A
installments 0..1 Número de parcelas Integer
Numérico
9 Se o número de parcelas não for enviado, o
BPag assumirá que a loja deseja que o usuário
escolha o parcelamento nas páginas
hospedadas no BPag.
payment_value 0..1 Valor a ser cobrado nesta forma de
pagamento.
Long
Numérico
18 Somente valores positivos serão aceitos.
Valor sem formatação.
Os últimos dois dígitos são em centavos. Ex.
1234 = 12.34
Se este valor não for enviado, o BPag
considerará o valor total do pedido.
cc_brand 0..1 Bandeira do cartão de crédito. String
Alfanumérico
30 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
cc_number 0..1 Número do cartão de crédito. String
Alfanumérico
20 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
O número do cartão deve ser encriptado com a
chave pública da BoldCron.
cc_cvv 0..1 Código de verificação do cartão de
crédito.
String
Alfanumérico
4 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
O número do cartão deve ser encriptado com a
chave pública da BoldCron.
cc_exp_month 0..1 Mês de expiração do cartão de crédito. String
Alfanumérico
2 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
Formato “MM”
cc_exp_year 0..1 Ano de expiração do cartão de crédito. String
Alfanumérico
4 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
Formato “yyyy”
cc_exp 0..1 Validade do cartão de crédito
encriptada. O lojista pode optar por
enviar cc_exp_month + cc_exp_year
ou cc_exp
String
Alfanumérico
175 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
Formato “MM/yyyy”.
cc_card_holder 0..1 Nome do titular do cartão de crédito. String
Alfanumérico
40 Este parâmetro somente será utilizado quando
o método de pagamento for cartão de crédito.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
19 UOLDIVEO – Guia de Integração Padrão
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjPaymentData
Objeto BjCustomerData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjCustomerData
customer_id 0..1 Id/Código/Login do usuário no sistema
da loja.
String
Alfanumérico
20
customer_eval 0..1 Número de pontos no programa de
fidelidade da loja.
String
Alfanumérico
20
customer_ip 0..1 Endereço IP do usuário String
Alfanumérico
20 Usado em caso de integração Host-Host
síncrona.
customer_info 1 Dados do usuário Objeto do tipo
BjCustomerItem
billing_info 0..1 Dados da cobrança Objeto do tipo
BjCustomerItem
shipment_info 0..1 Dados de entrega Objeto do tipo
BjCustomerItem
Objeto BjCustomerItem
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjCustomerItem
first_name 1 Primeiro nome String
Alfanumérico
30
middle_name 0..1 Nome do meio String
Alfanumérico
60
last_name 0..1 Sobrenome String
Alfanumérico
30
email 0..1 E-mail String
Alfanumérico
256
gender 0..1 Sexo String
Alfanumérico
1 M – Masculino
F – Feminino
marital_status 0..1 Estado Civil String
Alfanumérico
1 S – Solteiro
M – Casado/Married
W – Viúvo/Widow
D - Divorciado
birthday 0..1 Data de nascimento String
Alfanumérico
30 Formato “yyyyMMdd”
document_type 0..1 Tipo de documento String
Alfanumérico
2 0 – CPF
1 – CNPJ
2 – ID
3 – Passaporte
document 0..1 Número do documento String
Alfanumérico
50
phone_home 0..1 Telefone residencial Objeto do tipo
BjPhone
phone_office 0..1 Telefone comercial Objeto do tipo
BjPhone
phone_mobile 0..1 Celular Objeto do tipo
BjPhone
address_street 0..1 Endereço String
Alfanumérico
100
address_street_nr 0..1 Número String
Alfanumérico
25
address_additional_
data
0..1 Complemento (apartamento, bloco,
etc)
String
Alfanumérico
25
address_comunity 0..1 Bairro String
Alfanumérico
25
address_city 0..1 Cidade String
Alfanumérico
25
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
20 UOLDIVEO – Guia de Integração Padrão
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjCustomerItem
address_state 0..1 Estado String
Alfanumérico
25
address_country 0..1 País String
Alfanumérico
2 ISO Code
address_zip 0..1 CEP String
Alfanumérico
8
Objeto BjPhone
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjPhone
country_code 0..1 Código do país String
Numérico
3
area_code 0..1 Código de área String
Numérico
4
phone_number 1 Número de telefone String
Numérico
15
Objeto BjAirlineData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjAirlineData
pnr 0..1 Localizador String
Alfanumérico
10
is_caldholder_travell
ing
0..1 Indica se o titular do cartão é
passageiro
Integer 1 1 – verdadeiro
0 – falso
passanger_data 0..* Passageiros Objeto do tipo
BjPaxData
departure_airport 1 Aeroporto de partida String
Alfanumérico
3 Código IATA do aeroporto
departure_time 1 Data e hora de partida String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
arrival_airport 0..1 Aeroporto de chegada String
Alfanumérico
3 Código IATA do aeroporto
arrival_time 0..1 Data e hora de chegada String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
legs 0..* Rotas que compõem a viagem Lista de objetos
BjAirlineRoute
Objeto BjPaxData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjPaxData
first_name 1 Primeiro nome String
Alfanumérico
30
middle_name 0..1 Nome do meio String
Alfanumérico
60
last_name 1 Sobrenome String
Alfanumérico
30
Objeto BjAirlineRoute
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjAirlineRoute
carrier_code 1 Código da companhia aérea String
Alfanumérico
2
flight_number 1 Número do vôo String
Alfanumérico
10
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
21 UOLDIVEO – Guia de Integração Padrão
fare_basis 0..1 Classe tarifária String
Alfanumérico
10
departure_airport 1 Aeroporto de partida String
Alfanumérico
3 Código IATA do aeroporto
departure_time 1 Data e hora de partida String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
arrival_airport 0..1 Aeroporto de chegada String
Alfanumérico
3 Código IATA do aeroporto
arrival_time 0..1 Data e hora de chegada String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
Objeto BjExtraFields
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjExtraFields
parameter 1 Nome do campo extra String
Alfanumérico
40
value 1 Valor do campo extra String
Alfanumérico
256
PayOrder - Retorno
Depois que os dados do pedido forem armazenados, o UOLDIVEO Gateway de Pagamentos retornará os
dados abaixo como resposta a chamada webservices. Para os casos de pagamento síncrono, o retorno
ocorrerá depois que todo o processo de pagamento tiver terminado.
Retorno XML
Campo Qtd Descrição Tipo Tamanho
Comentário
Return XML
status 1 Código de retorno String
Numérico
3 Este status é da comunicação. Veja
bpag_data.status para verificar o status do
pedido.
msg 1 Mensagem de retorno String
Alfanumérico
256
bpag_data 0..1 Dados do BPag Objeto do tipo
BjBPagData
fi_data 0..* Dados da instituição financeira Objeto do tipo
BjFIData
fdm_data 0..1 Dados da análise anti-fraude Objeto do tipo
BjFDMData
Objeto BjBPagData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjBPagData
status 1 Status do pedido no BPag. String
Numérico
3 Status do pedido de acordo com o apêndice B
msg 1 Mensagem de status do pedido. String
Alfanumérico
256
url 0..1 URL de redirecionamento no caso de
processamento assíncrono.
String
Alfanumérico
256
id 1 Id do pedido no BPag String
Numérico
18
Objeto BjFIData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFIData
bpag_payment_id 1 Id do pagamento. String
Numérico
18 BPag permitirá, num futuro próximo, múltiplos
pagamentos por pedido. Por esta razão, é
importante que cada pagamento tenha um ID
único.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
22 UOLDIVEO – Guia de Integração Padrão
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFIData
status 1 Código retornado pela instituição
financeira.
String
Numérico
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numérico
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alfanumérico
256
payment_method 1 Método de pagamento no BPag String
Alpahnumeric
20 Veja seção 4
normalized_paymen
t_method
1 Método de pagamento normalizado no
BPag
String
Alfanumérico
20 Veja seção 4
installments 1 Quantidade de parcelas String
Alfanumérico
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numérico
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numérico
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
trn_type 0..1 Tipo de transação String
Numérico
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alfanumérico
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alfanumérico
20
cc_brand 0..1 Bandeira String
Alfanumérico
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alfanumérico
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alfanumérico
30
auth_code 0..1 Código de autorização String
Alfanumérico
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alfanumérico
30
date 0..1 Data e hora da transação String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alfanumérico
256
status_3ds 0..1 Status da validação 3DSecure String
Alfanumérico
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alfanumérico
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numérico
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alfanumérico
256
settlement_status 0..1 Status de conciliação String
Alfanumérico
2 NS: não conciliado
SC: conciliado e confirmado
SP: conciliado de forma preditiva
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
23 UOLDIVEO – Guia de Integração Padrão
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFIData
settlement_type 0..1 Tipo de conciliação String
Alfanumérico
2 PB: preditiva pelo BPag
PW: preditiva pela instituição financeira via
WEB
PE: preditiva pela instituição financeira via EDI
PM: preditiva manualmente pela loja
SW: confirmado pela instituição financeira via
web.
SE: confirmado pela instituição financeira via
EDI
SM: confirmado manualmente pela loja
settlement_msg 0..1 Mensagem de conciliação. String
Alfanumérico
256
settlement_credit_d
ate
0..1 Data na qual o valor deve ser (foi)
creditado na conta da loja.
String
Alfanumérico
15 Formato “yyyyMMdd”
last_attempt 0..1 Última tentativa de pagamento feita
com sucesso ou insucesso.
Objeto of type
BjFiLastAttempt
Data
15
Objeto BjFILastAttemptData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFIData
status 1 Código retornado pela instituição
financeira.
String
Numérico
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numérico
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alfanumérico
256
installments 1 Quantidade de parcelas String
Alfanumérico
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numérico
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numérico
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
attempt_trn_type 0..1 Tipo de transação String
Numérico
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alfanumérico
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alfanumérico
20
cc_brand 0..1 Bandeira String
Alfanumérico
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alfanumérico
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alfanumérico
30
auth_code 0..1 Código de autorização String
Alfanumérico
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alfanumérico
30
date 0..1 Data e hora da transação String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alfanumérico
15 Formato “yyyyMMddHHmmSS”
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
24 UOLDIVEO – Guia de Integração Padrão
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFIData
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alfanumérico
256
attempt_status_3ds 0..1 Status da validação 3DSecure String
Alfanumérico
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alfanumérico
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numérico
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alfanumérico
256
Objeto BjFDMData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFDMData
status 1 Resposta do módulo anti-fraude do
BPag
String
Alfanumérico
3 AC – Aceito
RJ – Rejeitado
RW – Em revisão
msg 1 Mensagem do modulo anti-fraude String
Alfanumérico
256
score 0..1 Score do modulo anti-fraude String
Alfanumérico
18
fdm_bureau_data 0..* Status, mensagem e score retornados
por cada agência anti-fraude
consultada.
Objeto of type
BjFDMBureauD
ata
Estes valores retornam exatamente conforme
retornados pela agência (ClearSale,
Cybersource, etc)
Objeto BjFDMBureauData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjFDMData
bureau 1 Nome da agência String
Alfanumérico
50 BOLDCRON
CYBERSOURCE
CLEARSALE
FCONTROL
status 1 Código de retorno da agência anti-
fraude.
String
Alfanumérico
50
msg 0..1 Mensagem de retorno da agência anti-
fraude.
String
Alfanumérico
1000
score 0..1 Score String
Alfanumérico
50
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
25 UOLDIVEO – Guia de Integração Padrão
Campainha (Bell)
A URL para a qual será feito este POST, será a enviada no campo “behavior_data.url_post_bell” da primeira
requisição WebService (PayOrder).
UOLDIVEO Gateway de Pagamentos enviará três IDs, conforme descrito abaixo. Lojistas que controlam
somente uma tentativa de pagamento no UOLDIVEO Gateway de Pagamentos para merch_ref (referência
do lojista) e não permitem múltiplos pagamentos por pedido, precisarão apenas do merch_ref quando forem
fazer a chamada à Sonda (Probe).
[HTTPS POST: BPag => web site do lojista]
URL: endereço enviado pela loja no payOrder no campo
behavior_data.url_post_bell.
Parâmetros de Entrada:
Campo Qtd Descrição Tipo Tamanh
o
Comentário
Campainha (Bell)
merchant 1 Código da loja no BPag String
Alfanumérico
20
merch_ref 1 Identificação do pedido no sistema da
loja.
String
AlphNumérico
20
id 1 Id do pedido no BPag String
Numérico
18
bpag_payment_id 1 Id do pagamento no BPag. Será
utilizado no futuro quando o BPag
suportar múltiplos meios de pagamento
por pedido.
String
Numérico
18
Desta forma, o sistema do lojista deve implementar uma página web para receber o POST descrito acima.
Esta página web deve retornar um XML de forma que o UOLDIVEO Gateway de Pagamentos fique ciente
que a loja recebeu com sucesso a campainha. Caso isso não ocorra, o UOLDIVEO Gateway de
Pagamentos irá agendar uma nova tentativa de notificação após algum tempo, geralmente 1 minuto. O
número de tentativas de notificação é limitado, geralmente 30 vezes.
Return XML
Campo Qtd Descrição Tipo Tamanho
Comentário
XML de Retorno da Campainha
status 1 Resposta da loja ao recebimento da
campainha.
String
Numérico
3 A loja deve enviar 1 para indicar ao BPag que a
campainha foi recebida com sucesso. Caso
contrário, uma nova tentativa de envio da
campainha sera feita. Exceto para o valor -1,
para o qual o BPag parará de processar e
cancelará todas as transações já feitas.
msg 1 Mensagem de processamento da
campainha.
String
Alfanumérico
256
additional_
merchant_data
0..* Dados adicionais úteis para o
gerenciamento da loja.
Lista de objetos
BjExtraFields
Descritos em
payOrder ws.
Estes dados não influenciarão o
processamento. Qualquer informação será
adicionada ao pedido com o campo extra.
Exceto PNR, que será incluído em
airline_data.pnr.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
26 UOLDIVEO – Guia de Integração Padrão
Sonda (Probe)
A Sonda é a rotina que verifica o status do pedido. Esta chamada WebService segue a assinatura abaixo:
[Webservices: web site da loja => Servidores do BPag]
Nome do método: doService
Parâmetros:
Version: 1.1.0
Action: probe
Merchant: código da loja no ambiente do BPag
User: login do usuário cadastrado no ambiente administrativo do BPag
Password: senha do usuário cadastrado no ambiente administrativo do
BPag
Data: xml segundo especificado na seção 3.4.1
Return: xml segundo especificado na seção 3.4.2
URL do ambiente de testes:
http://www.boldcron.com.br/homologa/bpag2/services/BPagWS?wsdl
URL do ambiente de produção:
https://bpag.uol.com.br/bpag2/services/BPagWS?wsdl
Parâmetros de Entrada:
Campo Qtd Descrição Tipo Tamanho
Comentário
merch_ref 1 Identificação do pedido no sistema da
loja.
String
Alfanumérico
20
id 0..1 Id do pedido no BPag. String
Numérico
18
bpag_payment_id 0..1 Id do pagamento no BPag. Será útil no
futuro quando o BPag permitir
múltiplos pagamentos por pedido.
String
Numérico
18
O UOLDIVEO Gateway de Pagamentos está preparado para receber 3 IDs, conforme descrito acima.
Lojistas que controlam para que apenas uma tentativa de pagamento seja feita para cada merch_ref
(referência do lojista) e não permitem múltiplos pagamentos por pedido, pode utilizar apenas o merch_ref na
chamada a Sonda.
Caso contrário, o UOLDIVEO Gateway de Pagamentos irá retornar múltiplos pedidos com o mesmo
merch_ref e diferentes IDs, uma para cada tentativa. Se o lojista enviar o id também, então o UOLDIVEO
Gateway de Pagamentos retornará um pedido único.
Num futuro próximo, o UOLDIVEO Gateway de Pagamentos permitirá múltiplos pagamentos por pedido. Por
esta razão, o lojista deve enviar o bpag_payment_id se está interessado em detalhes sobre um pagamento
específico utilizado no pedido.
Retorno XML
Campo Qtd Descrição Tipo Tamanho
Comentário
status 1 Status do processamento String
Numérico
3 Status da comunicação. O status do pedido
deve ser verificado no campo bpag_data.status.
msg 1 Mensagem de retorno String
Alfanumérico
256
order_data 0..* Objeto do tipo
BjOrderData
Objeto BjOrderData
Field Qtd Description Type Size Comment
BjOrderData
bpag_data 0..1 Dados do pedido pelo BPag Objeto do tipo
BjBPagData
fi_data 0..* Dados do pedido pela Instituição
Financeira
Objeto do tipo
BjFIData
fdm_data 0..1 Dados do pedido pelo sistema de
análise anti-fraude
Objeto do tipo
BjFDMData
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
27 UOLDIVEO – Guia de Integração Padrão
billing_data 0..1 Dados de cobrança Objeto do tipo
BjBillingData
Objeto BjBPagData
Field Qtd Description Type Size Comment
Objeto BjBPagData
status 1 Status do pedido no BPag. String
Numeric
3 Status do pedido de acordo com o apêndice B
msg 1 Mensagem de status do pedido. String
Alphanumeric
256
url 0..1 URL de redirecionamento no caso de
processamento assíncrono.
String
Alphanumeric
256
id 1 Id do pedido no BPag String
Numeric
18
Objeto BjFIData
Field Qtd Description Type Size Comment
Objeto BjFIData
bpag_payment_id 1 Id do pagamento. String
Numeric
18 BPag permitirá, num futuro próximo, múltiplos
pagamentos por pedido. Por esta razão, é
importante que cada pagamento tenha um ID
único.
status 1 Código retornado pela instituição
financeira.
String
Numeric
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numeric
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alphanumeric
256
payment_method 1 Método de pagamento no BPag String
Alpahnumeric
20 Veja seção 4
normalized_paymen
t_method
1 Método de pagamento normalizado no
BPag
String
Alphanumeric
20 Veja seção 4
installments 1 Quantidade de parcelas String
Alphanumeric
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numeric
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numeric
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
trn_type 0..1 Tipo de transação String
Numeric
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alphanumeric
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alphanumeric
20
cc_brand 0..1 Bandeira String
Alphanumeric
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alphanumeric
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alphanumeric
30
auth_code 0..1 Código de autorização String
Alphanumeric
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alphanumeric
30
date 0..1 Data e hora da transação String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
28 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alphanumeric
256
status_3ds 0..1 Status da validação 3DSecure String
Alphanumeric
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alphanumeric
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numeric
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alphanumeric
256
settlement_status 0..1 Status de conciliação String
Alphanumeric
2 NS: não conciliado
SC: conciliado e confirmado
SP: conciliado de forma preditiva
settlement_type 0..1 Tipo de conciliação String
Alphanumeric
2 PB: preditiva pelo BPag
PW: preditiva pela instituição financeira via
WEB
PE: preditiva pela instituição financeira via EDI
PM: preditiva manualmente pela loja
SW: confirmado pela instituição financeira via
web.
SE: confirmado pela instituição financeira via
EDI
SM: confirmado manualmente pela loja
settlement_msg 0..1 Mensagem de conciliação. String
Alphanumeric
256
settlement_credit_d
ate
0..1 Data na qual o valor deve ser (foi)
creditado na conta da loja.
String
Alphanumeric
15 Formato “yyyyMMdd”
last_attempt 0..1 Última tentativa de pagamento feita
com sucesso ou insucesso.
Objeto do tipo
BjFiLastAttempt
Data
15
Objeto BjFILastAttemptData
Field Qtd Description Type Size Comment
Objeto BjFIData
status 1 Código retornado pela instituição
financeira.
String
Numeric
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numeric
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alphanumeric
256
installments 1 Quantidade de parcelas String
Alphanumeric
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numeric
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numeric
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
attempt_trn_type 0..1 Tipo de transação String
Numeric
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
29 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
cc_number_hash 0..1 Hash do número do cartão crédito String
Alphanumeric
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alphanumeric
20
cc_brand 0..1 Bandeira String
Alphanumeric
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alphanumeric
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alphanumeric
30
auth_code 0..1 Código de autorização String
Alphanumeric
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alphanumeric
30
date 0..1 Data e hora da transação String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alphanumeric
256
attempt_status_3ds 0..1 Status da validação 3DSecure String
Alphanumeric
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alphanumeric
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numeric
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alphanumeric
256
Objeto BjFDMData
Field Qtd Description Type Size Comment
Objeto BjFIData
status 1 Resposta do módulo anti-fraude do
BPag
String
Alphanumeric
3 AC – Aceito
RJ – Rejeitado
RW – Em revisão
msg 1 Mensagem do modulo anti-fraude String
Alphanumeric
256
score 0..1 Score do modulo anti-fraude String
Alphanumeric
18
fdm_bureau_data 0..* Status, mensagem e score retornados
por cada agência anti-fraude
consultada.
Objeto do tipo
BjFDMBureauD
ata
Estes valores retornam exatamente conforme
retornados pela agência (ClearSale,
Cybersource, etc)
Objeto BjFDMBureauData
Field Qtd Description Type Size Comment
Objeto BjFDMData
bureau 1 Nome da agência String
Alphanumeric
50 BOLDCRON
CYBERSOURCE
CLEARSALE
FCONTROL
status 1 Código de retorno da agência anti-
fraude.
String
Alphanumeric
50
msg 0..1 Mensagem de retorno da agência anti-
fraude.
String
Alphanumeric
1000
score 0..1 Score String
Alphanumeric
50
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
30 UOLDIVEO – Guia de Integração Padrão
Objeto BjBillingData
Field Qtd Description Type Size Comment
Objeto BjFIData
is_caldholder_travell
ing
0..1 Indica se o comprador é passageiro.
Utilizado somente para companhias
aéreas.
Integer 1 1 – true
0 – false
first_name 1 Primeiro nome String
Alphanumeric
30
middle_name 0..1 Nome do meio String
Alphanumeric
60
last_name 0..1 Sobrenome String
Alphanumeric
30
email 0..1 E-mail String
Alphanumeric
256
gender 0..1 Sexo String
Alphanumeric
1 M – Masculino
F – Feminino
marital_status 0..1 Estado Civil String
Alphanumeric
1 S – Solteiro
M – Casado/Married
W – Viúvo/Widow
D - Divorciado
birthday 0..1 Data de nascimento String
Alphanumeric
30 Formato “yyyyMMdd”
document_type 0..1 Tipo de documento String
Alphanumeric
2 0 – CPF
1 – CNPJ
2 – ID
3 – Passaporte
document 0..1 Número do documento String
Alphanumeric
50
phone_home 0..1 Telefone residencial Objeto do tipo
BjPhone
phone_office 0..1 Telefone comercial Objeto do tipo
BjPhone
phone_mobile 0..1 Celular Objeto do tipo
BjPhone
address_street 0..1 Endereço String
Alphanumeric
100
address_street_nr 0..1 Número String
Alphanumeric
25
address_additional_
data
0..1 Complemento (apartamento, bloco,
etc)
String
Alphanumeric
25
address_comunity 0..1 Bairro String
Alphanumeric
25
address_city 0..1 Cidade String
Alphanumeric
25
address_state 0..1 Estado String
Alphanumeric
25
address_country 0..1 País String
Alphanumeric
2 ISO Code
address_zip 0..1 CEP String
Alphanumeric
8
Objeto BjPhone
Field Qtd Description Type Size Comment
Objeto BjPhone
country_code 0..1 Código do país String
Numeric
3 Apenas os valores positivos serão aceitos.
Valor sem formatação.
area_code 0..1 Código de area String
Numeric
4 Apenas os valores positivos serão aceitos.
Valor sem formatação.
phone_number 1 Número de telefone String
Numeric
15 Apenas os valores positivos serão aceitos.
Valor sem formatação.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
31 UOLDIVEO – Guia de Integração Padrão
Captura
A Captura é uma rotina que confirma um pedido cujo valor já foi reservado no limite do comprador.
Geralmente, só está disponível para cartões de crédito. Este WebService deve ser usado somente por
lojistas em modo de Pré-Autorização. Isto quer dizer que o pedido somente será pré-autorizado (ou
autorizado) pela instituição financeira no primeiro fluxo (PayOrder/Campainha/Sonda). Se o lojista não
capturar estas transações, elas não serão cobradas. Este fluxo é particularmente útil para lojistas que
precisam confirmar se o item vendido está disponível em estoque.
O modo padrão de operação é Venda. Portanto, se você não solicitou outro modo de operação, você não
precisará implementar este WebService.
Esta chamada webservice segue a assinatura abaixo:
[Webservices: web site da loja => Servidores do BPag]
Nome do método: doService
Parâmetros:
Version: 1.0.0
Action: capture
Merchant: código da loja no ambiente do BPag
User: login do usuário cadastrado no ambiente administrativo do BPag
Password: senha do usuário cadastrado no ambiente administrativo do
BPag
Data: xml segundo especificado na seção 3.4.1
Return: xml segundo especificado na seção 3.4.2
URL do ambiente de testes:
http://www.boldcron.com.br/homologa/bpag2/services/BPagWS?wsdl
URL do ambiente de produção:
https://bpag.uol.com.br/bpag2/services/BPagWS?wsdl
Parâmetros de Entrada:
Campo Qtd Descrição Tipo Tamanh
o
Comentário
merch_ref 1 Identificação do pedido no sistema da
loja.
String
Alfanumérico
20
id 0..1 Id do pedido no BPag. String
Numérico
18
bpag_payment_id 0..1 Id do pagamento no BPag. Será útil no
futuro quando o BPag permitir
múltiplos pagamentos por pedido.
String
Numérico
18
cc_data 0..* Dados de cartão de crédito. Objeto do tipo
BjCreditCardDat
a
Este parâmetro deverá ser enviado somente se
o lojista não permitir ao BPag armazenar dados
de cartão de crédito (embora o BPag esteja
preparado para ser PCI/DSS compliance). E
somente alguns métodos de pagamento
necessitam destes dados no momento da
captura.
O UOLDIVEO Gateway de Pagamentos está preparado para receber 3 IDs, conforme descrito acima.
Lojistas que controlam para que apenas uma tentativa de pagamento seja feita para cada merch_ref
(referência do lojista) e não permitem múltiplos pagamentos por pedido, podem utilizar apenas o merch_ref
na chamada de Captura.
Caso contrário, o UOLDIVEO Gateway de Pagamentos terá múltiplos pedidos com o mesmo merch_ref e
diferentes IDs, uma para cada tentativa. Neste caso, o UOLDIVEO Gateway de Pagamentos irá capturar o
último pedido cujo status é diferente de Pago, Cancelado ou Inválido.
Se o lojista enviar o id também, então o UOLDIVEO Gateway de Pagamentos capturará um pedido único.
Num futuro próximo, o UOLDIVEO Gateway de Pagamentos permitirá múltiplos pagamentos por pedido. Por
esta razão, o lojista deve enviar o bpag_payment_id se está interessado em capturar apenas um
pagamento específico utilizado no pedido.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
32 UOLDIVEO – Guia de Integração Padrão
Objeto BjCreditCardData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjCreditCardData
cc_brand 0..1 Bandeira do cartão de crédito. String
Alfanumérico
30 Veja comentário sobre cc_data acima.
cc_number 0..1 Número do cartão de crédito. String
Alfanumérico
20 Veja comentário sobre cc_data acima.
O número do cartão deve ser encriptado com a
chave pública da BoldCron.
cc_cvv 0..1 Código de verificação do cartão de
crédito.
String
Alfanumérico
4 Veja comentário sobre cc_data acima.
O cvv deve ser encriptado com a chave pública
da BoldCron.
cc_exp_month 0..1 Mês de expiração do cartão de crédito. String
Alfanumérico
2 Veja comentário sobre cc_data acima.
Formato “MM”
cc_exp_year 0..1 Ano de expiração do cartão de crédito. String
Alfanumérico
4 Veja comentário sobre cc_data acima.
Formato “yyyy”
cc_exp 0..1 Validade do cartão de crédito
encriptada. O lojista pode optar por
enviar cc_exp_month + cc_exp_year
ou cc_exp
String
Alfanumérico
175 Veja comentário sobre cc_data acima.
A data de expiração deve ser encriptado com a
chave pública da BoldCron.
Formato “MM/yyyy”.
cc_card_holder 0..1 Nome do titular do cartão de crédito. String
Alfanumérico
40 Veja comentário sobre cc_data acima.
.
Retorno XML
Campo Qtd Descrição Tipo Tamanho
Comentário
status 1 Status do processamento String
Numérico
3 Status da comunicação. O status do pedido
deve ser verificado no campo bpag_data.status.
msg 1 Mensagem de retorno String
Alfanumérico
256
bpag_data 0..1 Dados do pedido pelo BPag Objeto do tipo
BjBPagData
fi_data 0..* Dados dos pagamentos pelas
Instituições Financeiras
Objeto do tipo
BjFIData
Objeto BjBPagData
Field Qtd Description Type Size Comment
Objeto BjBPagData
status 1 Status do pedido no BPag. String
Numeric
3 Status do pedido de acordo com o apêndice B
msg 1 Mensagem de status do pedido. String
Alphanumeric
256
url 0..1 URL de redirecionamento no caso de
processamento assíncrono.
String
Alphanumeric
256
id 1 Id do pedido no BPag String
Numeric
18
Objeto BjFIData
Field Qtd Description Type Size Comment
Objeto BjFIData
bpag_payment_id 1 Id do pagamento. String
Numeric
18 BPag permitirá, num futuro próximo, múltiplos
pagamentos por pedido. Por esta razão, é
importante que cada pagamento tenha um ID
único.
status 1 Código retornado pela instituição
financeira.
String
Numeric
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numeric
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alphanumeric
256
payment_method 1 Método de pagamento no BPag String
Alpahnumeric
20 Veja seção 4
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
33 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
normalized_paymen
t_method
1 Método de pagamento normalizado no
BPag
String
Alphanumeric
20 Veja seção 4
installments 1 Quantidade de parcelas String
Alphanumeric
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numeric
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numeric
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
trn_type 0..1 Tipo de transação String
Numeric
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alphanumeric
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alphanumeric
20
cc_brand 0..1 Bandeira String
Alphanumeric
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alphanumeric
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alphanumeric
30
auth_code 0..1 Código de autorização String
Alphanumeric
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alphanumeric
30
date 0..1 Data e hora da transação String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alphanumeric
256
status_3ds 0..1 Status da validação 3DSecure String
Alphanumeric
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alphanumeric
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numeric
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alphanumeric
256
settlement_status 0..1 Status de conciliação String
Alphanumeric
2 NS: não conciliado
SC: conciliado e confirmado
SP: conciliado de forma preditiva
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
34 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
settlement_type 0..1 Tipo de conciliação String
Alphanumeric
2 PB: preditiva pelo BPag
PW: preditiva pela instituição financeira via
WEB
PE: preditiva pela instituição financeira via EDI
PM: preditiva manualmente pela loja
SW: confirmado pela instituição financeira via
web.
SE: confirmado pela instituição financeira via
EDI
SM: confirmado manualmente pela loja
settlement_msg 0..1 Mensagem de conciliação. String
Alphanumeric
256
settlement_credit_d
ate
0..1 Data na qual o valor deve ser (foi)
creditado na conta da loja.
String
Alphanumeric
15 Formato “yyyyMMdd”
last_attempt 0..1 Última tentativa de pagamento feita
com sucesso ou insucesso.
Object of type
BjFiLastAttempt
Data
15
Objeto BjFILastAttemptData
Field Qtd Description Type Size Comment
Objeto BjFIData
status 1 Código retornado pela instituição
financeira.
String
Numeric
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numeric
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alphanumeric
256
installments 1 Quantidade de parcelas String
Alphanumeric
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numeric
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numeric
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
attempt_trn_type 0..1 Tipo de transação String
Numeric
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alphanumeric
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alphanumeric
20
cc_brand 0..1 Bandeira String
Alphanumeric
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alphanumeric
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alphanumeric
30
auth_code 0..1 Código de autorização String
Alphanumeric
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alphanumeric
30
date 0..1 Data e hora da transação String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alphanumeric
256
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
35 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
attempt_status_3ds 0..1 Status da validação 3DSecure String
Alphanumeric
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alphanumeric
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numeric
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alphanumeric
256
Cancelamento
O Cancelamento é uma rotina que cancela um pedido pré-autorizado ou pago. É importante observar as
restrições das instituições financeiras. Por exemplo, a Mastercard, no Brasil, permite o cancelamento até 24
horas após o pedido ter sido autorizado. A Visa, no Brasil, permite desde que seja no mesmo dia. A Amex
não permite.
Esta chamada webservice segue a assinatura abaixo:
[Webservices: web site da loja => Servidores do BPag]
Nome do método: doService
Parâmetros:
Version: 1.0.0
Action: cancel
Merchant: código da loja no ambiente do BPag
User: login do usuário cadastrado no ambiente administrativo do BPag
Password: senha do usuário cadastrado no ambiente administrativo do
BPag
Data: xml segundo especificado na seção 3.4.1
Return: xml segundo especificado na seção 3.4.2
URL do ambiente de testes:
http://www.boldcron.com.br/homologa/bpag2/services/BPagWS?wsdl
URL do ambiente de produção:
https://bpag.uol.com.br/bpag2/services/BPagWS?wsdl
Parâmetros de Entrada:
Campo Qtd Descrição Tipo Tamanh
o
Comentário
merch_ref 1 Indentificação do pedido no sistema da
loja.
String
Alfanumérico
20
id 0..1 Id do pedido no BPag. String
Numérico
18
bpag_payment_id 0..1 Id do pagamento no BPag. Será útil no
futuro quando o BPag permitir
múltiplos pagamentos por pediddo.
String
Numérico
18
cc_data 0..* Dados de cartão de crédito. Objeto do tipo
BjCreditCardDat
a
Este parâmetro deverá ser enviado somente se
o lojista não permitir ao BPag armazenar dados
de cartão de crédito (embora o BPag esteja
preparado para ser PCI/DSS compliance). E
somente alguns métodos de pagamento
necessitam destes dados no momento da
captura.
O UOLDIVEO Gateway de Pagamentos está preparado para receber 3 IDs, conforme descrito acima.
Lojistas que controlam para que apenas uma tentativa de pagamento seja feita para cada merch_ref
(referência do lojista) e não permitem múlitplos pagamentos por pedido, podem utilizar apenas o merch_ref
na chamada de Cancelamento.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
36 UOLDIVEO – Guia de Integração Padrão
Caso contrário, o UOLDIVEO Gateway de Pagamentos terá múltiplos pedidos com o mesmo merch_ref e
diferentes IDs, uma para cada tentativa. Neste caso, o UOLDIVEO Gateway de Pagamentos irá cancelar o
último pedido cujo status é diferente de Cancelado.
Se o lojista enviar o id também, então o UOLDIVEO Gateway de Pagamentos cancelará um pedido único.
Num futuro próximo, o UOLDIVEO Gateway de Pagamentos permitirá múltiplos pagamento por pedido. Por
esta razão, o lojista deve enviar o bpag_payment_id se está interessado em cancelar apenas um
pagamento específico utilizado no pedido.
Objeto BjCreditCardData
Campo Qtd Descrição Tipo Tamanho
Comentário
Objeto BjCreditCardData
cc_brand 0..1 Bandeira do cartão de crédito. String
Alfanumérico
30 Veja comentário sobre cc_data acima.
cc_number 0..1 Número do cartão de crédito. String
Alfanumérico
20 Veja comentário sobre cc_data acima.
O número do cartão deve ser encriptado com a
chave pública da BoldCron.
cc_cvv 0..1 Código de verificação do cartão de
crédito.
String
Alfanumérico
4 Veja comentário sobre cc_data acima.
O cvv deve ser encriptado com a chave pública
da BoldCron.
cc_exp_month 0..1 Mês de expiração do cartão de crédito. String
Alfanumérico
2 Veja comentário sobre cc_data acima.
Formato as “MM”
cc_exp_year 0..1 Ano de expiração do cartão de crédito. String
Alfanumérico
4 Veja comentário sobre cc_data acima.
Formato “yyyy”
cc_exp 0..1 Validade do cartão de crédito
encriptada. O lojista pode optar por
enviar cc_exp_month + cc_exp_year
ou cc_exp
String
Alfanumérico
175 Veja comentário sobre cc_data acima.
A data de expiração deve ser encriptado com a
chave pública da BoldCron.
Formato “MM/yyyy”.
cc_card_holder 0..1 Nome do titular do cartão de crédito. String
Alfanumérico
40 Veja comentário sobre cc_data acima.
.
Retorno XML
Campo Qtd Descrição Tipo Tamanho
Comentário
status 1 Status do processamento String
Numérico
3 Status da comunicação. O status do pedido
deve ser verificado no campo bpag_data.status.
msg 1 Mensagem de retorno String
Alfanumérico
256
bpag_data 0..1 Dados do pedido pelo BPag Objeto do tipo
BjBPagData
fi_data 0..* Dados dos pagamentos pelas
Insituições Financeiras
Objeto do tipo
BjFIData
Objeto BjBPagData
Field Qtd Description Type Size Comment
Objeto BjBPagData
status 1 Status do pedido no BPag. String
Numeric
3 Status do pedido de acordo com o apêndice B
msg 1 Mensagem de status do pedido. String
Alphanumeric
256
url 0..1 URL de redirecionamento no caso de
processamento assíncrono.
String
Alphanumeric
256
id 1 Id do pedido no BPag String
Numeric
18
Objeto BjFIData
Field Qtd Description Type Size Comment
Objeto BjFIData
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
37 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
bpag_payment_id 1 Id do pagamento. String
Numeric
18 BPag permitirá, num futuro próximo, múltiplos
pagamentos por pedido. Por esta razão, é
importante que cada pagamento tenha um ID
único.
status 1 Código retornado pela instituição
financeira.
String
Numeric
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numeric
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alphanumeric
256
payment_method 1 Método de pagamento no BPag String
Alpahnumeric
20 Veja seção 4
normalized_paymen
t_method
1 Método de pagamento normalizado no
BPag
String
Alphanumeric
20 Veja seção 4
installments 1 Quantidade de parcelas String
Alphanumeric
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numeric
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numeric
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
trn_type 0..1 Tipo de transação String
Numeric
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alphanumeric
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alphanumeric
20
cc_brand 0..1 Bandeira String
Alphanumeric
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alphanumeric
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alphanumeric
30
auth_code 0..1 Código de autorização String
Alphanumeric
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alphanumeric
30
date 0..1 Data e hora da transação String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alphanumeric
256
status_3ds 0..1 Status da validação 3DSecure String
Alphanumeric
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alphanumeric
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numeric
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alphanumeric
256
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
38 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
settlement_status 0..1 Status de conciliação String
Alphanumeric
2 NS: não conciliado
SC: conciliado e confirmado
SP: conciliado de forma preditiva
settlement_type 0..1 Tipo de conciliação String
Alphanumeric
2 PB: preditiva pelo BPag
PW: preditiva pela instituição financeira via
WEB
PE: preditiva pela instituição financeira via EDI
PM: preditiva manualmente pela loja
SW: confirmado pela instituição financeira via
web.
SE: confirmado pela instituição financeira via
EDI
SM: confirmado manualmente pela loja
settlement_msg 0..1 Mensagem de conciliação. String
Alphanumeric
256
settlement_credit_d
ate
0..1 Data na qual o valor deve ser (foi)
creditado na conta da loja.
String
Alphanumeric
15 Formato “yyyyMMdd”
last_attempt 0..1 Última tentativa de pagamento feita
com sucesso ou insucesso.
Object of type
BjFiLastAttempt
Data
15
Objeto BjFILastAttemptData
Field Qtd Description Type Size Comment
Objeto BjFIData
status 1 Código retornado pela instituição
financeira.
String
Numeric
3
normalized_status 1 Código retornado pela instituição
financeira normalizado pelo BPag.
String
Numeric
3 De acordo com o apêndice C
msg 1 Mensagem de retorno da instituição
financeira.
String
Alphanumeric
256
installments 1 Quantidade de parcelas String
Alphanumeric
20
value 1 Valor cobrado nesta forma de
pagamento
String
Numeric
20 Este valor inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
original_value 1 Valor original, antes do cálculo de
juros.
String
Numeric
20 Este valor não inclui os juros do parcelamento.
Valor sem formatação.
Os últimos dois dígitos são os centavos. Ex.
1234 = 12.34
attempt_trn_type 0..1 Tipo de transação String
Numeric
2 0 – Venda
1 – Reembolso / Cancelamento de Venda
2 – Pré-Autorização
3 – Captura de Pré-Autorização
4 – Cancelamento de Pré-Autorização
5 – Cancelamento de Captura de Pré-
Autorização
cc_number_hash 0..1 Hash do número do cartão crédito String
Alphanumeric
40
cc_number_masked 0..1 Número do cartão de crédito
mascarado
String
Alphanumeric
20
cc_brand 0..1 Bandeira String
Alphanumeric
20
cc_card_holder 0..1 Titular do cartão de crédito String
Alphanumeric
40
aux_number 0..1 Id auxiliar da instituição financeira
(NSU TEF, etc)
String
Alphanumeric
30
auth_code 0..1 Código de autorização String
Alphanumeric
30
id 0..1 Id da instituição financeira
(Comprovante, NSU, tid, etc)
String
Alphanumeric
30
date 0..1 Data e hora da transação String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
39 UOLDIVEO – Guia de Integração Padrão
Field Qtd Description Type Size Comment
Objeto BjFIData
expiration_date 0..1 Data de expiração da forma de
pagamento. Usado para boletos.
String
Alphanumeric
15 Formato “yyyyMMddHHmmSS”
additional_data 0..1 Informações adicionais enviadas pela
instituição financeira.
String
Alphanumeric
256
attempt_status_3ds 0..1 Status da validação 3DSecure String
Alphanumeric
2 NV – Não verificado ou não disponível.
AF – Autenticação falhou. Usuário preencheu
dados inválidos.
AS – Autenticado com sucesso.
NI – Autenticação não implementada pelo
emissor.
msg_3ds 0..1 Mensagem da validação 3DSecure String
Alphanumeric
256
status_avs 0..1 Score da verificação de endereço feita
pela instituição financeira.
String
Numeric
3 De “0” a “100” de acordo com o número de
campos conferidos corretamente. “-1” ou não
retorna quando não disponível.
msg_avs 0..1 Mensagem da verificação AVS. String
Alphanumeric
256
Apêndice A: Métodos de Pagamento
Este apêncide descreve, primeiramente, os principais métodos de pagamento utilizados no Brasil. Os
métodos de pagamento internacionais são descritos na parte final país a país.
Normalmente, são necessários 7 dias para configurar um novo método de pagamento (descontado o tempo
para adquirir a afiliação com a Instituição Financeira).
CARTÕES DE CRÉDITO
American Express
Nome do Método Normalizado Descrição Curta
setef_amex amex American Express por Software Express ( TEF – X.25)
amex_webpos amex American Express por Web Pos (ambiente web)
amex_webpos2p amex American Express por Web Pos (sem pop-up)
Aura
Nome do Método Normalizado Descrição Curta
setef_aura aura Aura por Software Express (TEF – X.25)
Diners Club
Nome do Método Normalizado Descrição Curta
setef_diners diners Diners Club por Software Express ( TEF – X.25)
redecard_diners diners Komerci Redecard Diners Club (ambiente web)
redecard_ws_diners Komerci Redecard Diners Club (sem pop-up)
MasterCard
Nome do Método Normalizado Descrição Curta
setef_mastercard mastercard MasterCard por Software Express ( TEF – X.25)
redecard_mastercard mastercard Komerci RedeCard MasterCard (ambiente web)
redecard_ws_mastercard mastercard Komerci RedeCard MasterCard (sem pop-up)
cielows2p_mastercard mastercard Cielo e-commerce (sem pop-up)
cielows_mastercard mastercard Cielo e-commerce ((ambiente web)
Visa
Nome do Método Normalizado Descrição Curta
setef_visa visa VISA por Software Express ( TEF – X.25)
redecard_ws_visa visa Komerci Redecard Visa (sem pop-up)
redecard_visa Visa Komerci Redecard Visa (ambiente web)
cielows2p_visa visa Cielo e-commerce (sem pop-up)
cielows_visa visa Cielo e-commerce (ambiente web)
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
40 UOLDIVEO – Guia de Integração Padrão
Hipercard
Nome do Método Normalizado Descrição Curta
setef_hipercard hipercard Hipercard por Software Express ( TEF – X.25)
Elo
Nome do Método Normalizado Descrição Curta
setef_elo elo VISA por Software Express ( TEF – X.25)
cielows2p_elo elo Cielo e-commerce (sem pop-up)
Goodcard
Nome do Método Normalizado Descrição Curta
goodcard goodcard Cartão de Crédito Good Card
Private Label
Nome do Método Normalizado Descrição Curta
setef_pontocred pontocred Cartão PontoCred por Software Express ( TEF – X.25)
setef_extra extra Cartão Extra por Software Express ( TEF – X.25)
setef_comprabem comprabem Cartão CompraBem por Software Express ( TEF – X.25)
setef_paoacucar paoacucar Cartão Pão de Açúcar por Software Express ( TEF – X.25)
setef_sendas sendas Cartão Sendas por Software Express ( TEF – X.25)
setef_extrapresentes extrapresentes Cartão Extra Presentes por Software Express ( TEF – X.25)
setef_plenocard plenocard Cartão Plenocard processado na Telenet por Software Express ( TEF – X.25 )
setef_personalcard personalcard Cartão Personalcard processado na Softnex por Software Express ( TEF – X.25 )
Obs: entre em contato com a equipe de suporte do BPag para saber os outros cartões private label suportados
DÉBITO ONLINE
Banco do Brasil
Nome do Método Normalizado Descrição Curta
bb_debito bb Débito Banco do Brasil.
bb_crediario bb Crediário Banco do Brasil.
bb_boleto boleto Boleto bancário banco do Brasil.
bb bb Deixar o cliente selecionar a opção de pagamento no ambiente do Banco.
Banrisul
Nome do Método Normalizado Descrição Curta
banrisul_pgta banrisul Débito Banrisul
banrisul_pgtx banrisul Venda parcelada Banrisul
banrisul_pgtp banrisul Venda Pré-datada Banrisul
banrisul_pgbc boleto Boleto Banrisul (gerado no ambiente do Banco)
Bradesco
Nome do Método Normalizado Descrição Curta
bradesco_boleto boleto Boleto Bradesco (gerado no ambiente do Banco)
bradesco_transfer bradesco Transferência Bradesco
bradesco bradesco Débito Bradesco
BV
Nome do Método Normalizado Descrição Curta
bv_financiamento bv Financiamento do banco Votorantim
Itaú
Nome do Método Normalizado Descrição Curta
itau itau Débito Itaú Shopline
boleto_shopline boleto Boleto Itaú (gerado no ambiente do Banco)
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
41 UOLDIVEO – Guia de Integração Padrão
HSBC
Nome do Método Normalizado Descrição Curta
hsbc hsbc Débito HSBC
Visa Electron
Nome do Método Normalizado Descrição Curta
cielows_visaelectron visaelectron Débito VISA Electron (somente para cartões Bradesco)
Maestro
Nome do Método Normalizado Descrição Curta
cielows_maestro maestro Débito Maestro
OUTROS
Nome do Método Normalizado Descrição Curta
paggo_oi paggo_oi Cartão de Crédito Paggo com autenticação e autorização via celular Oi
pagdigital_aura aura Cartão de Crédito Aura via Pagamento Digital
pagdigital_amex amex Cartão de Crédito Amex via Pagamento Digital
pagdigital_diners diners Cartão de Crédito Diners via Pagamento Digital
pagdigital_mastercard mastercard Cartão de Crédito Mastercard via Pagamento Digital
pagdigital_visa visa Cartão de Crédito Visa via Pagamento Digital
pagseguro pagseguro Multiplos Meios de Pagamento
cef_loterica cefLoterica Pagamento Eletrônico Caixa – Pagamento de conta sem fatura
BOLETOS
Boletos gerados pelo UOLDIVEO Gateway de Pagamentos não precisarão de afiliação com os bancos, será
somente necessário habilitar a conta bancária da loja para recebimento de pagamentos via boleto. O lojista
deve informar ao UOLDIVEO Gateway de Pagamentos o código do banco, a carteira, o número da conta e
outros dados eventualmente necessários.
Note que nos meios de pagamento Débito Online, descritos acima, os bancos suportam a emissão de
boleto em seu próprio ambiente. Abaixo, listamos o código do método de pagamento para as duas opções.
Nome do Método Normalizado Descrição Curta
bb_boleto boleto Boleto Banco do Brasil (gerado no ambiente do banco)
boleto_bb boleto Boleto Banco do Brasil (gerado pelo BPag)
boleto_shopline boleto Boleto Itaú (gerado no ambiente do banco)
boleto_itau boleto Boleto Itaú (gerado pelo BPag)
banrisul_pgbc boleto Boleto Banrisul (gerado no ambiente do banco)
bradesco_boleto boleto Boleto Bradesco (gerado no ambiente do banco)
boleto_bradesco boleto Boleto Bradesco (gerado pelo BPag)
boleto_santander boleto Boleto Santander (gerado pelo BPag)
INTERNACIONAIS
Estados Unidos
Nome do Método Normalizado Descrição Curta
cybs_amex amex Cartão de Crédito Amex
cybs_diners diners Cartão de Crédito Diners
cybs_mastercard mastercard Cartão de Crédito Mastercard
cybs_visa visa Cartão de Crédito Visa
Europa
Nome do Método Normalizado Descrição Curta
ogone_amex amex Cartão de Crédito Amex
ogone_diners diners Cartão de Crédito Diners
ogone_mastercard mastercard Cartão de Crédito Mastercard
ogone_visa visa Cartão de Crédito Visa
ogonedl_mastercard mastercard Cartão de Crédito Mastercard
ogonedl_visa visa Cartão de Crédito Visa
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
42 UOLDIVEO – Guia de Integração Padrão
ogonedl_amex amex Cartão de Crédito Amex
ogonedl_diners diners Cartão de Crédito Diners
ogonedl_cartebleue cartebleue Cartão de Crédito Carteblueu
Argentina
Nome do Método Normalizado Descrição Curta
nps_amex amex Cartão de Crédito Amex (ambiente web)
nps_cabal cabal Cartão de Crédito Cabal (ambiente web)
nps_diners diners Cartão de Crédito Diners (ambiente web)
nps_mastercard mastercard Cartão de Crédito Mastercard (ambiente web)
nps_nevada nevada Cartão de Crédito Nevada (ambiente web)
nps_visa visa Cartão de Crédito Visa (ambiente web)
pspsubuno_arg_amex amex Cartão de Crédito Amex
pspsubuno_arg_argencard argencard Cartão de Débito Argencard *
pspsubuno_arg_cabal cabal Cartão de Crédito Cabal *
pspsubuno_arg_consumax consumax Cartão de Crédito Consumax *
pspsubuno_arg_diners diners Cartão de Crédito Diners
pspsubuno_arg_italcred italcred Cartão de Crédito ItalCred *
pspsubuno_arg_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_arg_naranja naranja Cartão de Crédito Naranja *
pspsubuno_arg_nevada nevada Cartão de Crédito Nevada *
pspsubuno_arg_visadebito Visa Cartão de Débito Visa *
pspsubuno_arg_visa visa Cartão de Crédito Visa
*Em homologação
Bolívia
Nome do Método Normalizado Descrição Curta
pspsubuno_bol_amex amex Cartão de Crédito Amex
pspsubuno_bol_diners diners Cartão de Crédito Diners
pspsubuno_bol_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_bol_visa visa Cartão de Crédito Visa
Caribe
Nome do Método Normalizado Descrição Curta
global_dom_visa visa Global Collect Visa (República Dominicana)
global_dom_mastercard mastercard Global Collect MasterCard (República Dominicana)
global_dom_diners diners Global Collect Diners (República Dominicana)
global_dom_amex amex Global Collect AMEX (República Dominicana)
global_abw_visa visa Global Collect Visa (Aruba)
global_abw_mastercard mastercard Global Collect MasterCard (Aruba)
global_abw_diners diners Global Collect Diners (Aruba)
global_abw_amex amex Global Collect AMEX (Aruba)
global_cur_visa visa Global Collect Visa (Curaçao)
global_cur_mastercard mastercard Global Collect MasterCard (Curaçao)
global_cur_diners diners Global Collect Diners (Curaçao)
global_cur_amex amex Global Collect AMEX (Curaçao)
global_maf_visa visa Global Collect Visa (St. Martin)
global_maf_mastercard mastercard Global Collect MasterCard (St. Martin)
global_maf_diners diners Global Collect Diners (St. Martin)
global_maf_amex amex Global Collect AMEX (St. Martin)
Chile
Nome do Método Normalizado Descrição Curta
webpay webpay Cartões de Crédito Amex, Diners, Mastercard e Visa selecionados no ambiente da
Transbank (plataforma web)
pspsubuno_chl_amex amex Cartão de Crédito Amex
pspsubuno_chl_cabal cabal Cartão de Crédito Cabal *
pspsubuno_chl_diners diners Cartão de Crédito Diners
pspsubuno_chl_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_chl_visa visa Cartão de Crédito Visa
*Em homologação
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
43 UOLDIVEO – Guia de Integração Padrão
Colômbia
Nome do Método Normalizado Descrição Curta
ecollect_amex Amex Cartão de Crédito Amex (ambiente web) *
ecollect_credential Credential Cartão de Crédito Credential (ambiente web) *
ecollect_diners Diners Cartão de Crédito Diners (ambiente web) *
ecollect_mastercad mastercard Cartão de Crédito Mastercard (ambiente web)
ecollect_visa visa Cartão de Crédito Visa (ambiente web)
pspsubuno_col_amex amex Cartão de Crédito Amex
pspsubuno_col_diners diners Cartão de Crédito Diners
pspsubuno_col_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_col_visa visa Cartão de Crédito Visa
*Em homologação
México
Nome do Método Normalizado Descrição Curta
pspsubuno_mex_amex amex Cartão de Crédito Amex
pspsubuno_mex_diners diners Cartão de Crédito Diners
pspsubuno_mex_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_mex_visa visa Cartão de Crédito Visa
Peru
Nome do Método Normalizado Descrição Curta
peru_mastercad mastercard Cartão de Crédito Mastercard (ambiente web) *
peru_visa visa Cartão de Crédito Visa (ambiente web) *
pspsubuno_per_amex amex Cartão de Crédito Amex
pspsubuno_per_diners diners Cartão de Crédito Diners
pspsubuno_per_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_per_visa visa Cartão de Crédito Visa
*Em homologação
Paraguai
Nome do Método Normalizado Descrição Curta
pspsubuno_pry_amex amex Cartão de Crédito Amex
pspsubuno_pry_cabal cabal Cartão de Crédito Cabal *
pspsubuno_pry_diners diners Cartão de Crédito Diners
pspsubuno_pry_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_pry_visa visa Cartão de Crédito Visa
*Em homologação
Uruguai
Nome do Método Normalizado Descrição Curta
pspsubuno_ury_amex amex Cartão de Crédito Amex
pspsubuno_ury_cabal cabal Cartão de Crédito Cabal *
pspsubuno_ury_diners diners Cartão de Crédito Diners
pspsubuno_ury_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_ury_visa visa Cartão de Crédito Visa
*Em homologação
Venezuela
Nome do Método Normalizado Descrição Curta
credicard_mastercad mastercard Cartão de Crédito Mastercard (ambiente web)
credicard_visa visa Cartão de Crédito Visa (ambiente web)
pspsubuno_ven_amex amex Cartão de Crédito Amex
pspsubuno_ven_diners diners Cartão de Crédito Diners
pspsubuno_ven_mastercad mastercard Cartão de Crédito Mastercard
pspsubuno_ven_visa visa Cartão de Crédito Visa
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
44 UOLDIVEO – Guia de Integração Padrão
APÊNDICE B: Código de Status do Pedido Status do Pedido
Descrição Código Descrição
0 Pago Pedido pago com sucesso.
1 Não Pago Comprador finaliza pagamento sem sucesso e o pedido é dado como terminado pela
Instituição Financeira.
2 Inválido
Este status acontece quando a transação não pode mais ser processada pelo BPag. Esta
mudança pode ocorrer por regras da própria loja ou por ação manual via painel de controle
do BPag.
3 Cancelado (Estornado) Pagamento cancelado.
4 Não Efetivado Este é o status inicial do pedido.
5 Saldo Insuficiente Ocorre quando o comprador não tem saldo suficiente em sua conta bancária.
6 Pendente de Liberação Ocorre quando a compra precisa da aprovação de mais de uma pessoa na instituição
financeira. Comum para débitos online em contas empresariais.
7 Pendente de Pagamento Ocorre quando a instituição financeira está aguardando o pagamento. Ocorre para
métodos de pagamento via boleto ou para débigo Real entre 0h e 7h.
8 Não Capturado
Este é um status intermediário, principalmente para cartões de crédito, que significa se o
valor da compra foi reservado no limite do comprado. Mas ainda é necessário capturar a
transação para que ele seja efetivamente cobrado.
10 Pago Parcialmente
Ocorre quando o comprador pagou valor inferior ao valor total do pedido. Geralmente isto
ocorre quando o usuário tenta fraudar o pagamento de boletos ou quando o usuário erra,
sem intenção, o valor dos centavos do boleto.
12 Em Análise Significa que o pedido está sendo analisado pelo módulo Antifraude.
APÊNDICE C: Códigos de Resposta Código Descrição
Geral
0 Sucesso
-1 Erro de processamento interno.
-2 Erro de acesso/gravação no banco de dados.
-3 Este pedido já foi finalizado.
-4 Loja não cadastrada no sistema.
-5 Forma de pagamento não cadastrada.
-6 Erro de processamento na operadora.
-7 Erro ao obter o pedido.
-8 Erro processamento pelo SiTef.
-9
Pedido não encontrado. Verifique se o ID do pedido está correto e
se ele pertence a loja do usuário logado.
-10 Erro definido pelo CYBS
-11 Erro ao mudar status do pedido.
-12 Falha ao tentar validar request.
-13 Loja requisitou que o processo seja finalizado.
-14 Pedido em status inválido para execução da ação.
-15 Erro de processamento MOSET
-16 Erro de processamento no componente de Integração SITEF
-17
Erro de processamento no componente de Integração com
GlobalCollect
-18 Erro de processamento no componente cielows
Validação de Dados
-30 Dados inválidos.
-31 Número do cartão é necessário para esta operação.
-32 Código de segurança do cartão é necessário para esta operação.
-33 Mês de validade do cartão é necessário para esta operação.
-34 Ano de validade do cartão é necessária para esta operação.
-35 XML mal formatado.
-36 Os valores do pedido estão inconsistentes.
-37 Usuário ou senha não encontrado.
-38 O usuário não tem permissão para executar essa função.
-39 Erro ao especificar idioma.
-40 Erro ao especificar moeda.
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
45 UOLDIVEO – Guia de Integração Padrão
-41 Forma de pagamento inválida.
-42 BIN do cartão não definido, ou inválido
-43 Bandeira do cartão não definida, ou inválido
-44 Perfil selecionado inválido para esta loja.
-45 Request mal formatado. Ausência de parâmetros de segurança.
-46 Request com falha na validação dos dados de segurança.
-47
Request não permitido. Tempo esperado para recebimento dessa
requisição expirou.
Parcelamento
-50 Parcelamento inválido pelas regras configuradas no BPAG.
-51 Parcelamento emissor.
-52 Erro ao gravar parcelamento do pedido.
Criptografia
-60 Sistema de criptografia ainda não iniciado.
-61 Erro ao decriptar dados.
Retorno WebService
-70 Forma de pagamento não implementa template TEF.
-71 Modo de operacao não suportado.
-72 Erro ao executar pré-autorização.
-73 Erro ao executar venda.
-74 Erro ao executar captura.
-75 Erro ao executar cancelamento.
-76 Operação não suportada.
-77 Operação não implementada.
-78 Pedido já cancelado.
-79 A forma de pagamento difere da enviada anteriormente.
-80 Acao solicitada desconhecida.
-81 Pedido gravado no BD com sucesso.
-82 Operação não permitida.
-83 Erro ao executar consulta BIN.
-84 Erro ao consultar o status do pedido na IF.
-85 Erro ao gerar Boleto.
-86 Versão inválida.
-87 Erro ao executar transações 3DSecure.
-88 Limite de transação excedido
-89 Erro ao processar débito automático
-190
Alguns pagamentos não puderam ser cancelados. Verifique o
status de cada pagamento.
-191
Os pagamentos deste pedido não estão em estado passível de
cancelamento.
-192
Alguns pagamentos não puderam ser capturados. Verifique o status
de cada pagamento.
-193
Os pagamentos deste pedido não estão em estado passível de
captura.
Retorno de Operação de Cartão de Crédito
-90 Não autorizado.
-91 Problemas com cartão.
-92 Parcelamento inválido pelas regras cadastradas na operadora.
-93 Aguarde contato.
-94 Código de segurança inválido.
-95 Tente novamente
-96 Dados inválidos.
-97 Valor da transação excedeu o limite de crédito do cartão.
-98 Cartão expirado.
-99 Autenticação 3DSecure falhou.
-100 Serviço Indisponível.
-101 Este cartão não foi emitido para autenticação 3DSecure.
-102 Transação pendente. Procedimento manual necessário.
-103 Conferência AVS falhou.
-104 Código de afiliação inválido.
-105 Operação ainda não realizada.
-106 Cartão não pertence à bandeira informada.
-107
BIN indisponível para avaliação de origem, ou se é emitido no
exterior/brasil
UOLDIVEO – Guia de Integração Padrão – Versão 2.3.2
46 UOLDIVEO – Guia de Integração Padrão
-108
Ocorreu time out na comunicação com a operadora, verifique o
status da transação mais tarde.
-109 BIN de cartão não permitido por causa das configurações da loja.
-110 Cartão perdido ou roubado
-111 Erro de processamento interno instituição
-112 Dados não encontrados
-113 Ramos de atividade não permitida
-114 Estabelecimento não pertence a rede
-115 Retentativas em andamento
-116 Retentativas esgotadas
Retorno do Módulo Antifraude
-160 Erro na consulta ao BPag Anti-Fraude.
-161 O pedido foi reprovado.
-162 O pedido está em revisão.
-163 O pedido está pendente.
-164 Pedido está sendo processado pelo processo síncrono
Retorno de Indisponibilidade
-200 Meio de pagamento temporariamente indisponível
-201 Bandeira incompatível com a forma de pagamento
-202 Banco emissos não está disponível para realizar a autenticação
-203 Número do pedido duplicado
-205
Pedido já enviado para processamento. Favor aguardar o retorna
da Instituição Financeira.
Sobre o UOLDIVEO
O UOLDIVEO é a mais nova unidade de negócios do Grupo UOL, consolidada pelas empresas UOL Host Data Center, DIVEO e DHC
Outsourcing, com o objetivo de ser uma provedora de soluções completas, por meio de infraestrutura para implementar, integrar e
gerenciar soluções de telecomunicações e data centers para empresas de pequeno, médio e grande porte. Com sede em São Paulo, o
UOLDIVEO possui 4 data centers interligados por uma rede própria e se destaca pelo acompanhamento constante da evolução das
necessidades de seus clientes, oferecendo produtos e serviços de alta tecnologia, rapidez na entrega e na implementação.
O lugar certo para os seus negócios.
Belo Horizonte | Brasília | Campinas | Curitiba | Porto Alegre | Rio de Janeiro | São Paulo