### Installation

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Instructions for installing the Inter SDK Python package, either by cloning the repository or directly from PyPI.

```bash
git clone https://github.com/inter-co/pj-sdk-python.git
cd pj-sdk-python
pip install -r requirements.txt
```

```bash
pip install pj-sdk-python
```

--------------------------------

### Model Class Example (Balance)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Illustrates the structure of a model class (dataclass) used for SDK responses, using Balance as an example.

```python
from decimal import Decimal

@dataclass
class Balance:
    available: Decimal
    check_blocked: Decimal
    judicially_blocked: Decimal
    administratively_blocked: Decimal
    limit: Decimal

    @staticmethod
    def from_dict(data: Dict) -> 'Balance':
        # ... logic to convert dictionary to Balance object ...
        pass

    def to_dict(self) -> dict:
        # ... logic to convert Balance object to dictionary ...
        pass

# Usage:
saldo_obj = inter_sdk.banking().retrieve_balance()
print(f"Saldo disponível: {saldo_obj.available:.2f}")
```

--------------------------------

### Model Class Example (BillingIssueRequest with Enum)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Demonstrates using Enums for predefined fields within model classes, shown with BillingIssueRequest and PersonType.

```python
from inter_sdk.models.cobranca import BillingIssueRequest, Person, PersonType

# ... define payer data (Person), etc. ...

boleto_request = BillingIssueRequest(
    # ... other data ...
    payer=Person(
        person_type=PersonType.FISICA, # Using the Enum
        # ... other payer data ...
    )
)

resposta = inter_sdk.billing().issue_billing(boleto_request)
```

--------------------------------

### Webhook Callback Payload Example

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

An example of the JSON payload structure that a server configured for webhooks will receive via a POST request.

```JSON
[
  {
    "endToEndId": "E12345678202009091221abcdef12345",
    "txid": "cd1fe328c875481285a6f233ae41b662",
    "chave": "a82d0acf-6cad-42a1-b5d4-4165416545646845",
    "valor": "100.00",
    "horario": "2020-09-10T13:03:33.902Z",
    "infoPagador": "Pagamento serviço X",
    "devolucoes": [
      {
        "id": "D123456",
        "rtrId": "D12345678202009111000abcde123456",
        "valor": "10.00",
        "horario": {
          "solicitacao": "2020-09-11T10:00:00.123Z",
          "liquidacao": "2020-09-11T10:00:05.456Z"
        },
        "status": "DEVOLVIDO"
      }
    ]
  }
]
```

--------------------------------

### Pix Pagamento Callback Example

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/banking.md

An example of a callback payload for a Pix payment, detailing transaction information, status, and recipient details.

```JSON
{
  "chave": "01123456000123",
  "codigoSolicitacao": "c42f0787-02cb-4b31-827e-459ec9d7ece1",
  "dataHoraMovimento": "2023-09-30T17:34:00.663504",
  "dataHoraSolicitacao": "2023-09-30T17:34:00.527",
  "descricaoPagamento": "Pagamento Pix Teste",
  "endToEnd": "E00416968202309302034aqtneKsYCqs",
  "instituicaoDestinatario": "Banco Inter S.A.",
  "recebedor": { "cpfCnpj": "01123456000123", "nome": "João da Silva" },
  "status": "PROCESSADO",
  "tipoMovimentacao": "PAGAMENTO",
  "valor": "0.01"
}
```

--------------------------------

### Paginated Statement Retrieval

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Example of how to handle paginated results when retrieving enriched statements.

```python
page = 0
while True:
    stmt = inter_sdk.banking().retrieve_enriched_statement(
        "2023-01-01", "2023-01-05", None, page, 10
    )
    for tx in stmt.transactions:
        print(tx.transaction_id)
    if page >= stmt.total_pages - 1:
        break
    page += 1
```

--------------------------------

### SDK Initialization

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Demonstrates how to initialize the InterSdk object with necessary credentials and environment settings.

```python
from inter_sdk import InterSdk

inter_sdk = InterSdk(
    environment="PRODUCTION",  # "PRODUCTION" ou "SANDBOX"
    client_id="seu-client-id",
    client_secret="seu-client-secret",
    pfx_path="certificates/production.pfx",
    pfx_password="sua-senha"
)
```

--------------------------------

### Running Functional Tests

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Instructions on how to execute the SDK's functional tests.

```bash
python functional_tests/FunctionalTestsRunner.py
```

--------------------------------

### SDK Python Oficial do Inter

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/README.md

Guia de instalação e uso do SDK Python oficial do Banco Inter.

```Markdown
sdk-python.md: Guia de instalação e uso do SDK Python oficial do Inter.
```

--------------------------------

### DARF Payment Response (200)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/banking.md

