A API de Extratos da Grafeno oferece uma série de funcionalidades projetadas para facilitar a gestão das contas e operações financeiras associadas à sua conta Grafeno.
Obtenha o saldo e o extrato da sua conta Grafeno de forma simples e dinâmica através da nossa API de extratos!
A API de extratos da Grafeno possuí 3 recursos:
- Saldos: Obtenha os saldos de sua conta;
- Movimentações: Obtenha o extrato de sua conta Grafeno;
- Contas: Obtenha uma lista de todas as contas que você é participante.
A seguir, detalhamos as principais funcionalidades oferecidas pelos três endpoints principais
Listar Contas Bancárias:
- Lista todas as contas bancárias vinculadas à sua conta Grafeno, incluindo Conta Empresa, Conta Vinculada (Escrow) e Conta Escrow Flex.
- Fornece detalhes como número da conta, titularidade, tipo e status.
Obter Saldo da Conta Grafeno:
- Consulta o saldo atual da sua conta Grafeno em tempo real.
- Inclui informações sobre saldo disponível e saldo bloqueado.
Listar todas as movimentações das contas associadas:
- Lista todas as movimentações das contas associadas.
- Permite filtrar por data, tipo de transação e valor.
- Fornece detalhes de cada movimentação, como data, valor e beneficiário.
Retorno para a listagem de contas bancárias
| Parâmetro | Descrição | Tipo |
|---|---|---|
| id | Identificador único da conta bancária. | String |
| type | Tipo de conta, sempre ipBankAccount para este endpoint. | String |
| attributes.agency | Número da agência da conta bancária. | String |
| attributes.account | Número da conta bancária. | String |
| attributes.bank | Código do banco da conta bancária. | String |
| attributes.companyName | Nome da empresa titular da conta. | String |
| attributes.documentNumber | Número do documento da empresa (CNPJ). | String |
| attributes.mover.moverDocumentNumber | Número do documento do movimentador da conta. | String |
| attributes.mover.moverCompanyName | Nome do movimentador da conta. | String |
| attributes.approver.approverDocumentNumber | Número do documento do aprovador da conta. | String |
| attributes.approver.approverCompanyName | Nome do aprovador da conta. | String |
| attributes.associatedFund | Fundo associado à conta (se aplicável). | String |
| attributes.viewers | Visualizadores autorizados da conta (se aplicável). | String |
| attributes.roles | Papéis associados à conta ("owner", "mover", "approver") | Array |
Retorno para consulta de saldo
| Parâmetro | Descrição | Tipo |
|---|---|---|
| id | Identificador único da entrada no extrato. | String |
| type | Tipo de resposta, sempre balance para este endpoint. | String |
| attributes.currentBalance | Saldo atual da conta. | String |
| attributes.availableBalance | Saldo disponível para uso imediato. | String |
| attributes.initialBalance | Saldo inicial no período especificado. | String |
| attributes.finalBalance | Saldo final no período especificado. | String |
| meta.search.entryAtGteq | Data de início do período de busca. | String |
| meta.search.entryAtLteq | Data de término do período de busca. | String |
Retorno para extrato da conta
| Parâmetro | Descrição | Tipo |
|---|---|---|
| id | Identificador único da entrada no extrato. | String |
| type | Tipo de entrada, sempre statementEntry para este endpoint. | String |
| attributes.entryAt | Data e hora da entrada. | String |
| attributes.kind | Tipo de transação (por exemplo, "PIX Enviado"). | String |
| attributes.bankAccount.name | Nome do titular da conta bancária. | String |
| attributes.bankAccount.documentNumber | Número do documento do titular da conta bancária. | String |
| attributes.value | Valor da transação. | String |
| attributes.apiPartnerTransactionUuid | UUID da transação do parceiro API. | String |
| attributes.balance | Saldo da conta após a transação. | String |
| meta.search.entryAtGteq | Filtro para entradas a partir desta data. | String |
| meta.search.entryAtLteq | Filtro para entradas até esta data. | String |
Tipos de movimentações
| Transação | Tipo |
|---|---|
| Estorno de TED | chargeback |
| Estorno do Envio PIX | pix_sent_chargeback |
| Custos | costs |
| TED Recebida | entry |
| TEF Recebida | tef_entry |
| Estorno de TEF recebida | tef_entry_chargeback |
| PIX Recebido | pix_entry |
| Estorno PIX recebido | pix_entry_chargeback |
| Transferência | internal_transfer |
| TED Enviada | withdrawal |
| TEF Enviada | tef_withdrawal |
| Estorno de TEF enviada | tef_withdrawal_chargeback |
| PIX Enviado | pix_withdrawal |
| Recebimento de boletos | repayment |
| Recebimento de protestos | protest_repayment |
| Tarifas de conta | invoice |
| Estorno de Pagamento | payment_chargeback |
| Movimentação | generic_movement |
| Pagamento | barcode_payment |
| Pagamento de Boleto (Tributos e Convênios) | tribute_payment |
| Pagamento de Boleto (Tributos e Convênios) | fiducia_barcode_payment_withdrawal |
| Pagamento em lote de Boleto (Tributos e Convênios) | fiducia_batch_transfer_withdrawal |
| Estorno de Pagamento | fiducia_barcode_payment_chargeback |
| Estorno de Pagamento | barcode_payment_chargeback |
| Reconciliação | reconciliation |
| Custas Cartorárias | notary_costs |
| Entrada de Split de Cobrança | charge_apportionment_entry |
| Saída de Split de Cobrança | charge_apportionment_withdrawal |
| Débito de transferência de titularidade | charge_concession_withdrawal |
| Recebimento Cartão | card_received |
| Tarifa TED | ted_cost |
| Transferência Recebida | transfer_received |
| Transferência Enviada | transfer_sent |
| Pix Cobrança Recebido | pix_charge_received |
| Recebimento Boleto Via Pix | pix_boleto_received |
| Estorno de Envio de TED | ted_sent_chargeback |
| Estorno de Tarifa de TED | ted_cost_chargeback |
| Tarifa PIX | pix_cost |
| Estorno de Tarifa PIX | pix_cost_chargeback |
Benefícios Gerais
As funcionalidades da API Grafeno oferecem uma série de benefícios gerais para a gestão financeira:
- Automatização e Eficiência: Reduz a necessidade de processos manuais, automatizando a coleta e análise de dados financeiros.
- Transparência e Controle: Proporciona uma visão clara e detalhada das finanças da sua empresa, permitindo um controle mais rigoroso e informado.
- Segurança: Assegura que as movimentações financeiras sejam monitoradas e controladas adequadamente, reduzindo riscos de fraudes e erros.
- Integração: Facilita a integração com seu ERP ou plataforma utilizada, permitindo uma gestão mais coesa e eficiente dos recursos financeiros.
Exemplos de Uso
- Gestão Centralizada de Contas: Com a funcionalidade de listar contas bancárias, um administrador financeiro pode acessar e monitorar todas as contas da empresa em um só lugar, identificando rapidamente quais contas precisam de atenção ou ajuste.
- Verificação de Saldo em Tempo Real: Antes de realizar uma grande transferência, o responsável financeiro pode usar o endpoint para obter saldo e verificar se há fundos suficientes, evitando possíveis falhas na transação devido a saldo insuficiente.
- Auditoria e Conciliação Financeira: Utilizando o endpoint de listar movimentações da conta, uma equipe de auditoria pode revisar todas as transações realizadas em um período específico, garantindo que todas as entradas e saídas de recursos estejam devidamente documentadas e conciliadas com os registros contábeis.
- Análise de Fluxo de Caixa: Exportando os dados de movimentações, a equipe financeira pode analisar os padrões de fluxo de caixa, identificar períodos de maior e menor liquidez, e planejar ações estratégicas para otimizar a gestão de recursos.
- Redução de Riscos: Com as contas vinculadas (Escrow), as empresas podem reduzir riscos em transações comerciais, garantindo que os fundos só sejam movimentados após a verificação e aprovação do credor, aumentando a confiança nas transações.
A API Grafeno é uma poderosa ferramenta que fornece uma ampla gama de funcionalidades para melhorar a gestão financeira de empresas.
Com a capacidade de listar contas bancárias, obter saldos em tempo real e listar movimentações detalhadas, as empresas podem alcançar uma maior eficiência, transparência e controle sobre suas finanças. Seja para simplificar a gestão diária, realizar auditorias precisas ou garantir a segurança das transações, a API de Pagamentos da Grafeno oferece as ferramentas necessárias para apoiar suas necessidades.