Get Dynamic Immediate Charge (COB-3)

​

Retrieves a dynamic immediate charge (cob) by its transaction identifier (txid). Returns the complete charge details including status, amount, and QR code payload. Implements Bacen API Pix v2.9.0 specification.

Query Parameters
  • inicio
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • fim
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

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

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
  • paginacao.paginaAtual
    Type: integer Format: int32

    Página corrente (0-based)

  • paginacao.itensPorPagina
    Type: integer Format: int32

    Itens por página

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/cob
curl 'http://localhost:8080/api/cob?inicio=&fim=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "parametros": {
    "inicio": "2026-08-14T09:00:00Z",
    "fim": "2026-08-14T18:00:00Z",
    "cpf": "string",
    "cnpj": "string",
    "locationPresente": true,
    "status": "ATIVA",
    "paginacao": {
      "paginaAtual": 1,
      "itensPorPagina": 1,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "cobs": [
    {
      "id": "string",
      "type": "STATIC",
      "txid": "string",
      "status": "ATIVA",
      "revisao": 1,
      "calendario": {
        "criacao": "2026-09-16T19:14:18.660Z",
        "expiracao": 1
      },
      "valor": {
        "original": "string",
        "modalidadeAlteracao": 1,
        "retirada": {
          "saque": {
            "valor": "string",
            "modalidadeAlteracao": 0,
            "modalidadeAgente": "AGTEC",
            "prestadorDoServicoDeSaque": "string"
          },
          "troco": {
            "valor": "string",
            "modalidadeAlteracao": 0,
            "modalidadeAgente": "AGTEC",
            "prestadorDoServicoDeSaque": "string"
          }
        }
      },
      "chave": "string",
      "devedor": {
        "cpf": "string",
        "cnpj": "string",
        "nome": "string"
      },
      "loc": {
        "id": "string",
        "location": "string",
        "tipoCob": "cob",
        "criacao": "2026-09-16T19:14:18.660Z"
      },
      "location": "string",
      "solicitacaoPagador": "string",
      "infoAdicionais": [
        {
          "nome": "string",
          "valor": "string"
        }
      ],
      "pix": [
        {
          "endToEndId": "E1234567820260713123456789012345",
          "txid": "string",
          "valor": "100.0",
          "componentesValor": {
            "original": {
              "valor": "100.0"
            },
            "saque": {
              "valor": "20.0",
              "modalidadeAgente": "AGTEC",
              "prestadorDoServicoDeSaque": "string"
            },
            "troco": {
              "valor": "20.0",
              "modalidadeAgente": "AGTEC",
              "prestadorDoServicoDeSaque": "string"
            },
            "juros": {
              "valor": "100.0"
            },
            "multa": {
              "valor": "100.0"
            },
            "abatimento": {
              "valor": "100.0"
            },
            "desconto": {
              "valor": "100.0"
            }
          },
          "chave": "string",
          "horario": "2026-09-16T19:14:18.660Z",
          "infoPagador": "string",
          "devolucoes": [
            {
              "id": "devolucao001",
              "rtrId": "D1234567820260713123456789012345",
              "valor": "10.0",
              "natureza": "ORIGINAL",
              "descricao": "string",
              "horario": {
                "solicitacao": "2026-09-16T19:14:18.660Z",
                "liquidacao": "2026-09-16T19:14:18.660Z"
              },
              "status": "EM_PROCESSAMENTO",
              "motivo": "string"
            }
          ]
        }
      ],
      "pixCopiaECola": "string",
      "qrCodeImage": {
        "contentType": "string",
        "base64": "string"
      },
      "createdAt": "2026-09-16T19:14:18.660Z"
    }
  ]
}

Charge retrieved successfully