Pular para o conteúdo principal

​
Endpoint

POST https://api.bunny.build/api/v1/pix-qr

​
Autenticação

HeaderObrigatórioValor
X-API-KeySimSua chave de API (bun_...)
Content-TypeSimapplication/json

​
Visão geral

Gere strings PIX Copia e Cola válidas e QR codes escaneáveis para o sistema de pagamento instantâneo brasileiro. Forneça uma chave PIX, nome do beneficiário, cidade e valor opcional para receber um payload totalmente compatível e uma imagem QR code em base64 pronta para incorporar no seu checkout, fatura ou recibo.

​
Casos de uso

  • Incorporar QR code PIX em páginas de checkout para pagamento instantâneo
  • Gerar links de doação para organizações sem fins lucrativos e campanhas
  • Automatizar a geração de faturas com IDs de transação únicos
  • Habilitar fluxos de pagamento entre pessoas em aplicativos fintech

​
Corpo da requisição

CampoTipoObrigatórioDescrição
keystringSimChave PIX: número de telefone, CPF, e-mail ou EVP (chave aleatória)
namestringSimNome do beneficiário (máx. 25 caracteres)
citystringSimCidade do beneficiário (máx. 15 caracteres)
amountnumberNãoValor em BRL. Omita para transações de valor aberto
descriptionstringNãoDescrição da transação (máx. 72 caracteres)
txidstringNãoID da transação para conciliação

​
Exemplo

{
  "key": "11999887766",
  "name": "Bunny Build",
  "city": "Sao Paulo",
  "amount": 10.00
}

​
Resposta

​
200 OK

CampoTipoDescrição
payloadstringString PIX Copia e Cola (formato EMV)
qr_base64stringImagem QR code PNG em base64
mime_typestringTipo MIME da imagem QR code
keystringChave PIX utilizada
namestringNome do beneficiário
citystringCidade do beneficiário
amountnumberValor em BRL, se fornecido
Exemplo 
{
  "payload": "00020126330014BR.GOV.BCB.PIX0111119998877665204000053039865406100.005802BR5911Bunny Build6009Sao Paulo62070503***6304ABCD",
  "qr_base64": "iVBORw0KGgoAAAANSUhEUgAA...",
  "mime_type": "image/png",
  "key": "11999887766",
  "name": "Bunny Build",
  "city": "Sao Paulo",
  "amount": 10.00
}

​
401 Unauthorized

{
  "detail": "Missing API key. Include X-API-Key header."
}

​
402 Payment Required

{
  "detail": "Monthly quota exceeded. Upgrade your plan."
}

​
422 Unprocessable Entity

{
  "detail": "Fields 'key', 'name', and 'city' are required."
}

​
429 Too Many Requests

{
  "detail": "Rate limit exceeded. Try again in 60 seconds."
}

​
Exemplo cURL

curl -X POST https://api.bunny.build/api/v1/pix-qr \
  -H "X-API-Key: bun_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"key": "11999887766", "name": "Bunny Build", "city": "Sao Paulo", "amount": 10.00}'