Manual de Integração - BRWebService - Versão 1.4.1 Gearman

Statix Inovação e Tecnologia
BR WebService – Manual de Integração
BR WebService - Manual de Integração

1. Objetivo
Este manual tem como objetivo apresentar as especificações e os critérios técnicos
necessários para a utilização do WebService de Integração da Statix Inovação e Tecnologia (BR-
WS).
Através do BR-WS poderá ser realizado o envio das informações das vendas capturadas
pelo cliente, e o recebimento das informações processadas pelas administradoras de cartão.
2. Histórico de Alterações
Versão Data Analista Descrição
1.0 25/02/2014 Alexandre Criação do Documento
Silva
1.0.1 12/03/2014 Alexandre Adicionar campo: “numero” no objeto de parcela
Silva
1.0.2 14/03/2014 Alexandre Mudança dos valores dos campos: “bandeira” e
Silva “modalidade” no objeto Venda
1.0.3 04/04/2014 Alexandre  Mudança no formato do campo data
Silva  Adição dos campos: “codigoLoja” e “formaCaptura”
no objeto de Venda
1.0.4 08/04/2014 Alexandre  Adição dos campos: “percTaxaAdministracao” e
Silva “percTaxaAntecipacao” no objeto de Parcela
1.0.5 21/05/2014 Alexandre  Adição do campo: “chaveVenda” no objeto de
Venda
 Adição do campo: “chaveParcela” no objeto de
Parcela
1.0.6 22/05/2014 Alexandre  Correção do domínio do campo “nsuOrigem” do
objeto de parcela.
 Correção do domínio dos seguintes campos do
objeto de venda:
o nrAutorizacao
o nsuOrigem
o bandeira
o modalidade
1.0.7 27/04/2015 Alexandre  Criação dos seguintes campos no objeto de
ConsultaVenda
o dataCreditoInicial
o dataCreditoFinal
o status
o codigoEstabelecimento
1.0.8 07/05/2015 Alexandre  Adição do status: 0 – Não conciliada
1.0.9 08/05/2015 Alexandre  Criação do seguinte campo no objeto de
ConsultaVenda
o nsuAdministradora
BR WebService - Manual Integração Página 1 de 20

ConsultaVenda
o codigoLoja
1.0.11 03/06/2015 Alexandre  Adição da modalidade VOUCHER
1.0.12 04/06/2015 Alexandre  Correção do formato do campo data/hora
ConsultaVenda
o nrParcela
1.0.14 25/06/2015 Alexandre  Inclusão das bandeiras
o 22 – Discover
o 23 - Esplanada
o 24 - BaneseCard
 Inclusão das redes
o 9 - Amex
o 10 - Banesecard
o 11 – Elavon
1.1.0 09/07/2015 Alexandre  Criação do serviço de exclusão de venda do cliente
1.1.1 15/07/2015 Alexandre  Correção da lista de valores do campo
formaCaptura do objeto de Venda.
1.1.2 08/09/2015 Alexandre  Liberação de exclusão de venda de clientes, apenas
com o filtro data da venda
 Adição do campo taxa de antecipação nominal no
objeto de parcela
 Adição do campo vendas duplicadas no objeto de
retorno
1.2.0 10/09/2015 Alexandre  Criação do serviço de consulta de lançamento da
administradora
1.2.1 17/09/2015 Alexandre  Inclusão de orientações acerca da utilização dos
filtros da consulta de vendas da administradora
 Inclusão da lista de históricos de lançamentos
1.3.0 22/09/2015 Alexandre  Criação do serviço de consulta de extrato bancário
 Adição do campo chaveDetalheExtrato no objeto
consultaVenda
 Adição do campo chaveDetalheExtrato no objeto
consultaLancamento
1.3.1 24/08/2016 Alexandre  Adição do campo dataVenda no objeto de parcela
1.3.2 29/08/2016 Alexandre  Atualização das redes e bandeiras
1.3.3 18/10/2016 Alexandre  Adição do campo produto no objeto Venda
1.3.4 21/10/2016 Alexandre  Adição do campo codigoProduto no objeto Venda
1.4.0 22/03/2018 Alexandre  Criação dos serviços:
o consultaAdquirente
o consultaBandeira
o registraAdquirenteCliente
1.4.1 26/04/2018 Alexandre  Adição do campo redeCaptura no objeto Venda

