Postman Collection

Guia completo para usar a collection oficial da Mises API no Postman.

Download da Collection

A collection oficial da Mises API está disponível em formato JSON e pode ser importada diretamente no Postman.

Importar no Postman

1. Abra o Postman
2. Clique em Import no canto superior esquerdo
3. Selecione a aba Raw text
4. Cole o JSON da collection (disponível abaixo)
5. Clique em Import

Variáveis da Collection

A collection utiliza variáveis para facilitar o uso e evitar repetição de valores:

Variável	Descrição	Valor Padrão
base_url	URL base da API	https://api.misespay.com
client_id	Seu Client ID	(configure com suas credenciais)
client_secret	Seu Client Secret	(configure com suas credenciais)
access_token	Token JWT (preenchido automaticamente)	(vazio inicialmente)
sale_id	ID da última venda criada	(preenchido automaticamente)
withdrawal_id	ID do último saque criado	(preenchido automaticamente)
idempotency_key	Chave de idempotência (gerada automaticamente)	(gerado automaticamente)

Configurar Credenciais

1. Clique na collection Mises PIX API
2. Vá para a aba Variables
3. Edite os valores de client_id e client_secret
4. Clique em Save

SEGURANÇA

Nunca compartilhe sua collection com as credenciais preenchidas. Use variáveis de ambiente do Postman para dados sensíveis.

Fluxo de Uso

1. Autenticação

Execute a requisição Gerar Token na pasta Autenticação:

POST {{base_url}}/auth

O que acontece:

• Envia client_id e client_secret
• Recebe access_token
• Script automático salva o token na variável access_token
• Token é usado automaticamente nas próximas requisições

Script de teste (já incluído):

if (pm.response.code === 200) {
  var jsonData = pm.response.json();
  pm.collectionVariables.set("access_token", jsonData.access_token);
  pm.test("Token salvo com sucesso", function () {
    pm.expect(jsonData.access_token).to.not.be.empty;
  });
}

2. Criar Venda PIX

Execute a requisição Criar Venda PIX na pasta Vendas:

POST {{base_url}}/v1/sales

O que acontece:

• Usa o access_token automaticamente
• Cria uma venda com QR Code PIX
• Script automático salva o sale_id

Script de teste (já incluído):

if (pm.response.code === 201) {
  var jsonData = pm.response.json();
  pm.collectionVariables.set("sale_id", jsonData.id);
  pm.test("Venda criada com sucesso", function () {
    pm.expect(jsonData.id).to.not.be.empty;
    pm.expect(jsonData.qrcode_text).to.not.be.empty;
  });
}

3. Buscar Venda

Execute a requisição Buscar Venda por ID na pasta Vendas:

GET {{base_url}}/v1/sales/{{sale_id}}

Usa automaticamente o sale_id da venda criada anteriormente.

4. Consultar Saldo

Execute a requisição Get Balance na pasta Saldo:

GET {{base_url}}/v1/balance

Retorna saldo total, disponível e retido.

5. Criar Saque

Execute a requisição Create Withdrawal na pasta Saques:

POST {{base_url}}/v1/withdrawals

O que acontece:

• Script de pré-requisição gera UUID v4 para idempotency_key
• Usa o access_token automaticamente
• Cria o saque
• Script de teste salva o withdrawal_id

Script de pré-requisição (já incluído):

// Gerar UUID v4 para Idempotency-Key
const uuid = require("uuid");
pm.collectionVariables.set("idempotency_key", uuid.v4());

Script de teste (já incluído):

pm.test("Status code is 201 or 200", function () {
  pm.expect(pm.response.code).to.be.oneOf([200, 201]);
});

pm.test("Response has withdrawal_id", function () {
  var jsonData = pm.response.json();
  pm.expect(jsonData.data).to.have.property("withdrawal_id");
  pm.collectionVariables.set("withdrawal_id", jsonData.data.withdrawal_id);
});

Autenticação Automática

A collection está configurada com Bearer Token no nível da collection:

Authorization: Bearer {{access_token}}

Isso significa que todas as requisições (exceto /auth) usam automaticamente o token.

Como funciona:

1. Execute Gerar Token
2. Token é salvo em
3. Todas as próximas requisições usam esse token automaticamente

Scripts Automáticos

Testes Automáticos

Cada requisição tem testes que validam:

• Status code correto
• Campos obrigatórios presentes
• Valores salvos em variáveis

Execute e veja os resultados na aba Test Results.

Pré-requisições

Algumas requisições executam scripts antes de enviar:

• Create Withdrawal: Gera idempotency_key único

Exemplos de Resposta

Cada requisição inclui exemplos de resposta para:

• ✅ Sucesso
• ❌ Erros comuns

Veja na aba Examples de cada requisição.

Testando Idempotência

Para testar idempotência em saques:

1. Execute Create Withdrawal uma vez
2. NÃO execute novamente imediatamente (o script gera nova chave)
3. Para testar idempotência:
   • Copie o valor de
   • Execute novamente
   • Cole o mesmo valor de idempotency_key no header
   • Você receberá status 200 OK com "idempotent": true

Variáveis de Ambiente (Recomendado)

Para maior segurança, use Environments ao invés de variáveis da collection:

Criar Environment

1. Clique no ícone de Environments (olho)
2. Clique em Add
3. Nomeie como "MisesPay Production"
4. Adicione as variáveis:

base_url: https://api.misespay.com
client_id: seu_client_id_aqui
client_secret: seu_client_secret_aqui
access_token: (deixe vazio)

5. Selecione o environment antes de usar

Vantagens

• ✅ Credenciais não ficam salvas na collection
• ✅ Fácil alternar entre ambientes (dev/prod)
• ✅ Compartilhe a collection sem expor credenciais

Troubleshooting

Token Expirado

Erro:

{
  "error": "Unauthorized",
  "message": "Invalid or expired token"
}

Solução: Execute novamente Gerar Token.

Idempotency-Key Ausente

Erro:

{
  "success": false,
  "message": "Header Idempotency-Key é obrigatório"
}

Solução: Certifique-se de que o script de pré-requisição está ativado.

Saldo Insuficiente

Erro:

{
  "success": false,
  "message": "Saldo insuficiente para realizar o saque"
}

Solução:

1. Execute Get Balance para verificar saldo
2. Crie vendas para adicionar saldo
3. Tente sacar um valor menor

Collection JSON

Para baixar a collection completa, acesse:

https://github.com/misespay/postman-collection

Ou copie o JSON fornecido pela equipe MisesPay.

Recursos Adicionais

Runner (Executar em Lote)

Use o Collection Runner para executar todas as requisições em sequência:

1. Clique nos três pontos da collection
2. Selecione Run collection
3. Configure a ordem e iterações
4. Clique em Run

Monitores

Configure monitores para executar a collection periodicamente:

1. Clique nos três pontos da collection
2. Selecione Monitor collection
3. Configure frequência e notificações

Documentação Automática

Gere documentação automática da collection:

1. Clique nos três pontos da collection
2. Selecione View documentation
3. Clique em Publish

Próximos Passos

• Authentication - Entenda a autenticação
• Withdrawals - Documentação de saques
• Idempotency - Entenda idempotência