Lista de erros do Fees Engine

Formato do erro

{
   "code": "<error_code>",
   "title": "<error_title>",
   "message": "<error_message>"
}

Definição dos campos

code – Um identificador único e estável para o erro. Útil para tratamento programático e solicitações de suporte.
title – Um resumo curto e legível do problema.
message – Orientação detalhada para ajudá-lo a resolver o erro.

Essa estrutura garante que você sempre receba feedback acionável quando algo não sair como esperado.

Erros do Fees Engine

Os seguintes erros podem ocorrer ao interagir com os endpoints do Fees Engine. Cada erro segue nossa estrutura padrão, facilitando a depuração e a resposta a problemas de forma programática. Consulte a tabela abaixo para uma lista de possíveis códigos de erro, o que eles significam e como resolvê-los.

400

`code`	`title`	`message`
FEE-0001	Unexpected fields in the request	The request body contains more fields than expected. Please send only the allowed fields as per the documentation. The unexpected fields are listed in the fields object.
FEE-0002	Missing fields in request	Your request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request.
FEE-0003	Bad request	The server could not understand the request due to malformed syntax. Please check the listed fields and try again.
FEE-0005	Calculation field type invalid	The Calculation field type is invalid. Values can only be percentage or flat.
FEE-0006	Invalid query parameter	One or more query parameters are in an incorrect format. Please check the following parameters ‘parametros_erros’ and ensure they meet the required format before trying again.
FEE-0007	Invalid date format error	The ‘initialDate’, ‘finalDate’, or both are in the incorrect format. Please use the ‘yyyy-mm-dd’ format and try again.
FEE-0008	Invalid final date error	The ‘finalDate’ cannot be earlier than the ‘initialDate’. Please verify the dates and try again.
FEE-0009	Date range exceeds limit error	The range between ‘initialDate’ and ‘finalDate’ exceeds the permitted limit of %v months. Please adjust the dates and try again.
FEE-0010	Invalid date range error	Both ‘initialDate’ and ‘finalDate’ fields are required and must be in the ‘yyyy-mm-dd’ format. Please provide valid dates and try again.
FEE-0011	Pagination limit exceeded	The pagination limit exceeds the maximum allowed of %v items per page. Please verify the limit and try again.
FEE-0012	Entity not found	No entity was found for the given ID. Please make sure to use the correct ID for the entity you are trying to manage.
FEE-0013	Invalid fee priority	The priority field in fees is invalid. Field can not be repeated.
FEE-0014	Account not found on Midaz	Failed to find account ‘%v’ on Midaz. Please check the account alias passed.
FEE-0015	minimumAmount greater than maximumAmount	minimumAmount value is greater than maximumAmount.
FEE-0016	Invalid path parameter	Path parameters is in an incorrect format. Please check the following parameter and ensure they meet the required format before trying again.
FEE-0017	Nothing to update	No updatable fields were provided. Please include at least one field to update.
FEE-0018	Package already exists	There is a Package with same index values for [organizationId, ledgerId, segmentId, transactionRoute, minimumAmount, maximumAmount]
FEE-0019	Invalid header parameter	One or more headers parameters are in an incorrect format. Please check the following parameters and ensure they meet the required format before trying again.
FEE-0020	Missing header	Headers parameters is required. Please check the following header parameters %v and ensure they are passing the values correctly.
FEE-0021	Invalid transaction type	Only one transaction type (‘amount’, ‘share’, or ‘remaining’) must be specified in the ‘%v’ field for each entry. Please review your input and try again.
FEE-0022	Failed to calculate fee	Error to make the calculation of a fee about a transaction.
FEE-0023	Missing calculation model	The calculation model is required to Fee.
FEE-0024	originalAmount is required when priority is one	For Priority equals to one, referenceAmount must be ‘originalAmount’ for fee.
FEE-0025	Failed to apply rule: flatFee or percentual	applicationRule flatFee or percentual must have exactly 1 calculation for Fee.
FEE-0026	Invalid calculation type: percentual	The calculation type percentual must be ‘percentage’ for Fee.
FEE-0027	Invalid calculation type: flatFee	The calculation type flatFee must be ‘flat’ for Fee.
FEE-0028	Missing required fee fields	All fields of a new Fee must be filled. Please check again the payload passed.
FEE-0029	Calculation field is required for fee	Please fill the Calculation object correctly. All calculation fields must be filled.
FEE-0030	referenceAmount is not valid	Field reference amount must be originalAmount or afterFeesAmount.
FEE-0031	Invalid applicationRule	Field application rule must be maxBetweenTypes, flatFee or percentual.
FEE-0032	Invalid calculation type	Field calculation type must be percentage or flat.
FEE-0033	maximumAmount less than minimumAmount	maximumAmount value is less than minimumAmount.
FEE-0034	Package filtering error	Failed to filter a single package by transactionRoute, segmentID, and maximum/minimum amount. Either no package was found or multiple packages matched the criteria.
FEE-0035	Package amount range overlap	The maximumAmount and minimumAmount of the new package overlap with the amount range of an existing package.
FEE-0036	Invalid sort order	Invalid ‘sort_order’ value. Expected ‘asc’ or ‘desc’.
FEE-0037	Error to distribute values	Error to try distribute the values of send object. Please check the data passed.
FEE-0038	Failed to apply rule: maxBetweenTypes	applicationRule maxBetweenTypes must have more than 1 calculation for Fee %v.
FEE-0039	Invalid segmentID	The specified segmentID is not a valid UUID. Please check the value passed.
FEE-0040	Invalid ledgerID	The specified ledgerID is not a valid UUID. Please check the value passed.
FEE-0041	Unmarshalling error	Invalid value for field ‘%s’: expected type ‘%s’, but got ‘%s’.
FEE-0042	Error to convert values	The value of the field %s is invalid. Remember to use dot (.) as decimal separator instead of comma (,). Example: use 1000.50 instead of 1000,50.
FEE-0043	originalAmount is required when isDeductibleFrom is true	For isDeductibleFrom `true`, referenceAmount must be ‘originalAmount’ for ‘%s’.
FEE-0044	applicationRule invalid value	applicationRule is invalid, Err: %v.
FEE-0045	forbidden to access Midaz	Error to access Midaz. Please check the client credentials to access Midaz for creditAccount %v validation.
FEE-0046	calculation value percentage invalid	Calculation value is invalid can not utrapass 100%%. Please check the calculation value for Fee %v..
FEE-0047	calculation value flat invalid	Calculation value is invalid can not utrapass the minimum amount %v. Please check the calculation value for Fee %v.
FEE-0048	error to access Midaz	Error to access Midaz to validate creditAccount %v. Please check the client credentials to access Midaz.
FEE-0049	deductible value forbidden	Can not update deductible value to true. The calculation value is bigger than 100%% for Fee %v.
FEE-0050	deductible value forbidden	Can not update deductible value to true. Calculation value is bigger than the minimum amount %v for Fee %v.
FEE-0051	Invalid page parameter	Query parameter page is invalid. The page must be greater than 0.
FEE-0053	Invalid billing package type	The billing package type is invalid. Valid types are ‘volume’ and ‘maintenance’.
FEE-0054	Missing volume fields	Volume billing packages require: eventFilter (transactionRoute, status), pricingModel, tiers, assetCode, debitAccountAlias, and creditAccountAlias.
FEE-0055	Missing maintenance fields	Maintenance billing packages require: feeAmount, assetCode, maintenanceCreditAccount, and accountTarget.
FEE-0056	Invalid pricing model	The pricing model is invalid. Valid models are ‘tiered’ and ‘fixed’.
FEE-0057	Invalid pricing tier	Pricing tier configuration is invalid. Each tier must have minQuantity and unitPrice. Tiers must not overlap.
FEE-0058	Billing route overlap	A billing package already exists for this organization, ledger, and transaction route combination.
FEE-0063	Invalid billing period	The billing period format is invalid. Use ‘YYYY-MM’ (monthly), ‘YYYY-Www’ (weekly), or ‘YYYY-MM-DD’ (daily) format.
FEE-0064	Invalid free quota	The free quota value is invalid. Must be a non-negative integer.
FEE-0065	Invalid discount tier	Discount tier configuration is invalid. Each tier must have minQuantity and discountPercentage between 0 and 100.
FEE-0067	Invalid count mode	The count mode is invalid. Valid modes are ‘perRoute’ and ‘perAccount’.
FEE-0069	Invalid account target	The accountTarget must have exactly one of segmentId, portfolioId, or aliases. Aliases limited to 100 entries.
FEE-0070	Invalid fee amount	The fee amount is invalid. It must be a positive value greater than zero.

