Identificador único da Belvo para o item atual.
A identificação interna da instituição para a transação.
Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
Detalhes sobre a conta.
Identificador único da Belvo para o item atual.
O link.id ao qual os dados pertencem.
Detalhes sobre a instituição.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
O tipo de conta.
Retornamos um dos seguintes valores do enum:
ADVANCE_DEPOSIT_ACCOUNTCHECKING_ACCOUNTCREDIT_CARDFINANCING_ACCOUNTINVESTMENT_ACCOUNTINVOICE_FINANCING_ACCOUNTLOAN_ACCOUNTPENSION_FUND_ACCOUNTSAVINGS_ACCOUNTUNCATEGORIZED
Indica se esta conta é um ASSET ou um LIABILITY. Você pode considerar o saldo de um ASSET como positivo, enquanto o saldo de um LIABILITY como negativo.
O tipo de conta, conforme designado pela instituição.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O subtipo de conta, conforme designado pela instituição.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O nome da conta, conforme fornecido pela instituição.
O número da conta, conforme designado pela instituição.
O código da agência onde o produto foi aberto.
O dígito verificador do número do produto, se aplicável.
Detalhes sobre os saldos atual e disponível para a conta.
O saldo atual é calculado de maneira diferente de acordo com o tipo de conta.
- 💰 Contas correntes e poupança:
O saldo da conta do usuário no timestamp collected_at.
- 💳 Cartões de crédito:
O valor que o usuário gastou no período de faturamento atual do cartão (consulte credit_data.cutting_date para informações sobre quando o período de faturamento atual termina).
- 🏡 Contas de empréstimo:
O valor restante a pagar no empréstimo do usuário.
O saldo que o titular da conta pode usar.
- 💰 Contas correntes e poupança:
O saldo disponível pode ser diferente do saldo current devido a transações pendentes.
- 💳 Cartões de crédito:
O valor de crédito que o usuário ainda tem disponível para o período atual. O valor é calculado como credit_data.credit_limit menos balance.current.
- 🏡 Contas de empréstimo:
O valor presente necessário para quitar o empréstimo, conforme fornecido pela instituição.
Nota: Se a instituição não fornecer esse valor, retornamos null.
O valor que está atualmente bloqueado devido a transações pendentes.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
balancesestiver disponível.
O código de moeda de três letras (ISO-4217).
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
balancesestiver disponível.
O nome público para o tipo de identificação. Para contas de poupança e corrente brasileiras 🇧🇷, este campo será AGENCY/ACCOUNT.
O valor para o public_identification_name.
Para contas de poupança e corrente 🇧🇷 OFDA brasileiras, este campo será o número da agência e da conta bancária, separados por uma barra. Por exemplo: 0444/45722-0.
Para contas de cartão de crédito 🇧🇷 OFDA brasileiras, retornaremos uma string de números de cartão de crédito concatenados associados à conta. Por exemplo: "8763,9076,5522"
A identificação interna da instituição para a conta.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
balancesestiver disponível.
Detalhes sobre os cartões de crédito associados a esta conta.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O limite de crédito superior do cartão.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
A data de vencimento da fatura do cartão de crédito.
O valor mínimo que o proprietário da conta precisa pagar no período de crédito atual.
A rede de crédito à qual o cartão está associado. Retornamos um dos seguintes valores:
VISAMASTERCARDAMERICAN_EXPRESSDINERS_CLUBHIPERCARDBANDEIRA_PROPRIACHEQUE_ELETRONICOELOOTHER
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
Informações adicionais sobre a rede de cartão de crédito.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
As opções de empréstimo associadas a esta conta.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O número de contrato padronizado específico do país.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O valor total inicial do empréstimo quando o contrato foi assinado, calculado pela instituição. Este valor inclui o principal + juros + impostos + taxas.
O custo efetivo total inicial do empréstimo.
O tipo do empréstimo, de acordo com a instituição.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O valor restante a pagar no total, incluindo juros.
Detalhamento dos juros aplicados ao empréstimo. Com o OF Brasil, recomendamos fortemente o uso das informações em interest_rate_data para obter informações detalhadas.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O nome do tipo de taxa de juros aplicada ao empréstimo.
Nota: Para OFDA Brasil, recomendamos que você use o parâmetro interest_date_data.tax_type.
O período em que o juro é aplicado ao empréstimo.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
A taxa de juros (em porcentagem ou valor monetário).
Nota: Para OFDA Brasil, recomendamos que você use os parâmetros interest_date_data.pre_fixed_rate e interest_date_data.post_fixed_rate.
Informações detalhadas sobre a taxa de juros.
O tipo de imposto sobre a taxa de juros. Retornamos um dos seguintes valores:
NOMINALEFFECTIVE
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O tipo de taxa de juros. Retornamos um dos seguintes valores:
SIMPLECOMPOUND
Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
O período em que o juro é aplicado ao empréstimo.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O cálculo base para a taxa de juros.
Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
A taxa de índice de referência. Retornamos um dos seguintes valores:
WITHOUT_INDEX_TYPEPRE_FIXEDPOST_FIXEDFLOATINGINDEXED_PRICERURAL_CREDITOTHER_INDEX
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O subtipo da taxa de índice de referência.
Informações adicionais sobre a taxa de índice de referência.
A taxa de juros com percentual prefixado.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
A taxa de juros com percentual pós-fixado.
Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
Detalhamento das taxas aplicadas ao empréstimo.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
O valor total da taxa. Mesma moeda do empréstimo.
O nome da taxa.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
feesestiver disponível.
O código de tarifa.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
feesestiver disponível.
Indica o tipo de cobrança. Retornamos um dos seguintes valores:
SINGLEPER_INSTALLMENT
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
feesestiver disponível.
Método de cobrança, conforme acordado com a instituição. Retornamos um dos seguintes valores:
MINIMUMMAXIMUMFIXEDPERCENTAGE
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
feesestiver disponível.
Parece que você não forneceu nenhum texto para tradução. Por favor, envie o texto que deseja que eu traduza do inglês para o português (Brasil).
Detalhes sobre quaisquer garantias de empréstimo que o indivíduo ou empresa forneceu.
O tipo de garantia, conforme definido pela instituição.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
collateralsestiver disponível.
O subtipo da garantia, conforme definido pela instituição.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
collateralsestiver disponível.
O código de moeda de três letras (ISO-4217).
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo
collateralsestiver disponível.
Informações detalhadas sobre quaisquer pagamentos de balloon para o empréstimo, se aplicável.
A frequência dos pagamentos parcelados contratados, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes:
DAYWEEKMONTHYEARNO_DEADLINE_REMAININGnull
A frequência com que as parcelas são pagas. Retornamos um dos seguintes valores:
IRREGULARWEEKLYFORTNIGHTLYMONTHLYBIMONTHLYQUARTERLYBIANNUALLYANNUALLYOTHER
Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
Informações adicionais sobre o installment_frequency.
A data em que a primeira parcela do empréstimo deve ser paga, no formato YYYY-MM-DD.
O número total de parcelas necessárias para quitar o empréstimo.
O número de parcelas restantes a pagar.
O número de parcelas já pagas.
O número de parcelas que estão em atraso.
Um array de datas em que o empréstimo foi desembolsado.
A data em que o empréstimo foi liquidado, no formato YYYY-MM-DD.
A data em que o contrato de empréstimo foi assinado, no formato YYYY-MM-DD.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.
A frequência dos pagamentos das parcelas restantes contratadas, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes valores:
DAYWEEKMONTHYEARNO_DEADLINE_REMAININGnull
O número total de parcelas restantes no empréstimo.
O cronograma de amortização do empréstimo.
Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
Informações adicionais sobre o amortization_schedule.
O ID do consignatário do empréstimo.
O número do contrato do empréstimo, conforme fornecido pela instituição.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
A data em que a transação ocorreu, no formato YYYY-MM-DD.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O carimbo de data/hora ISO-8601 de quando a transação ocorreu (no fuso horário UTC).
Nota: Para transações que ocorreram antes de 31.01.2024, o carimbo de data/hora pode indicar apenas o dia (por exemplo,
2016-01-29T00:00:00.000Z). No entanto, transações que ocorrerem após essa data devem incluir a data e a hora (2024-02-20T12:29:03.374Z).
Instituições que não seguem este formato: Algumas instituições podem não fornecer a hora exata da transação. Nesse caso, o carimbo de data/hora será definido como
00:00:00.000Z. A Belvo identificou as seguintes instituições como não cumprindo a regulamentação e levantou a questão com os reguladores: Bradesco, Itau e Sicoob.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil para transações de cartão de crédito e conta corrente.
A data em que a transação foi processada e contabilizada pela instituição, no formato YYYY-MM-DD.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil para transações de cartão de crédito.
No caso de a transação ocorrer em um fim de semana ou feriado, a Belvo inferirá a data em que a transação é contabilizada pela instituição. Normalmente, este é o próximo dia útil.
O valor da transação.
ℹ️ O valor exibido é sempre positivo, pois indicamos a direção da transação no parâmetro type.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O valor da transação na moeda local.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil para transações de cartão de crédito.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
O código de moeda de três letras (ISO-4217).
A descrição da transação fornecida pela instituição. Geralmente, este é o texto que o usuário final vê na plataforma online.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
Nota: Este campo não se aplica ao OF Brasil e retornará null.
Dados adicionais sobre o comerciante envolvido na transação. Nós só retornamos informações do comerciante para novas transações feitas a partir de contas corrente ou cartão de crédito.
Obter informações do comerciante Recuperamos as informações do comerciante para uma transação como parte do nosso produto de Categorização de Transações, transformando dados brutos em insights acionáveis. Para habilitar este produto, basta entrar em contato conosco, e nós cuidaremos disso imediatamente.
O nome da categoria de transação.
Obter categorização de transações Com a categorização de transações, limpamos e categorizamos transações para você, transformando dados brutos em insights acionáveis. Para habilitar esse recurso, basta entrar em contato conosco, e nós cuidaremos disso.
Retornamos um dos seguintes valores de enum:
Bills & UtilitiesCredits & LoansDepositsFees & ChargesFood & GroceriesHome & LifeIncome & PaymentsInsuranceInvestments & SavingsOnline Platforms & LeisurePersonal ShoppingTaxesTransfersTransport & TravelUnknown*Withdrawal & ATMnull
* Para clientes que não utilizam nosso produto de Categorização de Transações, retornamos null em vez disso.
A subcategoria da transação.
Obter categorização de transações
Para clientes que não utilizam nossa Categorização de Transações, retornamosnullem vez disso. Para habilitar este recurso, basta entrar em contato conosco, e nós cuidaremos disso.
Retornamos um dos seguintes valores de enum:
Electricity & EnergyRentTelecommunicationsWaterAutoCredit CardInstalmentInterest & ChargesMortgagePay AdvancePersonalAdjustmentsBank FeesChargebackRefundBlocked BalancesAlimonyAlcohol & TobaccoBakery & CoffeeBars & NightclubsConvenience StoreDeliveryGroceriesRestaurantsEducationGyms & FitnessHair & BeautyHealthHome Decor & AppliancesLaundry & Dry CleaningPharmaciesProfessional ServicesVeterinary ServicesFreelanceInterestRetirementSalaryGovernmentHome InsuranceAuto InsuranceHealth & Life InsuranceSavingsFixed incomeEquityInvestment FundsDerivativesCryptocurrenciesApps, Software and Cloud ServicesEvents, Parks and MuseumsGamblingGamingLotteryMovie & AudioBooks & NewsClothing & AccessoriesDepartment StoreElectronicsE-commerceGiftsOffice SuppliesPet SuppliesAuto Tax & FeesDonationGovernment FeesIncome TaxReal Estate Tax & FeesTax ReturnAccommodationAuto ExpensesAuto RentalFlightsGasMileage ProgramsParking & TollsPublic TransitTaxis & RidesharesOthernull
Nota: Este campo não se aplica ao OF Brasil e retornará null.
A direção da transação:
INFLOWindica dinheiro entrando na conta.OUTFLOWindica dinheiro saindo da conta.nullquando não há informações presentes sobre a direção da transação.
O status da transação. Retornamos um dos seguintes valores:
PROCESSED(A transação foi processada pela instituição.)PENDING(A instituição declara claramente que a transação ainda não foi processada.)UNCATEGORIZED(obsoleto)null(obsoleto)
Dados adicionais fornecidos pela instituição para transações com cartão de crédito.
O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
O título da fatura mensal do cartão de crédito à qual a transação pertence. O formato do valor retornado é específico da instituição, no entanto, alguns exemplos comuns são:
- diciembre-2021
- dec-2021
- dec-21
Nota: Este campo é retornado apenas para faturas 'fechadas' (o que significa que o período de faturamento terminou e a fatura foi emitida). Se o período de faturamento ainda estiver em andamento, retornamos
null.
A data em que a fatura deve ser paga, no formato YYYY-MM-DD.
Nota: Este campo é retornado apenas para faturas 'fechadas' (o que significa que o período de faturamento terminou e a fatura foi emitida). Se o período de faturamento ainda estiver em andamento, retornamos
null.
O identificador interno da instituição para a fatura.
Nota: Este campo é retornado apenas para faturas 'closed' (o que significa que o período de faturamento foi encerrado e a fatura foi emitida). Se o período de faturamento ainda estiver em andamento, retornamos
null.
Nota: Este campo não se aplica ao OFDA Brasil e retornará null.
Nota: Este campo não se aplica ao OFDA Brasil e retornará null.
O valor da fatura, a partir de collected_at. Para mais informações, veja credit_card_bill.
O número do cartão de crédito.
Nota: Frequentemente, são apenas os últimos quatro dígitos do cartão de crédito.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
A taxa que pode ser cobrada por uma transação com cartão. Retornamos um dos seguintes valores:
ANNUAL_FEENATIONAL_WITHDRAWALINTERNATIONAL_WITHDRAWALEMERGENCY_CREDIT_EVALUATION_FEEDUPLICATE_ISSUANCE_FEEPAYMENT_FEESMS_FEEOTHERSnull
Informações adicionais sobre a taxa.
Outros tipos de crédito que foram contratados no cartão. Retornamos um dos seguintes valores:
REVOLVING_CREDITBILL_INSTALLMENT_PAYMENTLOANOTHERSnull
Informações adicionais sobre o tipo de crédito.
Um identificador para a parcela, de acordo com a instituição.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O número total de parcelas para a transação com cartão, se aplicável.
Informações sobre a outra parte desta transação, se disponível.
O tipo de contraparte da transação. Retornamos um dos seguintes valores:
INDIVIDUALCOMPANYnull
O número do documento do representante.
Nota:
Para o Brasil:
- Quando o
typeéINDIVIDUAL, este é o número do CPF. - Quando o
typeéCOMPANY, este é o número do CNPJ.
O código de compensação bancária.
O código da agência onde a conta foi aberta.
O dígito verificador do número da conta, se aplicável.
Informações sobre os dados transacionais de empréstimos, se aplicável.
Boolean para indicar se este pagamento de empréstimo fazia parte do cronograma de pagamento original.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
O ID único da instituição para esta parcela de pagamento.
Detalhes sobre as taxas associadas a este pagamento. Aplicável apenas quando is_detached = true.
O nome da taxa.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo
feesestiver presente.
O código da instituição para a taxa.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo
feesestiver presente.
Detalhes relacionados às cobranças associadas a este pagamento. Aplicável somente quando is_detached = true.
O tipo de cobrança.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo
chargesestiver presente.
Informações adicionais sobre o type de cobrança.
O tipo de pagamento da transação. Retornamos um dos seguintes valores:
FULLINSTALLMENTnull
O tipo de transação. Por exemplo, um pagamento PIX ou um depósito.
Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil para transações de contas não relacionadas a empréstimos.
Informações adicionais sobre o operation_type, se aplicável.
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "internal_identification": "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl", "account": { "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "institution": { … }, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "last_accessed_at": "2021-03-09T10:28:40.000Z", "category": "CHECKING_ACCOUNT", "balance_type": "ASSET", "overdraft": { … }, "type": "STANDARD_NACIONAL", "subtype": "FINANCIAMENTO_HABITACIONAL_SFH", "name": "Cuenta Perfiles- M.N. - MXN-666", "number": "4057068115181", "agency": "6272", "check_digit": "7", "balance": { … }, "currency": "BRL", "public_identification_name": "AGENCY/ACCOUNT", "public_identification_value": "0444/45722-0", "internal_identification": "92792126019929279212650822221989319252576", "credit_data": { … }, "loan_data": { … }, "funds_data": null }, "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "value_date": "2019-10-23", "transacted_at": "2024-02-20T12:29:03.374Z", "accounting_date": "2019-10-23", "inferred_accounting_date": "2019-10-23", "amount": 2145.45, "local_currency_amount": 7623.64, "balance": null, "currency": "BRL", "description": "SEVEN BUDDHAS RFC:XXXXXXXXXX", "observations": null, "merchant": { "logo": "https://logo.clearbit.com/asesor-contable.es", "website": "https://merchants-r-us.com", "merchant_name": "Merchants R Us Global" }, "category": "Income & Payments", "subcategory": "Freelance", "reference": null, "type": "INFLOW", "status": "PROCESSED", "credit_card_data": { "collected_at": "2022-02-09T08:45:50.406032Z", "bill_name": "apr-2020", "bill_due_date": "2023-06-17", "bill_internal_identification": "927921260199292792126508222219893192525A6", "bill_status": null, "previous_bill_total": null, "bill_amount": 300, "card_number": "4453", "fee_type": "NATIONAL_WITHDRAWAL", "fee_type_additional_info": "ATM withdrawal in Curitiba.", "credits_type": "BILL_INSTALLMENT_PAYMENT", "credits_type_additional_info": "Some additional information.", "installment_identifier": "PARCELA_896", "number_of_installments": 4, "credit_card_bill": { … } }, "counterparty": { "type": "INDIVIDUAL", "document_number": "73677831148", "clearing_code": "001", "agency": "6272", "check_digit": "7", "number": "24550245" }, "loan_data": { "is_detached": true, "installment_id": "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH", "fees": [ … ], "charges": [ … ] }, "payment_type": "FULL", "operation_type": "TRANSFERENCIA_MESMA_INSTITUICAO", "operation_type_additional_info": "Internal transfer.", "mcc": 5137 }