Referência da API Conciliadora

Este website documenta a API pública Conciliadora

É através desta documentação que demonstramos como realizar a troca de informações com a nossa plataforma.

Você pode ver exemplos de código na área escura à direita; mude a linguagem de programação dos exemplos com as guias no canto superior direito.

Se algo estiver faltando ou parecer incorreto, entre em contato conosco.

A API utiliza a tecnologia REST e OData.

Para a utilização e consumo dos endpoints da API da Conciliadora é permitido 1 request por segundo.

Consultas

As consultas são feitas através de uma requisição GET e seus retornos tem os formatos de resposta em JSON e XML.

Para maiores informações de como especificar o tipo de retorno consulte Formatos.

Autenticação

curl "URL"
  -H "Authorization: SUA_API_KEY"

var client = new HttpClient()
client.BaseAddress = new Uri("URL");
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("SUA_API_KEY");

    $url = 'URL';
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: SUA_API_KEY'));

api_url_base = 'URL'
headers = {'Authorization': 'SUA_API_KEY'}
response = requests.get(api_url_base, headers=headers)

A API de Consulta da Conciliadora é baseada em JSON. Para fazer uma chamada autenticada para a API, você deve incluir sua API Key que deve ser incluida através do cabeçalho (header) conforme exemplo: Authorization: SUA_API_KEY

Formato

curl "URL"
  -H "Authorization: SUA_API_KEY"
  -H "Accept: application/xml"

var client = new HttpClient()
client.BaseAddress = new Uri("URL");
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("SUA_API_KEY");
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/xml"));

    $url = 'URL';
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: SUA_API_KEY',
                                               'Accept: application/xml'));

api_url_base = 'URL'
headers = {'Content-Type': 'application/xml',
           'Authorization': 'SUA_API_KEY'}
response = requests.get(api_url_base, headers=headers)

A API de Consulta da Conciliadora permite interagir através de JSON e XML, sendo JSON o formato padrão de resposta.

Para obter o retorno no formato XML deve-se informar o parâmetro para o aceite do formato conforme demonstrado abaixo:

Accept: application/xml

Paginação

A API de Consulta da Conciliadora permite o controle da paginação através dos parâmetros Count, Top e Skip.

curl 'https://api.conciliadora.com.br/api/NomeDaChamada?$count=true&$top=10&$skip=10' 
	-H 'Authorization: SUA_API_KEY'

Opções de consulta

Obtendo todos os dados
curl "https://api.conciliadora.com.br/api/NomeDaChamada"
  -H "Authorization: SUA_API_KEY"

Obtendo um dado apenas
curl "https://api.conciliadora.com.br/api/NomeDaChamada(ID)"
  -H "Authorization: SUA_API_KEY"

Filtrando consultas
curl "https://api.conciliadora.com.br/api/NomeDaChamada?$filter=Campo eq 'NomeASerFiltrado'"
  -H "Authorization: SUA_API_KEY"

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

namespace API
{
    class Program
    {
        private static void Main(string[]args)
        {
            var retornaTodosOsDados = MainAsync("NomeDaChamada", "");
            //var retornaUmDadoApenas = MainAsync("NomeDaChamada", "(ID)");
            //var retornaDadosFiltrados = MainAsync("NomeDaChamada","?$filter=Campo eq 'NomeDoFiltro'");
            Console.ReadKey();
        }
        public static async Task MainAsync(string chamada, string parametro)
        {
            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri("https://api.conciliadora.com.br/");
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Authorization = 
                                new AuthenticationHeaderValue("SUA_API_KEY");


                HttpResponseMessage response = await client.GetAsync("api/" + chamada + parametro);
                if (response.IsSuccessStatusCode)
                {
                    var prod = await response.Content.ReadAsStringAsync();
                    Console.WriteLine(prod.ToString());
                }
            }
        }
    }
}

    $urlTodosOsDados = 'https://api.conciliadora.com.br/api/NomeDaChamada';
    //$urlUmDadoApenas = 'https://api.conciliadora.com.br/api/NomeDaChama(1)';
    //$urlOrdenando = 'https://api.conciliadora.com.br/api/NomeDaChamada?$orderby=Campo';
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Authorization: SUA_API_KEY'));
    curl_setopt($ch, CURLOPT_TIMEOUT, 5);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $data = curl_exec($ch);
    curl_close($ch);
    echo $data;

import json
import requests

api_url_base = 'https://api.conciliadora.com.br/api/NomeDaChamada'

headers = {'Content-Type': 'application/json',
           'Authorization': 'SUA_API_KEY'}

response = requests.get(api_url_base, headers=headers)

if response.ok:
  resp = json.loads(response.content.decode('utf-8'))

  for key in resp:
    print(resp[key])
else:
  response.raise_for_status()

As opções de consulta da API são parâmetros de sequência que controlam a quantidade e a ordem dos dados retornados. Os nomes de todas as opções de consulta da API utilizam um prefixo defino pelo caracter cifrão ($).

As opções de consulta permitem as seguintes operações $filter , $count , $orderby , $skip e $top e que podem ser utilizadas com os operadores listados abaixo:

Adquirente

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#Adquirentes",
    "value": [
        {
            "Codigo": 1,
            "Nome": "Cielo"
        },
        {
            "Codigo": 2,
            "Nome": "Rede"
        }
    ]
}