1. Arquitetura de Comunicação
a. Modelo Conceitual
O BR-WS disponibilizará as seguintes funcionalidades:
a) Registro de venda do cliente

b) Consulta de venda do cliente
c) Consulta de venda da administradora
d) Exclusão de venda do cliente
e) Consulta de lançamento da administradora
f) Consulta de extrato bancário
g) Consulta de adquirentes integradas com o sistema de conciliação
h) Consulta de bandeiras integradas com o sistema de conciliação
i) Registro das adquirentes, bandeiras e modalidades que o cliente utiliza
Existirá um único Web Service com todos os serviços apresentados acima. O fluxo de
comunicação é sempre iniciado pelo cliente através do envio de uma mensagem XML (ou
Json) ao Web Service com o pedido do serviço desejado.
O pedido de serviço será atendido na mesma conexão (todos os serviços serão síncronos).
O processamento do pedido do serviço é concluído na mesma conexão, com a devolução

de uma mensagem XML (ou Json) contendo o retorno do processamento do serviço
pedido;
O diagrama a seguir ilustra o fluxo conceitual de comunicação entre o sistema do cliente e

o BR-WS:
Cliente BR-WS
Sistema ERP ou PDV HTTPs WebService
Fluxo de
Comunicação

b. Padrão de mensagens
i. Formato de preenchimento dos campos

Formato Obervação
Data (date) Formato: AAAA-MM-DD
AAAA = ano com 4 caracteres
MM = mês com 2 caracteres
DD = dia com 2 caracteres
Data/Hora Formato: AAAA-MM-DD HH:mm:ss
(timestamp) AAAA = ano com 4 caracteres
MM = mês com 2 caracteres
DD = dia com 2 caracteres
HH = hora com 2 caracteres (formato 24 horas)
mm = minuto com 2 caracteres
ss = segundo com 2 caracteres
Valores Decimais Formato: 0.00
(double) O ponto (.) só será utilizado para separar a parte inteira da
fracionária. Não se deve utilizar separador de milhar. Exemplos:
32.786,43 = 32786.43
2,00 = 2.00 ou 2
0,30 = 0.30 ou 0.3
Valores Percentuais Formato: 0.0000
(double) Valores em percentual devem ser apresentados em sua forma
fracionária, com 5 dígitos. O ponto (.) separa a parte inteira da parte
fracionária. Exemplos:
58% = 0.58
200% = 2.0 ou 2
37,65% = 0.3725
Não deve ser inserido caractere não significativo para preencher o tamanho completo do
campo, ou seja, zeros antes de número ou espaço em branco após cadeia de caracteres.
Campos não obrigatórios ou sem valor (null) não necessitam ser enviados.

2. BR WebService
a. Objetos utilizados
A seguir segue tabela com a definição dos objetos utilizados como dados. A tabela está
dividida em 4 colunas, a saber:
 Objeto: tipo composto;

 Campo: tipo simples;
 Tipo: tipo de dados:
o C: caractere;
o N: número;
o D: data ou data/hora;
o O: objeto. Exemplo: Objeto mensagem tem um campo “cartao” do Tipo
“O”, logo “cartao” é um objeto Cartao;
o L: lista de objeto. Exemplo: Cartão possui campo “listaPerguntaResposta”
do tipo “L”, logo “listaPerguntaResposta” é uma lista com 1 ou n
ocorrências do objeto PerguntaResposta;
 Descrição: informações sobre o campo;
