Introdução e Autenticação

Nossa API foi desenvolvida com foco em simplicidade e eficiência, seguindo os padrões REST para garantir uma integração rápida e compatível com diferentes sistemas. Todas as respostas são retornadas em formato JSON, oferecendo uma estrutura consistente, legível e de fácil manipulação para desenvolvedores.

Autenticação

Para acessar a API, é necessário utilizar a chave secreta fornecida durante o processo de integração. A autenticação segue o padrão Basic Access Authentication.

Você pode localizar suas credenciais no painel da sua conta, acessando Integrações → Chave de API, onde encontrará:

Secret Key → utilizada como o username nas requisições;
Company Id → utilizada como o password nas requisições;

Em cada requisição, inclua essas informações no cabeçalho HTTP, no campo Authorization, conforme o exemplo abaixo:

Exemplo em Node.js:

const options = {
  method: 'POST',
  url: 'https://api.venitip.com.br/functions/v1/transactions',
  headers: {
    authorization:
      'Basic ' + new Buffer('{SECRET_KEY}:{COMPANY_ID}').toString('base64'),
  },
};

Endpoints Base

A URL base para todas as requisições da API é

https://api.venitip.com.br/functions/v1

Recursos Disponíveis

Nossa API oferece os seguintes recursos principais:

Transações(PIX IN): Gerenciamento completo de transações (criação, listagem e busca)
Withdrawals(PIX OUT): Gerenciamento de saques (criação, listagem e busca)