Example of a successful response (200) for a DARF payment, including approval details and transaction identifiers.

```JSON
{
  "quantidadeAprovadores": 4,
  "autenticacao": "12345678910433",
  "dataPagamento": "23/01/2022",
  "tipoRetorno": "PAGAMENTO",
  "codigoSolicitacao": "8bbdede4-35db-4ec9-b652-e176841e62c8"
}
```

--------------------------------

### Webhooks para APIs Inter

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/README.md

Informações sobre configuração e uso de Webhooks para as APIs Cobrança, Pix e Banking do Banco Inter.

```Markdown
webhooks.md: Informações sobre configuração e uso de Webhooks para as APIs Cobrança, Pix e Banking.
```

--------------------------------

### API Pix v2

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/README.md

Detalhes da API Pix do Banco Inter, cobrindo Cobranças imediatas e com vencimento.

```Markdown
pix.md: Detalhes da API Pix v2 (Cobranças imediatas e com vencimento).
```

--------------------------------

### Error Handling with SdkException

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Illustrates how to catch and process exceptions raised by the SDK, accessing detailed error information.

```python
from inter_sdk.exceptions import SdkException

try:
    balance = inter_sdk.banking().retrieve_balance()
    print(balance.available)
except SdkException as e:
    print(e.error.title)
    print(e.error.detail)
    for violation in e.error.violations:
        print(f"{violation.property}: {violation.reason}")
```

--------------------------------

### Account Selection

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Shows how to set and use a specific current account when the Inter account has multiple associated accounts.

```python
inter_sdk.set_account("123456")  # Conta 123456
saldo = inter_sdk.banking().retrieve_balance()

inter_sdk.set_account("098765")  # Conta 098765
extrato = inter_sdk.banking().retrieve_statement("2023-09-01", "2023-09-15")
```

--------------------------------

### Retrieving SDK Warnings

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Code to access and print any warnings generated by the SDK.

```python
for warning in inter_sdk.warnings():
    print(warning)
```

--------------------------------

### Pagar Cobrança Imediata (Sandbox)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Simulates the payment of an immediate charge. This endpoint is exclusive to the Sandbox environment. Requires 'pix.write' OAuth scope.

```APIDOC
POST /cob/pagar/{txid}

Parameters:
  - Path Param: txid (string, required)
  - Request Body: { "valor": number } (Amount to pay)

Responses:
  - 201 Created: { "e2e": "string" }
  - 400 Bad Request
  - 403 Forbidden
  - 503 Service Unavailable

OAuth Scope: pix.write
Rate Limit: 10/min (Sandbox)
```

--------------------------------

### Configuração de Webhooks e Notificações

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/README.md

Documentação para a configuração de webhooks e notificações na API do Banco Inter. Detalha como configurar e gerenciar notificações em tempo real.

```APIDOC
webhooks.md:
  - Configuração de webhooks e notificações
```

--------------------------------

### API Pix v2 - Endpoints Base e Autenticação

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Define os endpoints base para produção e sandbox, além dos requisitos de autenticação via token OAuth 2.0 e o uso do header Authorization.

```APIDOC
Endpoints Base:
  Produção: https://cdpj.partners.bancointer.com.br/pix/v2
  Sandbox: https://cdpj-sandbox.partners.bancointer.co/pix/v2

Autenticação:
  Header obrigatório: Authorization: Bearer <access_token>
  Token válido por 60 minutos.
  Header opcional para múltiplas contas: x-conta-corrente: <número_da_conta>
```

--------------------------------

### Autenticação e Obtenção de Token

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/README.md

Documentação para autenticação na API do Banco Inter e obtenção de tokens de acesso. Inclui detalhes sobre os endpoints e parâmetros necessários para o processo de autenticação.

```APIDOC
autenticacao.md:
  - Autenticação e obtenção de token
```

--------------------------------

### API Pix v2 - Criar Cobrança Imediata (txid gerado pelo PSP)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Cria cobranças imediatas onde o txid é gerado pelo Inter. Detalha o endpoint, escopo, rate limit e o corpo da requisição.

```APIDOC
POST /cob

Escopo OAuth: cob.write
Rate Limit: 120/min (Produção), 10/min (Sandbox)

Request Body: Similar ao PUT /cob/{txid}.

Responses:
  201 Created: Cobrança criada com txid gerado. Retorna CobPayload.
  400 Bad Request: CobOperacaoInvalida
  403 Forbidden: AcessoNegado
  503 Service Unavailable: ServicoIndisponivel
```

--------------------------------

### API Pix v2 - Criar Cobrança Imediata com txid

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Permite a criação de cobranças imediatas utilizando um txid definido pelo cliente. Inclui detalhes sobre escopo, rate limit, parâmetros de path, corpo da requisição e respostas.

