Skip to main content
Uma transação representa uma cobrança PIX gerada pelo Bob Payments. Ela inclui o código copia-e-cola, dados do cliente, valor, status e qual gateway processou o pagamento.

​
O objeto transação

{
  "id": "clx7a8b9c0d1e2f3g4h5",
  "externalId": "pedido_123",
  "pixCode": "00020126580014br.gov.bcb.pix...",
  "status": "waiting_payment",
  "amountCents": 10000,
  "product": "Plano Premium",
  "quantity": 1,
  "expirationDate": "2026-01-16T10:30:00.000Z",
  "paidAt": null,
  "refundedAt": null,
  "isSandbox": false,
  "createdAt": "2026-01-16T10:00:00.000Z",
  "updatedAt": "2026-01-16T10:00:00.000Z",
  "customer": {
    "id": "cly1234567890",
    "name": "João Silva",
    "document": "12345678900",
    "email": "[email protected]",
    "phone": "11999999999"
  }
}

​
Campos

CampoTipoDescrição
idstringIdentificador único da transação (CUID)
externalIdstring | nullID externo do seu sistema, se enviado
pixCodestringCódigo PIX copia-e-cola — exiba ao cliente ou converta em QR Code
statusstringStatus atual. Veja os valores possíveis abaixo
amountCentsintegerValor da cobrança em centavos (10000 = R$ 100,00)
productstringNome do produto ou serviço
quantityintegerQuantidade. Default: 1
expirationDatestringData/hora de expiração do PIX (ISO 8601)
paidAtstring | nullData/hora do pagamento confirmado. null se ainda não pago
refundedAtstring | nullData/hora do estorno. null se não estornado
isSandboxbooleantrue se a transação foi criada em sandbox
createdAtstringData/hora de criação (ISO 8601)
updatedAtstringData/hora da última atualização (ISO 8601)
customerobjectDados do cliente vinculado à transação

​
Status

ValorDescriçãoFinal?
waiting_paymentPIX gerado, aguardando pagamentoNão
processingPagamento em processamentoNão
paidPagamento confirmadoSim
expiredPIX expirou sem pagamentoSim
cancelledTransação canceladaSim
refundedPagamento estornadoSim
failedFalha no processamentoSim
Transações em status final não podem ser alteradas. Ao consultar uma transação expirada, o status é atualizado automaticamente.

​
Regras importantes

  • Idempotência: se já existe uma transação waiting_payment com os mesmos dados (cliente, valor e produto), ela é retornada em vez de criar uma nova — sem cobrança duplicada.
  • Expiração automática: o tempo padrão é 30 minutos, configurável por projeto (5 a 1440 minutos).
  • Gateway automático: você não escolhe o gateway — o Bob roteia para o melhor disponível com failover automático.
  • Valores em centavos: amountCents: 10000 = R$ 100,00.
  • Ambiente pelo token: use sk_test_ para sandbox, sk_live_ para produção. O campo isSandbox confirma o ambiente da transação.

Precisa de ajuda?

Nossa equipe está disponível para auxiliar no processo de desenvolvimento. Entre em contato pelo e-mail [email protected].