List charges by tax ID and type

​

Retrieves a paginated list of charges for a given tax ID (CPF/CNPJ) filtered by type (STATIC, DYNAMIC, or DYNAMIC_DUE_DATE). Supports pagination via query parameters: page (default: 0), size (default: 50, max: 500), sort (e.g., sort=createdAt,desc).

Path Parameters
  • taxId
    Type: string
    required

    Tax ID (CPF or CNPJ) of the charge owner

Query Parameters
  • type
    Type: string enum
    required

    Type of QR Code to filter

    Type of QR Code

    values
    • STATIC
    • DYNAMIC
    • DYNAMIC_DUE_DATE
    • UNKNOWN
  • pagination
    Type: object ·
    required

    Pagination parameters (page, size, sort)

    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
  • x-branch
    Type: string
    required

    Branch of the charge owner account

  • x-account-number
    Type: string
    required

    Number of the charge owner account

  • Idempotency-Key
    Type: string
    required

    Unique idempotency key

Responses
  • application/json
  • application/json
Request Example for get/cob/legacy/{taxId}
curl 'http://localhost/cob/legacy/12345678901?type=STATIC&page=0&size=50&sort=' \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "string",
  "type": "STATIC",
  "key": "string",
  "value": "string",
  "merchant": {
    "nome": "string",
    "cidade": "string",
    "taxId": "string",
    "endereco": {
      "logradouro": "string",
      "cidade": "string",
      "uf": "string",
      "cep": "string"
    }
  },
  "txid": "string",
  "additionalInfo": "string",
  "brCode": "string",
  "createdAt": "2026-07-31T17:52:48.626Z"
}

Paginated list of charges retrieved successfully