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
- 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 extratoend_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ítulodue_date (
datetime.date
) – data de vencimentopayment_date (
datetime.date
, opcional) – data de pagamento, se não informado, será o mesmo dia.
- Returns
Retorno do pagamento
- Return type
- 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
- title: str
Título da Operação
- 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
- scheduled_date: Optional[date]
Data agendada para finalizar pagamento
- transaction_id: str
Código da Transação