<XML>
<ArrayOfAdquirente xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
    <Adquirente>
        <Codigo>1</Codigo>
        <Nome>Cielo</Nome>
    </Adquirente>
    <Adquirente>
        <Codigo>2</Codigo>
        <Nome>Rede</Nome>
    </Adquirente>
</ArrayOfAdquirente>

Retorna uma lista de Adquirentes e seus respectivos identificadores.

GET https://api.conciliadora.com.br/api/Adquirentes

Resposta

Cancelamento de Vendas

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#CancelamentoVenda",
    "value":[
        {
            "Id": 25765727,
            "RefoId": 4,
            "Empresa": "EMP TESTE",
            "AdqId": 1,
            "Adquirente": "Cielo",
            "DataVenda": "2016-01-06",
            "DataPagto": "2016-02-10",
            "DataCancelamento": "2016-01-06",
            "CodigoProduto": 4,
            "Produto": "MASTER CREDITO",
            "Autorizacao": "042675",
            "Nsu": "984514",
            "Tid": "10250498260000F05C2A",
            "Terminal": "11170152",
            "ResumoVenda": "160106",
            "ValorBruto": -64.5,
            "Taxa": 2.3,
            "OutrasDespesas": null,
            "ValorLiquido": -63.02,
            "Estabelecimento": "1025049826",
            "Cartao": "0000000000000000000",
            "NumParcela": 0,
            "TotalParcelas": 0,
            "Banco": 1,
            "Agencia": "3608",
            "Conta": "480258",
            "Motivo": "CANCELAMENTO DE VENDAS"
        }
    ]
}

<XML>
<ArrayOfVenda xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.CancelamentoVenda">
    <Venda>
        <AdqId>1</AdqId>
        <Adquirente>Cielo</Adquirente>
        <Agencia>3608</Agencia>
        <Autorizacao>042675</Autorizacao>
        <Banco>1</Banco>
        <Cartao>0000000000000000000</Cartao>
        <CodigoProduto>4</CodigoProduto>
        <Conta>480258</Conta>
        <DataCancelamento>2016-01-06T00:00:00</DataCancelamento>
        <DataPagto>2016-02-10T00:00:00</DataPagto>
        <DataVenda>2016-01-06T00:00:00</DataVenda>
        <Empresa>EMP TESTE</Empresa>
        <Estabelecimento>1025049826</Estabelecimento>
        <Id>25765727</Id>
        <Motivo>CANCELAMENTO DE VENDAS</Motivo>
        <Nsu>984514</Nsu>
        <NumParcela>0</NumParcela>
        <OutrasDespesas i:nil="true" />
        <Produto>MASTER CREDITO</Produto>
        <RefoId>4</RefoId>
        <ResumoVenda>160106</ResumoVenda>
        <Taxa>2.30</Taxa>
        <Terminal>11170152</Terminal>
        <Tid>10250498260000F05C2A</Tid>
        <TotalParcelas>0</TotalParcelas>
        <ValorBruto>-64.50</ValorBruto>
        <ValorLiquido>-63.020000</ValorLiquido>
    </Venda>
</ArrayOfVenda>

Esta chamada retorna as informações detalhadas de todas as transações de cancelamentos de vendas informadas pelas operadoras.

GET https://api.conciliadora.com.br/api/CancelamentoVenda

Resposta

Conciliação Sistema

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#ConsultaConciliacaoSistema",
    "value": [
        {
            "Id": 33977011,
			"RefoId": 64,
			"Empresa": "CL TEF ZAP GRAF ",
			"Cnpj": "33537741000165",
			"CodigoSistemaCliente": null,
			"SistemaCliente": null,
			"Lote": null,
			"AdqId": 1,
			"Adquirente": "Cielo",
			"CodigoProduto": 5,
			"Produto": "MAESTRO",
			"ProdutoCliente": "MAESTRO",
			"DataVenda": "2016-01-23",
			"DataPrevistaPagto": "2016-01-25",
			"Autorizacao": "451673",
			"Nsu": "451673",
			"Tid": "451673",
			"Terminal": null,
			"ValorBruto": 20,
			"Taxa": 1.75,
			"ValorLiquido": 19.65,
			"NroParcela": 0,
			"TotalParcelas": 0,
			"IdPagamento": "4139BC16-45DF-4030-97E4-726D7C4ED613",
			"CodigoMeioCaptura": 3,
			"MeioCaptura": "E-COMMERCE",
			"Status": 0,
			"Divergencia": "-",
			"DataPagto": "2016-01-25",
			"ValorPago": 19.65,
			"Antecipado": false
        }
    ]
}