```APIDOC
PUT /cob/{txid}

Escopo OAuth: cob.write
Rate Limit: 120/min (Produção), 10/min (Sandbox)

Path Param:
  txid (string, required, pattern `[a-zA-Z0-9]{26,35}`): Identificador único da transação.

Request Body (CobPayload):
  calendario (objeto Calendario, required): Expiração da cobrança.
  devedor (objeto CobDevedor, opcional): Dados do devedor.
  loc (objeto Location, opcional): Vincula a uma location existente.
  valor (objeto Valor, required): Valor da cobrança.
  chave (string, required): Chave Pix do recebedor.
  solicitacaoPagador (string, opcional, max 140): Mensagem para o pagador.
  infoAdicionais (array InfoAdicionais, opcional, max 50): Campos adicionais.

Responses:
  201 Created: Cobrança criada. Retorna CobPayload.
  400 Bad Request: CobOperacaoInvalida
  403 Forbidden: AcessoNegado
  404 Not Found: NaoEncontrado (e.g., Location não existe)
  503 Service Unavailable: ServicoIndisponivel
```

--------------------------------

### Esqueleto OpenAPI

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/README.md

Esqueleto básico da especificação OpenAPI, sem definições de endpoints específicos do Inter.

```YAML
openapi.yaml: Esqueleto básico da especificação OpenAPI (não contém definições dos endpoints Inter).
```

--------------------------------

### LoteCobv API Endpoints

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Provides endpoints for consulting batch payment slips (LoteCobv), including summaries, filtering by status, and listing batches. Includes details on scopes, rate limits, parameters, and responses.

```APIDOC
GET /lotecobv/{id}/sumario
  Consultar Sumário do Lote
  - Description: Consulta um sumário do processamento do lote (total, criadas, negadas).
  - OAuth Scope: lotecobv.read
  - Rate Limit: 120/min (Produção), 10/min (Sandbox)
  - Path Param: id (string, required)
  - Responses:
    - 200 OK: Retorna sumário (dataCriacaoProcessamento, statusProcessamento, totalCobrancas, totalCobrancasNegadas, totalCobrancasCriadas).
    - 403 Forbidden.
    - 404 Not Found.
    - 503 Service Unavailable.

GET /lotecobv/{id}/situacao/{situacao}
  Consultar Cobranças do Lote por Situação
  - Description: Consulta as CobVs de um lote filtradas por situação de processamento.
  - OAuth Scope: lotecobv.read
  - Rate Limit: 120/min (Produção), 10/min (Sandbox)
  - Path Params:
    - id (string, required).
    - situacao (string, required, enum EM_PROCESSAMENTO, CRIADA, NEGADA).
  - Responses:
    - 200 OK: Retorna detalhes do lote e a lista cobsv filtrada pela situação.
    - 403 Forbidden.
    - 404 Not Found.
    - 503 Service Unavailable.

GET /lotecobv
  Consultar Lista de Lotes de CobVs
  - Description: Consulta uma lista paginada de lotes criados.
  - OAuth Scope: lotecobv.read
  - Rate Limit: 120/min (Produção), 10/min (Sandbox)
  - Query Params:
    - inicio (datetime, required).
    - fim (datetime, required).
    - paginacao.paginaAtual (integer, opcional, default 0).
    - paginacao.itensPorPagina (integer, opcional, default 100, max 1000).
  - Responses:
    - 200 OK: Retorna objeto com parametros e lista lotes.
    - 400 Bad Request: LoteCobVConsultaInvalida
    - 403 Forbidden: AcessoNegado
    - 503 Service Unavailable: ServicoIndisponivel

Schemas (LoteCobV):
  - LoteCobVPayload: Estrutura principal do lote (descricao, cobsv).
  - CobVSolicitada: Representa uma CobV dentro da requisição de criação/alteração do lote (contém todos os campos de CobVPayload).
  - CobVRevisadaItem: Representa uma CobV dentro da requisição de revisão do lote (contém txid e os campos de CobVPayload a serem revisados).
  - LoteCobVConsultado: Estrutura retornada na consulta de lote (id, descricao, criacao, status, cobsv).
  - CobVProcessada: Representa uma CobV dentro da resposta de consulta de lote (txid, status [EM_PROCESSAMENTO, CRIADA, NEGADA], problema [opcional, RFC 7807]).
  - LoteCobVSumario: Estrutura retornada na consulta de sumário.
```

--------------------------------

### Consulta e Histórico de Transações

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/README.md

Documentação para os endpoints de consulta e histórico de transações na API do Banco Inter. Permite o acesso a informações detalhadas sobre as transações realizadas.

