Descrição dos Campos

Descrição dos objetos utilizados

Os objetos enviados e recebidos pelo serviços estão detalhados abaixo com o nome padrão utilizado como parâmetros nas chamadas aos serviços.

loteVenda

loteVenda

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 registros Objeto Agrupa todos os dados retornados
2 1 codigoCliente Num Código do cliente no ConciliadorBR
3 1 nrVendas Num Quantidade de transações de venda
4 1 totalVendas Num Valor total bruto das vendas
5 1 vendas Objeto Agrupa uma única venda independente do numero de parcelas
6 2 nsuOrigem Alfa Àrea de uso do cliente – código identificador da transação definido pelo cliente O campo nsuOrigem deve ser um identificador único para cada transação
7 2 nsuAdministradora Num Número sequencial único da Administradora de cartão
8 2 codigoLoja Num Código da loja fornecido pelo ConciliadorBR
9 2 nrAutorizacao Alfa Código de autorização da transação
10 2 redeAdquirente Num Código da rede adquirente – vide tabela I – Adquirentes
11 2 data Data Data da venda
12 2 chaveVenda Num Chave única no ConciliadorBR
13 2 formaCaptura Alfa Identificador do tipo de captura, para valores aceitos verifique a tabela III
14 2 valor Num Valor total da venda
15 2 nrParcelas Num Quantidade total de parcelas
16 2 bandeira Num Código da bandeira do produto, vide tabela II – Bandeiras
17 2 modalidade Num Código da modalidade de pagamento ou Natureza, vide tabela V
18 2 dataVendaInicial Data Data inicial da venda
19 2 dataVendaFinal Data Data final da venda
20 2 dataCbackInicial Data Data inicial do chageback no período
21 2 dataCbackFinal Data Data final do chageback no período
22 2 codigoRequisicao Alfa Código da requisição
23 2 nrPagina Alfa Número da página

Retorno da Consulta Venda

Retorno da Consulta Venda

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 consultaVenda Objeto Agrupa todos parâmetros de pesquisa
2 1 codigoCliente Num Código do cliente no Conciliador, utilizado somente quanto o mesmo TOKEN permite acesso a mais de um cliente.
3 1 nsuLote Num Número do lote identificado pelo cliente no registro de vendas
4 1 nsuVenda Num Àrea de uso do cliente – código identificador da transação definido pelo cliente
5 1 nrAutorizacao Alfa Código de autorização da transação
6 1 codigoRequisicao Num Número da requisição gerada pelo Webservice
7 1 nrPagina Num Número da pagina de retorno de dados
8 1 dataVendaInicial Data Data inicial de venda do período
9 1 dataVendaFinal Data Data final de venda do período
10 1 dataInclusaoInicial Data Data inicial de inclusão do período
11 1 dataInclusaoFinal Data Data final de inclusão do período
12 1 dataPagamentoInicial Data Data inicial de pagamento do período
13 1 dataPagamentoFinal Data Data final de pagamento do período
14 1 dataCancelamentoInicial Data Data inicial de cancelamento do período
15 1 dataCancelamentoFinal Data Data final de cancelamento do período
16 1 dataCreditoInicial Data Data inicial de crédito do período
17 1 dataCreditoFinal Data Data inicial de crédito do período
18 1 status Num Situação da parcela, vide tablea IV
19 1 codigoEstabelecimento Num Código do estabelecimento na administradora de cartão
20 1 codigoLoja Num Codigo da loja no Conciliador
21 1 nsuAdministradora Num Número Sequencial único da administradora
22 1 nrParcela Num Número da parcela

Retorno da Registra Venda

Retorno da Registra Venda

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado do registro de vendas
2 1 codigoRetorno Alfa Código de retorno EX : MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem descrita por extenso
4 1 codigoRequisicao Num Código da requisição processada pelo conciliador, poderá ser utilizada para rastreamento em caso de falha

Retorno da Exclui VendaCliente

