Você precisa de uma chave
sk_test_. Se ainda não tem, veja Configurar sua conta.1
Instale os pré-requisitos
Você precisa de Node.js 20 ou 22 (LTS).
2
Crie o projeto e instale o SDK
3
Configure a chave de API
Crie um arquivo
.env na raiz com a sua chave de sandbox:4
Crie a cobrança PIX
Crie uma sessão de checkout com PIX. A resposta traz a
checkoutUrl, para onde você redireciona o comprador:5
Faça seu primeiro pagamento
No sandbox, o desfecho é controlado pelos dois últimos dígitos do valor — sem PIX real:
Como a sessão acima usa
10_000, o pagamento é confirmado em segundos e dispara o webhook transaction.paid.6
Confira o pagamento no Dashboard
Acesse Transações em app.payments.bob.company e veja a cobrança recém-paga, com o campo
isSandbox: true.Próximos passos
Entender o fluxo
Veja como sessão, transação, checkout e webhook se conectam.
Configurar webhooks
Implemente a confirmação assíncrona no seu servidor.
Testar no sandbox
Simule os estados do pagamento sem movimentar dinheiro real.
Ver todos os caminhos
Compare checkout hospedado, SDK Checkout e API direta.