<XML>
<ArrayOfVenda xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.ConsultaConciliacaoSistema">
    <Venda>
        <AdqId>1</AdqId>
		<Adquirente>Cielo</Adquirente>
		<Antecipado>false</Antecipado>
		<Autorizacao>461373</Autorizacao>
		<Cnpj>12345678000900</Cnpj>
		<CodigoMeioCaptura>3</CodigoMeioCaptura>
		<CodigoProduto>5</CodigoProduto>
		<CodigoSistemaClientei:nil="true"/>
		<DataPagto>2016-01-25T00:00:00</DataPagto>
		<DataPrevistaPagto>2016-01-25T00:00:00</DataPrevistaPagto>
		<DataVenda>2016-01-23T00:00:00</DataVenda>
		<Divergencia>-</Divergencia>
		<Empresa>EMP TESTE</Empresa>
		<Id>33977009</Id>
		<IdPagamento>4139BC16-45DF-4030-97E4-726D7C4ED613</IdPagamento>
		<Lotei:nil="true"/>
		<MeioCaptura>E-COMMERCE</MeioCaptura>
		<NroParcela>0</NroParcela>
		<Nsu>461373</Nsu>
		<Produto>MAESTRO</Produto>
		<ProdutoCliente>MAESTRO</ProdutoCliente>
		<RefoId>64</RefoId>
		<SistemaClientei:nil="true"/>
		<Status>0</Status>
		<Taxa>1.75</Taxa>
		<Terminali:nil="true"/>
		<Tid>461373</Tid>
		<TotalParcelas>0</TotalParcelas>
		<ValorBruto>6.00</ValorBruto>
		<ValorLiquido>5.900000</ValorLiquido>
		<ValorPago>5.890000</ValorPago>
    </Venda>
<ArrayOfVenda>

Esta chamada retorna as informações detalhadas referente as conciliações de vendas realizadas entre as vendas envidas pelo sistema do cliente com as vendas informadas pela operadora.

GET https://api.conciliadora.com.br/api/ConsultaConciliacaoSistema

Resposta

Pagamentos

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#ConsultaPagamento",
    "value":[
        {
            "Id": 25563523,
            "IdPagamento": null,
            "RefoId": 4,
            "Empresa": "EMP TESTE",
            "Estabelecimento": "9918035734",
            "Cnpj": "12345601000105",
            "DataPagamento": "2016-01-04",
            "DataPrevistaPagamento": null,
            "DataVenda": "2015-12-01",
            "AdqId": 3,
            "Adquirente": "Amex",
            "Autorizacao": "275672",
            "Nsu": "959876",
            "Tid": "2719175",
            "Parcela": 0,
            "TotalParcelas": 0,
            "CodigoProduto": 197,
            "Produto": "AMEX CREDITO A VISTA",
            "ResumoVenda": "120121",
            "ValorBruto": 45,
            "Taxa": 3.9,
            "OutrasDespesas": null,
            "ValorLiquido": 43.24,
            "IdtAntecipacao": false,
            "Banco": 237,
            "Agencia": "462",
            "Conta": "1170473",
            "NomeLoja": "LojaTeste123",
            "Terminal": "9918035734",
            "IdTipoTransacao": 1,
            "TipoTransacao": "Pagamento",
            "IdStatus": null,
            "Status": null,
            "Divergencias": null,
            "ValorLiquidoVenda": null,
            "Observacao": "",
            "MotivoAjuste": null,
            "ContaAdquirente": null,
            "TaxaAntecipacao": null,
            "TaxaAntecipacaoMensal": null,
            "ValorTaxaAntecipacao": null,
            "ValorTaxa": 1.75,
            "ContaAdquirente": true,
            "IdModalidade" 1,
            "Modalidade": "Crédito a Vista",
            "TemConciliacaoBancaria": false,
            "Cartao": "123456******7890"
        }
    ]
}

<XML>
<ArrayOfPagamento xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.ConsultaPagamento">
    <Pagamento>
        <AdqId>3</AdqId>
        <Adquirente>Amex</Adquirente>
        <Agencia>462</Agencia>
        <Autorizacao>275672</Autorizacao>
        <Banco>237</Banco>
        <Cnpj>12345601000105</Cnpj>
        <CodigoProduto>197</CodigoProduto>
        <Conta>1170473</Conta>
        <DataPagamento>2016-01-04T00:00:00</DataPagamento>
        <DataPrevistaPagamento i:nil="true" />
        <DataVenda>2015-12-01T00:00:00</DataVenda>
        <Divergencias i:nil="true" />
        <Empresa>EMP TESTE</Empresa>
        <Estabelecimento>9918035734</Estabelecimento>
        <Id>25563523</Id>
        <IdPagamento i:nil="true" />
        <IdStatus i:nil="true" />
        <IdTipoTransacao>1</IdTipoTransacao>
        <IdtAntecipacao>false</IdtAntecipacao>
        <MotivoAjuste i:nil="true" />
        <Nsu>959876</Nsu>
        <Observacao></Observacao>
        <OutrasDespesas i:nil="true" />
        <Parcela>0</Parcela>
        <Produto>AMEX CREDITO A VISTA</Produto>
        <RefoId>4</RefoId>
        <ResumoVenda>120121</ResumoVenda>
        <Status i:nil="true" />
        <Taxa>3.90</Taxa>
        <NomeLoja>LojaTeste123</NomeLoja>
        <Terminal>9918035734</Terminal>
        <Tid>2719175</Tid>
        <TipoTransacao>Pagamento</TipoTransacao>
        <TotalParcelas>0</TotalParcelas>
        <ValorBruto>45.00</ValorBruto>
        <ValorLiquido>43.240000</ValorLiquido>
        <ValorLiquidoVenda i:nil="true" />
        <ContaAdquirente i:nil="true" />
        <TaxaAntecipacao i:nil="true" />
        <TaxaAntecipacaoMensal i:nil="true" />
        <ValorTaxaAntecipacao i:nil="true" />
        <ValorTaxa>1.75</ValorTaxa>
        <ContaAdquirente>true</ContaAdquirente>
        <IdModalidade>1</IdModalidade>
        <Modalidade>Crédito a Vista</Modalidade>
        <TemConciliacaoBancaria>True</TemConciliacaoBancaria>
        <Cartao>123456******7890</Cartao>
    </Pagamento>
