Bem-vindo(a) à documentação da API do GatewayFy, onde fornecemos todas as ferramentas necessárias para que você possa integrar facilmente funcionalidades de pagamentos e gerenciamento financeiro em sua aplicação. Esta API permite realizar operações como recebimentos via Pix, boleto ou cartão, além de permitir saques, transferências, consulta de saldos e históricos de pagamento.

Nossa API é projetada com foco na segurança e na facilidade de uso, garantindo que você possa implementar funcionalidades complexas com simplicidade e confiabilidade.

​
Requisições e URL base

A API do GatewayFy é construída sobre os princípios REST, utilizando HTTPS em todas as requisições para garantir a segurança, a integridade e a privacidade dos seus dados. Não são suportadas requisições HTTP sem criptografia.

Utilize a seguinte URL base para todas as suas requisições:

https://app.gatewayfy.com/api/v3

​
Autenticação

A autenticação é crucial para interagir com a nossa API. Detalhes completos sobre como autenticar suas requisições podem ser encontrados em nossa página de documentação específica para autenticação. Por favor, visite Autenticação API para obter informações sobre como configurar e usar suas credenciais de autenticação.

​
Formato de Respostas

A API utiliza padrões de resposta HTTP para indicar o sucesso ou falha de operações. As respostas seguem padrões comuns:

  • 200 OK: A requisição foi bem-sucedida.
  • 201 Created: A requisição foi bem-sucedida e um novo recurso foi criado.
  • 400 Bad Request: A requisição não foi bem-sucedida devido a erros de validação ou dados inválidos.
  • 401 Unauthorized: A requisição não foi bem-sucedida devido a falta de autenticação ou token inválido.
  • 404 Not Found: O recurso solicitado não foi encontrado.
  • 500 Internal Server Error: Ocorreu um erro interno no servidor.

Encorajamos os desenvolvedores a implementarem tratamentos de erro adequados para garantir que as aplicações possam responder graciosamente em diferentes cenários de falha.

​
Suporte e Dúvidas

Se tiver dúvidas ou precisar de assistência técnica, nossa equipe de suporte está disponível para ajudá-lo. Visite nossa seção de FAQ ou entre em contato através do nosso suporte técnico para obter ajuda adicional.

Esta introdução oferece uma visão geral de como começar a usar a API do GatewayFy. Nas próximas seções, detalharemos cada endpoint, com exemplos práticos e explicações sobre como usar cada funcionalidade disponível.

Autenticação