Consultar cobrança

Devolve a cobrança pelo txid. O pagamento se lê em status (CONCLUIDA) e em ex.situacaoFundos.

GET /v2/cob/{txid}

Escopo: cob.read.

GET /v2/cob/COB01J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "txid": "COB01J1ZK7M9QW3ERT5TY6UI8O",
  "revisao": 0,
  "status": "ATIVA",
  "calendario": { "criacao": "2026-09-18T12:00:00.767Z", "expiracao": 900 },
  "devedor": { "cpf": "12345678909", "nome": "Fulano de Tal" },
  "valor": { "original": "150.00" },
  "chave": "01J8Z3QK5W7R2N4M6P8T0V2X4Y",
  "solicitacaoPagador": "Pedido 778812",
  "pixCopiaECola": "00020126480014br.gov.bcb.pix0126...6304C057"
}

Uma cobrança paga responde status: CONCLUIDA e o bloco ex:

GET /v2/cob/FIN02J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
  "txid": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
  "revisao": 1,
  "status": "CONCLUIDA",
  "valor": { "original": "150.00" },
  "ex": {
    "endToEndId": "E12345678202609181200000000000001",
    "situacaoFundos": "CREDITADO"
  }
}

Campo	Tipo	Descrição
`ex.endToEndId`	string	Identificador do Pix na liquidação. É ele que entra na devolução.
`ex.situacaoFundos`	string	`CREDITADO` é saldo disponível. `RETIDO` está bloqueado. `EM_DEVOLUCAO` está voltando ao pagador e não vira saldo. `DEVOLVIDO` voltou ao pagador. Só `CREDITADO` é saldo.
`ex.subconta`	string	Sub-conta que recebe, quando a cobrança foi criada com ela.
`ex.splitConfig`	string	Configuração de split da cobrança, quando houver.

Com ex.subconta ou ex.splitConfig, o bloco ex já vem antes do pagamento, com situacaoFundos e endToEndId vazios.

O Pix recebido #

O mesmo pagamento pode ser lido pelo endToEndId.

GET /v2/pix/{e2eId}

Escopo: pix.read.

GET /v2/pix/E12345678202609181200000000000001
→ 200
{
  "endToEndId": "E12345678202609181200000000000001",
  "txid": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
  "valor": "150.00",
  "horario": "2026-09-18T12:00:00Z",
  "pagador": { "cpf": "12345678909" },
  "ex": { "situacaoFundos": "CREDITADO", "ispbPagador": "00000000" }
}

Campo	Tipo	Descrição
`ex.titularidadeOk`	booleano	`true` quando o pagador é o titular da cobrança. Só aparece quando a conferência rodou.

Quando quem paga é pessoa jurídica, devedor e pagador trazem cnpj no lugar de cpf.

GET /v2/pix?inicio=...&fim=... lista os Pix recebidos num intervalo, no formato padrão do Banco Central.

Erros #

Status	`title`	Quando
404	`nao_encontrado`	O `txid` não existe nesta conta.