```APIDOC
transacoes.md:
  - Consulta e histórico de transações
```

--------------------------------

### API Pix Callback Query and Retry

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/webhooks.md

Permite consultar o histórico de callbacks Pix enviados e solicitar o reenvio de callbacks específicos. Requer escopo 'webhook.read' para consulta e 'webhook.write' para reenvio. O reenvio suporta até 50 txids por requisição.

```APIDOC
GET /pix/v2/webhook/callbacks
  Consultar callbacks Pix enviados.
  Escopo: webhook.read
  Rate Limit: 10/minuto
  Query Params: dataHoraInicio, dataHoraFim, pagina, tamanhoPagina, txid (opcional).

POST /pix/v2/webhook/callbacks/retry (Beta)
  Reenviar callbacks Pix.
  Escopo: webhook.write
  Rate Limit: 5/minuto
  Body: { "txId": ["..."], "chavePix": "..." } (até 50 txid's)
```

--------------------------------

### API de Cobrança (Boleto com Pix) v3

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/README.md

Detalhes da API de Cobrança do Banco Inter, focada em Boletos com Pix.

```Markdown
cobranca.md: Detalhes da API de Cobrança (Boleto com Pix) v3.
```

--------------------------------

### Endpoints de Pagamentos e Transferências

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/README.md

Documentação para os endpoints de pagamentos e transferências na API do Banco Inter. Abrange as funcionalidades relacionadas a movimentações financeiras.

```APIDOC
pagamentos.md:
  - Endpoints de pagamentos e transferências
```

--------------------------------

### API Pix Webhook Management

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/webhooks.md

Gerencia webhooks para notificações de recebimento Pix e devoluções. Permite registrar, consultar e excluir configurações de webhook para chaves Pix específicas. O escopo necessário é 'webhook.write' ou 'webhook.read'.

```APIDOC
PUT /pix/v2/webhook/{chave}
  Registrar/Atualizar webhook Pix.
  Escopo: webhook.write
  Rate Limit: 10/minuto
  Body: { "webhookUrl": "https://..." }

GET /pix/v2/webhook/{chave}
  Consultar webhook Pix.
  Escopo: webhook.read
  Rate Limit: 10/minuto

DELETE /pix/v2/webhook/{chave}
  Excluir webhook Pix.
  Escopo: webhook.write
  Rate Limit: 10/minuto
```

--------------------------------

### Consultar Lista de Cobranças Imediatas

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Fetches a paginated list of immediate payments with filtering options. Requires 'cob.read' OAuth scope. Supports filtering by date range, CPF/CNPJ, location presence, and status.

```APIDOC
GET /cob

Parameters:
  - Query Params:
    - inicio (datetime, required)
    - fim (datetime, required)
    - cpf (string, opcional)
    - cnpj (string, opcional)
    - locationPresente (boolean, opcional)
    - status (string, opcional, enum ATIVA, CONCLUIDA, REMOVIDA_PELO_USUARIO_RECEBEDOR, REMOVIDA_PELO_PSP)
    - paginacao.paginaAtual (integer, opcional, default 0)
    - paginacao.itensPorPagina (integer, opcional, default 100, max 1000)

Responses:
  - 200 OK: Object with 'parametros' and list 'cobs'
  - 400 Bad Request: CobConsultaInvalida
  - 403 Forbidden: AcessoNegado
  - 503 Service Unavailable: ServicoIndisponivel

OAuth Scope: cob.read
Rate Limit: 120/min (Production), 10/min (Sandbox)
```

--------------------------------

### Endpoints de Gerenciamento de Contas

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/README.md

Documentação referente aos endpoints para gerenciamento de contas na API do Banco Inter. Detalha as operações disponíveis para contas.

```APIDOC
contas.md:
  - Endpoints de gerenciamento de contas
```

--------------------------------

### API Pix v2 - Revisar Cobrança Imediata

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Permite a alteração de dados de uma cobrança imediata existente através do método PATCH. Inclui detalhes sobre o endpoint, parâmetros, corpo da requisição e respostas.

```APIDOC
PATCH /cob/{txid}

Escopo OAuth: cob.write
Rate Limit: 120/min (Produção), 10/min (Sandbox)

Path Param:
  txid (string, required): Identificador da cobrança.

Request Body: Similar ao PUT /cob/{txid}, campos opcionais. Pode incluir status: "REMOVIDA_PELO_USUARIO_RECEBEDOR".

Responses:
  200 OK: Cobrança revisada. Retorna CobPayload atualizado.
  400 Bad Request: CobOperacaoInvalida
  403 Forbidden: AcessoNegado
  404 Not Found: CobNaoEncontrado
  503 Service Unavailable: ServicoIndisponivel
```

--------------------------------

