/cobv

​
Query Parameters
  • inicio
    Type: string Format: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • fim
    Type: string Format: date

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • cpf
    Type: string
  • cnpj
    Type: string
  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
  • loteCobVId
    Type: string
  • lotecobvid
    Type: string
    deprecated

    Deprecated alias of loteCobVId (pre-Bacen wire name)

  • pagination
    Type: object ·
    required

    Pagination and sorting parameters

    • page
      Type: integer Format: int32

      Page number (zero-based)

    • size
      Type: integer Format: int32
      max:  
      500

      Number of items per page (max: 500)

    • sort
      Type: array string[]

      Sort criteria in the format 'field,direction' (e.g., 'createdAt,desc')

Headers
  • Idempotency-Key
    Type: string
    required
Responses
  • application/json
Request Example for get/cobv
curl 'http://localhost/cobv?page=0&size=50&sort=' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "items": [
    {
      "id": "string",
      "type": "STATIC",
      "txid": "string",
      "status": "ATIVA",
      "revisao": 1,
      "chave": "string",
      "calendario": {
        "criacao": "2026-07-31T12:59:10.382Z",
        "dataDeVencimento": "2026-07-31",
        "validadeAposVencimento": 1
      },
      "valor": {
        "original": "string",
        "multa": {
          "modalidade": "1",
          "valorPerc": "string"
        },
        "juros": {
          "modalidade": "1",
          "valorPerc": "string"
        },
        "abatimento": {
          "modalidade": "1",
          "valorPerc": "string"
        },
        "desconto": {
          "modalidade": "1",
          "descontoDataFixa": [
            {
              "data": "2026-07-31",
              "valorPerc": "string"
            }
          ],
          "valorPerc": "string"
        }
      },
      "devedor": {
        "cpf": "string",
        "cnpj": "string",
        "nome": "string"
      },
      "recebedor": {
        "nome": "string",
        "cidade": "string",
        "taxId": "string",
        "endereco": {
          "logradouro": "string",
          "cidade": "string",
          "uf": "string",
          "cep": "string"
        }
      },
      "solicitacaoPagador": "string",
      "infoAdicionais": [
        {
          "nome": "string",
          "valor": "string"
        }
      ],
      "loc": {
        "id": "string",
        "url": "string"
      },
      "pix": [
        {
          "endToEndId": "string",
          "txid": "string",
          "valor": "string",
          "horario": "2026-07-31T12:59:10.382Z",
          "infoPagador": "string"
        }
      ],
      "pixCopiaECola": "string",
      "qrCodeImage": {
        "contentType": "string",
        "base64": "string"
      },
      "createdAt": "2026-07-31T12:59:10.382Z"
    }
  ],
  "totalItems": 1,
  "page": 1,
  "size": 1,
  "totalPages": 1,
  "hasNext": true
}

OK