Method Reference - PagFinance

The client exposes the resources below. Each resource groups methods related to one API domain.

Reference based on the public contract of the @pagfinance/sdk package. The corresponding REST endpoints are documented in the API Reference.

Resource overview

Resource	Methods
`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

Price quotes and asset configuration. Public methods, no authentication.

acceptedCryptos()

Returns the configuration of the cryptocurrencies accepted by the platform.

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

gatewayConfig()

Returns the payment gateway configuration.

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

assets()

Lists the available assets.

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

getAssetPrice({ assetId, fiatCurrency })

Returns the price of an asset in a fiat currency.

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

payments

Payment validation, quoting, creation, and lookup.

validateCode({ code })

Validates a payment code (PIX, boleto, or gift card).

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

quote(req)

Requests a quote for a payment.

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

create(req)

Creates a payment from a quote.

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

submit(req)

Submits the transaction of a created payment.

await client.payments.submit(req);

list()

Lists the authenticated user’s payments.

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

get(id)

Returns a specific payment by its identifier.

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

receipts

Transaction receipts, agnostic to the payment type.

get({ type, tx, chain })

Returns the receipt of a transaction. Agnostic: it works for PIX, boleto, and gift card.

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

kyc

Identity verification (natural persons and legal entities).

Method	Description
`naturalProposal`	Creates a KYC proposal for a natural person.
`legalProposal`	Creates a KYC proposal for a legal entity.
`documentUrl`	Gets the URL for document upload.
`check`	Looks up the verification status.
`cpfValidate`	Validates a CPF (Brazilian taxpayer ID).
`userData`	Returns the user data associated with the KYC.

user

Authenticated user data.

me()

Returns the authenticated user’s data.

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

auth

Authentication and token management. Full details in Authentication and Configuration.

Method	Description
`signIn(params, signer)`	Runs the complete login flow and stores the token.
`challenge(params)`	Requests the challenge (nonce).
`verify(params)`	Verifies the signature and receives the JWT token.
`setToken(token)`	Sets the JWT token on the client.
`getToken()`	Returns the current token.
`clearToken()`	Removes the token from the client.
`otpSend(params)`	Sends an OTP code.
`enableAutoRelogin(fn)`	Enables automatic re-login on 401.

Errors

Every method may throw PagFinanceError.

​Resource overview

​assets

​payments

​receipts

​kyc

​user

​auth

​Errors

Resource overview

assets

payments

receipts

kyc

user

auth

Errors