Consultar cobro
Devuelve el cobro por el txid. El pago se lee en status (CONCLUIDA) y en ex.situacaoFundos.
GET /v2/cob/{txid}
Alcance: 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"
}
Un cobro pagado responde status: CONCLUIDA y el bloque ex:
GET /v2/cob/FIN02J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
"txid": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
"revisao": 1,
"status": "CONCLUIDA",
"valor": { "original": "150.00" },
"ex": {
"endToEndId": "E12345678202609181200000000000001",
"situacaoFundos": "CREDITADO"
}
}
| Campo | Tipo | Descripción |
|---|---|---|
ex.endToEndId |
string | Identificador del Pix en la liquidación. Es el que se usa en la devolución. |
ex.situacaoFundos |
string | CREDITADO es saldo disponible. RETIDO está bloqueado. EM_DEVOLUCAO está volviendo al pagador y no se convierte en saldo. DEVOLVIDO volvió al pagador. Solo CREDITADO es saldo. |
ex.subconta |
string | Subcuenta que recibe, cuando el cobro se creó con ella. |
ex.splitConfig |
string | Configuración de split del cobro, cuando la haya. |
Con ex.subconta o ex.splitConfig, el bloque ex ya viene antes del pago, con situacaoFundos y endToEndId vacíos.
El Pix recibido #
El mismo pago se puede leer por el endToEndId.
GET /v2/pix/{e2eId}
Alcance: 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 | Descripción |
|---|---|---|
ex.titularidadeOk |
booleano | true cuando el pagador es el titular del cobro. Solo aparece cuando se realizó la verificación. |
Cuando quien paga es una persona jurídica, devedor y pagador traen cnpj en lugar de cpf.
GET /v2/pix?inicio=...&fim=... lista los Pix recibidos en un intervalo, en el formato estándar del Banco Central.
Errores #
| Estado | title |
Cuándo |
|---|---|---|
| 404 | nao_encontrado |
El txid no existe en esta cuenta. |