### Listar Transações

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/transacoes.md

Este endpoint permite listar transações. Detalhes sobre a requisição e o formato da resposta ainda precisam ser adicionados.

```APIDOC
GET /transacoes
  Descrição: Lista transações.
  Requisição: TODO: exemplo de chamada GET /transacoes
  Resposta: TODO: formato de resposta
```

--------------------------------

### API Pix v2 - Tratamento de Erros

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Detalha os códigos de status HTTP e o formato das respostas de erro seguindo a RFC 7807, com exemplos de erros comuns.

```APIDOC
Códigos de Status HTTP:
  2xx: Sucesso
  4xx: Erro do cliente
  5xx: Erro do servidor

Formato de Erro (RFC 7807):
  type: Identificador do erro (e.g., https://pix.bcb.gov.br/api/v2/error/CobNaoEncontrado)

Erros Comuns Gerais:
  RequisicaoInvalida (400)
  AcessoNegado (403)
  NaoEncontrado (404)
  ErroInternoDoServidor (500)
  ServicoIndisponivel (503)
```

--------------------------------

### Pagar Cobrança com Vencimento (Sandbox)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Simulates the payment of a CobV. This endpoint is exclusive to the Sandbox environment. Requires 'pix.write' OAuth scope. It takes a transaction ID (txid) and the payment value as input.

```APIDOC
POST /cobv/pagar/{txid}

Path Param:
  txid (string, required)

Request Body:
  { "valor": number }

Responses:
  201 Created: Pagamento simulado. Retorna `{ "e2e": "string" }`.
  400 Bad Request
  403 Forbidden
  503 Service Unavailable
```

--------------------------------

### API Banking Webhook Management

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/webhooks.md

Gerencia o webhook para notificações de eventos da API Banking, como status de pagamentos e recebimentos Pix. Permite registrar, consultar e excluir a URL de notificação. Requer escopo 'webhook.write' ou 'webhook.read'.

```APIDOC
PUT /banking/v2/webhook
  Registrar/Atualizar webhook Banking.
  Escopo: webhook.write
  Body: { "webhookUrl": "https://..." }

GET /banking/v2/webhook
  Consultar webhook Banking.
  Escopo: webhook.read

DELETE /banking/v2/webhook
  Excluir webhook Banking.
  Escopo: webhook.write
```

--------------------------------

### API: Gerenciamento de Cobranças

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/cobranca.md

Documentação completa dos endpoints da API para gerenciar cobranças, incluindo consulta, edição, cancelamento e exportação.

```APIDOC
GET /{codigoSolicitacao}
  Recupera os detalhes completos de uma cobrança específica pelo seu UUID.
  - **Escopo OAuth:** `boleto-cobranca.read`
  - **Rate Limit:** 60 requisições por minuto.
  ### Exemplo de Resposta (200 OK):
  ```json
  {
    "cobranca": {
      "codigoSolicitacao": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "seuNumero": "SN0002",
      "situacao": "A_RECEBER"
    }
  }
  ```

PATCH /{codigoSolicitacao}
  Modifica dados de uma cobrança existente (ex: data de vencimento, valor). Nem todos os campos são editáveis após a emissão.
  - **Escopo OAuth:** `boleto-cobranca.write`
  - **Rate Limit:** 60 requisições por minuto.
  ### Payload (Exemplo - Alterar Vencimento e Valor):
  ```json
  {
    "dataVencimento": "2023-11-30",
    "valorNominal": 160.00
  }
  ```
  ### Resposta (200 OK):
  ```json
  {
    "status": "PROCESSANDO", 
    "mensagem": "Edição solicitada",
    "codigoEdicao": "uuid-da-edicao" 
  }
  ```

POST /{codigoSolicitacao}/cancelar
  Solicita o cancelamento de uma cobrança que ainda não foi paga.
  - **Escopo OAuth:** `boleto-cobranca.write`
  - **Rate Limit:** 60 requisições por minuto.
  ### Payload:
  ```json
  {
    "motivoCancelamento": "CLIENTE_DESISTIU" 
  }
  ```
  ### Resposta (202 Accepted):
  ```json
  {
    "status": "PROCESSANDO", 
    "mensagem": "Cancelamento solicitado"
  }
  ```

GET /{codigoSolicitacao}/pdf
  Obtém o PDF do boleto associado à cobrança.
  - **Escopo OAuth:** `boleto-cobranca.read`
  - **Rate Limit:** 60 requisições por minuto.
  ### Resposta (200 OK):
  - **Headers:** `Content-Type: application/pdf`
  - **Body:** Conteúdo binário do arquivo PDF.

GET /sumario
  Retorna um resumo quantitativo e financeiro das cobranças por situação, baseado nos filtros aplicados.
  - **Escopo OAuth:** `boleto-cobranca.read`
  - **Rate Limit:** 60 requisições por minuto.
  ### Parâmetros de Query:
  - Similares aos da consulta de coleção (`dataInicial`, `dataFinal`, `filtrarDataPor`, `situacao`, `tipoCobranca`, `seuNumero`, `pessoaPagadora`, `cpfCnpjPessoaPagadora`).
  ### Exemplo de Resposta (200 OK):
  ```json
  [
    { "situacao": "A_RECEBER", "valor": 15000.50, "quantidade": 10 },
    { "situacao": "RECEBIDO", "valor": 8500.00, "quantidade": 5 },
    { "situacao": "ATRASADO", "valor": 3200.00, "quantidade": 2 }
  ]
  ```
```

