Skip to main content

Bem-vindo

A API MisesPay permite integrar o processamento de pagamentos em suas aplicações. Esta documentação cobre todos os endpoints disponíveis para gerenciar clientes, projetos, cobranças, transações e pagamentos PIX.

URL Base

Todas as requisições devem ser feitas para:

Autenticação

A autenticação é feita em duas etapas: você troca as credenciais da sua conta por um access token de curta duração e envia esse token no header Authorization de cada requisição.

1. Obtenha suas credenciais

Crie uma credencial de API no Dashboard. Ela é composta por um client_id e um client_secret:
  • mp_live_* — credencial de produção
  • mp_test_* — credencial de sandbox
O client_secret é exibido uma única vez, no momento da criação. Guarde-o em local seguro.

2. Gere um access token

Troque suas credenciais por um token no endpoint de autenticação:
Resposta
Credenciais inválidas ou revogadas retornam 401 {"error": "Unauthorized", "message": "Invalid credentials"}.

3. Use o token nas requisições

Envie o token no header Authorization:
O token expira em 300 segundos (5 minutos). Gere um novo token no /auth quando ele expirar — não há refresh token.

Permissões

Cada credencial possui permissões granulares que determinam quais endpoints ela pode acessar. As permissões são atribuídas no momento da criação da credencial.

Permissões disponíveis

A permissão FULL_ACCESS concede acesso a todos os endpoints, equivalente a possuir todas as permissões listadas acima.

Restrição por IP

Opcionalmente, você pode restringir uma credencial a uma lista de IPs permitidos. Quando a lista está configurada, requisições originadas de IPs fora dela são rejeitadas com erro 403 Forbidden. Recomendamos configurar a restrição de IP em credenciais com permissões sensíveis, como FULL_ACCESS e WITHDRAWAL:WRITE.

Recursos Disponíveis

PIX

Criar cobranças PIX

Webhooks

Receber notificações de eventos

Projetos

Organizar pagamentos por projeto

Saques

Criar saques via PIX

Transações

Visualizar detalhes de transações

Conta

Consultar dados da conta e saldo