Skip to main content

​
PrimePix API v1

A PrimePix API permite criar cobranças PIX, acompanhar pagamentos em tempo real e gerenciar o saldo da sua conta de forma simples e segura. Exemplo de resposta do endpoint raiz da API: 
{
  "status": "online",
  "message": "PrimePix API v1 está funcionando",
  "version": "1.0.0",
  "baseUrl": "https://api.primepix.me/v1",
  "endpoints": {
    "pix_create": "/v1/pix/create",
    "pix_status": "/v1/pix/status/:id",
    "balance": "/v1/balance",
    "transactions": "/v1/transactions",
    "withdraw": "/v1/withdraw"
  }
}

​
Comece em minutos

Configure a integração e crie sua primeira cobrança PIX rapidamente.

Comece aqui

Siga o guia de primeiros passos para obter suas credenciais e chamar seu primeiro endpoint.

​
Fluxo básico da integração

Da criação da cobrança ao recebimento do valor na sua conta PrimePix.

Autenticação

Veja como usar X-API-Key e X-API-Secret em cada requisição.

Criar cobrança PIX

Gere um QR Code PIX ou código copia-e-cola para os seus clientes.

Acompanhar status

Consulte o status de uma cobrança: pending, paid, expired e outros.

Saldo, transações e saques

Veja como consultar saldo, listar transações e solicitar saques da sua conta.

​
Referência completa da API

Explore todos os endpoints disponíveis na PrimePix API v1.

Visão geral da API

Entenda a estrutura da API, base URL, padrões de resposta e códigos de erro.

Endpoints de conta

Documentação detalhada de /balance, /transactions e /withdraw.

​
Próximos passos

Ir para o dashboard

Acesse o Dashboard PrimePix para obter credenciais, acompanhar cobranças e visualizar relatórios.