404

`code`	`title`	`message`
FEE-0052	Billing package not found	No billing package was found for the given ID.
FEE-0059	Target account not found	The target account was not found or is inactive in Midaz.
FEE-0061	No active billing packages	No active billing packages were found for the specified organization and ledger.

422

`code`	`title`	`message`
FEE-0060	Billing calculation failed	Failed to calculate billing. Check the error details for the specific package and resource that caused the failure.
FEE-0062	Segment resolution failed	Failed to resolve accounts for the configured segment. Verify the segment exists and try again.
FEE-0068	Service dependency unavailable	A required service is temporarily unavailable. Please try again later.

500

`code`	`title`	`message`
FEE-0004	Internal Server Error	The server encountered an unexpected error. Please try again later or contact support.

Primeiros passos

API de Organizações

API de Ledgers

API de Ativos

API de Tipos de Conta

API de Contas

API de Portfólios

API de Segmentos

API de Saldos

API de Transações

API de Operações

API de Rotas de Operação

API de Rotas de Transação

API de Índices de Metadados

API de Titulares

API de Instrumentos

API de Pacotes de Cobrança

API de Pacotes

API de Cálculo de Cobrança

API de Estimativa

API de Criptografia

API de Proteção

API de Taxas de Ativos

Tratamento de erros

Fees Engine

Lista de erros do Fees Engine

Erros do Fees Engine

400

404

422

500

​Erros do Fees Engine

​400

​404

​422

​500

Erros do Fees Engine

400

404

422

500