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

Listar

Lista cobranças com vencimento (Cobv). Scope: cobv.read. Itens no array cobv.

Parâmetros

AcceptObrigatório
header
Tipo:string
inicioOpcional
query
Tipo:string
fimOpcional
query
Tipo:string
cpfOpcional
query
Tipo:string
cnpjOpcional
query
Tipo:string
statusOpcional
query
Tipo:string

Autenticação e scopes

Limitação (Cobv): rotas Cobv exigem cobv.read e cobv.write. Se esses scopes não constarem no token após o login, a API responde 403. Não use cob.read ou cob.write como substituto.

Requer Bearer token com scope cobv.read.

Retorno 200

Envelope paginado com array cobv + metadados de página (correlationId, currentPage, lastPage, perPage, total).

Cada item inclui txid, status, calendario.dataDeVencimento, valor, devedor, chave, loc (quando aplicável).

Notas

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

{
  "cobv": [
    {
      "txid": "G8kSgU5AVIX1y4CZJaHdjb3lo",
      "revisao": 0,
      "status": "ATIVA",
      "calendario": {
        "criacao": "2024-10-04T21:42:56.000000Z",
        "dataDeVencimento": "2026-08-15",
        "validadeAposVencimento": 30
      },
      "devedor": {
        "nome": "Maria Pagadora Exemplo",
        "cpf": "11144477735"
      },
      "valor": { "original": "150.00" },
      "qrCode": "00020101021226730014br.gov.bcb.pix...",
      "chave": "e3fe4462-4c8e-42c1-8360-b41b404ae557",
      "solicitacaoPagador": "Fatura 123",
      "loc": {
        "id": 1,
        "location": "https://pix.example.com/cobv/abc",
        "tipoCob": "cobv"
      },
      "pix": []
    }
  ],
  "correlationId": "ca387ccd-4904-4eb0-8b5e-c304776b6592",
  "currentPage": 1,
  "lastPage": 1,
  "perPage": 10,
  "total": 1
}