Documentação
Tudo o que você precisa para chamar o gateway — um contrato para todas as integrações fintech.
Primeiros passos
Todos os endpoints ficam sob uma URL base e seguem as mesmas convenções:
Cada página de app tem um playground ao vivo — preencha os parâmetros e clique em Send request, sem configuração de cliente. A especificação completa legível por máquina está no OpenAPI / Swagger UI.
Uma integração típica tem três passos:
- Faça login — chame os endpoints de login do app com as credenciais / OTP.
- Salve o token — um login bem-sucedido retorna um
tokendo gateway. - Chame os endpoints — passe
token=em cada requisição autenticada.
Autenticação
Cada app usa um fluxo de login nativo da fintech subjacente (OTP por SMS, usuário/senha, PIN + OTP). Em caso de sucesso, o gateway emite seu próprio token de sessão:
Passe esse token como parâmetro de consulta token= em cada endpoint seguinte. O gateway o resolve para a sessão upstream no servidor — você nunca mais lida com credenciais upstream.
Os tokens são vinculados à conta que fez login. Se a sessão upstream expirar, faça login novamente para obter um token novo.
Formato de resposta
Cada resposta — de sucesso ou erro — é envolvida no mesmo envelope:
O campo data.upstream sempre carrega a resposta fintech original, então você pode usar os campos normalizados por conveniência e ainda auditar ou analisar o payload bruto quando precisar de detalhes específicos do app.
Erros
| Status | Significado |
|---|---|
400 | Erro de validação — um parâmetro está ausente ou malformado. |
401 | Credenciais inválidas, token incorreto/expirado ou sem sessão ativa. |
502 | Não foi possível contatar o app fintech upstream ou ele deu erro. |
Erros de credenciais e de upstream ainda incluem data.upstream quando disponível, então o corpo de erro do upstream nunca fica oculto de você.
APIs disponíveis
Cada integração vem com documentação completa dos endpoints e um playground ao vivo:
