⌘K

Consultar Cobrança

Consulta uma cobrança recorrente pelo txid, incluindo o histórico de status e as tentativas de liquidação.

GET/cobr/{txid}

Consulta os dados completos de uma cobrança recorrente. Requer o scope cobr.read. Retorna 200 com a cobrança e o array de tentativas de liquidação. Caso não exista, retorna 404 (CobRNaoEncontrado).

Base URL: https://api.pix.basspago.com.br

Headers

Header	Valor	Descricao
`Authorization`	Bearer {access_token}	Token de acesso obtido via OAuth2 (scope cobr.read)

Parametros de Rota

Nome	Tipo	Descricao
`txid`	string	Identificador da transação (padrão [a-zA-Z0-9]{26,35})

Exemplo de Response

{
  "txid": "3136957d93134f2184b369e8f1c0729d",
  "idRec": "RR1234567820260801abcdefghijk",
  "status": "ATIVA",
  "infoAdicional": "Serviço de streaming — ciclo 08/2026",
  "calendario": {
    "criacao": "2026-08-01T10: 30: 00.000Z",
    "dataDeVencimento": "2026-08-15"
  },
  "valor": {
    "original": "35.00"
  },
  "politicaRetentativa": "PERMITE_3R_7D",
  "ajusteDiaUtil": true,
  "devedor": {
    "cep": "89256140",
    "cidade": "Uberlândia",
    "email": "cliente@mail.com",
    "logradouro": "Alameda Franco 1056",
    "uf": "MG"
  },
  "recebedor": {
    "agencia": "9708",
    "conta": "012682",
    "tipoConta": "CORRENTE"
  },
  "atualizacao": [
    {
      "data": "2026-08-01T10: 30: 00.000Z",
      "status": "CRIADA"
    },
    {
      "data": "2026-08-05T08: 00: 00.000Z",
      "status": "ATIVA"
    }
  ],
  "tentativas": [
    {
      "dataLiquidacao": "2026-08-15",
      "tipo": "AGND",
      "status": "AGENDADA",
      "endToEndId": "E12345678202608151221abcdef12345",
      "atualizacao": [
        {
          "data": "2026-08-05T08: 00: 00.000Z",
          "status": "SOLICITADA"
        },
        {
          "data": "2026-08-05T08: 00: 05.000Z",
          "status": "AGENDADA"
        }
      ]
    }
  ]
}

Exemplos de Codigo

curl -X GET https://api.pix.basspago.com.br/cobr/3136957d93134f2184b369e8f1c0729d \
  --cert ./client.crt \
  --key ./client.key \
  -H "Authorization: Bearer {access_token}"

Tentativas de Liquidação

O array tentativas registra cada tentativa de liquidação da cobrança. Cada item traz a dataLiquidacao, o tipo da tentativa, o status atual, o endToEndId (quando o pagamento já foi iniciado) e o histórico em atualizacao.

Tipos de Tentativa

Tipo	Descrição
`AGND`	Tentativa agendada original, criada na data de vencimento da cobrança
`NTAG`	Nova tentativa agendada (retentativa solicitada pelo recebedor)
`RIFL`	Retentativa por indisponibilidade ou falha no fluxo de liquidação

Status da Tentativa

Status	Descrição
`SOLICITADA`	Tentativa de liquidação solicitada, aguardando agendamento
`AGENDADA`	Tentativa agendada no PSP do pagador para a dataLiquidacao
`PAGA`	Liquidação realizada com sucesso
`CANCELADA`	Tentativa cancelada (por exemplo, quando a cobrança é cancelada)
`REJEITADA`	Tentativa rejeitada pelo PSP do pagador (por exemplo, saldo insuficiente)
`EXPIRADA`	Tentativa não liquidada na data prevista e substituída ou encerrada