Skip to main content
O @pagfinance/sdk é o SDK cliente, framework-agnóstico, para integrar aplicações externas à API do PagFinance (pagamentos cripto convertidos para PIX, boleto ou giftcard, verificação de KYC e cotações de preço).
Referência oficial do pacote: @pagfinance/sdk no npm. Esta documentação é baseada no README e no contrato público desse pacote.

Por que usar o SDK

O SDK foi projetado para ser plugável em qualquer aplicação e para nunca conter segredos, chaves ou lógica de criptografia. Toda a parte sensível permanece na aplicação host, protegendo a propriedade intelectual e a segurança do PagFinance.

Compatibilidade ampla

Funciona em Node 18+, navegadores e bundlers modernos.

Sem segredos embutidos

Nenhuma chave privada ou lógica de assinatura vive no cliente.

Autenticação Web3

Login por challenge-response (estilo SIWS), orquestrado pelo SDK.

Framework-agnóstico

Independente de framework de UI ou backend específico.

Requisitos

18+
Ambiente Node 18 ou superior, navegador moderno ou bundler.
opcional
Para endpoints autenticados, forneça um token JWT obtido pelo fluxo de login. Endpoints públicos não exigem token.

Instalação

Primeiro contato

Instancie o cliente apontando para o host da API e comece a chamar endpoints públicos, que não exigem autenticação:
Continue por Autenticação e Configuração para configurar o cliente e o login, depois veja Uso e Exemplos para fluxos ponta a ponta.

Próximos passos

Autenticação e Configuração

Opções do cliente, tokens e login challenge-response.

Uso e Exemplos

Fluxos completos de cotação, criação e recibo.

Referência de Métodos

Todos os recursos e métodos disponíveis.

API Reference

Endpoints REST subjacentes ao SDK.