Retorno da Exclui VendaCliente

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado do registro de vendas
2 1 codigoRetorno Alfa Código de retorno MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem descrita por extenso
4 1 codigoRequisicao Num Código da requisição processada pelo conciliador, poderá ser utilizada para rastreamento em caso de falha

Retorno da Venda Cliente

Retorno da Venda Cliente 

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado da consulta
2 1 codigoRetorno Alfa Código de retorno MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem de retorno por extenso
4 1 codigoRequisicao Num Número da requisição gerada pelo conciliador
5 1 nrPaginaAtual Num Número da página retornada
6 1 nrTotalPagina Num Quantidade total de páginas da consulta solicitada.
7 1 vendas Objeto Agrupa os dados de uma transação de venda
8 2 nsuOrigem Alfa Código unico definido pelo próprio cliente quando do envio da informação ao conciliador
9 2 nsuAdministradora Num Número Sequencial único da administradora
10 2 nrAutorizacao Alfa Código de autorização da transação
11 2 redeAdquirente Num Código da rede adquirente – vide tabela I – Adquirentes
12 2 data Data Data da transação de venda
13 2 nrCartao Alfa Número do cartão com algarismos suprimidos
14 2 loja Alfa Nome da loja no Conciliador
15 2 codigoLoja Num Código da loja no Conciliador
16 2 formaCaptura Alfa Identificador do tipo de captura, obedece a tabela III
17 2 codigoEstabelecimento Num Código da estabelecimento do lojista na operadora de cartão
18 2 chaveVenda Num Chave única para o registro no Conciliador
19 2 valor Num Valor total da venda
20 2 nrParcelas Num Quantidade de parcelas
21 2 bandeira Num Código da bandeira do produto, vide tabela II – Bandeiras
22 2 codigoProduto Num Código do produto, vide tabela VI – Produtos
23 2 produto Alfa Descritivo do produto
24 2 modalidade Num Código da modalidade de pagamento, vide tabela V
25 2 banco Num Número do Banco
26 2 agencia Num Número da agência bancária
27 2 conta Alfa Conta corrente

Retorno da Consulta Venda Adm

Retorno da Consulta Venda Adm

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado da consulta
2 1 codigoRetorno Alfa Código de retorno MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem de retorno por extenso
4 1 codigoRequisicao Num Número da requisição gerada pelo conciliador
5 1 nrPaginaAtual Num Número da página retornada
6 1 nrTotalPagina Num Quantidade total de páginas da consulta solicitada.
7 1 Vendas Objeto Agrupa os dados de uma transação de venda
8 2 nsuAdministradora Num Número Sequencial único da administradora
9 2 nrAutorizacao Alfa Código de autorização da transação
10 2 redeAdquirente Num Código da rede adquirente – vide tabela I – Adquirentes
11 2 data Data Data da transação de venda
12 2 nrCartao Alfa Número do cartão com algarismos suprimidos
13 2 loja Alfa Nome da loja no Conciliador
14 2 codigoLoja Num Código da loja no Conciliador
15 2 formaCaptura Alfa Identificador do tipo de captura, T=TEF, P=POS, obedece a tabela II
16 2 codigoEstabelecimento Num Código da estabelecimento do lojista na operadora de cartão
17 2 chaveVenda Num Chave única para o registro no Conciliador
18 2 valor Num Valor total da venda
19 2 nrParcelas Num Quantidade de parcelas
20 2 bandeira Num Código da bandeira do produto, vide tabela III – Bandeiras
21 2 codigoProduto Num Código do produto
22 2 produto Alfa Descritivo do produto
23 2 modalidade Num Código da modalidade de pagamento, Conforme tabela V
24 2 banco Num Número do Banco
25 2 agencia Num Número da agência bancária
26 2 conta Alfa Conta corrente
27 2 parcelas Objeto Objeto para dados de cada uma das parcelas
28 3 dataCredito Data Data prevista do crédito (pagto ao lojista)
29 3 status Num Situação da parcela, vide tabela IV – Status de parcelas
30 3 Número Num Número sequencial da parcela
31 3 dataPagamento Data Data efetiva de pagamento
32 3 valorTaxaAdministracao Num Valor calculado referente a taxa de administração
33 3 percTaxaAdministracao Num Percentual da taxa de administração
34 3 valorTaxaAntecipacao Num Valor calculado referente a taxa de antecipação
35 3 percTaxaAntecipacao Num Percentual da taxa de antecipação
36 3 percTaxaAntecipacaoNominal Num Percentual nominal da taxa de antecipação
37 3 valorAjuste Num Valor de ajuste
38 3 valorPago Num Valor efetivamente pago ao lojista
39 3 valor Num Valor da parcela
40 3 chaveParcela Num Campo que identifica unicamente uma parcela para o Conciliador

