Pular para o conteúdo principal

Introdução

A Merchant API da Volet.com permite que seu aplicativo receba pagamentos em cripto, envie pagamentos e transferências, acompanhe transações e consulte dados da conta, como saldos, tarifas e limites.

Para cenários passo a passo, veja os guias: Integração por API para receber pagamentos e Integração por API para pagamentos em massa.

URL base​

https://api.volet.com

Todos os endpoints são relativos a esta URL, por exemplo https://api.volet.com/api/account/balances.

Antes de começar​

  • Uma conta verificada da Volet.com, pessoal ou Business.
  • Uma API criada na seção de ferramentas de pagamento da sua conta, com as permissões de que sua integração precisa. Veja Criar um gateway de pagamento ou Ativar pagamentos em massa.
  • Os endereços IP dos seus servidores na lista de IPs permitidos da API.

A Volet.com não oferece sandbox. Teste sua integração com pequenas transações reais.

Autenticação​

Cada requisição inclui três cabeçalhos:

CabeçalhoValor
Api-NameO nome da API na sua conta da Volet.com
Account-EmailO e-mail da conta da Volet.com dona da API
Authentication-TokenUm token SHA-256 gerado a partir da senha da API e da data e hora atuais em UTC

Gerar o token de autenticação​

  1. Monte a string password:YYYYMMDD:HH, em que password é a senha da sua API, e a data e a hora estão em UTC.
  2. Calcule o hash SHA-256 da string.
  3. Envie o hash como string hexadecimal no cabeçalho Authentication-Token. A API não diferencia maiúsculas de minúsculas; o habitual é usar minúsculas.

Por exemplo, para a senha MySecret123 às 14:00 UTC de 26 de outubro de 2026:

SHA256("MySecret123:20261026:14")

resulta em:

c98e6521afe72b0945d9fdefdf3fd0b4dea10baa7f69325a7d6381c15f2421fd

O token muda a cada hora UTC. Gere-o imediatamente antes de cada requisição. A API também aceita os tokens da hora anterior e da seguinte, então uma requisição enviada na virada da hora ou de um servidor com o relógio levemente errado não é rejeitada.

No painel Try it de cada método, você pode digitar a senha da API e gerar o token no navegador. A senha não é enviada a lugar nenhum.

Mantenha a senha no seu servidor

Somente o token é enviado à API, nunca a senha. Não coloque a senha da API nem os tokens em código de frontend, apps móveis, bots ou outros scripts do lado do cliente.

Formato das requisições​

  • Requisições e respostas usam JSON sobre HTTPS. Envie Content-Type: application/json com o corpo das requisições.
  • Os valores são números decimais, por exemplo "amount": 100. A API também os aceita como strings, como "amount": "100.00". O número de casas decimais depende da moeda.
  • Os códigos das stablecoins incluem a rede onde os fundos passam por uma blockchain, por exemplo USDT_TRC20; as moedas das carteiras não têm rede, como USDT. Veja Códigos de moeda e valores.

Exemplo de requisição:

curl https://api.volet.com/api/account/balances \
-H "Api-Name: my-api" \
-H "Account-Email: [email protected]" \
-H "Authentication-Token: c98e6521afe72b0945d9fdefdf3fd0b4dea10baa7f69325a7d6381c15f2421fd"

Limite de requisições​

Para contas pessoais e contas empresariais que não concluíram a verificação, a API limita o número de requisições por hora. Quando o limite se esgota, a API retorna HTTP 401 com o erro attemptsHaveEndedException. Aguarde e envie a requisição mais tarde. Contas empresariais verificadas não têm esse limite por hora.