Referência de Métodos

O cliente expõe os recursos abaixo. Cada recurso agrupa métodos relacionados a um domínio da API.

Referência baseada no contrato público do pacote @pagfinance/sdk. Os endpoints REST correspondentes estão documentados na API Reference.

Visão geral dos recursos

Recurso	Métodos
`assets`	`acceptedCryptos`, `gatewayConfig`, `assets`, `getAssetPrice`
`payments`	`validateCode`, `quote`, `create`, `submit`, `list`, `get`
`receipts`	`get({ type, tx, chain })`
`kyc`	`naturalProposal`, `legalProposal`, `documentUrl`, `check`, `cpfValidate`, `userData`
`user`	`me`
`auth`	`signIn`, `challenge`, `verify`, `setToken`, `getToken`, `clearToken`, `otpSend`, `enableAutoRelogin`

assets

Cotações de preço e configuração de ativos. Métodos públicos, sem autenticação.

acceptedCryptos()

Retorna a configuração das criptomoedas aceitas pela plataforma.

const config = await client.assets.acceptedCryptos();

gatewayConfig()

Retorna a configuração do gateway de pagamento.

const gateway = await client.assets.gatewayConfig();

assets()

Lista os ativos disponíveis.

const assets = await client.assets.assets();

getAssetPrice({ assetId, fiatCurrency })

Retorna o preço de um ativo em uma moeda fiat.

const price = await client.assets.getAssetPrice({ assetId: 1, fiatCurrency: 'BRL' });

payments

Validação, cotação, criação e consulta de pagamentos.

validateCode({ code })

Valida um código de pagamento (PIX, boleto ou giftcard).

const transfer = await client.payments.validateCode({ code: '00020101...' });

quote(req)

Solicita uma cotação para um pagamento.

const quote = await client.payments.quote(req);

create(req)

Cria um pagamento a partir de uma cotação.

const payment = await client.payments.create(req);

submit(req)

Submete a transação de um pagamento criado.

await client.payments.submit(req);

list()

Lista os pagamentos do usuário autenticado.

const payments = await client.payments.list();

get(id)

Retorna um pagamento específico pelo identificador.

const payment = await client.payments.get(id);

receipts

Recibos de transação, agnósticos ao tipo de pagamento.

get({ type, tx, chain })

Retorna o recibo de uma transação. Agnóstico: serve para PIX, boleto e giftcard.

const receipt = await client.receipts.get({ type: 'pix', tx: '...', chain: 'solana' });

kyc

Verificação de identidade (pessoa física e jurídica).

Método	Descrição
`naturalProposal`	Cria uma proposta de KYC para pessoa física.
`legalProposal`	Cria uma proposta de KYC para pessoa jurídica.
`documentUrl`	Obtém a URL para envio de documentos.
`check`	Consulta o status da verificação.
`cpfValidate`	Valida um CPF.
`userData`	Retorna os dados do usuário associados ao KYC.

user

Dados do usuário autenticado.

me()

Retorna os dados do usuário autenticado.

client.setToken(tokenJWT);
const me = await client.user.me();

auth

Autenticação e gestão de tokens. Detalhes completos em Autenticação e Configuração.

Método	Descrição
`signIn(params, signer)`	Executa o fluxo completo de login e salva o token.
`challenge(params)`	Solicita o desafio (nonce).
`verify(params)`	Verifica a assinatura e recebe o token JWT.
`setToken(token)`	Define o token JWT no cliente.
`getToken()`	Retorna o token atual.
`clearToken()`	Remove o token do cliente.
`otpSend(params)`	Envia um código OTP.
`enableAutoRelogin(fn)`	Habilita re-login automático em 401.

Erros

Todos os métodos podem lançar PagFinanceError.

​Visão geral dos recursos

​assets

​payments

​receipts

​kyc

​user

​auth

​Erros

Visão geral dos recursos

assets

payments

receipts

kyc

user

auth

Erros