Retorno da Consulta Recebimento

Retorno da Consulta Recebimento

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado da consulta
2 1 codigoRetorno Alfa Código de retorno MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem de retorno por extenso
4 1 codigoRequisicao Num Número da requisição gerada pelo conciliador
5 1 nrPaginaAtual Num Número da página retornada
6 1 nrTotalPagina Num Quantidade total de páginas da consulta solicitada.
7 1 Recebimento Objeto Agrupa as vendas e os detalhes do recebimento
8 2 data_venda Date Data da Venda yyyy-mm-dd
9 2 datacredito Data Data prevista para pagamento yyyy-mm-dd
10 2 status Num Status da parcela consulta a Tabela IV – Status de parcelas
11 2 Parcela Num Numero da parcela
12 2 DataPagamento Date Data do pagamento efetuada pela adminstradora
13 2 data_cancelamento Date Data do cancelamento yyyy-mm-dd esse campo so vira com valor caso a venda tenha acontecido um cancelamento
14 2 valorTaxaAdministracao Num Valor da taxa de adminstração
15 2 percTaxaAdministracao Num Valor em porcentagem da taxa de administração
16 2 valorAjuste Num Valor descontado pela adminstradora por algum serviço
17 3 valorTaxaAntecipacao Num Valor calculado referente a taxa de antecipação
18 3 percTaxaAntecipacao Num Percentual da taxa de antecipação
19 3 percTaxaAntecipacaoNominal Num Percentual nominal da taxa de antecipação
20 3 valorAjuste Num Valor de ajuste
21 3 valorPago Num Valor efetivamente pago ao lojista
22 3 valor Num Valor da parcela
23 3 chaveParcela Num Campo que identifica unicamente uma parcela para o Conciliador
24 1 loja_cnpj String CNPJ da loja
25 1 codTefLoja Num Código do TEF da loja
26 2 codigoLoja Num Código da loja no Conciliador
27 2 nsu Num Número Sequencial único da administradora
28 2 autorizacao Alfa Código de autorização da transação
29 3 chaveParcela Num Campo que identifica unicamente uma parcela para o Conciliador

Retorno da Consulta Chargeback

Retorno da Consulta Chargeback

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado da consulta
2 1 codigoRetorno Alfa Código de retorno MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem de retorno por extenso
4 1 codigoRequisicao Num Número da requisição gerada pelo conciliador
5 1 nrPaginaAtual Num Número da página retornada
6 1 nrTotalPagina Num Quantidade total de páginas da consulta solicitada.
7 1 vendascCback Objeto Agrupa os dados de uma transação de chargeback
8 2 nsuAdministradora Num Número Sequencial único da administradora
9 2 nrAutorizacao Alfa Código de autorização da transação
10 2 redeAdquirente Num Código da rede adquirente – vide tabela I – Adquirentes
11 2 dataVenda Data Data da transação de venda
12 2 dataChargeback Data Data do chargeback
13 2 dataLimiteEnvio Data Data limite para a contestação
14 2 nrCartao Alfa Número do cartão com algarismos suprimidos
15 2 codigoLoja Num Código da loja no Conciliador
16 2 loja Alfa Nome da loja no Conciliador
17 2 cnpjLoja Num CNPJ da loja
18 2 terminal Alfa Número da maquineta que realizou a compra
19 2 valor Num Valor total do chargeback
20 2 nrParcelas Num Quantidade de parcelas
21 2 bandeira Num Código da bandeira do produto, vide tabela II – Bandeiras
22 2 codigoProduto Num Código do produto, vide tabela VI – Produtos
23 2 produto Alfa Descritivo do produto
24 2 modalidade Num Código da modalidade de pagamento, vide tabela V
25 2 TID Alfa Código único gerado para compras e-commerce