Objeto: Venda
Campo Tipo Descrição
nsuOrigem C Campo chave da venda para o cliente
nsuAdministradora N Nsu da venda na administradora
nrAutorizacao C Número da autorização da venda
redeAdquirente N Número da rede adquirente (responsável pelo liquidação
financeira da transação), conforme item 4.b
data D Data e hora da venda
nrCartao C Número do cartão
loja C Nome da loja
codigoEstabelecimento N Código do estabelecimento
valor N Valor da venda
nrParcelas N Número de parcelas da venda
bandeira N Número da bandeira, conforme item 4.c
modalidade N 1 – Débito, 2 – Crédito, 3 – Voucher
banco N Banco onde será creditado o valor para o cliente
agencia N Agência onde será creditado o valor para o cliente
conta N Conta onde será creditado o valor para o cliente
codigoLoja N Codigo da loja no Conciliador
formaCaptura C Veja lista de formas de captura no item 4.e
chaveVenda N Campo que identifica unicamente uma venda para o Conciliador
parcelas L Lista de parcelas da venda
produto C Nome do produto
codigoProduto N Código do produto
redeCaptura N Número da rede de captura da transação, conforme item 4.b

Objeto: Parcela
nsuOrigem C Campo chave da parcela para o cliente
dataCredito D Data de prevista de crédito
status N Código do status da parcela, conforme item 4.d
numero N Número da parcela
dataPagamento D Data que o crédito foi realizado
dataCancelamento D Data que o cancelamento foi realizado
valorTaxaAdministracao N Valor da taxa de administração
percTaxaAdministracao N Percentual da taxa de administração
valorTaxaAntecipacao N Valor da taxa de antecipação
percTaxaAntecipacao N Percentual da taxa de antecipação
valorAjuste N Valor de ajuste
valorPago N Valor pago
valor N Valor da parcela
chaveParcela N Campo que identifica unicamente uma parcela para o
Conciliador
percTaxaAntecipacaoNominal N Percentual da taxa de antecipação nominal
Objeto: Lancamento
data N Data do lançamento
codigoLoja N Código da loja no Conciliador
nomeLoja C Nome da loja no Conciliador
redeAdquirente N Número da rede adquirente, conforme item 4.b
codigoHistorico N Código do histórico de lançamento no Conciliador
descricaoHistorico C Descrição do histórico de lançamento
flagDebitoCredito C D – Débito, C – Crédito
valor N Valor do lançamento
codigoConciliador N Código de identificação do lançamento no conciliador
banco N Código do banco que foi realizado o lançamento
agencia N Número da agencia que foi realizado o lançamento
conta N Número da conta que foi realizado o lançamento

Objeto: Retorno
codigoRetorno C Vide anexo III – Tabela de códigos de retorno
detalheRetorno C No caso da solicitação não ter sido atendida por algum erro, será
informado neste campo maiores detalhes do problema
detectado
codigoRequisicao N Número que identifica unicamente esta requisição
nrPaginaAtual N Pagina atual enviada
nrTotalPagina N Número total de paginas
vendas L Lista de vendas (só tem retorno para consulta de venda)
vendasDuplicadas L Lista de venda duplicadas (esta informação não deve ser
preenchida na requisição, ela será retornada na resposta, para o
caso do cliente, que valida repetição de venda, tentar registrar
vendas duplicadas. Só é preenchido na resposta do serviço
registrar venda)
lancamentos L Lista de vendas (só tem retorno para consulta de lançamento)
extrato L Lista de extrato
adquirentes L Lista de adquirentes integradas
bandeiras L Lista de bandeiras integradas
adquirentesCliente L Lista de adquirentes, bandeiras e modalidades enviadas para
serem registradas. Neste registro de retorno será informado se
as informações foram incluídas ou se ocorreu algum erro.
Objeto: ConsultaVenda
codigoCliente N Código do cliente
nsuLote N Campo chave do lote de venda para o cliente
nsuVenda N Campo chave da venda para o cliente
nrAutorizacao N Número da autorização da venda
codigoRequisicao N Código da requisição da consulta original (utilizado para tratar
paginação)
nrPagina N Número da página requerida da consulta original(utilizado para
tratar paginação)
dataVendaInicial D Data de venda inicial
dataVendaFinal D Data de venda final
dataInclusaoInicial D Data de inclusão inicial
dataInclusaoFinal D Data de inclusão final
dataPagamentoInicial D Data de pagamento inicial
dataPagamentoFinal D Data de pagamento final
dataCancelamentoInicial D Data de cancelamento inicial
dataCancelamentoFinal D Data de cancelamento final
dataCreditoInicial D Data de crédito inicial
dataCreditoFinal D Data de crédito final
status N Situção da parcela (ver campo status do objeto parcela)
codigoEstabelecimento N Código do estabelecimento na administradora de cartão
codigoLoja N Codigo da loja no Conciliador
nsuAdministradora N Nsu da administradora
nrParcela N Número da parcela
chaveDetalheExtrato C Campo retornado na consulta de extrato, que permite visualizar
todos os lançamentos de uma linha de extrato específica

