Documentacao API

Conjunto de APIs para processo de integração de vendas de cartões com Valida Conciliador. A software house deve solicitar suas chaves de autenticação através do email: implantacao@validasolucoes.com.br .

Historicos de Modificações:

Requisições disponiveis para serviço de API:

A solicitações devem ser feitas via url, e terão como retorno dados no formato json.

Vendas (get_vendas);

VendaID (get_vendaId);

Pagamentos (get_recebimentos);

Ajustes (get_ajustes);

Redes (get_redes);

Bandeiras (get_bandeiras);

Bin (get_bin)

A url base da chamada sera formada por:

url_base + client_id + client_token + entidade + requisicao + variaveis diversas

url_base = http://cp.validasolucoes.com.br/api

client_id = Codigo de identificação da softwere house junto ao Valida Conciliador

client_token = Token secreto de autenticação da softwere house junto ao Valida Conciliador

entidade = CNPJ da empresa que a softwere house deseja consultar dados

requisição = Tipo de dados que a softwere house deseja consultar

Exemplos:

As requisições de Vendas, Recebimentos e Ajustes:

Sera acrescentado mais 2 variaveis obrigatorias: dtinicial e dtfinal, que será o periodo a ser consultado.

Exemplo da url estruturada:

http://cp.validasolucoes.com.br/Api?client_id=[client_id]&client_token=[client_token]&entidade=[entidade]&requisicao=[requisicao]&dtinicial=[dtinicial]&dtfinal=[dtfinal]

Todos os retornos terão os seguintes campos:

Status, Msg e Dados (Apenas se não houver erros na estrutura ou validações)

Obs: Sempre que o status retornar 100 a requisição foi feita com sucesso e caso de erro retornara 900.

Exemplos de erros:

{"status":"900","msg":"Erro na estrutura de Url"}

{"status":"901","msg":"Erro: client_token invalido ou inexistente!"}

{"status":"902","msg":"Erro: Empresa inativa ou inexistente!"}

{"status":"903","msg":"Erro: Empresa nao esta habilitada para a softwere house!"}

Exemplos de retornos:

Metodo POST

Incluir Vendas:

Url_Base:http://cp.validasolucoes.com.br/Api/incluirVendas?client_id=[client_id]&client_token=[client_token]&entidade=[entidade]

O envio dos dados dever ser feito via arquivo no formato json.

Campos Disponiveis:

• Nroloja - Numero da Loja no Sitef ou no ERP;
• DataVenda - Data da Venda;
• TimeVenda - Hora da Venda;
• NroCupom - Numero do Cupom;
• BinCartao - Bin do Cartao (6 Primeiros Digitos do Cartao);
• ValorVenda - Valor da Venda;
• Parcelas - Quantidade de Parcelas da Venda – Quando a venda for Parcelada Administradora o valor é 1;
• TpServico - 1 – Debito / 2 – Credito;
• IdFinanciamento - 1 – A vista / 2 – Parcelado Administradora / 3 – Parcelado Loja;
• NsuRede - Numero Sequencial Unico gerado pela operadora;
• NsuTef - Numero Sequencial Unico gerado pelo Sitef;
• Autorizacao - Autorizacao gerada pela administradora;
• CodRede - Codigo da Rede dentro do conciliador, com base no retorno da consulta realizada na API;
• CodEstab - Codigo de estabelecimento na adquirente/bandeira/rede;
• CodBandeira - Codigo da Bandeira dentro do conciliador, com base no retorno da consulta realizada na API;
• Origem - 1 – TEF / 2 – POS / 3 – Outros;
• NumCartao - Numero do cartao do cliente;
• ControleErp - chave gerado pelo ERP a ser usada nas consultas de confirmacão de vendas / Baixa de Parcelas;
• RedeNome - Nome da Rede;
• BandeiraNome - Nome da Bandeira;