--------------------------------

### Consultar Coleção de Cobranças

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/cobranca.md

Consulta uma lista paginada de cobranças com base em filtros de data, situação, pagador, número, tipo de cobrança e paginação. Retorna detalhes das cobranças, incluindo informações de boleto e Pix se aplicáveis.

```APIDOC
GET /

Escopo OAuth: boleto-cobranca.read
Rate Limit: 60 requisições por minuto.

Parâmetros de Query:
- dataInicial (string, Sim): Data inicial (YYYY-MM-DD)
- dataFinal (string, Sim): Data final (YYYY-MM-DD)
- filtrarDataPor (string, Não): VENCIMENTO (default), EMISSAO, PAGAMENTO, CANCELAMENTO, EXPIRACAO
- situacao (string, Não): RECEBIDO, A_RECEBER, MARCADO_RECEBIDO, ATRASADO, CANCELADO, EXPIRADO, FALHA_EMISSAO, EM_PROCESSAMENTO, PROTESTO
- pessoaPagadora (string, Não): Nome do pagador
- cpfCnpjPessoaPagadora (string, Não): CPF/CNPJ do pagador
- seuNumero (string, Não): Seu número/identificador da cobrança
- tipoCobranca (string, Não): SIMPLES, PARCELADO, RECORRENTE
- paginacao.itensPorPagina (integer, Não): Máx 1000, default 100
- paginacao.paginaAtual (integer, Não): Default 0
- ordenarPor (string, Não): PESSOA_PAGADORA, TIPO_COBRANCA, CODIGO_COBRANCA, IDENTIFICADOR, DATA_EMISSAO, DATA_VENCIMENTO, VALOR, STATUS
- tipoOrdenacao (string, Não): ASC (default), DESC

Exemplo de Resposta (200 OK):
{
  "totalPaginas": 1,
  "totalElementos": 1,
  "tamanhoPagina": 100,
  "primeiraPagina": true,
  "ultimaPagina": true,
  "numeroDeElementos": 1,
  "cobrancas": [
    {
      "codigoSolicitacao": "183e982a-34e5-4bc0-9643-def5432a",
      "seuNumero": "SN12345",
      "dataEmissao": "2023-10-01",
      "dataVencimento": "2023-10-31",
      "valorNominal": 500.00,
      "tipoCobranca": "SIMPLES",
      "situacao": "A_RECEBER",
      "dataSituacao": "2023-10-01",
      "valorTotalRecebido": null,
      "origemRecebimento": null,
      "arquivada": false,
      "boleto": {
        "nossoNumero": "0079...",
        "codigoBarras": "...",
        "linhaDigitavel": "..."
      },
      "pix": {
        "txid": "txid...",
        "pixCopiaECola": "brcode..."
      }
    }
  ]
}
```

--------------------------------

### Emitir Cobrança

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/cobranca.md

Registra uma nova cobrança, que pode incluir um boleto bancário e/ou um QR Code Pix. Requer escopo de escrita e está sujeito a rate limiting.

```APIDOC
POST /

Escopo OAuth: boleto-cobranca.write
Rate Limit: 60 requisições por minuto.
```

--------------------------------

### Webhook Management API

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Provides endpoints for creating, updating, querying, and deleting webhooks associated with Pix keys. Includes details on path parameters, request bodies, and response codes.