Objeto: ConsultaLancamento
dataInicial D Data inicial do lançamento (obrigatório)
dataFinal D Data final do lançamento (obrigatório)
valorInicial N Valor inicial do lançamento
valorFinal N Valor final do lançamento
codigoHistorico N Código do histórico de lançamento no Conciliador
flagDebitoCredito C D – Débito, C – Crédito
codigoRequisicao N Código da requisição da consulta original (utilizado para tratar
paginação)
nrPagina N Número da página requerida da consulta original(utilizado para
tratar paginação)
chaveDetalheExtrato C Campo retornado na consulta de extrato, que permite visualizar
todos os lançamentos de uma linha de extrato específica
Objeto: LoteVenda
nsuLote N Campo chave do lote de venda para o cliente
codigoCliente N Código do cliente
nrVendas N Número de vendas no lote
totalVendas N Valor total de vendas deste lote
vendas L Lista de venda
Objeto: ConsultaExtrato
data D Data do lançamento (obrigatório)
codigoConta N Código que identifica unicamente uma conta bancária no
Conciliador

Objeto: Extrato
data D Data do lançamento (obrigatório)
nomeLoja C Nome da loja no Conciliador
codigoConta N Código que identifica unicamente uma conta bancária no
Conciliador
banco N Código do banco na FEBRABAN
agencia N Código da agencia bancária
conta N Código da conta bancária
descricao C Descrição do lançamento
documento N Número do documento do lançamento
valorLiquidoVenda N Valor a receber oriundo de vendas com cartão de crédito
valorDebitoAdicional N Valor a ser deduzido do valor líquido de venda
valorCreditoAdicional N Valor a ser acrescido ao valor líquido de venda
valorLancamento N Valor do lançamento = valorLiquidoVenda +
valorCreditoAdicional – valorDebitoAdicional
chaveDetalheExtrato C Campo utilizado para obter todas as parcelas que compõe o
valorLiquidoVenda, e todos os lançamentos que compõe os
valores adicionais. Se os valores adicionais forem zero, indica que
não tem lançamentos adicionais para a data.
Este campo deve ser passado na consulta de venda para obter as
parcelas pagas e na consulta de lançamento para obter os
lançamentos adicionais
Objeto: Adquirente
codigo N Código da adquirente integrada no sistema de conciliação
descricao C Descrição da adquirente integrada
Objeto: Bandeira
codigo N Código da bandeira integrada no sistema de conciliação
descricao C Descrição da bandeira integrada
Objeto: LoteAdquirente
nrAdquirentes N Número de adquirentes enviadas
adquirentes L Lista de adquirentes, bandeiras e modalidades do cliente. Deve
ter a mesma quantidade informado no atributo nrAdquirentes

Objeto: AdquirenteCliente
nomeAdquirente C Nome da adquirente utilizada pelo cliente
nomeBandeira C Nome da bandeira utilizada pelo cliente
nomeModalidade C Nome da modalidade utilizada pelo cliente
cnpj N Cnpj da loja do cliente que utiliza a adquirente, bandeira e
modalidade
id N Chave primária da adquirente, bandeira e modalidade do cliente
no sistema de conciliação (não deve ser informada, esta
informação será gerada e retornada pelo serviço)
dataInclusao D Data e hora de inclusão da adquirente, bandeira e modalidade
do cliente no sistema de conciliação (não deve ser informada,
esta informação será gerada e retornada pelo serviço)
situacao N Situação da adquirente, bandeira e modalidade do cliente no
sistema de conciliação (não deve ser informada, esta informação
será gerada e retornada pelo serviço)
Pode assumir um dos seguintes valores:
1. CADASTRADA – informação foi recebida e será
avaliada.
2. SOLICITANDO EXTRATO – o processo de solicitação
de extrato foi iniciado.
3. IMPLANTADA – o processo de solicitação de extrato
foi finalizado.
4. INTEGRANDO COM ADQUIRENTE – o sistema de
conciliação não é integrado com a adquirente
informada, o processo de integração com a
adquirente foi iniciado.
dataPrimeiraVenda D Data da primeira venda (caso a situação seja IMPLANTADA) desta
adquirente, bandeira e modalidade no sistema de conciliação
(não deve ser informada, esta informação será gerada e
retornada pelo serviço)
descricaoErro C Descrição do erro que impediu a inclusão da adquirente,
bandeira e modalidade

