Skip to main content
O @repass/sdk é o cliente TypeScript oficial da API do Repass. Ele encapsula autenticação, retentativas, idempotência, paginação e erros tipados: você manipula a API com autocomplete total.
O SDK cobre toda a superfície de organização (a mesma da Referência da API) usando uma API key rstr_. Endpoints públicos de borda (redirect de tracking e ingestão de webhooks de gateway) ficam fora do SDK por usarem outro modelo de autenticação.

Por que usar

Altamente tipado

Tipos para todo request e response, derivados das mesmas convenções da API. Erros viram classes que você consegue estreitar no catch.

Zero dependências de runtime

Usa apenas fetch/AbortController globais. Instala leve e roda em Node 18+, browsers e edge runtimes.

Resiliente por padrão

Retentativas com backoff em 429/5xx/falhas de rede, timeout por requisição e idempotência automática em POSTs re-tentados.

Paginação ergonômica

list() é aguardável e iterável: pegue uma página ou percorra todas com for await.

Instalação

Requer Node.js 18+ (ou qualquer runtime com fetch global). É distribuído em ESM e CJS, com type declarations incluídas.

Em 30 segundos

A rstr_ é uma credencial de servidor com os poderes do membro dono da key. Nunca a exponha em código de frontend ou em repositórios públicos. Use o SDK no backend / em ambientes de servidor.

Próximos passos

Início rápido

Do zero a uma comissão calculada, em TypeScript.

Configuração

Chave, base URL, timeout, retries, fetch customizado e opções por requisição.

Recursos e métodos

O mapa completo de repass.<recurso>.<método>.

Tratamento de erros

A hierarquia RepassError e como reagir a cada caso.