# PagFinance ## Documentation ### SDKs - [Introduction and Installation](https://docs.pag.finance/en/sdks/introduction.md): Overview and installation of the official @pagfinance/sdk, the framework-agnostic client for integrating your application with the PagFinance API. - [Authentication and Configuration](https://docs.pag.finance/en/sdks/authentication.md): PagFinanceClient configuration, JWT token management, and the Web3 challenge-response login flow. - [Usage and Examples](https://docs.pag.finance/en/sdks/usage-examples.md): Practical SDK usage examples: public endpoints, authenticated calls, error handling, and the end-to-end transaction flow. - [Method Reference](https://docs.pag.finance/en/sdks/method-reference.md): Complete reference of the @pagfinance/sdk resources and methods: assets, payments, receipts, kyc, user, and auth. ## API Reference ### Get Started - [Overview](https://docs.pag.finance/en/api-reference/overview.md): Overview of the PagFinance partner API: base URL, versioning, authentication schemes, response envelopes, rate limits, and common errors. - [Authentication](https://docs.pag.finance/en/api-reference/authentication.md): Partner authentication with a Bearer API key or HMAC-SHA256, and end-user JWT issuance via POST /auth/token. - [Crypto settlement](https://docs.pag.finance/en/api-reference/crypto-settlement.md): Supported chains (Solana, EVM, Stellar, Tron, XRPL), the live asset catalog in gateway-config-latest.json, the memo reconciliation model, and the cash-out settlement state machine. - [Issue token](https://docs.pag.finance/en/api-reference/endpoints/auth-token.md) ### Users - [Create user](https://docs.pag.finance/en/api-reference/endpoints/users-create.md) - [List users](https://docs.pag.finance/en/api-reference/endpoints/users-list.md) - [Get user](https://docs.pag.finance/en/api-reference/endpoints/users-get.md) - [Block user](https://docs.pag.finance/en/api-reference/endpoints/users-block.md) ### Partners and API Keys - [Create API key](https://docs.pag.finance/en/api-reference/endpoints/apikeys-create.md) - [List API keys](https://docs.pag.finance/en/api-reference/endpoints/apikeys-list.md) - [Revoke API key](https://docs.pag.finance/en/api-reference/endpoints/apikeys-revoke.md) - [Set webhook config](https://docs.pag.finance/en/api-reference/endpoints/webhook-config-set.md): Sets the single destination for this partner's outbound webhooks. This is the official way to register the destination for outbound notifications. - Define o destino único dos webhooks de saída deste parceiro. - [Get webhook config](https://docs.pag.finance/en/api-reference/endpoints/webhook-config-get.md) - [Delete webhook config](https://docs.pag.finance/en/api-reference/endpoints/webhook-config-delete.md) - [Rotate webhook secret](https://docs.pag.finance/en/api-reference/endpoints/rotate-webhook-secret.md) - [Rotate HMAC secret](https://docs.pag.finance/en/api-reference/endpoints/rotate-secret.md) ### Fees and revenue share - [Fee schedule](https://docs.pag.finance/en/api-reference/endpoints/fees-get.md) - [Set markup](https://docs.pag.finance/en/api-reference/endpoints/fees-markup.md) - [Simulate fee](https://docs.pag.finance/en/api-reference/endpoints/fees-simulate.md) - [Revenue balance](https://docs.pag.finance/en/api-reference/endpoints/earnings-get.md) - [Revenue summary](https://docs.pag.finance/en/api-reference/endpoints/earnings-summary.md) - [Revenue statement](https://docs.pag.finance/en/api-reference/endpoints/earnings-statement.md) ### KYC - [KYC](https://docs.pag.finance/en/api-reference/kyc.md): Identity verification: document lookup and verify, and full onboarding sessions for individuals (PF) and companies (PJ). Partner-authenticated. - [Look up document](https://docs.pag.finance/en/api-reference/endpoints/kyc-lookup.md) - [Verify document](https://docs.pag.finance/en/api-reference/endpoints/kyc-verify.md) - [Start PF session](https://docs.pag.finance/en/api-reference/endpoints/kyc-session-pf.md) - [Start PJ session](https://docs.pag.finance/en/api-reference/endpoints/kyc-session-pj.md) - [List sessions](https://docs.pag.finance/en/api-reference/endpoints/kyc-sessions-list.md) - [Get session](https://docs.pag.finance/en/api-reference/endpoints/kyc-session-get.md) - [Sync session](https://docs.pag.finance/en/api-reference/endpoints/kyc-session-sync.md) - [Documentoscopy URL](https://docs.pag.finance/en/api-reference/endpoints/kyc-session-docurl.md) - [User KYC status](https://docs.pag.finance/en/api-reference/endpoints/kyc-user-check.md) ### Prices - [Get asset price](https://docs.pag.finance/en/api-reference/endpoints/price-get.md) - [Accepted cryptos](https://docs.pag.finance/en/api-reference/endpoints/accepted-cryptos.md) ### Cash-out (offramp) - [Validate code](https://docs.pag.finance/en/api-reference/endpoints/validate-code.md) - [Create quote](https://docs.pag.finance/en/api-reference/endpoints/cashout-quote.md) - [Create intent](https://docs.pag.finance/en/api-reference/endpoints/cashout-intent.md) - [Get intent](https://docs.pag.finance/en/api-reference/endpoints/cashout-intent-get.md) - [List intents](https://docs.pag.finance/en/api-reference/endpoints/cashout-intents-list.md) - [Cash-out feed](https://docs.pag.finance/en/api-reference/endpoints/partner-cashout-intents.md) - [Cash-out feed item](https://docs.pag.finance/en/api-reference/endpoints/partner-cashout-intent-get.md) ### Cash-in (onramp) - [Create quote](https://docs.pag.finance/en/api-reference/endpoints/cashin-quote.md) - [Create intent](https://docs.pag.finance/en/api-reference/endpoints/cashin-intent.md) - [Get intent](https://docs.pag.finance/en/api-reference/endpoints/cashin-intent-get.md) - [List intents](https://docs.pag.finance/en/api-reference/endpoints/cashin-intents-list.md) - [Get payment](https://docs.pag.finance/en/api-reference/endpoints/cashin-payment-get.md) - [Cash-in feed](https://docs.pag.finance/en/api-reference/endpoints/partner-cashin-intents.md) - [Cash-in feed item](https://docs.pag.finance/en/api-reference/endpoints/partner-cashin-intent-get.md) ### Receipts - [Get receipt](https://docs.pag.finance/en/api-reference/endpoints/receipt-pix.md) - [List payments](https://docs.pag.finance/en/api-reference/endpoints/receipt-payments.md) ### Links - [Create link](https://docs.pag.finance/en/api-reference/endpoints/links-create.md) - [List links](https://docs.pag.finance/en/api-reference/endpoints/links-list.md) - [Resolve link](https://docs.pag.finance/en/api-reference/endpoints/links-resolve.md) - [Cancel link](https://docs.pag.finance/en/api-reference/endpoints/links-cancel.md) ### BRLP - [BRLP](https://docs.pag.finance/en/api-reference/brlp.md): BRLP, the BRL-pegged layer: BRL pricing and the BRLP withdraw (Mode B) that converts BRLP to BRL via PIX. This group targets the sandbox.brlp.io domain. ### Webhooks - [Webhooks](https://docs.pag.finance/en/api-reference/webhooks.md): Outbound event notifications (API to your backend): register a destination, the event catalog, payload shapes, HMAC signature verification, and retry policy. ## FAQ ### Overview - [Welcome to PagFinance](https://docs.pag.finance/en/faq/welcome.md): The Web3 payment infrastructure that connects stablecoins and cryptocurrencies to local currency payments such as PIX, boletos, and bank transfers. ### Frequently Asked Questions - [Introduction](https://docs.pag.finance/en/faq/introduction.md): Common questions about PagFinance: how it works, who can use it, which currencies are accepted, and how to integrate. - [Which cryptocurrencies are accepted?](https://docs.pag.finance/en/faq/accepted-cryptocurrencies.md): Assets currently accepted on the Solana network: SOL, USDC, USDT, PYUSD, and WETH. New assets coming soon. - [Can I pay government taxes?](https://docs.pag.finance/en/faq/government-taxes.md): We currently do not process payments of government tax forms such as DARF, GRU, and GPS. The platform is intended for private transactions. - [How does PagFinance work?](https://docs.pag.finance/en/faq/how-it-works.md): Select a digital wallet, enter the invoice or PIX amount, and complete the payment with cryptocurrencies. Conversion to Brazilian reais is automatic. - [I made a payment but have not received it yet!](https://docs.pag.finance/en/faq/payment-not-received.md): Settlement times: PIX within 5 minutes and boleto within 24 hours. If the deadline has passed, contact support. - [I don't have SOL. Can I still use PagFinance?](https://docs.pag.finance/en/faq/no-solana-tokens.md): Yes. Use our bridge tool to bring your assets to the Solana network, even without holding any tokens on it. - [What is the maximum amount I can transact?](https://docs.pag.finance/en/faq/maximum-amount.md): The maximum amount per transaction on PagFinance is R$ 10,000.00. Higher amounts may go through additional review. - [Payment Receipt](https://docs.pag.finance/en/faq/payment-receipt.md): How to access and download your payment receipt on the platform using the same Web3 wallet used for the payment. - [Refunds](https://docs.pag.finance/en/faq/refunds.md): PagFinance's chargeback and refund policy: conditions, required documents, and review and return timeframes. - [What do we do?](https://docs.pag.finance/en/faq/what-we-do.md): We accept cryptocurrency deposits and convert them to Brazilian reais (BRL) directly in the recipient's account. ## OpenAPI Specs - [openapi](/openapi.json) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Brazilian Portuguese (71 pages)](https://docs.pag.finance/_llms/pt-br.txt): Documentação, Referência da API, FAQ. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.