Este guia apresenta o passo a passo para importar, configurar e utilizar a coleção Stone (Pagar.me) V5 no Postman, facilitando o início dos testes e das requisições à nossa API.
Precisa de ajuda durante o desenvolvimento? Nosso agente Guru está disponível para auxiliar com dúvidas técnicas sobre a API pelo WhatsApp: +55 11 5026-8643.

1. Importando a Coleção para o Postman

Você pode importar a coleção usando o arquivo local (.json) que está em anexo ao final deste artigo
 

📂 Importação por Arquivo (File)
1. No Postman, clique no botão "Import" (Importar).
 

2. Clique em "Upload Files" (Carregar Arquivos). 

3. Selecione o arquivo da coleção salvo no seu computador e clique em "Abrir". 

2. Configurando a Autenticação (Basic Auth)

Para que suas requisições sejam bem-sucedidas, você deve configurar a chave secreta no nível da coleção.

🔑 Obtendo Sua Chave de Autenticação de Testes
A chave está acessível no seu painel Stone, para obtê-la, clique em seu nome no canto superior direito > "Perfil" > "Acessos e Segurança" > “Chave de Autenticação”.

💡 Atenção: Testes são Vendas Fictícias
Lembre-se que as chaves de testes são destinados exclusivamente à simulação e debug, representando vendas fictícias. Nenhuma transação real será realizada ou cobrada.

⚙️ Configuração da Coleção no Postman
1. Acesse a pasta "Coleção Pagar.me V5 PSP" na barra lateral.
2. Selecione a aba "Authorization" (Autorização) da coleção.
3. Configure o "Type" (Tipo) como "Basic Auth".
4. Insira sua chave secreta de testes no campo "Username" (deixando a senha vazia).
5. Clique em "Save" (Salvar).
 

Resultado: Ao salvar, você habilita a autenticação global em todas as requisições da coleção, eliminando a necessidade de autenticação individual em cada uma delas.

3. Teste Inicial: Criar um Pedido com Cartão

Com a autenticação configurada, você pode realizar seu primeiro teste de integração.
Para criar um pedido com pagamento em cartão de crédito, siga os passos abaixo:

1. Acesse a pasta "PAGAMENTOS" > "Pedidos".
2. Selecione a requisição: "Pedido PSP | Criar pedido com os dados do cartão de crédito -> Apenas dados obrigatórios (PCI Compliance)".
3. Se desejar verificar todos os parâmetros (obrigatórios e opcionais), utilize a requisição "Pedido PSP | Criar pedido com os dados do cartão de crédito -> Completo (PCI Compliance)". 
4. Altere os dados no corpo da requisição (Body) conforme necessário e clique em "Send".
 

Outros Meios de Pagamento: Ao longo da coleção, há outros exemplos como a criação de pedido com pagamento em Boleto ou Pix.

ℹ️ Códigos de Resposta da API
Nossa API valida cada campo na requisição e utiliza códigos de resposta HTTP padrão para indicar sucesso ou falha na solicitação. Para obter mais detalhes sobre os HTTP Status Code e o Rate Limit (limite máximo de requisições por minuto), clique neste link.
 

4. Notas Importantes (Checklist Final)

Mantenha as seguintes notas em mente ao utilizar a coleção:

• Utilize sempre suas chaves de testes no Postman, lembrando que elas geram apenas vendas fictícias.
• Caso não possua o aplicativo do Postman baixado, você poderá baixá-lo através [deste link].
• A coleção é destinada para cadastros na API V5.
• Verifique ao final de cada requisição, pois pode haver anotações relevantes.
• É altamente recomendado consultar a documentação V5 sempre que utilizar esta coleção: https://docs.pagar.me/reference/pedidos-1 (você também consegue testar por lá, usando suas chaves). 

📎Coleção Pagar.me V5 PSP.postman_collection_2025