API Troco Fácil Brasil

www.trocofacilbrasil.com.br · telefone: (63) 99245-0556 · suporte@trocofacilbrasil.com.br

Por meio da API da Troco Fácil Brasil será possível aos desenvolvedores integrarem seus sistemas à nossa plataforma independentemente da linguagem que estejam utilizando.

A API da Troco Fácil Brasil possibilitará a devolução de troco, o recebimento de pagamentos de compras (Usando o saldo acumulado dos consumidores) e o cadastramento de novos usuários (consumidores) em nossa plataforma a partir do seu próprio sistema de forma bastante simplificada.

Elaboramos uma documentação bastante intuitiva onde será possível fazer a integração com a API da Troco Fácil Brasil. Caso alguma dúvida permaneça, podem entrar em contato com o suporte especializado através do e-mail: suporte@trocofacilbrasil.com.br.

Importante: A Troco Fácil Brasil não dará suporte à nenhuma linguagem de programação específica. Para tanto, o retorno às todas as requisições serão via JSON, garantindo assim que qualquer linguagem possa fazer o tratamento dos dados retornados.

Visão Geral da Integração

Ambiente

A API da Troco Fácil Brasil oferece dois ambientes de integração: homologação e produção.

Homologação

O ambiente de homologação serve para testar todas as funcionalidades disponíveis na API sem a necessidade de se preocupar com a veracidade dos dados. Os registros gerados aqui não possuem validade operacional ou monetária. Para fazer testes no ambiente de homologação, deverá fazer requisições à seguinte URL: https://homologacao.trocofacilbrasil.com.br/

Produção

Após realizarem todos os testes no ambiente de homologação e todos os critérios terem sido atendidos, o seu sistema estará apto a utilizar o ambiente de produção. Para isso, as requisições devem ser enviadas para a seguinte URL: https://api.trocofacilbrasil.com.br/

Enfatizamos que após a integração com o ambiente de produção ser concluída, todas as transações realizadas por meio da API serão oficiais. Portanto, recomendamos atenção quanto ao uso de ambos os ambientes para que não aja confusão quanto à qual ambiente deseja integrar.

Autenticação

Dados de Acesso

Antes de iniciar o processo de integração, primeiro é necessário os dados de acesso para que possa simular as transações em nossa API.

Para isso, envie um e-mail para o nosso suporte com o título "Dados de Integração API" para o seguinte e-mail: suporte@trocofacilbrasil.com.br.

Retornaremos o e-mail contendo os dados de acesso e o saldo para fazer as transações de testes.

Obs.: Tanto a empresa quanto o saldo serão todos fictícios, ou seja, sem validade alguma.

A autenticação é feita através do  CNPJ da empresa cadastrada e de um token que é gerado automaticamente no momento do cadastro.

Após a realização do cadastro de sua empresa em nossa plataforma, forneceremos uma string secreta (token), e única, que será usada para efetuar todas as operações.

O token poderá ser obtido acessando o painel administrativo de sua empresa através do seguinte link: https://www.app.trocofacilbrasil.com.br/login/. Ao acessar, clique no menu Área Administrativa, depois escolha a opção Dados da Empresa.

Tanto o CNPJ quanto o token devem ser passados via parâmetro na URL de requisição à API. Abaixo, seguem exemplos de requisições à nossa API.

Ambiente de Homologação:

https://homologacao.trocofacilbrasil.com.br/web/DevolverTroco/index.php?token={TOKEN}&cnpj={CNPJ}

Ambiente de Produção:

https://api.trocofacilbrasil.com.br/web/DevolverTroco/index.php?token={TOKEN}&cnpj={CNPJ}

Acesso ao Sandbox

Link de acesso para ver a simulação dos testes: http://sandbox.trocofacilbrasil.com.br/login/
No link acima, poderão estar acessando a plataforma on-line para conferir as transações realizadas.
Para isso, use o login master cujo perfil é de administrador.

Observação: Para realizar pagamentos por meio da API, os usuários deverão informar um código PIN.

Como o código PIN só pode ser obtido via aplicativo e é informado para o Caixa/Atendente no momento do pagamento, então por motivos de segurança sempre que um PIN for usado, um novo será gerado. Desta forma o PIN usado não poderá mais ser reutilizado.

Para obter os códigos PIN's para fazer testes, após logar no SANDBOX, vá em Aréa Administrativa, depois escolha a opção Pesquisar PIN's.
Basta digitar o CPF de testes que estiver usando e terá acesso ao PIN atual.

Esse recurso de obter os PIN's só existe no ambiente de testes, ou seja, nenhuma empresa real terá acesso aos PIN's dos usuários de nossa plataforma.

Devolver Troco

As transações para a devolução do troco serão processadas por meio da requisição abaixo.

Endpoint: web/DevolverTroco/index.php?token={TOKEN}&cnpj={CNPJ}
Método: POST

Parâmetros
Nome Tipo Informações adicionais
TOKEN String Obrigatório
CNPJ Números Obrigatório
Request body
Nome Tipo Informações adicionais
cpfCliente Numeros Obrigatório
loginAtendente String Obrigatório
valorTroco Decimal Obrigatório
Resposta da API
Cadastro de Cliente

Receber Pagamento

Será por meio desta requisição que todas as compras (Usando o saldo acumulado dos consumidores) via plataforma Troco Fácil Brasil serão processadas.

Endpoint: web/ReceberPagamento/index.php?token={TOKEN}&cnpj={CNPJ}
Método: POST

Parâmetros
Nome Tipo Informações adicionais
TOKEN String Obrigatório
CNPJ Números Obrigatório
Request body
Nome Tipo Informações adicionais
cpfCliente Números Obrigatório
valorPagamento Decimal Obrigatório
loginAtendente String Obrigatório
pin Números Obrigatório
Resposta da API
Receber Pagamento

Estornar Pagamento

Será por meio desta requisição que o estabelecimento comercial pode estornar o valor de um pagamento realizado via plataforma Troco Fácil Brasil serão processadas.

Endpoint: web/EstornarPagamento/index.php?token={TOKEN}&cnpj={CNPJ}
Método: POST

Parâmetros
Nome Tipo Informações adicionais
TOKEN String Obrigatório
CNPJ Números Obrigatório
Request body
Nome Tipo Informações adicionais
cpfCliente Números Obrigatório
valorEstorno Decimal Obrigatório
loginAtendente String Obrigatório
codigoTransacao String Obrigatório
Resposta da API
Estornar Pagamento

NOTA: Todas as informações e processamentos realizados através da API da Troco Fácil Brasil é de responsabilidade da empresa cujo sistema está sendo integrado. A Troco Fácil Brasil irá apenas receber tais informações e processá-la em sua plataforma.