Visão Geral
A plataforma Positivo 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.positivolabs.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.
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.
Parâmetros de Paginação
Os endpoints de listagem suportam os seguintes parâmetros de query:
| Parâmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
offset | integer | 0 | Número de registros a pular |
limit | integer | 20 | Máximo de registros a retornar |
order_by | string | created_at | Campo para ordenar resultados |
order | string | DESC | Direção da ordenação: ASC ou DESC |
Suporte
Precisa de ajuda? Entre em contato com o time de desenvolvimento.