```APIDOC
PUT /webhook/{chave}
  Define ou atualiza a URL de webhook para uma chave Pix específica.
  - Escopo OAuth: webhook.write
  - Rate Limit: 10/min (Produção e Sandbox)
  - Path Param: chave (string, required): Chave Pix (EVP, CNPJ, Email, Telefone - sem `+` para telefone).
  - Request Body: { "webhookUrl": uri } (URL HTTPS).
  - Responses:
    - 204 No Content: Sucesso.
    - 400 Bad Request: WebhookOperacaoInvalida
    - 403 Forbidden: AcessoNegado
    - 404 Not Found: Chave Pix não encontrada ou não pertence ao usuário.
    - 503 Service Unavailable: ServicoIndisponivel

GET /webhook/{chave}
  Consulta a URL de webhook configurada para uma chave.
  - Escopo OAuth: webhook.read
  - Rate Limit: 10/min (Produção e Sandbox)
  - Path Param: chave (string, required).
  - Responses:
    - 200 OK: Retorna { "webhookUrl": uri, "chave": string, "criacao": datetime }.
    - 403 Forbidden: AcessoNegado
    - 404 Not Found: WebhookNaoEncontrado
    - 503 Service Unavailable: ServicoIndisponivel

DELETE /webhook/{chave}
  Remove a configuração de webhook para uma chave.
  - Escopo OAuth: webhook.write
  - Rate Limit: 10/min (Produção e Sandbox)
  - Path Param: chave (string, required).
  - Responses:
    - 204 No Content: Sucesso.
    - 403 Forbidden: AcessoNegado
    - 404 Not Found: WebhookNaoEncontrado
    - 503 Service Unavailable: ServicoIndisponivel
```

--------------------------------

### API Cobrança Webhook Management

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/webhooks.md

Gerencia webhooks para notificações de eventos da API Cobrança (Boletos ou Pix via Boleto API), como pagamentos, cancelamentos e expirações. Permite registrar, consultar e excluir a URL de notificação. Requer escopo 'boleto-cobranca.write' ou 'boleto-cobranca.read'.

```APIDOC
PUT /cobranca/v3/cobrancas/webhook
  Registrar/Atualizar webhook Cobrança.
  Escopo: boleto-cobranca.write
  Body: { "webhookUrl": "https://..." }

GET /cobranca/v3/cobrancas/webhook
  Consultar webhook Cobrança.
  Escopo: boleto-cobranca.read

DELETE /cobranca/v3/cobrancas/webhook
  Excluir webhook Cobrança.
  Escopo: boleto-cobranca.write
```

--------------------------------

### Consultar Lista de Cobranças com Vencimento

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Retrieves a paginated list of CobVs with filtering options. Requires 'cobv.read' OAuth scope. Supports filtering by date range, CPF, CNPJ, location, status, pagination, and batch ID.

```APIDOC
GET /cobv

Query Params:
  inicio (datetime, required)
  fim (datetime, required)
  cpf (string, opcional)
  cnpj (string, opcional)
  locationPresente (boolean, opcional)
  status (string, opcional, enum `ATIVA`, `CONCLUIDA`, `REMOVIDA_PELO_USUARIO_RECEBEDOR`, `REMOVIDA_PELO_PSP`)
  paginacao.paginaAtual (integer, opcional, default 0)
  paginacao.itensPorPagina (integer, opcional, default 100, max 1000)
  loteCobVId (integer, opcional): Filtra por ID do lote.

Responses:
  200 OK: Retorna objeto com `parametros` e lista `cobs`.
  400 Bad Request: `CobVConsultaInvalida`
  403 Forbidden: `AcessoNegado`
  503 Service Unavailable: `ServicoIndisponivel`
```

--------------------------------

### Consultar Extrato Simples

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/banking.md

Consulta extrato simples por um período especificado (máximo de 90 dias). Requer autenticação e número da conta no header.

```APIDOC
GET /extrato

Parâmetros de query:
- dataInicio (string, obrigatório): Data inicial (YYYY-MM-DD)
- dataFim (string, obrigatório): Data final (YYYY-MM-DD)

Headers obrigatórios:
- Authorization: Bearer <access_token>
- x-conta-corrente: <número da conta>

Exemplo de resposta (200):
{
  "transacoes": [
    { /* ...transação... */ }
  ]
}
```

--------------------------------

### Criar Cobrança com Vencimento

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Creates a payment with a due date (CobV) using a client-defined transaction ID (txid). Requires 'cobv.write' OAuth scope. Supports detailed configuration of payment terms.

```APIDOC
PUT /cobv/{txid}

Parameters:
  - Path Param: txid (string, required, pattern [a-zA-Z0-9]{26,35})
  - Request Body: CobVPayload (object)
    - calendario (object CalendarioCobV, required)
    - devedor (object CobVDevedor, required)
    - loc (object LocationCobV, opcional)
    - valor (object ValorCobV, required)
    - chave (string, required)
    - solicitacaoPagador (string, opcional, max 140)
    - infoAdicionais (array InfoAdicionaisCobV, opcional, max 50)

Responses:
  - 201 Created: Complete CobVPayload
  - 400 Bad Request: CobVOperacaoInvalida
  - 403 Forbidden: AcessoNegado
  - 404 Not Found: NaoEncontrado
  - 503 Service Unavailable: ServicoIndisponivel

OAuth Scope: cobv.write
Rate Limit: 120/min (Production), 10/min (Sandbox)
```

