# Concluir uma solicitação de transações

Usado para retomar uma sessão de recuperação de Transação que foi pausada porque um token MFA foi exigido pela instituição.

Endpoint: PATCH /api/transactions/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `omit` (string)
    Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

  - `fields` (string)
    Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

## Request fields (application/json):

  - `session` (string, required)
    A sessão que você deseja retomar. Você precisa usar o valor session que é fornecido na resposta 428 Token Required que você recebe após fazer sua solicitação POST.
    Example: "6e7b283c6efa449c9c028a16b5c249fa"

  - `token` (string)
    O token MFA gerado pela instituição, que é necessário para continuar uma sessão.
    Example: "1234ab"

  - `link` (string, required)
    O link.id que você deseja retomar. Deve ser o mesmo link.id que você recebe na resposta 428 Token Required que contém o ID da session.
    Example: "683005d6-f45c-4adb-b289-f1a12f50f80c"

  - `save_data` (boolean)
    Indica se os dados devem ou não ser persistidos no Belvo. Por padrão, isso é definido como true e retornamos uma resposta 201 Created.

Quando definido como false, os dados não serão persistidos e retornamos uma resposta 200 OK.
    Example: true

## Response 200 fields (application/json):

  - `id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `internal_identification` (string, required)
    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.
    Example: "TXpRMU9UQTROMWhZV2xSU1FUazJSMDl"

  - `account` (object,null, required)
    Detalhes sobre a conta.

  - `account.id` (string, required)
    Identificador único da Belvo para o item atual.
    Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"

  - `account.link` (string,null, required)
    O link.id ao qual os dados pertencem.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `account.institution` (object, required)
    Detalhes sobre a instituição.

  - `account.institution.name` (string)
    O nome da instituição, conforme designado pela Belvo.
    Example: "erebor_mx_retail"

  - `account.institution.type` (string)
    O tipo de instituição. Retornamos um dos seguintes valores:

  - bank
  - fiscal
  - employment
    Enum: "bank", "fiscal", "employment"

  - `account.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `account.created_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `account.last_accessed_at` (string,null, required)
    O timestamp ISO-8601 do acesso mais recente e bem-sucedido da Belvo à instituição para o link fornecido.
    Example: "2021-03-09T10:28:40.000Z"

  - `account.category` (string,null, required)
    O tipo de conta.  
Retornamos um dos seguintes valores do enum:  
  - ADVANCE_DEPOSIT_ACCOUNT
  - CHECKING_ACCOUNT
  - CREDIT_CARD
  - FINANCING_ACCOUNT
  - INVESTMENT_ACCOUNT
  - INVOICE_FINANCING_ACCOUNT
  - LOAN_ACCOUNT
  - PENSION_FUND_ACCOUNT
  - SAVINGS_ACCOUNT
  - UNCATEGORIZED
    Enum: "ADVANCE_DEPOSIT_ACCOUNT", "CHECKING_ACCOUNT", "CREDIT_CARD", "FINANCING_ACCOUNT", "INVESTMENT_ACCOUNT", "INVOICE_FINANCING_ACCOUNT", "LOAN_ACCOUNT", "PENSION_FUND_ACCOUNT", "SAVINGS_ACCOUNT", "UNCATEGORIZED"

  - `account.balance_type` (string,null, required)
    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.
    Example: "ASSET"

  - `account.overdraft` (object,null)

  - `account.overdraft.arranged` (number, required)
    O limite de cheque especial acordado entre o titular da conta e a instituição.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo overdraft estiver disponível.
    Example: 5000.5

  - `account.overdraft.used` (number, required)
    O valor do cheque especial utilizado.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo overdraft estiver disponível.
    Example: 1000.5

  - `account.overdraft.unarranged` (number, required)
    O cheque especial utilizado que não foi acordado entre o titular da conta e a instituição.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil se o campo overdraft estiver disponível.
    Example: 300.1

  - `account.type` (string, required)
    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.
    Example: "STANDARD_NACIONAL"

  - `account.subtype` (string, required)
    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.
    Example: "FINANCIAMENTO_HABITACIONAL_SFH"

  - `account.name` (string,null, required)
    O nome da conta, conforme fornecido pela instituição.
    Example: "Cuenta Perfiles- M.N. - MXN-666"

  - `account.number` (string,null, required)
    O número da conta, conforme designado pela instituição.
    Example: "4057068115181"

  - `account.agency` (string,null, required)
    O código da agência onde o produto foi aberto.
    Example: "6272"

  - `account.check_digit` (string,null, required)
    O dígito verificador do número do produto, se aplicável.
    Example: "7"

  - `account.balance` (object, required)
    Detalhes sobre os saldos atual e disponível para a conta.

  - `account.balance.current` (number,null, required)
    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.
    Example: 5874.13

  - `account.balance.available` (number,null)
    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.
    Example: 5621.12

  - `account.balance.blocked` (number)
    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 balances estiver disponível.
    Example: 60.32

  - `account.balance.automatically_invested` (number)
    O valor que é automaticamente investido (conforme acordado com a instituição).

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo balances estiver disponível.
    Example: 131.5

  - `account.currency` (string, required)
    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 balances estiver disponível.
    Example: "BRL"

  - `account.public_identification_name` (string,null, required)
    O nome público para o tipo de identificação. Para contas de poupança e corrente brasileiras 🇧🇷, este campo será AGENCY/ACCOUNT.
    Example: "AGENCY/ACCOUNT"

  - `account.public_identification_value` (string,null, required)
    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"
    Example: "0444/45722-0"

  - `account.internal_identification` (string, required)
    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 balances estiver disponível.
    Example: "92792126019929279212650822221989319252576"

  - `account.credit_data` (object,null, required)
    Detalhes sobre os cartões de crédito associados a esta conta.

  - `account.credit_data.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `account.credit_data.credit_limit` (number,null, required)
    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.
    Example: 192000.9

  - `account.credit_data.limits` (array)

  - `account.credit_data.limits.identification_number` (string,null, required)
    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.
    Example: "4453"

  - `account.credit_data.limits.credit_limit` (number,null, required)
    O limite do cartão de crédito.
    Example: 1000.04

  - `account.credit_data.limits.used_amount` (number,null, required)
    A quantidade utilizada.
    Example: 400.04

  - `account.credit_data.limits.available_amount` (number, required)
    O valor ainda disponível.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 600

  - `account.credit_data.limits.is_limit_flexible` (boolean, required)
    Boolean para indicar se o credit_limit é flexível.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

  - `account.credit_data.limits.type` (string, required)
    O tipo de limite. Retornamos um dos seguintes valores:

  - TOTAL_LIMIT
  - MODAL_LIMIT

  > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "TOTAL_LIMIT", "MODAL_LIMIT"

  - `account.credit_data.limits.consolidation_type` (string, required)
    Indica se o limite de crédito é consolidado ou individual.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "INDIVIDUAL"

  - `account.credit_data.limits.line_name` (string,null, required)
    O nome da linha de limite de crédito.
    Example: "CREDITO_A_VISTA"

  - `account.credit_data.limits.line_name_additional_info` (string,null, required)
    Informações adicionais sobre o nome da linha.
    Example: "Informações adicionais e complementares"

  - `account.credit_data.cutting_date` (string,null)
    A data de vencimento da fatura do cartão de crédito.
    Example: "2019-12-11"

  - `account.credit_data.minimum_payment` (number,null)
    O valor mínimo que o proprietário da conta precisa pagar no período de crédito atual.
    Example: 2400.3

  - `account.credit_data.network` (string)
    A rede de crédito à qual o cartão está associado. Retornamos um dos seguintes valores:

  - VISA
  - MASTERCARD
  - AMERICAN_EXPRESS
  - DINERS_CLUB
  - HIPERCARD
  - BANDEIRA_PROPRIA
  - CHEQUE_ELETRONICO
  - ELO
  - OTHER

  > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "VISA", "MASTERCARD", "AMERICAN_EXPRESS", "DINERS_CLUB", "HIPERCARD", "BANDEIRA_PROPRIA", "CHEQUE_ELETRONICO", "ELO", "OTHER"

  - `account.credit_data.network_additional_info` (string,null)
    Informações adicionais sobre a rede de cartão de crédito.
    Example: "It's an orange card."

  - `account.credit_data.cards` (array)
    Detalhes sobre os cartões associados à conta.

  - `account.credit_data.cards.is_multiple` (boolean, required)
    Boolean para indicar se esta conta possui múltiplos cartões de crédito.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

  - `account.credit_data.cards.identification_number` (string, required)
    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.
    Example: "4453"

  - `account.credit_data.next_payment_date` (string,null)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.credit_data.no_interest_payment` (number,null)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.credit_data.interest_rate` (number,null)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.credit_data.monthly_payment` (number,null)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.credit_data.last_payment_date` (string,null)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data` (object,null, required)
    As opções de empréstimo associadas a esta conta.

  - `account.loan_data.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `account.loan_data.loan_code` (string, required)
    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.
    Example: "92792126019929279212650822221989319252576"

  - `account.loan_data.contract_amount` (number,null, required)
    O valor total inicial do empréstimo quando o contrato foi assinado, calculado pela instituição. Este valor inclui o principal + juros + impostos + taxas.
    Example: 202000

  - `account.loan_data.total_effective_cost` (number,null)
    O custo efetivo total inicial do empréstimo.
    Example: 209000

  - `account.loan_data.loan_type` (string, required)
    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.
    Example: "HOME_EQUITY"

  - `account.loan_data.outstanding_balance` (number,null, required)
    O valor restante a pagar no total, incluindo juros.
    Example: 182000

  - `account.loan_data.interest_rates` (array, required)
    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.

  - `account.loan_data.interest_rates.name` (string,null, required)
    O nome do tipo de taxa de juros aplicada ao empréstimo.