</ArrayOfPagamento>

Esta chamada retorna as informações detalhadas de todas as transações de pagamentos informadas pelas operadoras. Inclui também informações de Saque realizados em Wallet (Carteira digital).

Para retornar apenas as informações de pagamentos, deve-se usar o filtro passando o campo ContaAdquirente igual (eq) a true.

GET https://api.conciliadora.com.br/api/ConsultaPagamento

Resposta

Previsão de Pagamentos

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#ConsultaPrevisaoPagamento",
    "value": [
        {
            "Id": 352751719,
            "RefoId": 4,
            "Empresa": "EMP TESTE",
            "Estabelecimento": "1095541517",
            "Cnpj": "12345601000105",
            "AdqId": 1,
            "Adquirente": "Cielo",
            "CodigoProduto": 66,
            "Produto": "HIPERCARD CREDITO A VISTA",
            "DataVenda": "2018-07-22",
            "DataPagto": "2018-08-21",
            "DataCancelamento": null,
            "Autorizacao": "071184",
            "Nsu": "539024",
            "Tid": "10955415177ENPVGUICB",
            "ValorBruto": 50.95,
            "Taxa": 2.8,
            "ValorLiquido": 49.52,
            "ValorTaxa": 1.43,
            "OutrasDespesas": null,
            "ValorAReceber": 49.52,
            "DomicilioBancario": "001 / 3392 / 1480251",
            "Terminal": "10032342",
            "HoraTransacao": "11:28:55",
            "NomeTurno": null,
            "Obs": null,
            "NumCartao": "   606282******2678",
            "MotivoAjuste": null,
            "NomeLoja": null,
            "Parcela": 0,
            "TotalParcelas": 0
        }
    ]
}

<XML>
<ArrayOfPrevisaoPagamento xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.ConsultaPrevisaoPagamento">
    <PrevisaoPagamento>
        <AdqId>1</AdqId>
        <Adquirente>Cielo</Adquirente>
        <Autorizacao>071184</Autorizacao>
        <Cnpj>01234567000105</Cnpj>
        <CodigoProduto>66</CodigoProduto>
        <DataCancelamento i:nil="true" />
        <DataPagto>2018-08-21T00:00:00</DataPagto>
        <DataVenda>2018-07-22T00:00:00</DataVenda>
        <DomicilioBancario>001 / 3392 / 1480251</DomicilioBancario>
        <Empresa>EMP TESTE</Empresa>
        <Estabelecimento>1095541517</Estabelecimento>
        <HoraTransacao>11:28:55</HoraTransacao>
        <Id>352751719</Id>
        <MotivoAjuste i:nil="true" />
        <NomeLoja i:nil="true" />
        <NomeTurno i:nil="true" />
        <Nsu>539024</Nsu>
        <NumCartao>   606282******2678</NumCartao>
        <Obs i:nil="true" />
        <OutrasDespesas i:nil="true" />
        <Parcela>0</Parcela>
        <Produto>HIPERCARD CREDITO A VISTA</Produto>
        <RefoId>4</RefoId>
        <Taxa>2.80</Taxa>
        <Terminal>10032342</Terminal>
        <Tid>10955415177ENPVGUICB</Tid>
        <TotalParcelas>0</TotalParcelas>
        <ValorAReceber>49.520000</ValorAReceber>
        <ValorBruto>50.95</ValorBruto>
        <ValorLiquido>49.520000</ValorLiquido>
        <ValorTaxa>1.430000</ValorTaxa>
    </PrevisaoPagamento>

Esta chamada retorna as informações detalhadas de previsão de pagamentos, ou seja, tudo que você tem previsto para receber em determinada data.

GET https://api.conciliadora.com.br/api/ConsultaPrevisaoPagamento

Resposta

Status Processamento

"JSON"
{
	"@odata.context" : "https://api.conciliadora.com.br/api/$metadata#ConsultaStatusProcessamento",
	"value": [
		{
			"IdEmpresa": 10757,
            "DataInicio": "2022-05-02T00:00:00-03:00",
            "DataFim": "2022-05-05T00:00:00-03:00",
            "TipoArquivo": "Adquirente",
            "Status": "Todos",
            "Processos": {
                "ArquivoCliente": {
                    "Status": [
                        {
                            "Concluido": {
                                "Quantidade": 0
                            },
                            "Processando": {
                                "Quantidade": 0
                            },
                            "Pendente": {
                                "Quantidade": 0
                            },
                            "Erro": {
                                "Quantidade": 0
                            }
                        }
                    ]
                },
                "ArquivoAdquirente": {
                    "Status": [
                        {
                            "Concluido": {
                                "Quantidade": 6
                            },
                            "Processando": {
                                "Quantidade": 0
                            },
                            "Pendente": {
                                "Quantidade": 1
                            },
                            "Erro": {
                                "Quantidade": 1
                            }
                        }
                    ]
                },
                "ConciliacaoAdquirente": {
                    "Status": [
                        {
                            "Concluido": {
                                "Quantidade": 0
                            },
                            "Processando": {
                                "Quantidade": 0
                            },
                            "Pendente": {
                                "Quantidade": 0
                            },
                            "Erro": {
                                "Quantidade": 0
                            }
                        }
                    ]
                },
                "ConciliacaoCliente": {
                    "Status": [
                        {
                            "Concluido": {
                                "Quantidade": 0
                            },
                            "Processando": {
                                "Quantidade": 0
                            },
                            "Pendente": {
                                "Quantidade": 0
                            },
                            "Erro": {
                                "Quantidade": 0
                            }
                        }
                    ]
                }
            }
		}
	]
}

