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

    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
  • locationPresente
    Type: boolean
  • status
    Type: string enum

    Status of a dynamic charge

    values
    • ATIVA
    • CONCLUIDA
    • REMOVIDA_PELO_USUARIO_RECEBEDOR
    • REMOVIDA_PELO_PSP
  • 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
  • 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
Responses
  • application/json
  • application/json
Request Example for get/cob
curl 'http://localhost/cob?page=0&size=50&sort=' \
  --header 'x-branch: ' \
  --header 'x-account-number: ' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "id": "string",
  "type": "STATIC",
  "txid": "string",
  "status": "ATIVA",
  "revisao": 1,
  "calendario": {
    "criacao": "2026-07-31T17:52:48.655Z",
    "expiracao": 1
  },
  "valor": {
    "original": "string",
    "modalidadeAlteracao": 1
  },
  "chave": "string",
  "devedor": {
    "cpf": "string",
    "cnpj": "string",
    "nome": "string"
  },
  "loc": {
    "id": "string",
    "url": "string"
  },
  "solicitacaoPagador": "string",
  "infoAdicionais": [
    {
      "nome": "string",
      "valor": "string"
    }
  ],
  "pixCopiaECola": "string",
  "qrCodeImage": {
    "contentType": "string",
    "base64": "string"
  },
  "createdAt": "2026-07-31T17:52:48.655Z"
}

Charge retrieved successfully