Nota: Para OFDA Brasil, recomendamos que você use o parâmetro interest_rate_data.tax_type.
    Example: "NOMINAL"

  - `account.loan_data.interest_rates.type` (string, required)
    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.
    Enum: "MONTHLY", "YEARLY"

  - `account.loan_data.interest_rates.value` (number,null, required)
    A taxa de juros (em porcentagem ou valor monetário).

Nota: Para OFDA Brasil, recomendamos que você use os parâmetros interest_rate_data.pre_fixed_rate e interest_rate_data.post_fixed_rate.
    Example: 7.85

  - `account.loan_data.interest_rates.interest_rate_data` (object,null, required)
    Informações detalhadas sobre a taxa de juros.

  - `account.loan_data.interest_rates.interest_rate_data.tax_type` (string, required)
    O tipo de imposto sobre a taxa de juros. Retornamos um dos seguintes valores:

  - NOMINAL
  - EFFECTIVE
  
  > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "NOMINAL", "EFFECTIVE"

  - `account.loan_data.interest_rates.interest_rate_data.rate_type` (string, required)
    O tipo de taxa de juros. Retornamos um dos seguintes valores:

  - SIMPLE
  - COMPOUND

  > Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "SIMPLE", "COMPOUND"

  - `account.loan_data.interest_rates.interest_rate_data.type` (string)
    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.
    Enum: same as `account.loan_data.interest_rates.type` (2 values)

  - `account.loan_data.interest_rates.interest_rate_data.calculation_base` (string, required)
    O cálculo base para a taxa de juros.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "30/360"

  - `account.loan_data.interest_rates.interest_rate_data.reference_index_type` (string, required)
    A taxa de índice de referência. Retornamos um dos seguintes valores:

  - WITHOUT_INDEX_TYPE
  - PRE_FIXED
  - POST_FIXED
  - FLOATING
  - INDEXED_PRICE
  - RURAL_CREDIT
  - OTHER_INDEX

  > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "WITHOUT_INDEX_TYPE", "PRE_FIXED", "POST_FIXED", "FLOATING", "INDEXED_PRICE", "RURAL_CREDIT", "OTHER_INDEX"

  - `account.loan_data.interest_rates.interest_rate_data.reference_index_subtype` (string,null, required)
    O subtipo da taxa de índice de referência.
    Example: "TR_TBF"

  - `account.loan_data.interest_rates.interest_rate_data.reference_index_info` (string,null, required)
    Informações adicionais sobre a taxa de índice de referência.
    Example: "Additional information"

  - `account.loan_data.interest_rates.interest_rate_data.pre_fixed_rate` (number, required)
    A taxa de juros com percentual prefixado.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 0.062

  - `account.loan_data.interest_rates.interest_rate_data.post_fixed_rate` (number, required)
    A taxa de juros com percentual pós-fixado.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: 0.062

  - `account.loan_data.interest_rates.interest_rate_data.additional_info` (string,null, required)
    Informações adicionais sobre a taxa de juros.
    Example: "Additional information"

  - `account.loan_data.fees` (array,null, required)
    Detalhamento das taxas aplicadas ao empréstimo.

  - `account.loan_data.fees.type` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.
    Enum: "OPERATION_FEE", "INSURANCE_FEE", "OTHERS", null

  - `account.loan_data.fees.value` (number,null, required)
    O valor total da taxa. Mesma moeda do empréstimo.
    Example: 5.6

  - `account.loan_data.fees.name` (string, required)
    O nome da taxa.

 > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.
    Example: "Renovação de cadastro"

  - `account.loan_data.fees.code` (string, required)
    O código de tarifa.

 > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.
    Example: "CADASTRO"

  - `account.loan_data.fees.fee_charge_type` (string, required)
    Indica o tipo de cobrança. Retornamos um dos seguintes valores:

  - SINGLE
  - PER_INSTALLMENT

   > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.
    Enum: "SINGLE", "PER_INSTALLMENT"

  - `account.loan_data.fees.fee_charge` (string, required)
    Método de cobrança, conforme acordado com a instituição. Retornamos um dos seguintes valores:

  - MINIMUM
  - MAXIMUM
  - FIXED
  - PERCENTAGE

   > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo fees estiver disponível.
    Enum: "MINIMUM", "MAXIMUM", "FIXED", "PERCENTAGE"

  - `account.loan_data.fees.rate` (number,null, required)
    A taxa percentual da tarifa. Necessária quando fee_charge está definido como PERCENTAGE.
    Example: 0.062

  - `account.loan_data.contracted_charges` (array,null)
    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).

  - `account.loan_data.contracted_charges.type` (string)
    O tipo de cobrança contratada. Retornamos um dos seguintes valores:

  - LATE_PAYMENT_INTEREST_FEE
  - LATE_PAYMENT_PENALTY_FEE
  - DEFAULT_INTEREST_FEE
  - LOAN_CONTRACT_TAX
  - LATE_PAYMENT_TAX
  - NO_CHARGE
  - OTHER

  > Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo contracted_charges estiver disponível.
    Enum: "LATE_PAYMENT_INTEREST_FEE", "LATE_PAYMENT_PENALTY_FEE", "DEFAULT_INTEREST_FEE", "LOAN_CONTRACT_TAX", "LATE_PAYMENT_TAX", "NO_CHARGE", "OTHER"

  - `account.loan_data.contracted_charges.info` (string,null)
    Informações adicionais sobre a cobrança contratada.
    Example: "Late fee"

  - `account.loan_data.contracted_charges.rate` (number,null)
    A taxa percentual da cobrança, calculada com base no valor do empréstimo.
    Example: 0.062

  - `account.loan_data.collaterals` (array,null, required)
    Detalhes sobre quaisquer garantias de empréstimo que o indivíduo ou empresa forneceu.

  - `account.loan_data.collaterals.type` (string, required)
    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 collaterals estiver disponível.
    Example: "OPERACOES_GARANTIDAS_PELO_GOVERNO"

  - `account.loan_data.collaterals.subtype` (string, required)
    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 collaterals estiver disponível.
    Example: "CCR_CONVENIO_CREDITOS_RECIPROCOS"

  - `account.loan_data.collaterals.currency` (string, required)
    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 collaterals estiver disponível.
    Example: "BRL"

  - `account.loan_data.collaterals.amount` (number, required)
    O valor total da fatura.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo collaterals estiver disponível.
    Example: 45391.89

  - `account.loan_data.balloon_payments` (array,null, required)
    Informações detalhadas sobre quaisquer pagamentos de balloon para o empréstimo, se aplicável.

  - `account.loan_data.balloon_payments.due_date` (string,null, required)
    A data em que o pagamento do balloon deve ser efetuado, no formato YYYY-MM-DD.
    Example: "2021-09-06"

  - `account.loan_data.balloon_payments.currency` (string,null, required)
    O código de moeda de três letras (ISO-4217).
    Example: "BRL"

  - `account.loan_data.balloon_payments.amount` (number,null, required)
    O valor total do pagamento final.
    Example: 45391.89

  - `account.loan_data.installments_contract_term_frequency` (string,null, required)
    A frequência dos pagamentos parcelados contratados, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes:

  - DAY
  - WEEK
  - MONTH
  - YEAR
  - NO_DEADLINE_REMAINING
  - null
    Enum: "DAY", "WEEK", "MONTH", "YEAR", "NO_DEADLINE_REMAINING", null

  - `account.loan_data.installment_frequency` (string, required)
    A frequência com que as parcelas são pagas. Retornamos um dos seguintes valores:

  - IRREGULAR
  - WEEKLY
  - FORTNIGHTLY
  - MONTHLY
  - BIMONTHLY
  - QUARTERLY
  - BIANNUALLY
  - ANNUALLY
  - OTHER

  > Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
    Enum: "IRREGULAR", "WEEKLY", "FORTNIGHTLY", "MONTHLY", "BIMONTHLY", "QUARTERLY", "BIANNUALLY", "ANNUALLY", "OTHER"

  - `account.loan_data.installment_frequency_info` (string,null, required)
    Informações adicionais sobre o installment_frequency.
    Example: "Both the term and requency are the same."

  - `account.loan_data.first_installment_due_date` (string,null, required)
    A data em que a primeira parcela do empréstimo deve ser paga, no formato YYYY-MM-DD.
    Example: "2020-03-01"

  - `account.loan_data.number_of_installments_total` (integer,null, required)
    O número total de parcelas necessárias para quitar o empréstimo.
    Example: 60

  - `account.loan_data.number_of_installments_outstanding` (integer,null, required)
    O número de parcelas restantes a pagar.
    Example: 48

  - `account.loan_data.number_of_installments_paid` (integer,null, required)
    O número de parcelas já pagas.
    Example: 32

  - `account.loan_data.number_of_installments_past_due` (integer,null, required)
    O número de parcelas que estão em atraso.
    Example: 2

  - `account.loan_data.disbursement_dates` (array,null, required)
    Um array de datas em que o empréstimo foi desembolsado.
    Example: ["2021-09-23"]

  - `account.loan_data.settlement_date` (string,null, required)
    A data em que o empréstimo foi liquidado, no formato YYYY-MM-DD.
    Example: "2021-09-23"

  - `account.loan_data.contract_start_date` (string, required)
    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.
    Example: "2020-03-01"

  - `account.loan_data.contract_end_date` (string,null, required)
    A data em que se espera que o empréstimo seja concluído, no formato YYYY-MM-DD.
    Example: "2027-10-01"

  - `account.loan_data.contract_remaining_frequency` (string,null, required)
    A frequência dos pagamentos das parcelas restantes contratadas, conforme definido quando o contrato foi assinado pela primeira vez. Retornamos um dos seguintes valores:
- DAY
- WEEK
- MONTH
- YEAR
- NO_DEADLINE_REMAINING
- null
    Enum: same as `account.loan_data.installments_contract_term_frequency` (6 values)

  - `account.loan_data.contract_remaining_total` (integer,null, required)
    O número total de parcelas restantes no empréstimo.
    Example: 20

  - `account.loan_data.amortization_schedule` (string, required)
    O cronograma de amortização do empréstimo.

> Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.
    Example: "SEM_SISTEMA_AMORTIZACAO"

  - `account.loan_data.amortization_schedule_info` (string,null, required)
    Informações adicionais sobre o amortization_schedule.
    Example: "No need for a schedule."

  - `account.loan_data.consignee_id` (string,null, required)
    O ID do consignatário do empréstimo.
    Example: "60500998000135"

  - `account.loan_data.contract_number` (string,null, required)
    O número do contrato do empréstimo, conforme fornecido pela instituição.
    Example: "1324926521496"

  - `account.loan_data.monthly_payment` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.principal` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.payment_day` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.outstanding_principal` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.credit_limit` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.last_period_balance` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.interest_rate` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.limit_day` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.cutting_day` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.cutting_date` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.last_payment_date` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.loan_data.no_interest_payment` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `account.funds_data` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `created_at` (string, required)
    O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.
    Example: "2022-02-09T08:45:50.406032Z"

  - `value_date` (string, required)
    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.
    Example: "2019-10-23"

  - `transacted_at` (string)
    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.
    Example: "2024-02-20T12:29:03.374Z"

  - `accounting_date` (string,null, required)
    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.
    Example: "2019-10-23"

  - `inferred_accounting_date` (string)
    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.
    Example: "2019-10-23"

  - `amount` (number, required)
    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.
    Example: 2145.45

  - `local_currency_amount` (number,null, required)
    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.
    Example: 7623.64

  - `balance` (number,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `currency` (string,null, required)
    O código de moeda de três letras (ISO-4217).
    Example: "BRL"

  - `description` (string,null, required)
    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.
    Example: "SEVEN BUDDHAS RFC:XXXXXXXXXX"

  - `observations` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `merchant` (object,null, required)
    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.

  - `merchant.logo` (string,null)
    A URL para o logotipo do comerciante.
    Example: "https://logo.clearbit.com/asesor-contable.es"

  - `merchant.website` (string,null)
    A URL para o site do comerciante.
    Example: "https://merchants-r-us.com"

  - `merchant.merchant_name` (string)
    O nome do comerciante.
    Example: "Merchants R Us Global"

  - `category` (string,null, required)
    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 & Utilities
  - Credits & Loans
  - Deposits
  - Fees & Charges
  - Food & Groceries
  - Home & Life
  - Income & Payments
  - Insurance
  - Investments & Savings
  - Online Platforms & Leisure
  - Personal Shopping
  - Taxes
  - Transfers
  - Transport & Travel
  - Unknown*
  - Withdrawal & ATM
  - null


  \* Para clientes que não utilizam nosso produto de Categorização de Transações, retornamos null em vez disso.
    Enum: "Bills & Utilities", "Credits & Loans", "Deposits", "Fees & Charges", "Food & Groceries", "Home & Life", "Income & Payments", "Insurance", "Investments & Savings", "Online Platforms & Leisure", "Personal Shopping", "Taxes", "Transfers", "Transport & Travel", "Unknown", "Withdrawal & ATM", null

  - `subcategory` (string,null, required)
    A subcategoria da transação.

> Obter categorização de transações  
Para clientes que não utilizam nossa Categorização de Transações, retornamos null em vez disso. Para habilitar este recurso, basta entrar em contato conosco, e nós cuidaremos disso.

Retornamos um dos seguintes valores de enum:

- Electricity & Energy
- Rent
- Telecommunications
- Water
- Auto
- Credit Card
- Instalment
- Interest & Charges
- Mortgage
- Pay Advance
- Personal
- Adjustments
- Bank Fees
- Chargeback
- Refund
- Blocked Balances
- Alimony
- Alcohol & Tobacco
- Bakery & Coffee
- Bars & Nightclubs
- Convenience Store
- Delivery
- Groceries
- Restaurants
- Education
- Gyms & Fitness
- Hair & Beauty
- Health
- Home Decor & Appliances
- Laundry & Dry Cleaning
- Pharmacies
- Professional Services
- Veterinary Services
- Freelance
- Interest
- Retirement
- Salary
- Government
- Home Insurance
- Auto Insurance
- Health & Life Insurance
- Savings
- Fixed income
- Equity
- Investment Funds
- Derivatives
- Cryptocurrencies
- Apps, Software and Cloud Services
- Events, Parks and Museums
- Gambling
- Gaming
- Lottery
- Movie & Audio
- Books & News
- Clothing & Accessories
- Department Store
- Electronics
- E-commerce
- Gifts
- Office Supplies
- Pet Supplies
- Auto Tax & Fees
- Donation
- Government Fees
- Income Tax
- Real Estate Tax & Fees
- Tax Return
- Accommodation
- Auto Expenses
- Auto Rental
- Flights
- Gas
- Mileage Programs
- Parking & Tolls
- Public Transit
- Taxis & Rideshares
- Other
- null
    Enum: "Electricity & Energy", "Rent", "Telecommunications", "Water", "Auto", "Credit Card", "Instalment", "Interest & Charges", "Mortgage", "Pay Advance", "Personal", "Adjustments", "Bank Fees", "Chargeback", "Refund", "Blocked Balances", "Alimony", "Alcohol & Tobacco", "Bakery & Coffee", "Bars & Nightclubs", "Convenience Store", "Delivery", "Groceries", "Restaurants", "Education", "Gyms & Fitness", "Hair & Beauty", "Health", "Home Decor & Appliances", "Laundry & Dry Cleaning", "Pharmacies", "Professional Services", "Veterinary Services", "Freelance", "Interest", "Retirement", "Salary", "Government", "Home Insurance", "Auto Insurance", "Health & Life Insurance", "Savings", "Fixed income", "Equity", "Investment Funds", "Derivatives", "Cryptocurrencies", "Apps, Software and Cloud Services", "Events, Parks and Museums", "Gambling", "Gaming", "Lottery", "Movie & Audio", "Books & News", "Clothing & Accessories", "Department Store", "Electronics", "E-commerce", "Gifts", "Office Supplies", "Pet Supplies", "Auto Tax & Fees", "Donation", "Government Fees", "Income Tax", "Real Estate Tax & Fees", "Tax Return", "Accommodation", "Auto Expenses", "Auto Rental", "Flights", "Gas", "Mileage Programs", "Parking & Tolls", "Public Transit", "Taxis & Rideshares", "Other", null

  - `reference` (string,null, required)
    Nota: Este campo não se aplica ao OF Brasil e retornará null.

  - `type` (string,null, required)
    A direção da transação:
- INFLOW indica dinheiro entrando na conta.
- OUTFLOW indica dinheiro saindo da conta.
- null quando não há informações presentes sobre a direção da transação.
    Enum: "OUTFLOW", "INFLOW", null

  - `status` (string,null, required)
    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)
    Enum: "PENDING", "PROCESSED", "UNCATEGORIZED", null

  - `credit_card_data` (object,null, required)
    Dados adicionais fornecidos pela instituição para transações com cartão de crédito.

  - `credit_card_data.collected_at` (string, required)
    O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.
    Example: "2022-02-09T08:45:50.406032Z"

  - `credit_card_data.bill_name` (string,null, required)
    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.
    Example: "apr-2020"

  - `credit_card_data.bill_due_date` (string,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.
    Example: "2023-06-17"

  - `credit_card_data.bill_internal_identification` (string,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.
    Example: "927921260199292792126508222219893192525A6"

  - `credit_card_data.bill_status` (string,null, required)
    Nota: Este campo não se aplica ao OFDA Brasil e retornará null.

  - `credit_card_data.previous_bill_total` (string,null, required)
    Nota: Este campo não se aplica ao OFDA Brasil e retornará null.

  - `credit_card_data.bill_amount` (number,null, required)
    O valor da fatura, a partir de collected_at. Para mais informações, veja credit_card_bill.
    Example: 300

  - `credit_card_data.card_number` (string, required)
    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.
    Example: "4453"

  - `credit_card_data.fee_type` (string,null, required)
    A taxa que pode ser cobrada por uma transação com cartão. Retornamos um dos seguintes valores:

  - ANNUAL_FEE
  - NATIONAL_WITHDRAWAL
  - INTERNATIONAL_WITHDRAWAL
  - EMERGENCY_CREDIT_EVALUATION_FEE
  - DUPLICATE_ISSUANCE_FEE
  - PAYMENT_FEE
  - SMS_FEE
  - OTHERS
  - null
    Enum: "ANNUAL_FEE", "NATIONAL_WITHDRAWAL", "INTERNATIONAL_WITHDRAWAL", "EMERGENCY_CREDIT_EVALUATION_FEE", "DUPLICATE_ISSUANCE_FEE", "PAYMENT_FEE", "SMS_FEE", "OTHERS", null

  - `credit_card_data.fee_type_additional_info` (string,null, required)
    Informações adicionais sobre a taxa.
    Example: "ATM withdrawal in Curitiba."

  - `credit_card_data.credits_type` (string,null, required)
    Outros tipos de crédito que foram contratados no cartão. Retornamos um dos seguintes valores:

  - REVOLVING_CREDIT
  - BILL_INSTALLMENT_PAYMENT
  - LOAN
  - OTHERS
  - null
    Enum: "REVOLVING_CREDIT", "BILL_INSTALLMENT_PAYMENT", "LOAN", "OTHERS", null

  - `credit_card_data.credits_type_additional_info` (string,null, required)
    Informações adicionais sobre o tipo de crédito.
    Example: "Some additional information."

  - `credit_card_data.installment_identifier` (string, required)
    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.
    Example: "PARCELA_896"

  - `credit_card_data.number_of_installments` (integer,null, required)
    O número total de parcelas para a transação com cartão, se aplicável.
    Example: 4

  - `credit_card_data.credit_card_bill` (object,null)
    Informações sobre a fatura em que esta transação aparece.

  - `credit_card_data.credit_card_bill.id` (string)
    O identificador único criado pela Belvo usado para referenciar a fatura atual do cartão de crédito.

> Nota: Este campo é retornado apenas para faturas 'closed' (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.
    Example: "8e9d13c2-af41-4a49-b43e-2da012bd1d11"

  - `credit_card_data.credit_card_bill.internal_identification` (string,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.
    Example: "92792126019929279212650822221989319252576"

  - `counterparty` (object,null, required)
    Informações sobre a outra parte desta transação, se disponível.

  - `counterparty.type` (string,null, required)
    O tipo de contraparte da transação. Retornamos um dos seguintes valores:

  - INDIVIDUAL
  - COMPANY
  - null
    Enum: "INDIVIDUAL", "COMPANY", null

  - `counterparty.document_number` (string,null, required)
    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.
    Example: "73677831148"

  - `counterparty.clearing_code` (string,null, required)
    O código de compensação bancária.
    Example: "001"

  - `counterparty.agency` (string,null, required)
    O código da agência onde a conta foi aberta.
    Example: "6272"

  - `counterparty.check_digit` (string,null, required)
    O dígito verificador do número da conta, se aplicável.
    Example: "7"

  - `counterparty.number` (string,null, required)
    O número da conta do produto.
    Example: "24550245"

  - `loan_data` (object,null, required)
    Informações sobre os dados transacionais de empréstimos, se aplicável.

  - `loan_data.is_detached` (boolean, required)
    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.
    Example: true

  - `loan_data.installment_id` (string,null, required)
    O ID único da instituição para esta parcela de pagamento.
    Example: "WGx0aExYcEJMVm93TFRsZFcyRXRla0V0V2pBdE9Wd3RYWH"

  - `loan_data.fees` (array, required)
    Detalhes sobre as taxas associadas a este pagamento. Aplicável apenas quando is_detached = true.

  - `loan_data.fees.name` (string, required)
    O nome da taxa.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo fees estiver presente.
    Example: "Reavaliação periódica do bem"

  - `loan_data.fees.code` (string, required)
    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 fees estiver presente.
    Example: "aval_bem"

  - `loan_data.fees.amount` (number,null, required)
    O valor da taxa.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo fees estiver presente.
    Example: 8903.77

  - `loan_data.charges` (array, required)
    Detalhes relacionados às cobranças associadas a este pagamento. Aplicável somente quando is_detached = true.

  - `loan_data.charges.type` (string, required)
    O tipo de cobrança.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo charges estiver presente.
    Example: "MULTA_ATRASO_PAGAMENTO"

  - `loan_data.charges.info` (string, required)
    Informações adicionais sobre o type de cobrança.
    Example: "Late payment charge."

  - `loan_data.charges.amount` (number, required)
    O valor da cobrança.

> Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil quando o campo charges estiver presente.
    Example: 8903.77

  - `payment_type` (string,null, required)
    O tipo de pagamento da transação. Retornamos um dos seguintes valores:

  - FULL
  - INSTALLMENT
  - null
    Enum: "FULL", "INSTALLMENT", null

  - `operation_type` (string, required)
    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.
    Example: "TRANSFERENCIA_MESMA_INSTITUICAO"

  - `operation_type_additional_info` (string,null, required)
    Informações adicionais sobre o operation_type, se aplicável.
    Example: "Internal transfer."

  - `mcc` (integer,null, required)
    O código de categoria de comerciante (MCC) de quatro dígitos (conforme ISO-18245) para a transação. Este campo é aplicável apenas para transações com cartão de crédito.
    Example: 5137

## Response 408 fields (application/json):

  - `code` (string)
    Um código de erro único (request_timeout) que permite classificar e lidar com o erro programaticamente.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Uma breve descrição do erro.

Para erros de request_timeout, a descrição é:

  - The request timed out, you can retry asking for less data by changing your query parameters.
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 428 fields (application/json):

  - `code` (string)
    Um código de erro único (token_required) que permite classificar e lidar com o erro programaticamente.
ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 428 token_required.
    Example: "token_required"

  - `message` (string)
    Uma breve descrição do erro. Para erros token_required, a descrição é:

- A instituição requer um token MFA para fazer login.
    Example: "A MFA token is required by the institution to login"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

  - `session` (string)
    Um ID único de 32 caracteres da sessão de login (correspondente a um padrão regex de: [a-f0-9]{32}).
    Example: "2675b703b9d4451f8d4861a3eee54449"

  - `expiry` (integer)
    Tempo de duração da sessão em segundos.
    Example: 9600

  - `link` (string)
    Identificador único criado pela Belvo, usado para referenciar o Link atual.
    Example: "30cb4806-6e00-48a4-91c9-ca55968576c8"

  - `token_generation_data` (object)
    Detalhes sobre como gerar o token.

  - `token_generation_data.instructions` (string)
    Instruções para geração de token.
    Example: "Use this code to generate the token"

  - `token_generation_data.type` (string)
    Tipo de dados para gerar o token (QR code, desafio numérico).
    Example: "numeric"

  - `token_generation_data.value` (string)
    Valor a ser usado para gerar o token.
    Example: "12345"

  - `token_generation_data.expects_user_input` (boolean)
    Indica se o usuário precisa fornecer entrada para concluir a autenticação. Quando definido como false, seu usuário pode precisar:
- confirmar o login em outro dispositivo
- escanear um código QR
Você ainda precisará fazer uma chamada PATCH para concluir a solicitação.
    Example: true

## Response 500 fields (application/json):

  - `code` (string)
    Um código de erro único (unexpected_error) que permite classificar e tratar o erro de forma programática.

ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com erros 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Uma breve descrição do erro.

Para erros unexpected_error, a descrição é:

  - Belvo não consegue processar a solicitação devido a um problema interno do sistema ou a uma resposta não suportada de uma instituição.
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: [a-f0-9]{32}). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"