Retorna uma lista de Status referente ao processamento das informações e acordo com seu tipo.

GET https://api.conciliadora.com.br/api/ConsultaStatusProcessamento

Parâmetros

Resposta

Tabelas

Tabela I (Tipo Arquivo)

Tabela II (Processos)

Tabela III (Tipos de Processos)

Tabela IV (Status do Processo)

Tabela V (Status)

Tabela VI

Vendas

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#ConsultaVenda",
    "value": [
        {
            "Id": 24769841,
            "RefoId": 4,
            "Empresa": "EMP TESTE",
            "Estabelecimento": "1025049826",
            "Cnpj": "12345601000105",
            "AdqId": 1,
            "Adquirente": "Cielo",
            "CodigoProduto": 1,
            "Produto": "VISA CREDITO A VISTA",
            "CodigoModalidade": 1,
            "Modalidade": "Crédito a Vista",
            "DataVenda": "2016-01-01",
            "DataPrevistaPagto": "2016-02-01",
            "ResumoVenda": "160101",
            "Autorizacao": "913443",
            "Nsu": "982268",
            "Tid": "10250498260000EFCFCA",
            "NomeLoja": "LojaTeste",
            "Cartao": "0000000000000000000",
            "ValorBruto": 34,
            "PercentualTaxa": 2.3,
            "ValorTaxa": 0.78,
            "OutrasDespesas": null,
            "ValorLiquido": 33.22,
            "Terminal": "11170152",
            "Banco": 1,
            "Agencia": "3608",
            "Conta": "480258",
            "HoraTransacao": "08:03:34",
            "Parcela": 0,
            "TotalParcelas": 0,
            "Observacao": null,
            "Status": 1,
            "Rejeitado": false,
            "Cancelado": false,
            "Pago": true,
            "Cancelamento": null,
            "DataPagamento": "2016-02-01",
            "ValorPago": 33.22,
            "IdPagamento": null,
            "Pedido": null
        }
    ]
}

<XML>
<ArrayOfVenda xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.ConsultaVenda">
    <Venda>
        <AdqId>1</AdqId>
        <Adquirente>Cielo</Adquirente>
        <Agencia>3608</Agencia>
        <Autorizacao>913443</Autorizacao>
        <Banco>1</Banco>
        <Cancelado>false</Cancelado>
        <Cancelamento i:nil="true" />
        <Cartao>0000000000000000000</Cartao>
        <Cnpj>10588201000105</Cnpj>
        <CodigoModalidade>1</CodigoModalidade>
        <CodigoProduto>1</CodigoProduto>
        <Conta>480258</Conta>
        <DataPagamento>2016-02-01T00:00:00</DataPagamento>
        <DataPrevistaPagto>2016-02-01T00:00:00</DataPrevistaPagto>
        <DataVenda>2016-01-01T00:00:00</DataVenda>
        <Empresa>EMP TESTE</Empresa>
        <Estabelecimento>1025049826</Estabelecimento>
        <HoraTransacao>08:03:34</HoraTransacao>
        <Id>24769841</Id>
        <NomeLoja>LojaTeste</NomeLoja>
        <Modalidade>Crédito a Vista</Modalidade>
        <Nsu>982268</Nsu>
        <Observacao i:nil="true" />
        <OutrasDespesas i:nil="true" />
        <Pago>true</Pago>
        <Parcela>0</Parcela>
        <Pedido i:nil="true" />
        <PercentualTaxa>2.30</PercentualTaxa>
        <Produto>VISA CREDITO A VISTA</Produto>
        <RefoId>4</RefoId>
        <Rejeitado>false</Rejeitado>
        <ResumoVenda>160101</ResumoVenda>
        <Status>1</Status>
        <Terminal>11170152</Terminal>
        <Tid>10250498260000EFCFCA</Tid>
        <TotalParcelas>0</TotalParcelas>
        <ValorBruto>34.00</ValorBruto>
        <ValorLiquido>33.220000</ValorLiquido>
        <ValorPago>33.220000</ValorPago>
        <ValorTaxa>0.780000</ValorTaxa>
        <IdPagamento i:nil="true" />
    </Venda>
<ArrayOfVenda>

Esta chamada retorna as informações detalhadas de todas as transações de vendas informadas pelas operadoras.

GET https://api.conciliadora.com.br/api/ConsultaVenda

Resposta

