Acessar minha contaAbrir uma conta
GET/api/v2/cobranca/cob

Listar

Lista cobranças imediatas (Cob) com paginação. Scope: cob.read. Itens no array cobs.

Parâmetros

AcceptObrigatório
header
Tipo:string
inicioOpcional
query

Filtro início (ISO 8601)

Tipo:string
fimOpcional
query

Filtro fim (ISO 8601)

Tipo:string
cpfOpcional
query
Tipo:string
cnpjOpcional
query
Tipo:string
statusOpcional
query
Tipo:string
paginacao.paginaAtualOpcional
query
Tipo:integer
paginacao.itensPorPaginaOpcional
query
Tipo:integer

Autenticação e scopes

Requer Bearer token com scope cob.read.

Query (opcionais)

ParâmetroDescrição
inicio / fimIntervalo de criação (ISO 8601)
cpf / cnpjFiltro por documento do devedor
statusStatus da cobrança (ATIVA, EFETIVADO, etc.)
paginacao.paginaAtual / paginacao.itensPorPaginaPaginação

Retorno 200

Envelope paginado com array cobs (mesma estrutura de GET /cob/{txid} por item) + correlationId, currentPage, lastPage, perPage, total.

Códigos de resposta

CódigoSignificado
200OK
401Token inválido ou expirado
403Scope cob.read ausente

Notas

curl --location 'https://api-h.nuvende.com.br/api/v2/cobranca/cob' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{access_token}}'

{
  "cobs": [
    {
      "txid": "JsI6bA0QTb42rycbB8u6UzULCJHR2lC7QZd",
      "revisao": 0,
      "status": "ATIVA",
      "calendario": {
        "criacao": "2024-10-04T21:42:56.000000Z",
        "expiracao": 86400
      },
      "valor": {
        "original": "10.01",
        "modalidadeAlteracao": 0
      },
      "qrCode": "00020101021226730014br.gov.bcb.pix...",
      "chave": "e3fe4462-4c8e-42c1-8360-b41b404ae557",
      "pix": []
    }
  ],
  "correlationId": "ca387ccd-4904-4eb0-8b5e-c304776b6592",
  "currentPage": 1,
  "lastPage": 1,
  "perPage": 10,
  "total": 1
}