/api/v1/charges/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

  • cpfCnpj
    Type: string
  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ACTIVE
    • COMPLETED
    • EXPIRED
    • REMOVED_BY_RECEIVER
    • REMOVED_BY_PSP
  • lotecobvid
    Type: string Format: uuid
  • 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/api/v1/charges/cobv
curl 'http://localhost:8080/api/v1/charges/cobv?page=0&size=50&sort=' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "items": [
    {
      "id": "string",
      "type": "STATIC",
      "txid": "string",
      "status": "ACTIVE",
      "revision": 1,
      "key": "string",
      "calendar": {
        "createdAt": "2026-07-29T19:28:46.545Z",
        "dueDate": "2026-07-29",
        "validAfterDueDays": 1
      },
      "amount": {
        "original": "string",
        "abatement": {
          "mode": "NONE",
          "value": "string"
        },
        "discount": {
          "mode": "NONE",
          "fixedDateDiscounts": [
            {
              "date": "2026-07-29",
              "value": "string"
            }
          ],
          "value": "string"
        },
        "interest": {
          "mode": "NONE",
          "value": "string"
        },
        "fine": {
          "mode": "NONE",
          "value": "string"
        }
      },
      "merchant": {
        "name": "string",
        "city": "string",
        "taxId": "string"
      },
      "payerRequest": "string",
      "additionalInfo": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "location": {
        "id": "string",
        "url": "string"
      },
      "brCode": "string",
      "qrCodeImage": {
        "contentType": "string",
        "base64": "string"
      },
      "createdAt": "2026-07-29T19:28:46.545Z"
    }
  ],
  "totalItems": 1,
  "page": 1,
  "size": 1,
  "totalPages": 1,
  "hasNext": true
}

OK