Autenticar e obter token Bearer
https://api.zypfy.com/api/auth/loginAutentica o merchant com client_id + client_secret e devolve um JWT
válido por 1 hora. Use o token em todas as chamadas subsequentes no
header Authorization: Bearer SEU_TOKEN.
Rate limit
100 tentativas de login por IP a cada 15 minutos. Logins
bem-sucedidos não contam para o limite — apenas as falhas (senha /
credencial inválida). Se exceder, você recebe HTTP 429 com a mensagem
Too many login attempts. Try again in 15 minutes. e precisa esperar
a janela reabrir — não existe workaround, nem em produção. Na prática,
quem cacheia o token (abaixo) nunca chega perto desse limite.
Cache do token (obrigatório)
Reutilize o mesmo token por até ~55 minutos. Só peça um novo em duas situações:
- sua API responder
401(token expirado ou revogado); - falte pouco (~5 minutos) para os 3600s do token.
Se múltiplos processos do seu backend saem do mesmo IP e cada um tenta fazer login independentemente, o rate limit vai bloquear todos. Use um cache compartilhado (Redis, memcached, tabela no banco) para uma cópia única do token entre os workers.
Corpo da requisição
client_idstringobrigatórioID público da sua integração, gerado no dashboard.
exemplo:minhaloja_ABCD1234client_secretstringobrigatórioSegredo de 100 caracteres gerado junto com o
client_id. Só visível no ato da geração/regeneração — nunca é retornado depois.exemplo:6f1e2d3c4b5a...
Respostas
200Autenticação bem-sucedida. JWT retornado em token.
messagestringexemplo:Authentication successful.tokenstringJWT válido por 1 hora (3600s).
exemplo:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...userobjectcampos de user
idintegerexemplo:42namestringexemplo:Minha Lojaemailstring (email)exemplo:[email protected]verification_docsinteger1 se o KYC está aprovado, 0 caso contrário.
valores:01exemplo:1
400Campos obrigatórios ausentes ou malformados.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.
401Credenciais inválidas.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.
403Conta banida ou credenciais não configuradas para este usuário.
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.
429Rate limit excedido (100 / 15 min por IP; logins bem-sucedidos não contam).
messagestringMensagem humana descrevendo o erro.
exemplo:Invalid amount.codestring | nullCódigo opcional de erro para roteamento no seu sistema.
min_amountnumber (float) | nullPresente em erros de valor abaixo do mínimo configurado.
max_amountnumber (float) | nullPresente em erros de valor acima do máximo absoluto.
limitnumber (float) | nullPresente em erros de limite diário por transação excedido.
retry_after_secondsinteger | nullPresente em erros
WITHDRAWAL_COOLDOWN/ 429.