Visão Geral

A plataforma oferece um conjunto abrangente de APIs REST para integrar funcionalidades de pagamento e gerenciamento de contas em suas aplicações.

URL Base

https://yby-dev.usetupi.com.br/v1

Autenticação

Todas as requisições de API requerem um token JWT Bearer. Consulte o Guia de Autenticação para detalhes sobre como obter e gerenciar tokens.

APIs Disponíveis

Onboarding

Gerencie comerciantes e integrações de adquirentes.

• Cadastro — Criar e gerenciar comerciantes
• Integrações — Associar credenciais de adquirentes

Webhooks

Receba notificações em tempo real sobre eventos em sua conta.

• Notificação — Configurar endpoints e validar assinaturas
• Listar Eventos — Consultar o histórico de notificações

Formato de Resposta

Todas as respostas de API são retornadas em formato JSON.

Tratamento de Erros

Consulte a página de Tratamento de Erros para o formato de resposta e a lista completa de códigos HTTP usados pela plataforma.

Convenções

Nomenclatura de Campos

Todos os campos usam camelCase — ex.: dbaName, postalCode, accountType, createdAt.

Filtros e Paginação

Os endpoints de listagem usam paginação baseada em cursor e um padrão uniforme de filtros por query string. Consulte Filtros e Paginação.

Suporte

Precisa de ajuda? Entre em contato com o time de desenvolvimento.