3. Serviços
a. Registro de venda do cliente

Para o cliente registrar os dados de uma venda deverá chamar o serviço
registraVendaCliente do BR-WS passando os seguintes parâmetros:

versao N Versão do BR-WS utilizado
loteVenda O XML ou Json que representa o objeto de loteVenda.
O número máximo de vendas por lote é 100.
token N Conjunto de caracteres que autentica o cliente, esta informação
é fornecida pela Statix ou parceiro comercial
Como resposta a solicitação enviada acima será retornada uma cadeia de caracteres que
representa o XML ou Json do objeto de retorno, conforme a especificação dos objetos
utilizados (item 4.1).
b. Consulta de venda do cliente

Para o cliente consultar a vendas já registras por ele, deverá chamar o serviço
consultaVendaCliente do BR-WS passando os seguintes parâmetros:

consultaVenda O XML ou Json que representa um objeto consultaVenda
c. Consulta de venda da administradora
Para o cliente consultar a(s) venda(s) das administradoras de cartão, deverá chamar o
serviço consultaVendaAdm do BR-WS passando os seguintes parâmetros:

consultaVenda O XML ou Json que representa um objeto consultaVenda
Esta consulta possui várias opções de filtros, abaixo listamos as opções mínimas, mas
pode ser utilizada qualquer combinação dos filtros que se deseje.
1. Período de venda
2. Período de cancelamento
3. Período de pagamento
4. Período previsto de crédito
5. Código da requisição e numero da página (utilizado na paginação)
6. NSU da Venda do cliente
7. NSU da administradora
8. Número da autorização
d. Exclusão de venda do cliente

Para o cliente excluir uma venda enviada por ele mesmo, deverá chamar o serviço
excluiVendaCliente do BR-WS passando os seguintes parâmetros:

venda O XML ou Json que representa um objeto venda.
O campo data é obrigatório.
Se for informado apenas o campo data, serão apagadas todas as
vendas com a data informada.
Para apagar apenas uma venda informar os seguintes campos,
além do campo data:
 nsuOrigem
 valor
e. Consulta de lançamento da administradora

Para o cliente consultar o(s) lançamentos(s) das administradoras de cartão, deverá chamar o
serviço consultaLancamento do BR-WS passando os seguintes parâmetros:

Versão N Versão do BR-WS utilizado
consultaLancamento O XML ou Json que representa um objeto consultaLancamento
Token N Conjunto de caracteres que autentica o cliente, esta informação
f. Consulta de extrato bancário

Para o cliente consultar os valores, oriundos de vendas no cartão, creditados em um

determinado dia em sua(s) conta(s) bancárias, deverá chamar o serviço consultaExtrato do BR-
WS passando os seguintes parâmetros:

consultaExtrato O XML ou Json que representa um objeto consultaExtrato
Para saber todas as parcelas pagas e / ou lançamentos adicionais que compõe as linhas de
extrato, será necessária a realização de uma consulta de venda e / ou lançamentos passando
apenas o campo chaveDetalheExtrato como filtro.
O detalhamento das linhas de extrato não são enviadas na mesma resposta porque uma linha
de extrato é muitas vezes a consolidação de centenas de parcelas, ou seja, seria necessário o
envio de uma resposta muita grande, o que torna inviável retorna todas as informações
detalhadas em uma mesma requisição. A utilização das consultas de venda e lançamento
utilizam paginação, o que torna viável a extração destes dados.
g. Consulta de adquirentes integradas

Para o cliente consultar todas as adquirentes integradas com o sistema de conciliação até o
momento, deverá chamar o serviço consultaAdquirente do BR-WS passando os seguintes
parâmetros:

utilizados (item 4.1). A lista de adquirentes estará no atributo adquirentes do objeto Retorno.

h. Consulta de bandeiras integradas

Para o cliente consultar todas as bandeiras integradas com o sistema de conciliação até o
momento, deverá chamar o serviço consultaBandeira do BR-WS passando os seguintes
parâmetros:

utilizados (item 4.1). A lista de bandeiras estará no atributo bandeiras do objeto Retorno.
i. Registro das adquirentes, bandeiras e modalidades

utilizadas pelo cliente
Para o cliente registrar todas as adquirentes, bandeiras e modalidades que utiliza, ou consultar
o andamento da implantação destas, deverá chamar o serviço registraAdquirenteCliente do
BR-WS passando os seguintes parâmetros:

loteAdquirente O XML ou Json que representa um objeto loteAdquirente
utilizados (item 4.1). A lista com o retorno de cada adquirente, bandeira e modalidade
informadas estará no atributo adquirentesCliente do objeto Retorno.
Se a adquirente, bandeira e modalidade não existir será incluída, se já existir será retornada a
data de inclusão, a situação atual da implantação e a data da primeira venda registrada, caso
esta já tenho sido implantada. Se ocorrer algum erro, será informado no atributo
descricaoErro do objeto adquirenteCliente.

4. Anexo
a. Tabela de códigos de retorno das requisições
Código Tipo Descrição
MSG_001 Mensagem Resquisicao atendida com sucesso.
Erro inesperado, no momento de registrar a requisicao no
ERR_001 Erro banco de dados
ERR_002 Erro Erro inesperado, Tipo de entrada invalido.
ERR_003 Erro Erro inesperado na validacao do token. {0}
ERR_004 Erro Erro inesperado na consulta de requisicao. {0}
ERR_005 Erro Erro inesperado na obtencao dos filtros originais da consulta
ERR_006 Erro Erros nos filtros da requisicao original: {0}. {1}
ERR_007 Erro Erro inesperado na contagem do numero de paginas
ERR_008 Erro Erro inesperado na consulta de venda da administradora
ERR_009 Erro Erro inesperado na consulta das parcelas da venda
ERR_999 Erro Erro inesperado. {0}
NGC_001 Negócio Versão inválida
NGC_002 Negócio Token invalido
Número da página é obrigatório quando se informa o código da
NGC_003 Negócio requisição
Um dos períodos é obrigatório: cancelamento, inclusão,
NGC_004 Negócio pagamento, crédito ou venda
NGC_005 Negócio Codigo de requisicao: {0} inexistente para o cliente: {1}
NGC_006 Negócio O campo nrVendas eh obrigatorio
NGC_007 Negócio O campo totalVendas eh obrigatorio
NGC_008 Negócio A lista de vendas eh obrigatorio
O numero de vendas informado difere do numero de registros
NGC_009 Negócio da lista de vendas
O total de vendas informado difere da soma de registros da lista
NGC_010 Negócio de vendas
NGC_011 Negócio Campo data eh obrigatorio. Venda da posicao: {0}
NGC_012 Negócio Campo valor eh obrigatorio. Venda da posicao: {0}
NGC_014 Negócio Campo nrParcelas eh obrigatorio. Venda da posicao: {0}
O numero de parcelas informado difere do numero de registros
NGC_016 Negócio da lista de parcelas. Venda da posicao: {0}
Campo numero eh obrigatorio. Venda da posicao {0} parcela de
NGC_017 Negócio posicao: {1}
Campo valor eh obrigatorio. Venda da posicao: {0} parcela de
NGC_018 Negócio posicao: {1}
O valor da venda informado difere do valor da soma das
NGC_019 Negócio parcelas. Venda da posicao: {0}
O campo forma de captura deve ser igual a P (POS) ou T (TEF).
NGC_020 Negócio Venda da posicao: {0}
NGC_021 Negócio O campo Nsu de Origem é obrigatório
Não foi encontrada nenhuma venda com o nsuOrigem, data e
NGC_022 Negócio valor passados
NGC_023 Negócio A data inicial e final são obrigatórias
NGC_024 Negócio O campo chave de detalhe do extrato é inválido

