Valz Core APIs

Documentação oficial das APIs Valz

Construa experiências financeiras modernas com os serviços bancários digitais da Valz. Tenha acesso a APIs resilientes, versionamento transparente e suporte direto do time de engenharia para acelerar sua integração.

Explorar endpoints Falar com o suporte

Disponibilidade 99.98%

Latência média 180 ms

Clientes ativos 120+

Primeiros passos

Autenticação e segurança

Todas as requisições precisam ser autenticadas com o token JWT retornado no login e trafegam através de TLS 1.3. Gere credenciais no Console Valz, obtenha o token em QA ou Produção e rotacione acessos sempre que necessário.

Fluxo recomendado

Crie um usuário técnico no console e habilite os escopos mínimos.
Autentique com POST /v1/users/login para receber o JWT.
Envie o token em Authorization: Bearer <token> em todas as requisições subsequentes.
Capture erros 401/403 para renovar o token automaticamente.

Login e uso do token

curl --request POST https://api-qa.valzdigital.com/v1/users/login \
  --header "Content-Type: application/json" \
  --data '{
    "email": "[email protected]",
    "password": "<senha>"
  }'

# resposta
{
  "data": {
    "token": "eyJ0..."
  }
}

# requisição autenticada
curl https://api.valzdigital.com/v1/accounts \\
  --header "Authorization: Bearer eyJ0..."

Ambientes

Ambientes e URLs base

A Valz oferece ambientes isolados para homologação e produção, com observabilidade integrada.

Ambiente	Base URL	Chaves	Observações
Sandbox	`https://api-qa.valzdigital.com`	Prefixo `qa-`	Dados sintéticos, login isolado e webhooks simulados.
Produção	`https://api.valzdigital.com`	Prefixo `prd-`	Observabilidade 24/7 e alertas em tempo real.

Playbooks

Guias de integração

Referências rápidas inspiradas em portais como Nubank, Itaú e Banco Inter para acelerar testes ponta a ponta.

Onboarding em 48h

Solicite acesso sandbox e gere suas chaves.
Dispare simulações via `/simulation` e receba webhooks locais.
Valide o contrato com QA compartilhando os IDs de correlação.

Go-live seguro

Execute smoke tests com o time Valz acompanhando dashboards.
Configure limites transacionais dinâmicos via `/risk/limits`.
Ative alertas no Grafana/Datadog consumindo nossos webhooks.

Suporte contínuo

Abra tickets no Jira interno com o template VALZ-API anexando logs, request-id e prints do Swagger.

Boas práticas

Governança de integração

Observabilidade

Configure correlação de requisições via cabeçalho X-Valz-Correlation e monitore o dashboard em tempo real no Console.

Webhooks

Valide o header X-Valz-Signature usando o segredo do aplicativo e replique eventos idempotentes por até 24h.

Versionamento

Endpoints seguem o padrão /v<n>. Avisamos com 90 dias de antecedência antes de qualquer Breaking change.

Roadmap

Consulta de saldo instantânea (Q3) e APIs de onboarding digital (Q4). Cadastre-se para receber betas.

Atualizações

Release notes

Data	Status	Descrição
Jan 2025	Stable	Lançamento do Valz Real-Time Balance com melhorias de latência em 32%.
Dez 2024	Beta	Disponibilização de webhooks idempotentes e assinatura dupla em `/events`.
Out 2024	Preview	SDK TypeScript publicado para acesso antecipado (necessário NDA).