Retorno da Consulta Cancelamento

Retorno da Consulta Cancelamento

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 retorno Objeto Agrupa os dados retornados com o resultado da consulta
2 1 codigoRetorno Alfa Código de retorno MSG_001 = Sucesso, demais códigos vide tabela VI
3 1 detalheRetorno Alfa Mensagem de retorno por extenso
4 1 codigoRequisicao Num Número da requisição gerada pelo conciliador
5 1 nrPaginaAtual Num Número da página retornada
6 1 nrTotalPagina Num Quantidade total de páginas da consulta solicitada.
7 1 vendascCback Objeto Agrupa os dados de uma transação de chargeback
8 2 nsuAdministradora Num Número Sequencial único da administradora
9 2 nrAutorizacao Alfa Código de autorização da transação
10 2 redeAdquirente Num Código da rede adquirente – vide tabela I – Adquirentes
11 2 dataVenda Data Data da transação de venda
12 2 dataChargeback Data Data do chargeback
13 2 dataLimiteEnvio Data Data limite para a contestação
14 2 nrCartao Alfa Número do cartão com algarismos suprimidos
15 2 codigoLoja Num Código da loja no Conciliador
16 2 loja Alfa Nome da loja no Conciliador
17 2 cnpjLoja Num CNPJ da loja
18 2 terminal Alfa Número da maquineta que realizou a compra
19 2 valor Num Valor total do chargeback
20 2 nrParcelas Num Quantidade de parcelas
21 2 bandeira Num Código da bandeira do produto, vide tabela II – Bandeiras
22 2 codigoProduto Num Código do produto, vide tabela VI – Produtos
23 2 produto Alfa Descritivo do produto
24 2 modalidade Num Código da modalidade de pagamento, vide tabela V
25 2 tipoCancelamento Alfa Categoria do cancelamento
26 2 TID Alfa Código único gerado para compras e-commerce
27 2 parcelas Objeto Agrupa os dados das parcelas do cancelamento
28 3 dataCredito Data Data prevista para o crédito
29 3 status Num Status da parcela
30 3 numero Num Número da parcela
32 3 dataCancelamento Data Data do cancelamento
33 3 valorLiqOriginal Num Valor líquido original da parcela
34 3 valorBrutoOriginal Num Valor bruto original da parcela
35 3 dataUltCancParcial Data Data do último cancelamento parcial
36 3 valorCancelamento Num Valor do cancelamento
37 3 valorTaxaAdministracao Num Valor da taxa de administração
38 3 percTaxaAdministracao Num Taxa percentual de administração
39 3 valorTaxaAntecipacao Num Valor da taxa de antecipação
40 3 percTaxaAntecipacao Num Taxa percentual de antecipação
41 3 percTaxaAntecipacaoNominal Num Taxa percentual de antecipação mensal
42 3 valorAjuste Num Valor de ajuste da administradora
43 3 valorPago Num Valor pago na parcela depois da taxa
44 3 valor Num Valor da parcela
45 3 chaveParcela Num Chave única da parcela

Venda

Venda

Seq Nível Nome da TAG Tipo Dado Descrição
1 0 venda Objeto Agrupa todos parâmetros de pesquisa
2 1 nsuOrigem Alfa Código unico definido pelo próprio cliente quando do envio da informação ao conciliador
3 1 data Data Data da transação de venda
4 1 valor Num Valor total da venda