High-level API

API

class inter.Inter(*, client_id=None, client_secret=None, cert_path=None, key_path=None, client=None)[source]

Bases: object

Inicializa utilizando as credenciais ou um Client.

Parameters
  • client_id (str) – Client ID

  • client_secret (str) – Client Secret

  • cert_path (str) – Caminho do arquivo de certificado

  • key_path (str) – Caminho do arquivo de chave

  • client (Client) – Ao invés de inicializar com as credenciais é possivel passar um Client já inicializado. Útil para testes.

get_balance(date=None)[source]

Retorna o saldo disponível da conta em determinado dia.

Parameters

date (datetime.date) – data do saldo

Returns

saldo disponível

Return type

decimal.Decimal

get_statement(start_date, end_date)[source]

Busca extrato da conta referente as datas recebidas.

Parameters
  • start_date (datetime.date) – data inicial do extrato

  • end_date (datetime.date) – data final do extrato

Returns

lista de operações do periodo

Return type

List[Operation]

pay_barcode(barcode, value, due_date, payment_date=None)[source]

Pagamento imediato ou agendado de títulos com código de barras.

Necessita do Scopes.WRITE_PAYMENT.

Parameters
  • barcode (str) – código de barras (somente números)

  • value (str) – valor do título

  • due_date (datetime.date) – data de vencimento

  • payment_date (datetime.date, opcional) – data de pagamento, se não informado, será o mesmo dia.

Returns

Retorno do pagamento

Return type

Payment

class inter.Operation(date: date, description: str, title: str, type: str, value: Decimal)[source]

Bases: object

CREDIT = 'C'
DEBIT = 'D'
PAYMENT = 'PAGAMENTO'
PIX = 'PIX'
TYPES = ('PAGAMENTO', 'PIX')
date: date

Data da operação

description: str

Descrição da Operação

classmethod from_data(data)[source]

Transforma dados retornados da API em um objeto Operation.

Parameters

data (dict) – dicionário com dados de uma operação

Returns

Operação

Return type

Operation

title: str

Título da Operação

type: str

Tipo da operação. Exemplo: PAYMENT, PIX, etc.

value: Decimal

Valor da operação. Positivo se for crédito, negativo se for débito

class inter.Payment(approvers_number: int, status: str, transaction_id: str, scheduled_date: Optional[date] = None)[source]

Bases: object

APPROVED = 'APROVADO'
DONE = 'REALIZADO'
SCHEDULED = 'AGENDADO'
SCHEDULED_DONE = 'AGENDADO_REALIZADO'
STATUSES = ('REALIZADO', 'AGENDADO', 'AGUARDANDO_APROVACAO', 'APROVADO', 'AGENDADO_REALIZADO')
WAITING_APPROVAL = 'AGUARDANDO_APROVACAO'
approvers_number: int

Quantidade de Aprovadores necessários

classmethod from_data(data)[source]

Transforma dados retornados da API em um objeto Payment.

Parameters

data (dict) – dicionário com dados de um pagamento

Returns

Resultado do pagamento

Return type

Payment

scheduled_date: Optional[date]

Data agendada para finalizar pagamento

status: str

Status do Pagamento. Examplo DONE, SCHEDULED, etc.

transaction_id: str

Código da Transação

Testing