PushPag API
    • Bem-vindo à PushPag API
    • Autenticação
      • Gerar Token de Acesso
        POST
    • Transações
      • Criar Cobrança PIX
        POST
      • Consultar Status da Transação
        GET
    • Utilitários
      • Verificar Token
        GET
    • Raiz
    • Esquemas
      • AuthRequest
      • AuthResponse
      • CreateTransactionRequest
      • CustomerRequest
      • ItemRequest
      • TransactionResponse
      • Transaction
      • PixData
      • CustomerResponse
      • ItemResponse
      • Error
      • ValidationErrorResponse

    Bem-vindo à PushPag API

    Integre cobranças PIX ao seu sistema em minutos.

    URL Base#

    https://api.pushpag.com/v1

    Fluxo rápido de integração#

    1. Gere suas chaves no painel  →  pk_... e sk_...
    2. POST /auth/token            →  Bearer Token (60 min)
    3. POST /transactions          →  Cria cobrança, recebe QR Code
    4. GET  /transactions/{id}     →  Polling de status (PENDING → PAID)

    Autenticação#

    Todas as rotas protegidas exigem um Bearer Token no header:

    Como obter o token#

    1.
    Acesse Painel → Integrações e gere suas chaves de API
    2.
    Faça POST /auth/token com public_key e secret_key
    3.
    Use o token retornado em todas as requisições subsequentes
    ⚠️ Segurança: nunca exponha sua secret_key no frontend ou em repositórios públicos. Sempre realize a autenticação no seu servidor backend.
    O token expira em 60 minutos. Basta requisitar um novo quando necessário — não há limite de tokens por hora.

    Exemplo completo em PHP#


    Valores monetários#

    Todos os valores (amount) são em centavos (inteiros, sem casas decimais):
    ReaisCentavos
    R$5,00500
    R$19,901990
    R$99,999999
    Valor mínimo por transação: R$5,00 (500)

    Webhooks#

    Configure postbackUrl ao criar uma transação para receber notificações automáticas quando o status mudar. Responda com HTTP 200 para confirmar o recebimento — caso contrário, novas tentativas serão realizadas.
    Payload recebido no seu endpoint:
    {
      "event": "transaction.paid",
      "data": {
        "id": "f1da0134-...",
        "status": "PAID",
        "amount": 1990,
        "paidAt": "2025-12-11T14:09:22.000Z",
        "metadata": { "sellerExternalRef": "pedido-00123" }
      }
    }

    Status de transação#

    StatusDescriçãoAção sugerida
    PENDINGAguardando pagamentoContinuar polling
    PAIDPago com sucesso ✅Liberar produto/acesso
    EXPIREDQR Code expirado sem pagamentoCriar nova cobrança
    FAILEDFalha no processamentoNotificar cliente
    REFUNDEDEstornadoRegistrar estorno

    Erros#

    A API usa códigos HTTP padrão. O corpo de erro segue o formato:
    { "message": "Descrição legível", "code": "CODIGO_MAQUINA" }
    HTTPcodeSituação
    401MISSING_TOKENHeader Authorization ausente
    401INVALID_TOKENToken inválido ou expirado
    401INVALID_CREDENTIALSpk/sk incorretos
    404TRANSACTION_NOT_FOUNDID não encontrado
    422VALIDATION_ERRORCampos inválidos
    502GATEWAY_ERRORFalha com gateway de pagamento
    Modificado em 2026-04-06 07:00:03
    Próxima página
    Gerar Token de Acesso
    Built with