FullPix Transactions API
    FullPix Transactions API
    • Introdução e Autenticação
    • Validação de Webhooks
    • Pix In
      • Transactions
        • Webhooks
        • Estornar transação
        • Criar nova transação
        • Obter detalhes de uma transação
    • Pix Out
      • Withdrawals
        • Webhooks
        • Criar Saque

    Introdução e Autenticação

    📘 Introdução à API FullPix#

    A API FullPix foi desenvolvida para simplificar a integração de pagamentos instantâneos via Pix, oferecendo uma arquitetura RESTful moderna, padronizada e de fácil implementação.
    Todas as respostas são retornadas em JSON, permitindo uma comunicação clara, leve e compatível com qualquer linguagem de programação.

    🔐 Autenticação#

    Método de Acesso#

    A autenticação na FullPix é feita através do método Basic Authorization, utilizando dois identificadores:
    Username: sua Secret Key
    Password: sua Public Key
    Essas chaves garantem que apenas integrações autorizadas possam se comunicar com a API.

    Como Obter Suas Credenciais#

    1.
    Acesse o Painel FullPix
    2.
    Vá até API/Webhook → Chave de API
    3.
    Copie:
    A Secret Key, que será usada como username
    A Public Key, que será usada como password

    Implementando a Autenticação#

    Cada requisição à API deve conter o cabeçalho HTTP Authorization, no formato Basic {base64_encoded_credentials}.
    O valor {base64_encoded_credentials} é o resultado da codificação Base64 da string:
    {SECRET_KEY}:{PUBLIC_KEY}

    🟦 Exemplo em Node.js (TypeScript)#


    🟨 Exemplo em PHP#


    💻 Exemplo em cURL#


    🚫 Erros de Autenticação#

    Caso as credenciais estejam incorretas ou expiradas, a API responderá com:
    HTTP 401 Unauthorized
    Resposta:
    Unauthorized

    🌐 Endpoint Base#

    A URL base para todas as requisições da API é:
    https://api.fullpix.com.br/functions/v1

    ⚙️ Recursos Disponíveis#

    Atualmente, a FullPix disponibiliza os seguintes módulos principais:
    Transações PIX-IN: criação e consulta de transações Pix-In.
    Transações PIX-OUT: criação e consulta de transações Pix-Out.
    Acesse a documentação completa para detalhes de cada endpoint, parâmetros e respostas.

    🔒 Boas Práticas de Segurança#

    ✅ Nunca exponha sua Secret Key ou Public Key em aplicações cliente (front-end, apps, etc.)
    ✅ Guarde suas chaves em ambiente seguro (ex: variáveis de ambiente, cofre de segredos)
    ✅ Utilize sempre HTTPS para garantir a integridade e confidencialidade da comunicação
    Modificado em 2025-11-07 05:23:45
    Próxima página
    Validação de Webhooks
    Built with