Documentacao
Todas as secoes
Listagem central das secoes tecnicas do produto, separadas por operacao, autenticacao, client api, billing e administracao.
Grupo
Visao geral
Produto
Visao geral
O Uway Gateway e uma plataforma para centralizar integracoes de pagamento, padronizar contratos de API e permitir que cada merchant opere com varios gateways sem reescrever sua integracao a cada provider.
Arquitetura
Arquitetura
A arquitetura foi separada por dominio funcional para manter a Client Api previsivel, consistente e preparada para crescer com novos gateways e novas capacidades.
Observabilidade
Observabilidade
A observabilidade do produto foi desenhada para responder rapidamente tres perguntas: o sistema esta saudavel, qual gateway esta falhando e qual rotina automatica ficou para tras.
Grupo
Autenticacao
Visao geral
Autenticacao
A documentacao publica foca na autenticacao da Client Api, usada para integracoes server-to-server com chaves proprias do merchant.
Client Api
Autenticacao
A Client Api tem um endpoint de autenticacao explicita e um endpoint de introspeccao do api client autenticado. A autenticacao explicita aceita credenciais no body JSON ou via headers `X-API-PUBLIC-KEY` e `X-API-SECRET-KEY`.
Grupo
Client Api
Pagamentos
Client Api
Endpoints para criar, listar, consultar e acompanhar status de pagamentos. O formato recomendado da Uway usa um payload enxuto com blocos opcionais `checkout`, `payment_options` e `payment_source`. Campos antigos em formato plano continuam aceitos por compatibilidade, mas a recomendacao e usar o shape simplificado daqui para frente. Pix e boleto seguem o mesmo fluxo padronizado; em cartao, o provider pode aceitar `card_token` ou dados brutos dependendo da capability da conta selecionada.
Links de pagamento
Client Api
Links de pagamento hospedados no provider, com o mesmo principio de simplificacao da Uway: campos principais na raiz, `checkout` para redirect e `link_options` para opcoes mais avancadas. Campos antigos em formato plano continuam aceitos por compatibilidade.
Clientes
Client Api
Gerencia clientes no ecossistema do gateway.
Assinaturas
Client Api
Cria e gerencia cobrancas recorrentes.
Transferencias
Client Api
Transferencias via pix ou conta bancaria conforme o gateway.
Providers e saldos
Client Api
A Client Api expoe catalogo de providers ativos, saldos das contas de gateway e consulta/calculo de fees para apoiar automacao, conciliacao e operacao do merchant. Use esse catalogo para descobrir o que cada provider suporta antes de montar fluxos de cartao, subscriptions, refunds ou links de pagamento.
Refunds
Client Api
Estornos vinculados aos pagamentos do api client.
Chargebacks
Client Api
Consulta chargebacks sincronizados por webhook e vinculados ao api client.
Webhooks
Webhooks e callbacks
Abrir secao detalhada da documentacao.