Documentacao

Uway Gateway Docs

Client Api

Providers, saldos e fees

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.

Todas as secoes
GET

Listar providers

/api/client/api/gateway-providers

Sem custo SANDBOX gratis

Retorna providers habilitados, capabilities, methods, transfer methods e ambientes disponiveis. Esse endpoint e a fonte de verdade para descobrir se o provider suporta cobranca com cartao bruto, tokenizacao, refunds, subscriptions, payment links, balance ou transferencias.

Sucesso Response
GET

Listar saldos

/api/client/api/gateway-balances

Produção R$ 0,01 /req SANDBOX gratis

Consulta os saldos consolidados das contas de gateway acessiveis ao api client.

Sucesso Response
GET

Consultar saldo de uma conta

/api/client/api/gateway-balances/{gatewayAccount}

Produção R$ 0,01 /req SANDBOX gratis

Consulta o saldo de uma conta especifica vinculada ao merchant.

Sucesso Response
GET

Consultar fees

/api/client/api/gateway-fees

Produção R$ 0,01 /req SANDBOX gratis

Retorna as fees do provider ou da conta selecionada, com resolucao automatica quando nenhum gateway e informado.

Sucesso Response
POST

Calcular fee

/api/client/api/gateway-fees/calculate

Produção R$ 0,01 /req SANDBOX gratis

Calcula fee estimada para um payload informado na integracao.

Request
Sucesso Response
POST

Tokenizar cartao

/api/client/api/card-tokens

Produção R$ 0,03 /req SANDBOX gratis

Cria um token reutilizavel de cartao vinculado a um customer ja cadastrado no gateway. Esse token pode ser usado em cobrancas futuras conforme a capacidade do provider. Para Mercado Pago, tokenizacao e o fluxo recomendado para pagamentos com cartao. Para Asaas, o token pode ser usado, mas a cobranca direta com `card` + `holder` tambem e aceita.

Request
Sucesso Response
INFO

Como o Uway traduz erros do provider

gateway.provider_validation_failed

Quando o Asaas ou outro provider devolve erro de validacao, autenticacao ou autorizacao, a documentacao publica mostra o contrato do Uway. Os detalhes nativos do provider ficam em `provider_errors` quando fizer sentido.

Sucesso Response