Documentação da API

Nossos endpoints permitem criar cobranças, consultar pagamentos e verificar saldos. Todas as requisições devem ser autenticadas com um token no header X-API-Token que pode ser gerado na aba carteira.

URL Base: https://pixbitcoin.org/

Criar Pagamento

POST /api/create-payment

Cria uma nova cobrança Pix para depósito. O QR Code gerado tem validade de 10 minutos. O valor recebido pode ser convertido automaticamente para as criptomoedas DEPIX, BTC e USDt conforme as taxas abaixo.

Estrutura de Taxas de Conversão

Bitcoin (L-BTC)
Taxa 6% sobre a cotação do momento.
Dólar Theter (USDt)
Taxa de 2% sobre a cotação do momento.
DePix
Taxa de 2% no momento do saque.

Uma taxa fixa de R$ 1,00 adicionada a cada depósito.


Parâmetros do Body:

  • value Valor em BRL (Ex: "150.75"). Min R$10(USDt e Depix) e R$20(Bitcoin), Max R$5.000. De acordo com Limites
  • email E-mail da conta do cliente que receberá o saldo.
  • swap_to opcional Define a moeda de conversão automática. Opções: BTC, USDt, DEPIX.

EXEMPLO DE REQUISIÇÃO (cURL)

curl -X POST https://pixbitcoin.org/api/create-payment \
  -H "X-API-Token: <seu_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "250.00",
    "email": "cliente@example.com",
    "swap_to": "BTC"
  }'

EXEMPLO DE RESPOSTA (JSON)

{
  "id": "4fbbd7a-c1b1-4f3b-8a3b-18a0b0e5d8d6",
  "qrCopyPaste": "0002012666...",
  "qrImageUrl": "https://api.pixbitcoin.org/qrcodes/4fbb.../image.png",
  "expiresAt": "2025-07-19T16:33:12Z",
  "status": "waiting_payment"
}

Consultar Pagamento

GET /api/get-payment/{payment_id}

Verifica o status de um pagamento específico usando o id retornado na criação.

Status Possíveis:

  • waiting_payment: Aguardando o pagamento do Pix.
  • pending: Pagamento recebido e aguardando confirmações.
  • under_review: Pagamento recebido, mas em análise manual.
  • depix_sent: Pagamento confirmado e valor creditado na sua conta.
  • canceled: O pagamento foi cancelado pelo sistema ou usuário.
  • expired: O tempo para pagamento do QR Code expirou.
  • refunded: O valor do pagamento foi devolvido ao pagador.
  • error: Ocorreu um erro inesperado no processamento.

EXEMPLO DE REQUISIÇÃO (cURL)

curl https://pixbitcoin.org/api/get-payment/4fbb... \
  -H "X-API-Token: <seu_token>"

EXEMPLO DE RESPOSTA (JSON)

{
  "qrId": "4fbbd7a-c1b1-4f3b-8a3b-18a0b0e5d8d6",
  "status": "depix_sent",
  "payerName": "Fulano de Tal",
  "payerTaxNumber": "12345678901",
  "amount": 25000,
  "updatedAt": "2025-07-19T16:35:02Z"
}

Obter Saldo

GET /api/get-balance

Retorna os saldos disponíveis em todas as moedas para a conta associada ao token.

EXEMPLO DE REQUISIÇÃO (cURL)

curl https://pixbitcoin.org/api/get-balance \
  -H "X-API-Token: <seu_token>"

EXEMPLO DE RESPOSTA (JSON)

{
  "email": "cliente@example.com",
  "balances": {
    "DEPIX": {
      "available_cents": 12345,
      "available_brl": "R$ 123,45"
    },
    "BTC": {
      "available_sats": 987654,
      "available_btc": "0.00987654"
    },
    "USDt": {
      "available_cents_USDt": 2500000,
      "available_USDt": "2.500000"
    }
  }
}

Códigos de Status HTTP

  • 200 OK - Requisição bem-sucedida.
  • 400 Bad Request - Erro de validação nos dados enviados.
  • 401 Unauthorized - Token de API ausente ou inválido.
  • 403 Forbidden - Acesso negado para o recurso.
  • 404 Not Found - Recurso não encontrado.