Legacy: Consultar Transação

Consultar uma transação PIX legada por ID

Endpoint legado — será desabilitado em breve. Migre para POST /v2/account/transactions/list (mais flexível, com filtros e paginação). Após a data de descontinuação, esta rota retornará 410 Gone e novas integrações devem usar exclusivamente o endpoint moderno.

Requer autenticação

POST/v2/consult-transaction

Consulta uma transação PIX específica pelo pix_id. Retorna status numérico (legacy) e dados básicos da operação.

Parâmetros

pix_idstringobrigatório

ID interno da transação PIX (mesmo valor que transaction_id em rotas modernas).

Status legend (legacy)

Code	Label moderno	Significado
`0`	`pending`	Aguardando pagamento
`1`	`confirmed`	Pago / liquidado
`3`	`manual_review`	Em análise manual (compliance/AML)
`5`	`cancelled`	Cancelada (expiração ou cancelamento explícito)
`6`	`sending`	Em processamento (cashout PIX)
`99`	`failed`	Falhou

Erros

Código	HTTP	Descrição
`MISSING_REQUIRED_FIELD`	400	`pix_id` ausente
`TRANSACTION_NOT_FOUND`	404	`pix_id` não encontrado ou não pertence à credencial

cURL

PHP

JavaScript

Python

curl -X POST https://api.bspay.co/v2/consult-transaction \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"pix_id": "9a18e703b3f5db3d2704401f5f49c9ab"}'

Resposta 200 — formato legacy

{
  "transactionId": "9a18e703b3f5db3d2704401f5f49c9ab",
  "external_id": "order_001",
  "amount": 100.00,
  "currency": "BRL",
  "status": 1,
  "status_label": "confirmed",
  "e2e_id": "E17028875202604301400ABC123",
  "payer": {
    "name": "João Silva",
    "document": "12345678901"
  },
  "created_at": "2026-04-30T10:00:00Z",
  "confirmed_at": "2026-04-30T10:00:04Z"
}

Note que o response não tem o envelope success/data — é um payload "achatado" característico das rotas legadas.

AnteriorLegacy: PIX Payment (Cashout)PróximoRate Limiting