Vendas Conciliadas

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#ConsultaVendasConciliadas",
    "value": [
        {
            "Id": 135331195,
            "IdPagamento": "446274",
            "RefoId": 3799,
            "Empresa": "EMP TESTE",
            "Estabelecimento": "000000000026337",
            "Cnpj": "12345601000105",
            "AdqId": 10,
            "Adquirente": "GoodCard",
            "CodigoProduto": 323,
            "Produto": "GOODCARD CREDITO",
            "CodigoModalidade": 1,
            "Modalidade": "Crédito a Vista",
            "DataVenda": "2018-10-13",
            "DataPrevistaPagto": "2018-12-08",
            "ResumoVenda": null,
            "Autorizacao": "-",
            "Nsu": "561443087",
            "Tid": null,
            "Cartao": "0006035740358546870",
            "ValorBruto": 230.01,
            "PercentualTaxa": 3.5,
            "ValorTaxa": 8.05,
            "OutrasDespesas": null,
            "ValorLiquido": 221.96,
            "Terminal": "Não Informado",
            "Banco": 0,
            "Agencia": null,
            "Conta": null,
            "HoraTransacao": "16:47:00",
            "Parcela": 0,
            "TotalParcelas": 0,
            "Observacao": null,
            "Status": 4,
            "Rejeitado": false,
            "Cancelado": false,
            "Pago": false,
            "Cancelamento": null,
            "DataPagamento": null,
            "DataEmissao": "2018-10-13",
            "ValorPago": null,
            "Pedido": null
        }
    ]
}

<XML>
<ArrayOfVendasConciliadas xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.ConsultaVendasConciliadas">
    <VendasConciliadas>
        <AdqId>10</AdqId>
        <Adquirente>GoodCard</Adquirente>
        <Agencia i:nil="true" />
        <Autorizacao>-</Autorizacao>
        <Banco>0</Banco>
        <Cancelado>false</Cancelado>
        <Cancelamento i:nil="true" />
        <Cartao>0006035740358546870</Cartao>
        <Cnpj>12345601000105</Cnpj>
        <CodigoModalidade>1</CodigoModalidade>
        <CodigoProduto>323</CodigoProduto>
        <Conta i:nil="true" />
        <DataEmissao>2018-10-13T00:00:00</DataEmissao>
        <DataPagamento i:nil="true" />
        <DataPrevistaPagto>2018-12-08T00:00:00</DataPrevistaPagto>
        <DataVenda>2018-10-13T00:00:00</DataVenda>
        <Empresa>EMP TESTE</Empresa>
        <Estabelecimento>000000000026337</Estabelecimento>
        <HoraTransacao>16:47:00</HoraTransacao>
        <Id>135331195</Id>
        <IdPagamento>446274</IdPagamento>
        <Modalidade>Crédito a Vista</Modalidade>
        <Nsu>561443087</Nsu>
        <Observacao i:nil="true" />
        <OutrasDespesas i:nil="true" />
        <Pago>false</Pago>
        <Parcela>0</Parcela>
        <Pedido i:nil="true" />
        <PercentualTaxa>3.50</PercentualTaxa>
        <Produto>GOODCARD CREDITO</Produto>
        <RefoId>3799</RefoId>
        <Rejeitado>false</Rejeitado>
        <ResumoVenda i:nil="true" />
        <Status>4</Status>
        <Terminal>Não Informado</Terminal>
        <Tid i:nil="true" />
        <TotalParcelas>0</TotalParcelas>
        <ValorBruto>230.01</ValorBruto>
        <ValorLiquido>221.960000</ValorLiquido>
        <ValorPago i:nil="true" />
        <ValorTaxa>8.050000</ValorTaxa>
    </VendasConciliadas>
</ArrayOfVendasConciliadas>

Esta chamada retorna as informações detalhadas de todas as transações de vendas informadas pelas operadoras que foram conciliadas com as Vendas informadas pelo sistema do cliente.

GET https://api.conciliadora.com.br/api/ConsultaVendasConciliadas

Resposta

Vendas não Enviadas

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#ConsultaVendaNaoEnviada",
    "value": [
        {
            "Id": 24769841,
            "RefoId": 4,
            "Empresa": "EMP TESTE",
            "Estabelecimento": "1025049826",
            "Cnpj": "12345601000105",
            "AdqId": 1,
            "Adquirente": "Cielo",
            "CodigoProduto": 1,
            "Produto": "VISA CREDITO A VISTA",
            "CodigoModalidade": 1,
            "Modalidade": "Crédito a Vista",
            "DataVenda": "2016-01-01",
            "DataPrevistaPagto": "2016-02-01",
            "ResumoVenda": "160101",
            "Autorizacao": "913443",
            "Nsu": "982268",
            "Tid": "10250498260000EFCFCA",
            "Cartao": "0000000000000000000",
            "ValorBruto": 34,
            "PercentualTaxa": 2.3,
            "ValorTaxa": 0.78,
            "OutrasDespesas": null,
            "ValorLiquido": 33.22,
            "Terminal": "11170152",
            "Banco": 1,
            "Agencia": "3608",
            "Conta": "480258",
            "HoraTransacao": "08:03:34",
            "Parcela": 0,
            "TotalParcelas": 0,
            "Observacao": null,
            "Status": 1,
            "Rejeitado": false,
            "Cancelado": false,
            "Pago": true,
            "Cancelamento": null,
            "DataPagamento": "2016-02-01",
            "ValorPago": 33.22,
            "Pedido": null
        }
    ]
}

