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)
No Postman, clique no botão "Import" (Importar).
Clique em "Upload Files" (Carregar Arquivos).
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 Secreta de Testes
A chave secreta está acessível na sua Dashboard Pagar.me, no ambiente de testes. Para obtê-la, vá para "Configurações" > "Chaves".
💡 Atenção: Testes são Vendas Fictícias
Lembre-se que as chaves de testes e o ambiente 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
Acesse a pasta "Coleção Pagar.me V5 PSP" na barra lateral.
Selecione a aba "Authorization" (Autorização) da coleção.
Configure o "Type" (Tipo) como "Basic Auth".
Insira sua chave secreta de testes no campo "Username" (deixando a senha vazia).
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:
Acesse a pasta "PAGAMENTOS" > "Pedidos".
Selecione a requisição: "Pedido PSP | Criar pedido com os dados do cartão de crédito -> Apenas dados obrigatórios (PCI Compliance)".
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)".
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. Utilizando os Simuladores para Testar Cenários
É crucial utilizar os simuladores do Pagar.me para testar todos os cenários sem gerar transações reais. Ao clicar neste link, você será direcionado para a página da nossa documentação, contendo informações detalhadas sobre nossos simuladores. É importante saber que o Simulador PSP é destinado a cadastros no modelo PSP, enquanto os demais simuladores são para cadastros no modelo Gateway.
📢 PSP x Gateway: Diferenças
Para entender a diferença, assista ao vídeo: PSP x Gateway: qual é a diferença?. Por padrão, as contas têm o modelo PSP. Para mais informações sobre o modelo de conta Gateway, acesse este link e entre em contato com um especialista.
⚠️ Recomendação para Boleto e Pix
Devido à falta de opções para cenários com boleto e Pix no Simulador PSP no momento, recomendamos utilizar os simuladores de Gateway específicos.
Para usar os simuladores de Gateway, você deve indicar na Dashboard que pretende usá-los:
Acesse "Configurações" > "Meios de Pagamento" e atualize o campo "Modelo de negócio" para "Simulador".
5. 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 no modelo PSP na API V5.
Verifique ao final de cada requisição, pois pode haver anotações relevantes.
É altamente recomendado consultar a documentação do Pagar.me V5 sempre que utilizar esta coleção: https://docs.pagar.me/reference/pedidos-1 (você também consegue testar por lá, usando suas chaves).
Não esqueça de conferir e configurar os simuladores na sua Dashboard, conforme instruído anteriormente.