# Concluir uma solicitação de despesas recorrentes Usado para retomar uma sessão de recuperação de Despesas Recorrentes que foi pausada porque um token MFA foi exigido pela instituição. Endpoint: PATCH /api/recurring-expenses/ 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 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 que você deseja retomar. Deve ser o mesmo que você recebe na resposta 428 Token Required que contém o ID da . 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 e retornamos uma resposta 201 Created. Quando definido como , os dados não serão persistidos e retornamos uma resposta 200 OK. Example: true ## Response 200 fields (application/json): - `id` (string) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `account` (object,null, required) Detalhes sobre a conta. : Para o nosso recurso de despesas recorrentes, esta conta está relacionada à conta que foi analisada para gerar o relatório de despesas recorrentes. - `account.link` (string,null) O ao qual os dados pertencem. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `account.institution` (object) 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: - - - 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) 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.category` (string,null, required) O tipo de conta. Retornamos um dos seguintes valores do enum: - - - - - - - - Enum: "CHECKING_ACCOUNT", "CREDIT_CARD", "INVESTMENT_ACCOUNT", "LOAN_ACCOUNT", "PENSION_FUND_ACCOUNT", "SAVINGS_ACCOUNT", "UNCATEGORIZED", null - `account.balance_type` (string,null, required) Indica se esta conta é um ou um . Você pode considerar o saldo de um como positivo, enquanto o saldo de um como negativo. Example: "ASSET" - `account.type` (string,null, required) O tipo de conta, conforme designado pela instituição. Example: "Cuentas de efectivo" - `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.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. - : O saldo da conta do usuário no timestamp . - : O valor que o usuário gastou no período de faturamento atual do cartão (consulte para informações sobre quando o período de faturamento atual termina). - : O valor restante a pagar no empréstimo do usuário. Example: 5874.13 - `account.balance.available` (number,null) O saldo que o proprietário da conta pode usar. - : O saldo disponível pode ser diferente do saldo devido a transações pendentes. - : O valor de crédito que o usuário ainda tem disponível para o período atual. O saldo pode ser diferente do saldo devido a transações pendentes ou parcelas futuras. - : O valor presente necessário para quitar o empréstimo, conforme fornecido pela instituição. Se a instituição não fornecer este valor, retornamos . Example: 5621.12 - `account.currency` (string,null, required) A moeda da conta. Por exemplo: - 🇧🇷 BRL (Real Brasileiro) - 🇨🇴 COP (Peso Colombiano) - 🇲🇽 MXN (Peso Mexicano) Por favor, note que outras moedas além das listadas acima podem ser retornadas. Example: "MXN" - `account.public_identification_name` (string,null, required) O nome público para o tipo de identificação. Por exemplo: . ℹ️ Para contas de poupança e corrente 🇧🇷 brasileiras, este campo será . Example: "CLABE" - `account.public_identification_value` (string,null, required) O valor para o . ℹ️ Para contas de poupança e corrente brasileiras, este campo será o número da agência e da conta bancária, separados por uma barra. Por exemplo: . Example: "150194683119900273" - `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.credit_data` (object,null, required) As opções de crédito associadas a esta conta. - `account.credit_data.credit_limit` (number,null, required) O valor máximo de crédito que o proprietário pode receber. Example: 192000 - `account.credit_data.cutting_date` (string,null, required) A data de encerramento do período de crédito, no formato . Example: "2019-12-11" - `account.credit_data.next_payment_date` (string, required) A data de vencimento para o próximo pagamento, no formato . Example: "2019-12-13" - `account.credit_data.minimum_payment` (number,null, required) O valor mínimo a ser pago na . Example: 2400.3 - `account.credit_data.no_interest_payment` (number,null, required) O valor mínimo necessário para pagar para evitar a geração de juros. Example: 2690.83 - `account.credit_data.interest_rate` (number,null, required) A taxa de juros anualizada do crédito. Example: 4 - `account.credit_data.monthly_payment` (number,null) - `account.credit_data.last_payment_date` (string,null) - `account.credit_data.last_period_balance` (string,null) - `account.loan_data` (object,null, required) As opções de empréstimo associadas a esta conta. - `account.loan_data.contract_amount` (number,null) O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas. Example: 202000 - `account.loan_data.principal` (number,null, required) Valor total do empréstimo (o valor que o usuário recebe). Example: 192000 - `account.loan_data.loan_type` (string,null) O tipo do empréstimo, de acordo com a instituição. Example: "Consignado" - `account.loan_data.payment_day` (string,null) O dia do mês em que o proprietário precisa pagar o empréstimo (). Example: "27" - `account.loan_data.outstanding_principal` (number,null) Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros). Example: 142023 - `account.loan_data.outstanding_balance` (number,null, required) O valor restante a pagar no total, incluindo juros. Example: 182000 - `account.loan_data.monthly_payment` (number,null, required) O pagamento mensal recorrente, se aplicável. Example: 1000 - `account.loan_data.interest_rates` (array,null, required) Detalhamento dos juros aplicados ao empréstimo. - `account.loan_data.interest_rates.name` (string,null, required) O nome do tipo de taxa de juros aplicada ao empréstimo. Example: "jurosEfetivo" - `account.loan_data.interest_rates.type` (string,null, required) O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores: - - Enum: "MONTHLY", "YEARLY" - `account.loan_data.interest_rates.value` (number,null, required) A taxa de juros (em porcentagem ou valor monetário). Example: 7.85 - `account.loan_data.fees` (array,null) Detalhamento das taxas aplicadas ao empréstimo. - `account.loan_data.fees.type` (string, required) O tipo de taxa. Retornamos um dos seguintes valores: - - - Enum: "OPERATION_FEE", "INSURANCE_FEE", "OTHERS" - `account.loan_data.fees.value` (number, required) O valor total da taxa. Mesma moeda do Empréstimo. Example: 5.6 - `account.loan_data.number_of_installments_total` (integer,null) O número total de parcelas necessárias para pagar o empréstimo. Example: 60 - `account.loan_data.number_of_installments_outstanding` (integer,null) O número de parcelas restantes para pagar. Example: 48 - `account.loan_data.contract_start_date` (string,null) A data em que o contrato de empréstimo foi assinado, no formato . Example: "2020-03-01" - `account.loan_data.contract_end_date` (string) A data em que se espera que o empréstimo seja concluído, no formato . Example: "2027-10-01" - `account.loan_data.contract_number` (string,null) O número do contrato do empréstimo, conforme fornecido pela instituição. Example: "890ASLDJF87SD00" - `account.loan_data.credit_limit` (number,null) Por favor, consulte em vez disso. - `account.loan_data.last_period_balance` (number,null) Por favor, consulte em vez disso. - `account.loan_data.interest_rate` (number,null) Por favor, consulte o objeto . - `account.loan_data.limit_day` (string,null) Consulte em vez disso. - `account.loan_data.cutting_day` (string,null) O dia de fechamento do mês para o empréstimo. - `account.loan_data.cutting_date` (string,null) A data de encerramento do período do empréstimo, no formato . - `account.loan_data.last_payment_date` (string,null) A data em que o último pagamento do empréstimo foi realizado, no formato . - `account.loan_data.next_payment_date` (string,null) Por favor, use em vez disso, no formato . - `account.loan_data.no_interest_payment` (number,null) O valor mínimo necessário para pagar e evitar a geração de juros. - `account.funds_data` (array,null) Um ou mais fundos que contribuem para a conta de pensão. - `account.funds_data.name` (string,null) O nome do fundo de pensão. Example: "FIX X" - `account.funds_data.type` (string,null) Tipo de fundo de pensão. Example: "CNPJ" - `account.funds_data.public_identifications` (array,null) Os IDs públicos do fundo. - `account.funds_data.public_identifications.name` (string, required) O tipo de número de identificação para o fundo. Example: "CNPJ" - `account.funds_data.public_identifications.value` (string,null, required) O número de identificação do fundo. Example: "05.954.445/0221-68" - `account.funds_data.balance` (number,null) O montante no fundo. Example: 88427.94 - `account.funds_data.percentage` (number,null) Quanto este fundo, em porcentagem, contribui para o total da conta de pensão. Example: 100 - `account.bank_product_id` (string,null) - `account.internal_identification` (string,null) - `name` (string,null, required) O nome para a despesa recorrente. ℹ️ : Esta informação é retirada da seção de descrição de uma transação e, em seguida, normalizada para fornecer um nome de fácil leitura. Assim, às vezes o nome refletirá o comerciante para o qual o pagamento é feito (por exemplo, Netflix.com), enquanto para outras despesas recorrentes, isso pode ser algo como "Pagamento mensal para John". Example: "Netflix" - `transactions` (array, required) Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio. - `transactions.amount` (number, required) O valor da transação. Example: 2145.45 - `transactions.description` (string,null, required) A descrição da transação fornecida pela instituição. Normalmente, este é o texto que o usuário final veria no extrato bancário. A descrição pode ser uma string vazia. Para o EYOD Risk Insights, a descrição é aquela que você forneceu na solicitação inicial. Example: "Netflix.com/march" - `transactions.value_date` (string, required) A data em que a transação ocorreu, no formato . Example: "2019-10-23" - `frequency` (string, required) A frequência com que essa despesa recorrente ocorre. ℹ️ A Belvo identifica apenas frequências . Enum: "MONTHLY" - `average_transaction_amount` (number, required) O valor médio da transação da despesa recorrente. Example: 32.9 - `median_transaction_amount` (number, required) O valor mediano da transação da despesa recorrente. Example: 32.9 - `days_since_last_transaction` (integer, required) Número de dias desde que a última despesa recorrente ocorreu. Com base na frequência, você pode inferir quantos dias faltam até que a próxima cobrança ocorra. Example: 5 - `category` (string, required) A categoria de transação para a despesa recorrente. Para mais informações sobre as categorias disponíveis, consulte nossa documentação de categorização de transações. - (Netflix, Spotify, Assinaturas de Academia) - (eletricidade, telefone, internet) - (adiantamentos de cartão de crédito, empréstimo estudantil, leasing de embarcações) - (seguro residencial, automotivo, e de saúde & vida) - (viagem de Uber, airbnb, estacionamento) - (taxa de serviço, doação, impostos judiciais) Enum: "Bills & Utilities", "Credits & Loans", "Insurance", "Online Platforms & Leisure", "Transport & Travel", "Taxes" - `payment_type` (string,null, required) O tipo de despesa recorrente. Retornamos um dos seguintes valores: - - Enum: "SUBSCRIPTION", "REGULAR" ## Response 201 fields (application/json): - `id` (string) Identificador único da Belvo para o item atual. Example: "0d3ffb69-f83b-456e-ad8e-208d0998d71d" - `account` (object,null, required) Detalhes sobre a conta. : Para o nosso recurso de despesas recorrentes, esta conta está relacionada à conta que foi analisada para gerar o relatório de despesas recorrentes. - `account.link` (string,null) O ao qual os dados pertencem. Example: "30cb4806-6e00-48a4-91c9-ca55968576c8" - `account.institution` (object) 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: - - - 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) 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.category` (string,null, required) O tipo de conta. Retornamos um dos seguintes valores do enum: - - - - - - - - Enum: "CHECKING_ACCOUNT", "CREDIT_CARD", "INVESTMENT_ACCOUNT", "LOAN_ACCOUNT", "PENSION_FUND_ACCOUNT", "SAVINGS_ACCOUNT", "UNCATEGORIZED", null - `account.balance_type` (string,null, required) Indica se esta conta é um ou um . Você pode considerar o saldo de um como positivo, enquanto o saldo de um como negativo. Example: "ASSET" - `account.type` (string,null, required) O tipo de conta, conforme designado pela instituição. Example: "Cuentas de efectivo" - `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.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. - : O saldo da conta do usuário no timestamp . - : O valor que o usuário gastou no período de faturamento atual do cartão (consulte para informações sobre quando o período de faturamento atual termina). - : O valor restante a pagar no empréstimo do usuário. Example: 5874.13 - `account.balance.available` (number,null) O saldo que o proprietário da conta pode usar. - : O saldo disponível pode ser diferente do saldo devido a transações pendentes. - : O valor de crédito que o usuário ainda tem disponível para o período atual. O saldo pode ser diferente do saldo devido a transações pendentes ou parcelas futuras. - : O valor presente necessário para quitar o empréstimo, conforme fornecido pela instituição. Se a instituição não fornecer este valor, retornamos . Example: 5621.12 - `account.currency` (string,null, required) A moeda da conta. Por exemplo: - 🇧🇷 BRL (Real Brasileiro) - 🇨🇴 COP (Peso Colombiano) - 🇲🇽 MXN (Peso Mexicano) Por favor, note que outras moedas além das listadas acima podem ser retornadas. Example: "MXN" - `account.public_identification_name` (string,null, required) O nome público para o tipo de identificação. Por exemplo: . ℹ️ Para contas de poupança e corrente 🇧🇷 brasileiras, este campo será . Example: "CLABE" - `account.public_identification_value` (string,null, required) O valor para o . ℹ️ Para contas de poupança e corrente brasileiras, este campo será o número da agência e da conta bancária, separados por uma barra. Por exemplo: . Example: "150194683119900273" - `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.credit_data` (object,null, required) As opções de crédito associadas a esta conta. - `account.credit_data.credit_limit` (number,null, required) O valor máximo de crédito que o proprietário pode receber. Example: 192000 - `account.credit_data.cutting_date` (string,null, required) A data de encerramento do período de crédito, no formato . Example: "2019-12-11" - `account.credit_data.next_payment_date` (string, required) A data de vencimento para o próximo pagamento, no formato . Example: "2019-12-13" - `account.credit_data.minimum_payment` (number,null, required) O valor mínimo a ser pago na . Example: 2400.3 - `account.credit_data.no_interest_payment` (number,null, required) O valor mínimo necessário para pagar para evitar a geração de juros. Example: 2690.83 - `account.credit_data.interest_rate` (number,null, required) A taxa de juros anualizada do crédito. Example: 4 - `account.credit_data.monthly_payment` (number,null) - `account.credit_data.last_payment_date` (string,null) - `account.credit_data.last_period_balance` (string,null) - `account.loan_data` (object,null, required) As opções de empréstimo associadas a esta conta. - `account.loan_data.contract_amount` (number,null) O valor total inicial do empréstimo, calculado pela instituição, quando o contrato foi assinado. Este valor inclui o principal + juros + impostos + taxas. Example: 202000 - `account.loan_data.principal` (number,null, required) Valor total do empréstimo (o valor que o usuário recebe). Example: 192000 - `account.loan_data.loan_type` (string,null) O tipo do empréstimo, de acordo com a instituição. Example: "Consignado" - `account.loan_data.payment_day` (string,null) O dia do mês em que o proprietário precisa pagar o empréstimo (). Example: "27" - `account.loan_data.outstanding_principal` (number,null) Montante pendente do empréstimo, ou seja, quanto resta a pagar sobre o principal (não incluindo juros). Example: 142023 - `account.loan_data.outstanding_balance` (number,null, required) O valor restante a pagar no total, incluindo juros. Example: 182000 - `account.loan_data.monthly_payment` (number,null, required) O pagamento mensal recorrente, se aplicável. Example: 1000 - `account.loan_data.interest_rates` (array,null, required) Detalhamento dos juros aplicados ao empréstimo. - `account.loan_data.interest_rates.name` (string,null, required) O nome do tipo de taxa de juros aplicada ao empréstimo. Example: "jurosEfetivo" - `account.loan_data.interest_rates.type` (string,null, required) O período em que o juro é aplicado ao empréstimo. Retornamos um dos seguintes valores: - - Enum: "MONTHLY", "YEARLY" - `account.loan_data.interest_rates.value` (number,null, required) A taxa de juros (em porcentagem ou valor monetário). Example: 7.85 - `account.loan_data.fees` (array,null) Detalhamento das taxas aplicadas ao empréstimo. - `account.loan_data.fees.type` (string, required) O tipo de taxa. Retornamos um dos seguintes valores: - - - Enum: "OPERATION_FEE", "INSURANCE_FEE", "OTHERS" - `account.loan_data.fees.value` (number, required) O valor total da taxa. Mesma moeda do Empréstimo. Example: 5.6 - `account.loan_data.number_of_installments_total` (integer,null) O número total de parcelas necessárias para pagar o empréstimo. Example: 60 - `account.loan_data.number_of_installments_outstanding` (integer,null) O número de parcelas restantes para pagar. Example: 48 - `account.loan_data.contract_start_date` (string,null) A data em que o contrato de empréstimo foi assinado, no formato . Example: "2020-03-01" - `account.loan_data.contract_end_date` (string) A data em que se espera que o empréstimo seja concluído, no formato . Example: "2027-10-01" - `account.loan_data.contract_number` (string,null) O número do contrato do empréstimo, conforme fornecido pela instituição. Example: "890ASLDJF87SD00" - `account.loan_data.credit_limit` (number,null) Por favor, consulte em vez disso. - `account.loan_data.last_period_balance` (number,null) Por favor, consulte em vez disso. - `account.loan_data.interest_rate` (number,null) Por favor, consulte o objeto . - `account.loan_data.limit_day` (string,null) Consulte em vez disso. - `account.loan_data.cutting_day` (string,null) O dia de fechamento do mês para o empréstimo. - `account.loan_data.cutting_date` (string,null) A data de encerramento do período do empréstimo, no formato . - `account.loan_data.last_payment_date` (string,null) A data em que o último pagamento do empréstimo foi realizado, no formato . - `account.loan_data.next_payment_date` (string,null) Por favor, use em vez disso, no formato . - `account.loan_data.no_interest_payment` (number,null) O valor mínimo necessário para pagar e evitar a geração de juros. - `account.funds_data` (array,null) Um ou mais fundos que contribuem para a conta de pensão. - `account.funds_data.name` (string,null) O nome do fundo de pensão. Example: "FIX X" - `account.funds_data.type` (string,null) Tipo de fundo de pensão. Example: "CNPJ" - `account.funds_data.public_identifications` (array,null) Os IDs públicos do fundo. - `account.funds_data.public_identifications.name` (string, required) O tipo de número de identificação para o fundo. Example: "CNPJ" - `account.funds_data.public_identifications.value` (string,null, required) O número de identificação do fundo. Example: "05.954.445/0221-68" - `account.funds_data.balance` (number,null) O montante no fundo. Example: 88427.94 - `account.funds_data.percentage` (number,null) Quanto este fundo, em porcentagem, contribui para o total da conta de pensão. Example: 100 - `account.bank_product_id` (string,null) - `account.internal_identification` (string,null) - `name` (string,null, required) O nome para a despesa recorrente. ℹ️ : Esta informação é retirada da seção de descrição de uma transação e, em seguida, normalizada para fornecer um nome de fácil leitura. Assim, às vezes o nome refletirá o comerciante para o qual o pagamento é feito (por exemplo, Netflix.com), enquanto para outras despesas recorrentes, isso pode ser algo como "Pagamento mensal para John". Example: "Netflix" - `transactions` (array, required) Um array de objetos de transação minificados usado para avaliar a despesa recorrente. Se nenhuma transação for encontrada, retornamos um array vazio. - `transactions.amount` (number, required) O valor da transação. Example: 2145.45 - `transactions.description` (string,null, required) A descrição da transação fornecida pela instituição. Normalmente, este é o texto que o usuário final veria no extrato bancário. A descrição pode ser uma string vazia. Para o EYOD Risk Insights, a descrição é aquela que você forneceu na solicitação inicial. Example: "Netflix.com/march" - `transactions.value_date` (string, required) A data em que a transação ocorreu, no formato . Example: "2019-10-23" - `frequency` (string, required) A frequência com que essa despesa recorrente ocorre. ℹ️ A Belvo identifica apenas frequências . Enum: "MONTHLY" - `average_transaction_amount` (number, required) O valor médio da transação da despesa recorrente. Example: 32.9 - `median_transaction_amount` (number, required) O valor mediano da transação da despesa recorrente. Example: 32.9 - `days_since_last_transaction` (integer, required) Número de dias desde que a última despesa recorrente ocorreu. Com base na frequência, você pode inferir quantos dias faltam até que a próxima cobrança ocorra. Example: 5 - `category` (string, required) A categoria de transação para a despesa recorrente. Para mais informações sobre as categorias disponíveis, consulte nossa documentação de categorização de transações. - (Netflix, Spotify, Assinaturas de Academia) - (eletricidade, telefone, internet) - (adiantamentos de cartão de crédito, empréstimo estudantil, leasing de embarcações) - (seguro residencial, automotivo, e de saúde & vida) - (viagem de Uber, airbnb, estacionamento) - (taxa de serviço, doação, impostos judiciais) Enum: "Bills & Utilities", "Credits & Loans", "Insurance", "Online Platforms & Leisure", "Transport & Travel", "Taxes" - `payment_type` (string,null, required) O tipo de despesa recorrente. Retornamos um dos seguintes valores: - - Enum: "SUBSCRIPTION", "REGULAR" ## Response 403 fields (application/json): - `code` (string) Um código de erro único () que permite classificar e tratar o erro programaticamente. ℹ️ Consulte nosso DevPortal para mais informações sobre como lidar com 403 access_to_resource_denied. Example: "access_to_resource_denied" - `message` (string) Uma breve descrição do erro. Para erros , a descrição é: - . Example: "You don't have access to this resource." - `request_id` (string) Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 404 fields (application/json): - `code` (string) Um código de erro único () que permite classificar e lidar com o erro programaticamente. Example: "not_found" - `message` (string) Uma breve descrição do erro. Para erros , a descrição é: - Example: "Not found" - `request_id` (string) Um ID único de 32 caracteres da solicitação (correspondente a um padrão regex de: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb" ## Response 408 fields (application/json): - `code` (string) Um código de erro único () 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 , a descrição é: - . 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: ). 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 () 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 , a descrição é: - . 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: ). 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: ). 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 , 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 () 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 , a descriçã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: ). Forneça este ID ao entrar em contato com a equipe de suporte da Belvo para acelerar as investigações. Example: "9e7b283c6efa449c9c028a16b5c249fb"