<XML>
<ArrayOfVenda xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models.ConsultaVenda">
    <Venda>
        <Adquirente>Cielo</Adquirente>
        <Agencia>3608</Agencia>
        <Autorizacao>064688</Autorizacao>
        <Banco>1</Banco>
        <Cancelado i:nil="true" />
        <Cancelamento i:nil="true" />
        <Cartao>409600******4429000</Cartao>
        <Cnpj>33537741000165</Cnpj>
        <CodigoModalidade>0</CodigoModalidade>
        <CodigoProduto>2</CodigoProduto>
        <Conta>480258</Conta>
        <DataPagamento i:nil="true" />
        <DataPrevistaPagto>2016-01-05T00:00:00</DataPrevistaPagto>
        <DataVenda>2016-01-04T00:00:00</DataVenda>
        <Empresa>EMP TESTE</Empresa>
        <Estabelecimento>1023441710</Estabelecimento>
        <HoraTransacao>11:44:48</HoraTransacao>
        <Id>24804414</Id>
        <Modalidade>Débito</Modalidade>
        <Nsu>300025</Nsu>
        <Observacao i:nil="true" />
        <Pago i:nil="true" />
        <Parcela>0</Parcela>
        <Pedido i:nil="true" />
        <PercentualTaxa>1.75</PercentualTaxa>
        <Produto>VISA ELECTRON DEBITO A VISTA</Produto>
        <RefoId>64</RefoId>
        <Rejeitado>false</Rejeitado>
        <ResumoVenda>5160104</ResumoVenda>
        <Status i:nil="true" />
        <Terminal>01985775</Terminal>
        <Tid>                    </Tid>
        <TotalParcelas>0</TotalParcelas>
        <ValorBruto>86.50</ValorBruto>
        <ValorLiquido>84.990000</ValorLiquido>
        <ValorPago i:nil="true" />
        <ValorTaxa>1.510000</ValorTaxa>
    </Venda>
<ArrayOfVenda>

Esta chamada retorna as informações detalhadas referente as vendas que a Operadora informou e que não foram enviadas pelo sistema do cliente ou não foram conciliadas.

GET https://api.conciliadora.com.br/api/ConsultaVendaNaoEnviada

Resposta

Meio de Captura

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#MeiosCaptura",
    "value": [
        {
            "Codigo": 1,
            "Descricao": "POS"
        },
        {
            "Codigo": 2,
            "Descricao": "PDV"
        }
    ]
}

<XML>
<ArrayOfMeioCaptura xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
    <MeioCaptura>
        <Codigo>1</Codigo>
        <Descricao>POS</Descricao>
    </MeioCaptura>
    <MeioCaptura>
        <Codigo>2</Codigo>
        <Descricao>PDV</Descricao>
    </MeioCaptura>
</ArrayOfMeioCaptura>

Retorna uma lista de Meios de Captura e seus respectivos identificadores.

GET https://api.conciliadora.com.br/api/MeiosCaptura

Resposta

Modalidade

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#Modalidades",
    "value": [
        {
            "Codigo": 0,
            "Descricao": "Débito"
        },
        {
            "Codigo": 1,
            "Descricao": "Crédito a Vista"
        }
    ]
}

<XML>
<ArrayOfModalidade xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
    <Modalidade>
        <Codigo>0</Codigo>
        <Descricao>Débito</Descricao>
    </Modalidade>
    <Modalidade>
        <Codigo>1</Codigo>
        <Descricao>Crédito a Vista</Descricao>
    </Modalidade>
</ArrayOfModalidade>

Retorna uma lista de Modalidades e seus respectivos identificadores.

GET https://api.conciliadora.com.br/api/Modalidades

Resposta

Produtos

"JSON"
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#Produtos",
    "value": [
        {
            "Codigo": 1,
            "Nome": "VISA CREDITO A VISTA",
            "Modalidade": "Crédito"
        },
        {
            "Codigo": 2,
            "Nome": "VISA ELECTRON DEBITO A VISTA",
            "Modalidade": "Débito"
        }
    ]
}

<XML>
{
    "@odata.context": "https://api.conciliadora.com.br/api/$metadata#Produtos",
    "value": [
        {
            "Codigo": 1,
            "Nome": "VISA CREDITO A VISTA",
            "Modalidade": "Crédito"
        },
        {
            "Codigo": 2,
            "Nome": "VISA ELECTRON DEBITO A VISTA",
            "Modalidade": "Débito"
        }
    ]
}

Retorna uma lista de Produtos contendo os seus respectivos identificadores e modelidade.

GET https://api.conciliadora.com.br/api/Produtos

Resposta

Envios

Os envios são feitos através de uma requisição POST e seu retorno tem o formato de resposta em JSON.

Envio Venda Sistema

Nessa API é possivel fazer o envio de um arquivo contendo as informações de vendas registradas no sistema do cliente para a Conciliadora.

Esse arquivo deve estar no formato XML, sua codificação em UTF-8.

Parâmetros

curl --location --request POST 'https://api.conciliadora.com.br/api/EnvioVendaSistema' \
--form 'senha="123456"' \
--form 'idEmpresa="123"' \
--form 'file=@"/C:/SeuDiretorio/SeuArquivo.xml"'