b. Lista de redes adquirentes
Código Descrição
1 Cielo
2 RedeCard
3 HiperCard
4 CrediShop
5 Losango
6 GETNET
7 LiberCrad
8 FortBrasil
9 Amex
10 BaneseCard
11 Elavon
12 Ticket
13 Sodexo
14 Bin
15 Stone
16 Valecard
17 Policard
18 Nutricash
19 GoodCard
20 VR
21 Valeshop
22 Vero
23 Tricard
24 Safra
25 RedeUze
26 GreenCard
27 Dacasa

c. Lista de bandeiras
Código Descrição
1 Visa
2 MasterCard
3 HiperCard
4 Amex
5 CrediShop
7 LiberCard
8 GoodCard
9 Aura
10 Losango
11 Elo
12 SoroCred
13 Cabal
14 Diners
15 AgiPlan
16 FortBrasil
17 CredZ
18 CredSystem
19 CUP
20 Sicredi
21 BanesCard
22 Discover
23 Esplanada
24 BaneseCard
25 AVISTA
26 Ticket
27 Sodexo
28 Valecard
29 Policard
30 Nutricash
31 VR
32 JCB
33 Valeshop
34 BanriCompras
35 GetNet
36 SafraPay
37 Tricard
39 GreenCard
40 Dacasa

d. Lista de status da parcela
Código Descrição
0 Não conciliada
1 Previsto
2 Confirmado
3 Liquidado
4 Cancelado
5 Antecipado
6 Cancelado Administradora
7 Cancelado Cliente
10 Ajustado
11 Cancelado Por Reagendamento
12 Suspenso/Penhorado/Retido
13 Liquidado Por Aceleração
e. Lista de formas de captura

i.TEF
ii.POS
iii. Manual
iv. Internet
v. Leitor de Trilhas
vi. URA
vii. Arquivo
viii. Mobile

f. Lista de históricos de lançamentos
CÓDIGO DESCRIÇÃO CÓDIGO DESCRIÇÃO

1 Mensalidade Smart 49 POS-INATIV/CONEC/PIN
2 Cobrança Consulta Serasa 50 Tarifa Instalação de DISKTEF
3 Débito Parcelado 51 Correção de Pagamento
4 Ocorrências Extras 52 Reversão Débito Indevido
5 Taxa Conectividade 53 Reapresentação de Pagamento
6 Aluguel POS Inativo 54 Baixado(Retido/Suspenso/Penhorado)
7 Taxa Adesão 55 Mensalidade HiperCard
8 Reposição/Adic Maquineta 99 Historico Desconhecido
9 Estorno RedeShop/Maestro 100 Acerto Diversos
10 Adesão SecureCode 101 Consulta de Cheques
11 Mensalidade SecureCode 102 Débito por Crédito em Duplicidade
13 Consulta SecureCode 103 Estorno de Cobrança Plano Cielo
Débito por não reconhecimento de
14 Tarifa Débito 104 compra
15 Taxa Débito Não Liquidado 105 Débito referente contestação do portador
16 Estorno Crédito Indevido 106 Estorno de cancelamento de venda
17 Equipamento Perdido 107 Estorno Contrato de caução
18 Cancelamento de Venda 108 Taxa manutenção do TEF
19 2ª Via Extrato 109 Indenização POS perdido
Débito por descumprimento de cláusula
20 Extrato Saldo em Aberto 110 contratual
21 Diferença Taxa Cobrada a Maior 111 Tarifa Extrato Papel
22 Contestação de Venda 112 Débito por serviços não prestados
23 Contestação de Venda 113 Cancelamento/ChargeBack maestro
24 Penalidade CBK (EDITORA) 114 Regularização de rejeição ARV
25 Cartão não Válido no Brasil 115 Acerto de valores não recebidos
26 CV/NSU Internacional Data Venda 116 Acordo de cobrança
27 Créditos em Duplicidade 117 Cobrança de tarifa operacional
Credito EC - referente contestação
28 Aluguel POS/Taxa Conectividade Ref 118 portador
Débito por cancelamento e/ou devolução
29 Débito de Venda Feita em Duplicidade 120 dos serviços
Comprovante de Venda Solicitado Não
30 Recebido 121 Débito por não entrega da mercadoria
31 Crédito Indevido 122 Devolução Mensalidade HiperCard
32 Ajuste Cash Back 123 Pacote de Serviços
33 Ajuste Crédito/Débito 124 Oferta Rede
34 Venda Processada a Menor 125 Acerto de valores não processados
35 CREDITO PARCELAS 126 Pacote Cielo
36 Cobrança Indevida Tarifa. Meios Captura 127 Aceler. do Ajuste a Créd. ARV (CIELO)
37 Venda Processada a Maior 143 Manutenção de cadastro
38 Estorno de Taxa Administrativa 144 Help Service
39 Estorno de Cobrança Plano Cielo 145 Help Desk
40 Tarifa Extrato Mensal 146 Doc

