Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-132418.0 KB
PIX

Criar PIX Dinâmico

Cria uma cobrança PIX com QR Code único, valor predefinido e expiração automática. Ideal para e-commerce e pagamentos únicos.

post/v1/charges/pix/dynamic

Request body

amountinteger required

Valor em centavos (R$ 100,00 = 10000)

descriptionstring required

Descrição da cobrança

expires_atstring date-time

Data de expiração (ISO 8601). Se não informado, expira em 30 minutos

external_idstring

ID externo para controle (opcional)

metadataobject

Dados adicionais em formato chave-valor

Example request

{
  "amount": 25000,
  "description": "Compra de curso online - Módulo Avançado",
  "customer": {
    "name": "Maria Silva Santos",
    "document": "123.456.789-09",
    "email": "maria.silva@email.com",
    "phone": "+5511987654321"
  },
  "expires_at": "2024-01-01T15:30:00-03:00",
  "external_id": "pedido_12345",
  "metadata": {
    "produto": "curso_avancado",
    "categoria": "educacao",
    "cupom": "DESCONTO10"
  }
}

Response

PIX Dinâmico criado com sucesso

idstring

ID único da cobrança

status'pending' | 'confirmed' | 'expired' | 'failed'

Status atual da cobrança

amountinteger

Valor em centavos

currencystring
descriptionstring
created_atstring date-time

Example response

{
  "id": "chg_1a2b3c4d5e6f",
  "status": "pending",
  "amount": 25000,
  "currency": "BRL",
  "description": "Compra de curso online",
  "pix": {
    "qr_code": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
    "payload": "00020126580014br.gov.bcb.pix...",
    "txid": "E12345678202401011230123456789",
    "expires_at": "2024-01-01T15:30:00-03:00"
  },
  "customer": {
    "name": "Maria Silva Santos",
    "document": "123.456.789-09",
    "email": "maria.silva@email.com",
    "phone": "+5511987654321"
  },
  "created_at": "2024-01-01T14:30:00-03:00"
}