var client = new RestClient("https://api.conciliadora.com.br/api/EnvioVendaSistema");
client.Timeout = -1;
var request = new RestRequest(Method.Post);
request.AddParameter("senha", "123456");
request.AddParameter("idEmpresa", "123");
request.AddFile("file", "/C:/SeuDiretorio/SeuArquivo.xml");
request.AddFile("", "/path/to/file");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.conciliadora.com.br/api/EnvioVendaSistema',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('senha' => '123456','idEmpresa' => '123','file'=> new CURLFILE('/C:/SeuDiretorio/SeuArquivo.xml'),''=> new CURLFILE('/path/to/file')),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://api.conciliadora.com.br/api/EnvioVendaSistema"

payload={'senha': '123456',
'idEmpresa': '123'}
files=[
  ('file',('SeuArquivo.xml',open('/C:/SeuDiretorio/SeuArquivo.xml','rb'),'text/xml')),
  ('',('file',open('/path/to/file','rb'),'application/octet-stream'))
]
headers = {}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Os parâmetros à serem enviados pelo corpo da requisição são:

Estrutura do Arquivo

O arquivo XML obrigatoriamente deve ser iniciado pela TAG registros e finalizado pela TAG /registros.

Cabeçalho

<registros>
  <cabecalho>
    <Empresa>00000</Empresa>
    <DataInicial>DD/MM/AAAA</DataInicial>
    <DataFinal>DD/MM/AAAA</DataFinal>
    <Versao>3</Versao>
    <Lote>00001</Lote>
    <NomeSistema>SoftHouse - XXXXXXX</NomeSistema>
  </cabecalho>
  <registro>
    <Produto>4</Produto>
    <DescricaoTipoProduto>Master Credito</DescricaoTipoProduto>
    <CodigoAutorizacao>012345</CodigoAutorizacao>
    <IdentificadorPagamento>A76BFC0D-0004-4197-A721</IdentificadorPagamento>
    <DataVenda>01/07/2021</DataVenda>
    <DataVencimento>02/08/2021</DataVencimento>
    <ValorVendaParcela>287.95</ValorVendaParcela>
    <ValorLiquidoParcela>281.33</ValorLiquidoParcela>
    <TotalVenda>287.95</TotalVenda>
    <Taxa>2.30</Taxa>
    <Parcela>00</Parcela>
    <TotalDeParcelas>00</TotalDeParcelas>
    <NSU>123456</NSU>
    <TID>1234567890</TID>
    <Terminal>123</Terminal>
    <MeioCaptura>3</MeioCaptura>
    <Operadora>1</Operadora>
    <Modalidade>1</Modalidade>
  </registro>
</registros>

A TAG cabeçalho obrigatoriamente deve estar dentro da TAG Registros, deve ser iniciado pela TAG cabecalho e finalizado pela TAG /cabecalho e conter as informações conforme tabela abaixo.

Detalhes sobre o Lote

A TAG Lote indica como as vendas são agrupadas para envio. Exemplos de formas de envio da TAG Lote:
Se as transações são enviadas por turno, o lote deve indicar o turno que foi realizado a transação mais um número sequencial único. Turno = 01, número sequencial único = 001 então o lote iria ficar como 01001. Se as transações são enviadas por caixa, o lote deve indicar o caixa que foi realizado a transação mais um número sequencial único. Caixa = 5, número sequencial único = 002 então o lote iria ficar como 5002. Se as transações são enviadas por turno e caixa, o lote deve indicar o turno e o caixa que foi realizado a transação mais um número sequencial único, conforme modelos abaixo:
Turno = 01, Caixa = 2, número sequencial único = 001 então o lote iria ficar como 012001
Turno = 01, Caixa = 2, número sequencial único = 002 então o lote iria ficar como 012002
Turno = 03, Caixa = 4, número sequencial único = 001 então o lote iria ficar como 034001
Turno = 02, Caixa = 3, número sequencial único = 001 então o lote iria ficar como 023001

Registro(s)

A TAG registro obrigatoriamente deve estar dentro da TAG Registros, ser iniciado pela TAG registro e finalizado pela TAG /registro e conter as informação referente a transação registrada pelo sistema do cliente conforme tabela abaixo. Para transações parceladas, deve-se enviar um registro para cada parcela.

Resposta

"Resposta com Sucesso"
{
    "Codigo": 0,
    "Mensagem": "Arquivo enviado com sucesso",
    "XMLErros": null
},

"Resposta com Erro"
{
    "Codigo": 2,
    "Mensagem": "Empresa '123' não cadastrada. Favor entrar em contato com a central de atendimento",
    "XMLErros": null
},

Abaixo forma de como será a resposta após o envio do arquivo:

Códigos de Status

Abaixo a listagem dos códigos possíveis na resposta:

Valores

Alguns campos possuem valores vádidos que são retornados.

Daqui em diante será demostrado os valores válidos dos campos.

Status Conciliação

Status Pagamentos

A API Conciliadora usa os seguintes status de pagamento:

Status Venda

A API Conciliadora usa os seguintes status de venda:

Moeda

Tipo Transação

Os tipos de transação podem ser os seguintes:

Errors

A API Conciliadora usa os seguintes códigos de erro: