Pular para o conteúdo principal

Início Rápido

Guia passo a passo para integrar pagamentos PayerScan em sua plataforma.

Passo 1: Criar uma conta​

Acesse a página de registro para criar uma nova conta de comerciante no PayerScan.

Passo 2: Criar uma Loja​

Após fazer login, crie uma nova Loja (Store) no Painel do Comerciante para começar a aceitar pagamentos.

  1. Na barra lateral, clique em API Crypto para abrir a lista de Lojas.
  2. Clique no botão + Create Store.
  3. Preencha as informações da Loja e clique em Create.

Diálogo de criação de Loja

📖 Para instruções detalhadas, consulte o Guia de Criação de Loja.

Passo 3: Obter seu Merchant ID e Chave API​

Após criar a Loja, você verá seu Merchant ID e API Key na lista de Lojas.

Seu Merchant ID e API Key

  • Merchant ID — Identificador único da sua Loja (ex: MID-XXXXXXXXXX). Necessário nas requisições API.
  • API Key — Usada para autenticar requisições API. Clique no ícone de cópia para copiar.
aviso

Mantenha sua API Key segura. Não a exponha em código do lado do cliente ou repositórios públicos.

Passo 4: Configurar endereços de carteira​

Antes de criar faturas, adicione endereços de carteira para receber pagamentos em criptomoedas:

  • Adicione endereços de carteira para receber tokens TRC20/BEP20/...
  • Você pode adicionar múltiplos endereços para a mesma moeda e rede.

📖 Para instruções detalhadas, consulte o Guia de Adição de Carteira.

dica

Se você também deseja aceitar pagamentos via Binance Pay, consulte Configuração Binance Pay.

Passo 5: Configurar seu Backend​

Configure sua lógica backend para lidar com duas partes principais: criar faturas e processar webhooks.

5.1 — API de Criação de Fatura​

Chame a API Criar Fatura para gerar um link de pagamento:

curl -X POST "https://api.payerscan.com/payment/crypto" \
     -H "Content-Type: application/json" \
     -H "x-api-key: YOUR_API_KEY" \
     -d '{
        "merchant_id": "MID-XXXXXXXXXX",
        "amount": 100,
        "name": "Order #123456",
        "description": "Payment for shop order",
        "callback_url": "https://your-server.com/webhook/payment",
        "completed_url": "https://your-website.com/thank-you",
        "expired_url": "https://your-website.com/",
        "request_id": "ORDER_123456"
     }'

Redirecione o usuário para o link url_payment gerado na resposta.

5.2 — Rastrear status de pagamento​

Existem duas formas de rastrear o status de pagamento de uma fatura:

  • Webhook (⭐ Recomendado): O PayerScan envia automaticamente uma requisição POST para seu callback_url quando uma fatura é paga ou expirada. É uma abordagem push em tempo real — seu servidor recebe notificações instantaneamente sem precisar de polling. Basta expor um endpoint público e processar o payload recebido.

    📖 Para instruções detalhadas, consulte o Guia de Webhook.

  • API Get Invoice: Se você prefere uma abordagem pull, pode chamar a API Get Invoice para verificar manualmente o status atual de qualquer fatura a qualquer momento usando seu trans_id. Útil para verificações sob demanda, reconciliação de pedidos, ou como fallback quando webhooks estão atrasados.

    📖 Para instruções detalhadas, consulte o Get Invoice.

Passo 6: Crie sua primeira fatura​

Quando seu backend estiver pronto, crie sua primeira fatura para testar o fluxo de pagamento completo. Verifique que:

  • A página de pagamento carrega corretamente através do link url_payment.
  • Seu endpoint webhook recebe o callback quando o pagamento é concluído ou expirado.
  • Seu sistema atualiza o status do pedido adequadamente.