Get charge
Returns the charge by its txid. The payment is read in status (CONCLUIDA) and in ex.situacaoFundos.
GET /v2/cob/{txid}
Scope: 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"
}
A paid charge responds status: CONCLUIDA and the ex block:
GET /v2/cob/FIN02J1ZK7M9QW3ERT5TY6UI8O
→ 200
{
"txid": "FIN02J1ZK7M9QW3ERT5TY6UI8O",
"revisao": 1,
"status": "CONCLUIDA",
"valor": { "original": "150.00" },
"ex": {
"endToEndId": "E12345678202609181200000000000001",
"situacaoFundos": "CREDITADO"
}
}
| Field | Type | Description |
|---|---|---|
ex.endToEndId |
string | Identifier of the Pix at settlement. It is the one that goes into the refund. |
ex.situacaoFundos |
string | CREDITADO is available balance. RETIDO is on hold. EM_DEVOLUCAO is going back to the payer and does not become balance. DEVOLVIDO went back to the payer. Only CREDITADO is balance. |
ex.subconta |
string | Sub-account that receives, when the charge was created with one. |
ex.splitConfig |
string | Split configuration of the charge, when there is one. |
With ex.subconta or ex.splitConfig, the ex block already comes before the payment, with situacaoFundos and endToEndId empty.
The received Pix #
The same payment can be read by its endToEndId.
GET /v2/pix/{e2eId}
Scope: 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" }
}
| Field | Type | Description |
|---|---|---|
ex.titularidadeOk |
boolean | true when the payer is the holder of the charge. It only appears when the check ran. |
When the payer is a legal entity, devedor and pagador carry cnpj instead of cpf.
GET /v2/pix?inicio=...&fim=... lists the Pix received in an interval, in the standard Central Bank of Brazil format.
Errors #
| Status | title |
When |
|---|---|---|
| 404 | nao_encontrado |
The txid does not exist in this account. |