Errors list
Here you can find the list with all the errors that you might face throughout the API integration with Midaz.
API Error Codes Reference
When working with our API, you might encounter certain error responses. These errors are designed to help you quickly understand and troubleshoot issues. Below is a comprehensive table of possible error codes, along with their titles and descriptions, to aid in your integration process.
Field descriptions
| Name | Type | Description |
|---|---|---|
| String | The error code. |
| String | The title of the error. |
| String | A description with more information about the error. |
Code details
| Code | Title | Description |
|---|---|---|
0001 | Duplicate Ledger Error | A ledger named {{name}} already exists within the division {{divisionName}}. Please change the ledger's name or select a different division to attach it to. |
0002 | Ledger Name Conflict | A ledger named {{name}} already exists within your organization. Consider creating a new ledger under a division if you wish to use the same name. Alternatively, change your ledger's name or attach it to a division. |
0003 | Instrument Name or Code Duplicate | An instrument with the same name or code already exists in your ledger. Please modify the name or code of your new instrument. |
0004 | Code Uppercase Requirement | The code must be in uppercase. Please send the code in uppercase format. |
0005 | Currency Code Standard Compliance | Currency-type instruments must adhere to the ISO-4217 standard. Please use a currency code that follows ISO-4217 guidelines. |
0006 | Unmodifiable Field Error | Your request contains a field that cannot be modified. Please review your request and try again, removing any fields that cannot be edited. Consult the documentation for guidance. |
0007 | Entity Not Found | No entity was found matching the provided ID. Ensure the correct ID is being used for the entity you are attempting to manage. |
0008 | Action Not Permitted | The action you are attempting is not allowed in the current environment. Please consult the documentation for guidance on how to proceed. |
0009 | Missing Fields in Request | Your request is missing one or more required fields. Please refer to the documentation to verify the necessary fields for your request. |
0010 | Account Type Immutable | The account type specified cannot be modified. Please ensure the correct account type is being used and try again. |
0011 | Inactive Account Type Error | The account type specified cannot be set to INACTIVE. Please ensure the correct account type is being used and try again. |
0012 | Account Balance Deletion Error | An account or sub-account with a remaining balance cannot be deleted. Transfer all balances to another account before attempting deletion again. |
0013 | Resource Already Deleted | The resource you are trying to delete has already been deleted. Ensure you are using the correct ID and try again. |
0014 | Product ID Inactive | The Product ID you are attempting to use is inactive. Please use another Product ID and try again. |
0015 | Duplicate Product Name Error | A product with the name {{name}} already exists for ledger ID {{ledgerId}}. Please try again with a different ledger or name. |
0016 | Balance Remaining Deletion Error | The instrument cannot be deleted due to a remaining balance. Ensure all balances are cleared before attempting deletion again. |
0017 | Invalid Script Format Error | The script provided in your request is invalid or in an unsupported format. Please verify the script format and try again. |
0018 | Insufficient Funds Error | The transaction could not be completed due to insufficient funds in the account. Please add sufficient funds to your account and try again. |
0019 | Account Ineligibility Error | One or more accounts listed in the transaction are ineligible to participate. Review the account statuses and try again. |
0020 | Alias Unavailability Error | The alias {{alias}} is already in use. Please choose a different alias and try again. |
0021 | Parent Transaction ID Not Found | The parentTransactionId {{parentTransactionId}} does not correspond to any existing transaction. Please review the ID and try again. |
0022 | Immutable Field Error | The field {{field}} cannot be modified. Please remove this field from your request and try again. |
0023 | Transaction Timing Restriction | You can only perform another transaction using {{instrumentCode}} of {{amount}} from {{source}} to {{destination}} after {{timestampUnlock}}. Please wait until the specified time to try again. |
0024 | Account Status Transaction Restriction | The current statuses of the source and/or destination accounts do not permit transactions. Change the account status(es) and try again. |
0025 | Insufficient Account Balance Error | The account {{accountId}} does not have sufficient balance. Please try again with an amount that is less than or equal to the available balance. |
0026 | Transaction Method Restriction | Transactions using {{instrumentCode}} are not allowed for the source and/or destination. Please try again with accounts that permit transactions with {{instrumentCode}}. |
0027 | Duplicate Transaction Template Code Error | A transaction template with the code {{code}} already exists for your ledger. Please use a different code and try again. |
0028 | Duplicate Instrument Pair Error | A pair for the instruments {{baseInstrumentCode}}{{counterInstrumentCode}} already exists with the ID {{instrument_rates.id}}. Please update the existing entry instead of creating a new one. |
0029 | Invalid Parent Account ID | The specified parent account ID does not exist. Please verify the ID is correct and attempt your request again. |
0030 | Mismatched Instrument Code | The provided parent account ID is associated with a different instrument code than the one specified in your request. Please ensure the instrument code matches that of the parent account, or use a different parent account ID and try again. |
0031 | Chart Type Not Found | The chart type {{chartType}} does not exist. Please provide a valid chart type and refer to the documentation if you have any questions. |
0032 | Invalid Country Code | The provided country code in the 'address.country' field does not conform to the ISO-3166 alpha-2 standard. Please provide a valid alpha-2 country code. |
0033 | Invalid Code Format | The 'code' field must be alphanumeric, in upper case, and must contain at least one letter. Please provide a valid code. |
0034 | Instrument Code Not Found | The provided instrument code does not exist in our records. Please verify the instrument code and try again. |
0035 | Portfolio ID Not Found | The provided portfolio ID does not exist in our records. Please verify the portfolio ID and try again. |
0036 | Product ID Not Found | The provided product ID does not exist in our records. Please verify the product ID and try again. |
0037 | Ledger ID Not Found | The provided ledger ID does not exist in our records. Please verify the ledger ID and try again. |
0038 | Organization ID Not Found | The provided organization ID does not exist in our records. Please verify the organization ID and try again. |
0039 | Parent Organization ID Not Found | The provided parent organization ID does not exist in our records. Please verify the parent organization ID and try again. |
0040 | Invalid Type | The provided 'type' is not valid. Accepted types are: currency, crypto, commodities, or others. Please provide a valid type. |
Last updated