--------------------------------

### Consultar Pagamentos Realizados

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/banking.md

Consulta pagamentos realizados com filtros por código de barras, transação, período e critério de data. Requer autenticação e número da conta no header.

```APIDOC
GET /pagamento

Parâmetros de query:
- codBarraLinhaDigitavel (string, opcional)
- codigoTransacao (string, opcional)
- dataInicio (string, opcional): Data inicial (YYYY-MM-DD)
- dataFim (string, opcional): Data final (YYYY-MM-DD)
- filtrarDataPor (string, opcional): INCLUSAO, PAGAMENTO, VENCIMENTO

Headers obrigatórios:
- Authorization: Bearer <access_token>
- x-conta-corrente: <número da conta>

Exemplo de resposta (200):
[
  {
    "codigoTransacao": "3414f226-36fb-4d87-811e-cfd99911d845",
    "codigoBarra": "23791908400000545...",
    "tipo": "Pagamento Xpto",
    "dataVencimentoDigitada": "2019-10-10 13:00:00",
    "dataVencimentoTitulo": "2019-10-10 13:00:00",
    "dataInclusao": "2019-10-10 13:00:00",
    "dataPagamento": "2019-10-10 13:00:00",
    "valorPago": 85.9,
    "valorNominal": 85.9,
    "statusPagamento": "EMPROCESSAMENTO",
    "aprovacoesNecessarias": 2,
    "aprovacoesRealizadas": 2,
    "cpfCnpjBeneficiario": "123456789-01",
    "nomeBeneficiario": "João 123",
    "autenticacao": "...",
    "nsu": "82127399"
  }
]
```

--------------------------------

### Request Pix Refund

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/pix.md

Initiates a refund (partial or total) for a received Pix. Requires 'pix.write' OAuth scope.

```APIDOC
PUT /pix/{e2eId}/devolucao/{id}

Requests a refund (partial or total) of a received Pix.

OAuth Scope: pix.write
Rate Limit: 120/min (Production), 10/min (Sandbox)

Path Params:
  e2eId (string, required): End-to-End ID of the Pix transaction.
  id (string, required, pattern `[a-zA-Z0-9]{1,35}`): Unique refund ID defined by the client.

Request Body:
  valor (string<decimal>, required): Amount to be refunded.
  natureza (string, optional, default `ORIGINAL`, enum `ORIGINAL`, `RETIRADA`): Refund nature (for Pix Saque/Troco).
  descricao (string, optional, max 140): Message for the payer.

Responses:
  201 Created: Returns the Devolucao object.
  400 Bad Request: PixDevolucaoInvalida
  403 Forbidden: AcessoNegado
  404 Not Found: PixNaoEncontrado
  503 Service Unavailable: ServicoIndisponivel
```

--------------------------------

### Realizar Pagamento (Boleto, Convênio, Tributo)

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/banking.md

Inclui um pagamento imediato ou agendado de boleto, convênio ou tributo. Requer autenticação e número da conta no header.

```APIDOC
POST /pagamento

Payload:
{
  "codBarraLinhaDigitavel": "string",
  "valorPagar": "string",
  "dataPagamento": "string",
  "dataVencimento": "string",
  "cpfCnpjBeneficiario": "string"
}

Exemplo de resposta (200):
{
  "quantidadeAprovadores": 2,
  "dataAgendamento": "2019-10-10 13:00:00",
  "statusPagamento": "EMPROCESSAMENTO",
  "codigoTransacao": "8bbdede4-35db-4ec9-b652-e176841e62c8"
}
```

--------------------------------

### Consultar Saldo

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/banking.md

Consulta o saldo disponível, bloqueado e limite da conta. Permite filtrar por data. Requer autenticação e número da conta no header.

```APIDOC
GET /saldo

Parâmetros de query:
- dataSaldo (string, opcional): Data para consulta do saldo (YYYY-MM-DD)

Headers obrigatórios:
- Authorization: Bearer <access_token>
- x-conta-corrente: <número da conta>

Exemplo de resposta (200):
{
  "bloqueadoCheque": 240.25,
  "disponivel": 2850.55,
  "bloqueadoJudicialmente": 510.35,
  "bloqueadoAdministrativo": 510.35,
  "limite": 510.35,
  "dataReferencia": "01/01/2024"
}
```

--------------------------------

### Enabling Debug Mode

Source: https://github.com/jeanmrx1/inter-api-docs/blob/main/docs/sdk-python.md

Code snippet to enable or disable debug mode for the SDK.

```python
inter_sdk.set_debug(True)
```