Skip to main content

​
Endpoints

Explore e teste os principais endpoints da API Pública do PagueBit diretamente abaixo. Utilize o playground interativo para simular requisições e visualizar respostas em tempo real.

​
Criar pagamento dinâmico

POST /api-public/payments

​
Parâmetros do corpo (JSON)

​
amount
number
required
Valor entre 5 e 3000 (BRL)
​
email
string
E-mail do cliente
​
observation
string
Observação livre
​
webhookUrl
string
URL para receber webhooks

​
Resposta de sucesso

​
id
string
required
ID do pagamento criado
​
status
string
required
Status do pagamento (pending, approved, etc)
​
amount
number
required
Valor do pagamento
​
storeId
string
required
ID da loja
​
createdAt
string
required
Data de criação (ISO)
​
webhookUrl
string
URL do webhook
​
observation
string
Observação livre
​
email
string
E-mail do cliente
​
qrCodeUrl
string
URL do QR Code
​
qrCopyPaste
string
Código copia e cola do Pix
​
isPublic
boolean
required
Indica se o pagamento é público (sempre true para pagamentos criados pela API pública)

​
Exemplo de resposta

{
  "id": "pay_123",
  "status": "pending",
  "amount": 150.0,
  "storeId": "store_abc",
  "createdAt": "2025-12-16T15:00:00.000Z",
  "webhookUrl": "https://example.com/webhook",
  "observation": "Pedido #9876",
  "email": "cliente@example.com",
  "qrCodeUrl": "https://.../qrcode.png",
  "qrCopyPaste": "000201010212...",
  "isPublic": true
}

​
Possíveis erros

  • Valor mínimo permitido para API pública é R$ 5,00.
  • Valor máximo permitido para API pública é R$ 3000,00.

​
Buscar pagamento por ID

GET /api-public/payments/

​
Parâmetros de rota

​
id
string
required
ID do pagamento a ser buscado

​
Resposta de sucesso

​
id
string
required
ID do pagamento
​
status
string
required
Status do pagamento
​
amount
number
required
Valor do pagamento
​
storeId
string
required
ID da loja
​
createdAt
string
required
Data de criação (ISO)
​
webhookUrl
string
URL do webhook
​
observation
string
Observação livre
​
email
string
E-mail do cliente
​
qrCodeUrl
string
URL do QR Code
​
qrCopyPaste
string
Código copia e cola do Pix
​
isPublic
boolean
required
Indica se o pagamento é público (true se foi criado pela API pública, false caso contrário)

​
Exemplo de resposta

{
  "id": "pay_123",
  "status": "pending",
  "amount": 150.0,
  "storeId": "store_abc",
  "createdAt": "2025-12-16T15:00:00.000Z",
  "webhookUrl": "https://example.com/webhook",
  "observation": "Pedido #9876",
  "email": "cliente@example.com",
  "qrCodeUrl": "https://.../qrcode.png",
  "qrCopyPaste": "000201010212...",
  "isPublic": true
}

​
Possíveis erros

  • Pagamento não encontrado.

​
Listar pagamentos por loja

GET /api-public/payments

​
Parâmetros de query

​
page
int
default:"1"
Página (≥ 1)
​
limit
int
default:"50"
Itens por página (1–200)
​
status
string
Filtra por pending, approved, review, not_approved

​
Resposta de sucesso

​
items
array
required
Lista de pagamentos
​
page
int
required
Página atual
​
limit
int
required
Limite de itens por página
​
total
int
required
Total de pagamentos encontrados

​
Exemplo de resposta

{
  "items": [
    {
      "id": "pay_123",
      "status": "approved",
      "amount": 150.0,
      "storeId": "store_abc",
      "createdAt": "2025-12-16T15:00:00.000Z",
      "webhookUrl": "https://example.com/webhook",
      "observation": "Pedido #9876",
      "email": "cliente@example.com",
      "qrCodeUrl": "https://.../qrcode.png",
      "qrCopyPaste": "000201010212...",
      "isPublic": true
    },
    {
      "id": "pay_456",
      "status": "pending",
      "amount": 200.0,
      "storeId": "store_abc",
      "createdAt": "2025-12-16T16:00:00.000Z",
      "webhookUrl": null,
      "observation": null,
      "email": "outrocliente@example.com",
      "qrCodeUrl": null,
      "qrCopyPaste": null,
      "isPublic": false
    }
  ],
  "page": 1,
  "limit": 50,
  "total": 237
}
⚠️ Atenção: Todos os endpoints exigem autenticação via Bearer Token.
Consulte a seção de Autenticação para saber como obter e usar seu token.