CÓDIGO DESCRIÇÃO CÓDIGO DESCRIÇÃO

Reembolso Expresso - Entrega Livre
147 (Antecipação) 153 Crédito Cortesia
148 Seguros 154 Juros Sobre Saldo Devedor
149 Acerto de Valores não processados 155 Regularização de Saldo Devedor
150 Oferta Rede 156 Cobrança Plano Cielo
151 Tarifa de Extrato Eletrônico 157 Acerto de valores não reconhecidos
152 Débito Intercambio

Manual de Integração - BRWebService - Versão 1.4.1 Gearman

Enviado por

Dados do documento

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Manual de Integração - BRWebService - Versão 1.4.1 Gearman

Enviado por

Direitos autorais:

Formatos disponíveis

Statix Inovação e Tecnologia

BR WebService – Manual de Integração

BR WebService - Manual de Integração

BR WebService - Manual Integração Página 1 de 20

BR WebService - Manual Integração Página 2 de 20

a) Registro de venda do cliente

O processamento do pedido do serviço é concluído na mesma conexão, com a devolução

O diagrama a seguir ilustra o fluxo conceitual de comunicação entre o sistema do cliente e

Sistema ERP ou PDV HTTPs WebService

BR WebService - Manual Integração Página 3 de 20

i. Formato de preenchimento dos campos

BR WebService - Manual Integração Página 4 de 20

 Objeto: tipo composto;

 Descrição: informações sobre o campo;

BR WebService - Manual Integração Página 5 de 20

BR WebService - Manual Integração Página 6 de 20

BR WebService - Manual Integração Página 7 de 20

BR WebService - Manual Integração Página 8 de 20

BR WebService - Manual Integração Página 9 de 20

BR WebService - Manual Integração Página 10 de 20

a. Registro de venda do cliente

Campo Tipo Descrição

b. Consulta de venda do cliente

Campo Tipo Descrição

c. Consulta de venda da administradora

Campo Tipo Descrição

d. Exclusão de venda do cliente

Campo Tipo Descrição

e. Consulta de lançamento da administradora

Campo Tipo Descrição

f. Consulta de extrato bancário

Para o cliente consultar os valores, oriundos de vendas no cartão, creditados em um

Campo Tipo Descrição

g. Consulta de adquirentes integradas

Campo Tipo Descrição

BR WebService - Manual Integração Página 13 de 20

h. Consulta de bandeiras integradas

Campo Tipo Descrição

i. Registro das adquirentes, bandeiras e modalidades

Campo Tipo Descrição

BR WebService - Manual Integração Página 14 de 20

BR WebService - Manual Integração Página 15 de 20

b. Lista de redes adquirentes

BR WebService - Manual Integração Página 16 de 20

BR WebService - Manual Integração Página 17 de 20

d. Lista de status da parcela

e. Lista de formas de captura

BR WebService - Manual Integração Página 18 de 20

f. Lista de históricos de lançamentos

CÓDIGO DESCRIÇÃO CÓDIGO DESCRIÇÃO

BR WebService - Manual Integração Página 19 de 20

CÓDIGO DESCRIÇÃO CÓDIGO DESCRIÇÃO

BR WebService - Manual Integração Página 20 de 20

Você também pode gostar