API Response & Error Codes
- Updated On 17 Dec 2020
- 73 Minutes To Read
-
Print
-
DarkLight
Mambu Response Codes
These response codes give a more detailed analysis of any problems which may have occurred with an API call such as incorrect parameters, or actions which attempt to violate the business logic of the system (illegal state changes, invalid amounts and dates, etc)
The response codes listed below cover both API v1 and v2
Generic Response Codes (1 - 60)
| Response Code | Description |
|---|---|
| 0 SUCCESS | The request was successful |
| 1 INVALID_BASIC_AUTHORIZATION | The application id or application key are not configured properly |
| 2 INVALID_CREDENTIALS | The username and password provided was invalid |
| 3 INVALID_API_OPERATION | The API URI is incorrect |
| 4 INVALID_PARAMETERS | A required parameter for this API operation is invalid or has not been provided |
| 5 METHOD_NOT_IMPLEMENTED | The HTTP method for this operation is not implemented. For example, the API operation has only been defined for HTTP GET request and an HTTP Post request was called. |
| 6 INTERNAL_ERROR | An unknown Mambu exception was thrown |
| 7 API_NOT_AUTHORIZED | Caller is not authorized to make user of the API service. Check your Keys in the API Portal |
| 8 USER_TRANSACTION_LIMIT_EXCEEDED | The API was not properly configured for monitoring |
| 9 API_CONFIGURATION_ERROR | The API account is not authorized to make transactions (deposits, disbursals, etc) of this size |
| 10 INVALID_TENANT_ID | No tenant to answer this API call was found |
| 11 INVALID_PAGINATION_OFFSET_VALUE | The pagination offset value was not a proper Integer value |
| 12 OUT_OF_BOUNDS_PAGINATION_OFFSET_VALUE | The pagination offset value was smaller than 0 |
| 13 INVALID_PAGINATION_LIMIT_VALUE | The pagination limit value was not a proper Integer value |
| 14 OUT_OF_BOUNDS_PAGINATION_LIMIT_VALUE | The pagination limit value was smaller than 0 or bigger than its upper limit |
| 15 INVALID_PERMISSIONS | The user is missing permissions in order to complete an operation |
| 16 INVALID_IP_ADDRESS | This IP address is not authorized for API access |
| 17 INACTIVE_USER | User account is not active and cannot be used |
| 18 NO_API_ACCESS | User doesn't have API access permissions |
| 20 MAX_FILE_SIZE_EXCEEDED | The file size is larger than 5242880 bytes. |
| 21 MAX_FILENAME_LENGTH_EXCEEDED | The file name size, including the path, is larger than 256 characters. |
| 22 UNSUPPORTED_CHARACTER_ENCODING | The file has an unsupported character encoding. The character encoding must be supported by java. |
| 23 INVALID_API_PROTOCOL | The request was done through an invalid protocol. Mambu API's always use HTTPS. |
| 24 EXCESSIVE_INVALID_REQUESTS | The account is temporarily disabled due to excessive incorrect logins and must be unlocked by an administrator. For instructions on how to re-enable the account, please see: Managing Users and Permissions |
| 25 INCONSISTENT_IDENTIFIER_WITH_JSON | When the identifier does not match with the encoded key or id from the JSON object. |
| 26 INVALID_JSON_SYNTAX | When the JSON parsing fails. Some cases that can cause this error: invalid JSON syntax, invalid enum values, invalid data type for value, etc. |
| 27 PARAMETER_NOT_ALLOWED | A parameter in the API call is not allowed in this context. |
| 28 START_DATE_AFTER_END_DATE | When the API param start date is after API param end date. |
| 29 OBJECT_NOT_FOUND | When no object is found for the given identifier. |
| 30 MISSING_ENTITY_JSON | When the required entity JSON object is missing. |
| 31 MISSING_REQUIRED_PARAMETER | A required parameter is missing from input |
| 32 READ_ONLY_MODE | Returned when the server is unavailable for non-data-retrieval API calls since it is in Read-Only mode |
| 60 BLOCKING_OPERATION_IN_PROGRESS | When operation can not be performed due to another pending operation that locked shared resources. |
Loan Accounts (97 - 199)
| Response Code | Description |
|---|---|
| 97 NON_REVERSIBLE_WRITE_OFF | When the loan account cannot reverse the write-off transaction |
| 98 NON_WEEKLY_LOAN_REPAYMENTS | When the entity, which is reassigned to a centre with a different centre meeting day, has a loan account with non-weekly repayments |
| 99 INCONSISTENT_LINKED_ACCOUNT | When the linked account is not consistent with the current loan. |
| 100 INVALID_LOAN_ACCOUNT_ID | The loan account specified does not exist |
| 101 INVALID_AMOUNT | The amount parameter is 0, not an integer, or otherwise invalid |
| 102 INVALID_DATE | The date parameter is not properly formatted. Must follow the ISO standard such as: yyyy-MM-dd |
| 103 INVALID_NOTES | The notes parameter is not valid |
| 104 INVALID_TRANSACTION_TYPE_ID | When the provided id or key for the transaction channel is invalid |
| 105 INVALID_ACCOUNT_STATE | One of the accounts involved in the call is in an invalid state. This can occur for example when posting transactions to/from accounts in non-active statuses or when posting transactions that trigger bulk reversals to/from another account in non-active status. |
| 106 INVALID_FEE | The account is in an invalid state for the given operation. |
| 107 LOAN_PRODUCT_MISMATCH | The account parameters don't match the loan product parameters. |
| 108 INVALID_FIELD_FOR_TRANSACTION_TYPE | When a field is given as a parameter, but the transaction type does not allow it |
| 109 INACTIVE_TRANSACTION_TYPE | When trying to make a transaction using an inactive transaction channel. |
| 110 EXCESS_REPAYMENT_ERROR | The repayment amount exceed the loan balence |
| 111 TRANSACTION_LOGGED_AFTER_NOT_DISBURSED_TRANCHE | When a transaction is logged after a non disbursed tranche. |
| 112 UNDEFINED_ACCOUNT_FOR_FINANCIAL_RESOURCE_ERROR | The account specified for the financial resource is not defined |
| 113 INVALID_ACCOUNT_FOR_JOURNAL_ENTRY_ERROR | The account specified for the journal entry is invalid |
| 114 MISSING_LOAN_ID | The loan account identifier has not been specified |
| 115 MAXIMUM_EXPOSURE_EXCEEDED | when the maximum exposure is exceeded for a client |
| 116 INVALID_STATE_TRANSITION | An invalid loan account state transition |
| 117 NUMBER_OF_LOANS_EXCEED | When the number of loans for an organization is exceeded |
| 118 INVALID_FIRST_REPAYMENT_DUE_DATE | When the first repayment due date it's not valid |
| 119 INVALID_REPAYMENT_DUE_DAY | When repayment date is not the same as assigned centre's meeting day |
| 120 INVALID_INTEREST_RATE | An invalid interest rate is being used as a parameter |
| 121 INVALID_INSTALLMENTS | An invalid number of installments rate is being used as a parameter |
| 123 PREPAYMENT_NOT_ALLOWED_ERROR | When a pre-payment it's trying to be posted and it's not allowed at loan product level |
| 124 REPAYMENT_DATE_IN_THE_FUTURE_ERROR | When the specified repayment date it's set in future |
| 125 INVALID_DISBURSEMENT_DATE | When the specified disbursement date is invalid |
| 126 INVALID_ACCOUNT_STATE_FOR_RESCHEDULE | When the account's state doesn't allow a reschedule |
| 127 ORIGINAL_ACCOUNT_HAS_FUNDS | When trying to reschedule a loan which has funds. |
| 128 INVALID_ACCOUNT_STATE_FOR_REPAYMENTS | When the account's state doesn't allow a repayment to be entered |
| 129 DISBURSEMENT_FEES_EXCEED_LOAN_AMOUNT | When the total of disbursement fees exceeds the loan amount |
| 130 INTEREST_CANNOT_BE_APPLIED | When the interest cannot be applied in the account, because either the account it's not active, either there's no interest to be applied, either it's a flat fixed account and the interest has already been applied |
| 131 ENTRY_DATE_BEFORE_OTHER_TRANSACTIONS | Another balance transaction has already been logged before this entry date and must be undone for this one to be backdated |
| 132 INCONSISTENT_SCHEDULE_PRINCIPAL_DUE_WITH_LOAN_AMOUNT | When the total principal expected from the repayment schedule doesn't match the loan amount (no rounding was selected) |
| 133 ACCOUNT_HAS_NO_ACCRUED_INTEREST | When trying to apply the accrued interest and the account has no accrued interest. |
| 134 INTEREST_ALREADY_APPLIED_ON_DISBURSEMENT_ACCOUNT | When trying to apply interest for an account with Interest application method 'On Disbursement'. In this case the interest was already applied |
| 135 INCONSISTENT_WITH_FIXED_DAYS_OF_MONTH | When first repayment date doesn't match the loan product Fixed days of month Payment interval method settings |
| 136 NEGATIVE_PRINCIPAL_FOR_INSTALLMENT | When after the calculation of a repayments schedule, one of its repayments contains a negative principal |
| 137 INVALID_TAX_RATE | When the tax rate for an account that has taxes enabled does not exist |
| 138 INSUFFICIENT_GUARANTEES | When the loan account doesn't have the required guaranties percentage |
| 139 MISSING_REPAYMENT_PERIOD_COUNT | When the repayment period count is missing for a loan with a repayment method set to Interval |
| 140 MISSING_REPAYMENT_INTERVAL | When the repayment interval is missing for a loan with repayment method set to Interval |
| 141 FUTURE_PAYMENT_NOT_ALLOWED_ERROR | When a future payment is trying to be posted and it's not allowed at loan product level |
| 142 DISBURSEMENT_WITH_ZERO_LOAN_AMOUNT_NOT_ALLOWED | when a loan have zero loan amount and no capitalized fees, it can't be disbursed. |
| 143 ACCOUNT_ALREADY_LOCKED | When trying to lock an account that is already in a LOCK state |
| 144 ACCOUNT_ALREADY_UNLOCKED | When trying to unlock an account that is not in a LOCK state |
| 145 LOAN_AMOUNT_DECIMALS_NOT_ALLOWED_WITH_ROUNDING | When trying to give an amount to a loan account that has rounding enabled |
| 146 RESCHEDULED_LOAN | When the deletion is not allowed on the account, because it was rescheduled |
| 147 REFINANCED_LOAN | When the deletion is not allowed on the account, because it was refinanced |
| 148 TRANSACTION_IDENTIFIER_ALREADY_USED | When the posted transaction identifier already been used (it exists in the data store) |
| 149 INVALID_ID | When identifier for a posted transaction is only spaces or empty space |
| 150 FAILED_TO_GENERATE_IDENTIFIER | When the account identifier failed to be generated due to internal concurrency issue. |
| 151 INCONSISTENT_ACCOUNT_ID_WITH_ACCOUNT_HOLDER_TYPE | when trying to fetch an account for a client using a group id or vice-versa. |
| 152 INVALID_ASSET_NAME | When trying to store an account with guarantees of type asset and asset name is null. |
| 153 GUARANTOR_KEY_NOT_ALLOWED | When trying to store an account with guarantees of type asset, guarantor key should be empty. |
| 154 GUARANTOR_SAVINGS_KEY_NOT_ALLOWED | When trying to store an account with guarantees of type asset, savings account key should be empty. |
| 155 INVALID_GUARANTOR_KEY | When trying to store an account with guarantees of type guarantor and guarantor key is empty. |
| 156 INVALID_SAVINGS_ACCOUNT_KEY | When trying to store an account with guarantees of type guarantor and savings account key is empty. |
| 157 INVALID_GUARANTOR_STATE | When trying to store an account with guarantees of type guarantor and guarantor's state is not ACTIVE or INACTIVE. |
| 158 DUPLICATED_GUARANTOR_WITHOUT_SAVINGS_ACCOUNT | When trying to store an account with guarantees the guarantor can guaranty only once without an account. |
| 159 DUPLICATED_SAVINGS_ACCOUNT | When trying to store an account with guarantees the guarantor cannot guaranty with the same account twice. |
| 160 INSUFFICIENT_SAVINGS_ACCOUNT_BALANCE | When the amount guaranteed in a given guaranty is not covered by the savings account's balance (if one existing). |
| 161 INVALID_SAVINGS_ACCOUNT_STATE | When a savings account used for a guarantee is not in ACTIVE, ACTIVE_IN_ARREARS, MATURED or LOCKED state. |
| 162 DUPLICATED_ASSET | When a guarantor guarantees twice with the same asset. |
| 163 GUARANTOR_ASSET_NAME_NOT_ALLOWED | When trying to store an account with guarantees of type guarantor, asset name should be empty. |
| 164 TRANSACTION_NOT_FOUND | When trying to undo the disbursement of a not found transaction. |
| 165 INVALID_TRANSACTION_TYPE | When trying to undo the disbursement of a transaction and its type is invalid. |
| 166 UNREVERSED_TRANSACTION_LOGGED_AFTER_CURRENT_ONE | When trying to post a transaction but there has already been a different transaction posted after it, which cannot be reversed by bulk correction. |
| 167 INVALID_GUARANTOR_PERMISSION | When trying to store a guarantee for a guarantor that does not have permissions to guarantee. |
| 168 INVALID_CLIENT_ROLE_PERMISSION_FOR_OPENING_ACCOUNTS | When trying to create a loan account for a client that does not have permissions for opening accounts. The permission can be granted from Client Type from administration. |
| 169 MISSING_PENALTY_RATE | When the product requires penalties but the account doesn't have a penalty rate specified (or the product doesn't have a default penalty rate). |
| 170 INVALID_REPAYMENT_NUMBER | When the specified repayment number can't be found in the schedule |
| 171 MISSING_REPAYMENT_NUMBER | When the repayment number is mandatory but wasn't specified |
| 172 INVALID_REPAYMENT_STATE | When the state if the given repayment is not valid for the action |
| 173 CENTRE_MEETING_DAY_IN_NON_WORKING_DAY | When a centre meeting day is set in a non-working day and the due date of the repayment has to be moved |
| 174 ARBITRARY_FEE_NOT_ALLOWED | When an arbitrary fee is posted, but the product settings does not allow it. |
| 175 INVALID_REPAYMENT_ID | When the repayment posted does not belong to the account. |
| 176 ACCOUNT_BALANCE_OUTSIDE_CONSTRAINTS | When the account balance after applying the updates (principal balance, interest balance, etcetera) is negative or greater than the original balance. |
| 177 EDITING_DATE_NOT_IN_CENTER_MEETING_DAY | When editing a schedule for a loan account which has center meeting day, and the new edited value is not in the same day of week. |
| 178 EDITING_DUE_DATES_NOT_ALLOWED | When the product has interest application method ON_REPAYMENT and the repayment was fully paid or partially paid or the repayment had interest already applied, the due date of that repayment cannot be modified |
| 179 EDITING_REPAYMENTS_NOT_ALLOWED | When the loan product does not allow editing the repayment schedule. |
| 180 INTEREST_BALANCE_CANT_BE_EDITED_AT_SPECIFIED_DATE | When the user can't edit the interest from a specific repayment cannot be modified. For example when INTEREST DUE REDUCED is reversed and the user could reapply it on some other repayment. |
| 181 INVALID_DUE_DATE | When a due date of the schedule is not valid. For example: the due date of a repayment is before the due date of the previous repayment. |
| 182 NEGATIVE_BALANCE | When a balance (principal balance, interest balance, etcetera) for a repayment is negative. |
| 183 NON_POSITIVE_TOTAL_BALANCE | When the total balance for a repayment is not strictly positive |
| 184 PARAMS_INCONSISTENT_WITH_PRODUCT_RULES | When the parameter from API call is inconsistent with product info (>max, <min, etc). |
| 185 INVALID_GRACE_PERIOD | When grace period provided in API call is invalid(null, negative etc.). |
| 186 INVALID_ANTICIPATED_DISBURSEMENT | When anticipated disbursement provided in api call is invalid (null, wrong date format etc.). |
| 187 INVALID_REPAYMENT_FREQUENCY | When repayment period count or repayment period unit provided in API call is invalid (null, wrong value etc.). |
| 188 INVALID_PRINCIPAL_REPAYMENT_INVERVAL | When principal repayment interval provided in api call is invalid(null, wrong value etc.). |
| 189 INVALID_PRODUCT_STATE | When the product is in an invalid state for the given operation. |
| 190 BALLOON_PAYMENTS_NOT_ALLOWED_BY_PRODUCT | When a periodic payment amount is provided, but the product doesn't allow balloon payments. |
| 191 MANDATORY_PERIODIC_PAYMENT | When a periodic payment amount is not provided, but the product offers balloon payments. |
| 192 PERIODIC_PAYMENT_GREATER_THAN_LOAN_AMOUNT | When the periodic payment amount is greater than the account's whole loan amount. |
| 193 MISSING_INTEREST_RATE_SPREAD_ON_PRODUCT | When trying to preview a schedule for a loan product that has interest rate source equal to index interest rate and the product does not have a default interest spread defined. |
| 194 FIRST_REPAYMENT_DATE_BEFORE_EXPECTED_DISBURSEMENT_DATE | The first repayment cannot be before the expected disbursement date |
| 195 INVALID_PENALTY_RATE | The penalty rate is not correct. The rate is either NULL when a number is expected, or not within the allowed product constraints. |
| 196 CANNOT_EDIT_SOLIDARITY_LOANS | The account belongs to a solidarity group and cannot be edited |
| 197 INVALID_INTEREST_SPREAD | The interest spread is invalid (null, not within constraints or used when the interest rate source is FIXED_INTEREST_RATE) |
| 198 INVALID_PERIODIC_PAYMENT | The periodic payment is not valid. The account does not use balloon payments |
| 199 UNKNOWN_LOAN_ACCOUNT_ERROR | An error has occurred processing the loan account |
Groups (200 - 210)
| Response Code | Description |
|---|---|
| 200 MISSING_GROUP_ID | The group identifier has not been specified |
| 201 INVALID_GROUP_ID | No group with the given identifier exists |
| 202 INVALID_FULL_DETAILS | The fullDetails parameter is not valid |
| 203 INVALID_INDICATORS | The indicator specified is not valid |
| 204 GROUP_NOT_FOUND | When no group is found for given identifier |
| 205 INVALID_PARAMATERS_FOR_PRODUCT | When the loan/deposit parameters are not valid for the given product |
| 206 INVALID_USER_WHO_APPROVED_THE_LOAN_CANNOT_DISBURSE_IT | When the two man rule is enabled, the user who approved the loan cannot disburse it |
| 207 INVALID_GROUP_SIZE | The group size is outside of organisation's constraints |
| 208 MULTIPLE_GROUP_MEMBERSHIP | The group has clients that are already in the group and multiple membership is not allowed |
| 209 INVALID_GROUP_ROLE_NAME_KEY | There is not group role name with the key provided |
| 210 GROUP_ROLE_CLIENT_NOT_GROUP_MEMBER | The client ID provided for the role is not a group member |
Transactions and Till Balances (211 - 249)
| Response Code | Description |
|---|---|
| 211 TRANSACTION_ALREADY_REVERSED | When trying to reverse a transaction which is already reversed. |
| 212 INVALID_TRANSACTION_ID | When trying to do an action on a transaction and the given id is invalid. |
| 213 TRANSACTION_ID_AND_ACCOUNT_MISMATCH | When trying to do an action on a transaction for a given account and the transaction doesn't belong to that account. |
| 214 TRANSACTION_CREATED_DURING_IMPORT | When trying to reverse a deposit transaction created during import. The imported transactions cannot be reversed. |
| 215 TRANSACTION_LOGGED_FOR_CLOSED_TILL | When a loan or savings transaction was logged during the lifetime of a (now) closed till and an attempt is made to revert or delete the transaction. |
| 216 TILL_BALANCE_ABOVE_MAX | When the balance of the till goes above defined max limit. |
| 217 TILL_BALANCE_UNDER_MIN | When the balance of the till goes under min limit. |
| 218 TRANSACTION_MADE_FROM_A_TRANSFER | When a DEPOSIT transaction is trying to be reversed, but it was made via a Transfer. |
| 219 TRANSACTION_MADE_FROM_A_DISBURSEMENT | When a DEPOSIT transaction is trying to be reversed, but it was made via a Disbursement transaction. |
| 220 DEPOSIT_ACCOUNT_HAS_MATURITY_DATE_SET | Deposit cannot be reverted for active fixed deposits accounts that have a maturity date set. |
| 221 BALANCE_IS_NULL | When a deposit transaction is trying to be reversed but the balance is null. |
| 222 GUARANTOR_NOT_ALLOWED_BY_PRODUCT | When trying to create a loan account with guarantor for a product that doesn't allow guarantors. |
| 223 COLLATERAL_NOT_ALLOWED_BY_PRODUCT | When trying to create a loan account with collateral for a product that doesn't allow collateral guarantees. |
| 224 CANNOT_CHANGE_TILL_BALANCE | When trying to change a till's vault amount and the data is invalid. |
| 225 DEDUCTED_FEES_TOTAL_MORE_THAN_LOAN_AMOUNT | When trying to store a loan account and the total of deducted provided fees is more than the loan amount. |
| 226 NO_CAPITALIZED_DISBURSEMENT_FESS_WHEN_ZERO_LOAN_AMOUNT | When trying to store a loan account with loan amount zero and the developer does not provides any capitalized fee. |
| 227 DISBURSE_TO_SAVINGS_NOT_AVALAIBLE_WITH_INVESTOR_FUNDS | Disburse to savings is not available when there are investor funds set on the account. |
| 228 TRANSACTION_CHANNEL_IS_MANDATORY | When trying to store a loan account with required transaction channel and the developer does not provides a transaction channel. |
| 229 TRANSACTION_CHANNEL_NOT_AVAILABLE_WHEN_DISBURSE_TO_SAVINGS | When trying to store a loan account and the developer provides a transaction channel and a savings account key. |
| 230 GUARANTOR_CANNOT_BE_DELETED | When trying to delete a guarantor. |
| 231 CUSTOM_AMOUNT_IS_MANDATORY | When trying to store a loan account and the developer provides fees that require custom amount and the user does not specify it. |
| 232 INVALID_TRANSACTION_CHANNEL | When trying to store a loan account with required transaction channel and the developer provides an invalid transaction channel. |
| 233 MISSING_FEE | When trying to store a loan account and the developer provides custom fees that don't have the predefined fee specified. |
| 234 INCONSISTENT_ACCOUNT_FEE_WITH_PRODUCT_FEE | When trying to store a loan account and the developer provides fees which are not defined in the loan product. |
| 235 INCONSISTENT_DISBUSEMENT_DETAILS_WITH_ACCOUNT | When trying to store a loan account and the developer provides the expected disbursement date or/and first repayment date twice (at account level and at disbursement details level) but different. |
| 236 MISSING_TRANSACTION_CHANNEL_KEY | When trying to store a loan account and the developer does not provides the transaction channel id/encodedKey. |
| 237 TRANSACTION_DETAILS_NOT_AVAILABLE_FOR_PRODUCT | Wen trying to store a loan account and the developer provides transaction details for a loan product type for which the transaction details are not available. |
| 238 FEES_NOT_AVAILABLE_FOR_PRODUCT | When trying to store a loan account and the developer provides predefined fees for a loan product type for which the predefined fees are not available to select for a loan account. |
| 239 EXPECTED_DISBURSEMENT_DATE_NOT_AVAILABLE_FOR_PRODUCT | When trying to store a loan account and the developer provides the expected disbursement date for a loan product type for which the expected disbursement date is not available to select for a loan account. |
| 240 FIRST_REPAYMENT_DATE_NOT_AVAILABLE_FOR_PRODUCT | When trying to store a loan account and the developer provides the first repayment date for a loan product type for which the first repayment date is not available to select for a loan account. |
| 244 REDRAW_DISABLED | When trying to make redraw operations on an account with redraw disabled. |
| 247 PRODUCT_DOES_NOT_ALLOW_WITHDRAWAL_TRANSACTIONS | WITHDRAWAL_REDRAW transaction type is not allowed for given account product type |
| 248 EXCESS_PAYMENT_MADE_AMOUNT | PAYMENT_MADE transaction, which increases the redraw balance should not result in having excess amount (redraw balance higher than account balance ) |
| 249 PRODUCT_DOES_NOT_ALLOW_PAYMENT_MADE_TRANSACTIONS | PAYMENT_MADE transaction type is not allowed for given account product type |
Disbursement with Fees (250 - 299)
| Response Code | Description |
|---|---|
| 250 MISSING_FEE_KEY | When trying to disburse a loan account and the developer provides fees that don't have an encoded key. |
| 251 INVALID_FEE_KEY | When trying to disburse a loan account with given fees but the fee encoded key is not valid or it's not available for the loan account product. |
| 252 INCONSISTENT_FEE_AMOUNT_WITH_PRODUCT_FEE | When trying to disburse a loan account with given fees and the developer provides at. |
| 253 FEE_AMOUNT_MUST_BE_STRICTLY_POSITIVE | When trying to disburse a loan account with given fees and the provided amount is not strictly positive. |
| 254 REQUIRED_FEE_MISSING | When trying to disburse a loan account with given fees and the developer does not provide all required fees defined in the loan product. |
| 255 FEE_NOT_ACTIVE | When trying to disburse a loan account with given fees and the developer provides fees that are inactive. |
| 256 FEE_NOT_ALLOWED | When trying to disburse a loan account and the developer provides a fee that is not a disbursement fee, or when trying to edit fee due on schedule but the schedule does not allow it. |
| 257 INCONSISTENT_FIRST_REPAYMENT_DATE_WITH_PRODUCT_OFFSET | When trying to compute the schedule but the first repayment date is not between defined offset in the loan product. |
| 258 MISSING_ORIGINAL_TRANSACTION_ID | When trying to reverse a transaction but the original transaction id is not present in the API call parameters/json. |
| 260 REPAYMENT_WAS_FULLY_PAID | When attempting to edit the due date for a repayment that was already fully paid. |
| 261 REPAYMENT_HAS_INTEREST_APPLIED | There are Interest Applied transactions logged after the repayment's date. You will need to revert them before entering the repayment, so that the interest is calculated based on the new amounts. |
| 262 DUE_DATE_BEFORE_ACCOUNTING_CLOSURE | When editing a repayment due date and there is a GL accounting closure after the due date. |
| 263 DUE_DATE_BEFORE_LOGGED_TRANSACTION | When editing a repayment due date and the account has a transaction logged after the due date |
| 264 INVALID_PARENT_ACCOUNT_KEY | When the parent account key provided for a custom-made repayment is not the same as the one for the actual account |
| 265 AUTOMATICALLY_ADDED_INSTALLEMENTS_ARE_NOT_EDITABLE | For fixed accounts using the "apply interest after maturity" option, a new installment is added when interest is applied after the maturity date. This installment is not editable. |
| 266 PURE_GRACE_INSTALLMENT_ARE_NOT_EDITABLE | Pure grace installments are not editable |
| 267 CUSTOM_PAYMENT_NOT_ALLOWED_BY_PRODUCT | When a custom payment repayment is made but the product settings doen't allow this |
| 268 SAME_CUSTOM_PAYMENT_AMOUNT_TYPE_USED_MULTIPLE_TIMES | When a custom payment amount type is used more than once. |
| 269 CUSTOM_PAYMENT_AMOUNT_DIFFERENT_THAN_TOTAL_PAYMENT_AMOUNT | When a custom payment repayment is made and the sum of the custom payment amounts is different than the repayment total amount. |
| 271 ARREARS_TOLERANCE_PERIOD_OUTSIDE_CONSTRAINTS | When storing arrears tolerance period for loan account that is outside loan product constraints. |
| 272 NEGATIVE_ARREARS_TOLERANCE_PERIOD | When storing an arrears tolerance period for loan account that is a negative number. |
| 273 REQUIRED_ARREARS_TOLERANCE_PERIOD_MISSING | When storing an arrears tolerance period for loan account and the loan product doesn't have a default tolerance period defined. |
| 274 DUE_DATE_BEFORE_FEE_AMORTIZATION | When editing a repayment due date and there is a fee amortization after the due date |
| 275 MAX_CLIENT_LIMIT_REACHED | When the max number of clients has been reached for a tenant |
| 276 PENALTY_METHOD_NOT_ALLOWED_BY_PRODUCT | When the penalty method is not allowed by product settings |
| 277 CANNOT_REVERSE_TECHNICAL_OVERDRAFT | When a transaction cannot be reversed due to existing technical overdraft |
| 278 INSUFFICIENT_BALANCE | When transactions cannot be reversed because the ending available balance would become negative |
| 279 INVALID_PRODUCT_TYPE | When using a loan type other than revolving credit. Returns the error message: "errorSource": "Operation is not allowed for the product type: {product_loan_type}" |
| 282 NO_DUE_AMOUNT_TO_BE_PAID | Redraw repayment is not available when the account has no due amount to be paid |
| 299 UNKNOWN_GROUP_ERROR | An error has occurred processing the group |
Clients (300-399)
| Response Code | Description |
|---|---|
| 300 MISSING_CLIENT_ID | The client identifier has not been specified |
| 301 INVALID_CLIENT_ID | The client identifier is invalid |
| 303 INVALID_PICTURE_KEY | When the key of the picture is not valid |
| 304 INVALID_SIGNATURE_KEY | When the key of the signature is not valid |
| 305 INVALID_CLIENT_STATE | When the client/group state does not allow to be a guarantor or have a loan/savings account |
| 306 INVALID_CLIENT_ROLE_KEY | When trying to store a client and the role key is invalid. |
| 307 INCONSISTENT_CLIENT_ROLE_WITH_CLIENT_TYPE | When trying to store a client role of type GROUP for a client. |
| 308 INVALID_DEPENDENT_CUSTOM_FIELD_VALUE | When trying to store dependent custom field values with inconsistency with their parent custom field value. |
| 309 INVALID_BIRTH_DATE | When birth date is required by internal controls but the value was missing from input. |
| 310 DUPLICATE_CLIENT | When a duplicate client was found (according with the administration settings) and the action which is taken when a duplicate client is found is ERROR. |
| 311 INVALID_CLIENT_STATE_TYPE | When attaching a client and the state provided is invalid. |
| 312 INVALID_CLIENT_STATE_TRANSITION | When trying to change the state of a client but the change cannot be done. |
| 313 CLIENT_IS_MEMBER_OF_A_GROUP | When trying to reject or undo approve a client which is part of a group. |
| 314 CLIENT_IS_GUARANTOR | When trying to change the state of a client which is guarantor and the action is not permitted. |
| 315 CLIENT_HAS_ACCOUNTS | When trying to exit a client which has accounts which aren't closed. |
| 399 UNKNOWN_CLIENT_ERROR | An error has occurred processing the client |
Savings accounts (400 - 499)
| Response Code | Description |
|---|---|
| 400 INVALID_SAVINGS_ACCOUNT_ID | No savings account with the given identifier exists |
| 401 BALANCE_BELOW_ZERO | The API operation would result in a balance below zero |
| 402 MISSING_SAVINGS_ID | The specified savings account is not valid |
| 403 BACKDATE_BEFORE_ACTIVATION | Operations shouldn't be backdated before the activation date of a deposit account |
| 404 BACKDATE_BEFORE_OTHER_OPERATION | Operations shouldn't be backdated before other existing date |
| 405 BACKDATE_SET_IN_THE_FUTURE | When the operation is backdated in the future |
| 406 INVALID_DEPOSIT_AMOUNT | When the amount value is not between minimum opening balance and maximum opening balance values |
| 407 INVALID_DEPOSIT_ACCOUNT_STATE | When the deposit does not have the valid state for this operation (Active or Approved) |
| 408 LOCKED_SAVINGS_AMOUNT | When the savings amount cannot be decreased below the locked amount by withdraw or transfer |
| 409 SAVINGS_PRODUCT_MISMATCH | When the savings account has parameters different to those defined in the savings product |
| 410 SAVINGS_ACCOUNT_INVALID | When the accountType is missing while creating a new savings account |
| 411 ID_SHOULD_NOT_BE_PROVIDED | The ID should not be provided while creating a new savings account |
| 412 PRODUCT_DOESNT_ALLOW_WITHHOLDING_TAXES | The product does not support withholding taxes |
| 413 INVALID_WITHHOLDING_TAX_SOURCE_TYPE | The key is a valid index rate encoded key but not a withholding tax source key |
| 414 INVALID_INTEREST_CHARGE_FREQUENCY | When the received savings account has an Interest Charge Frequency Method different than the product's. |
| 415 INVALID_INTEREST_CHARGE_FREQUENCY_COUNT | When the received savings account has an Interest Charge Frequency Count different than the product's, or the Interest Charge Frequency Method doesn't support this field. |
| 416 INVALID_SAVINGS_ACCOUNT_STATE_TRANSITION | When the savings account state does not allow the account state transition |
| 417 MAXIMUM_WITHDRAWAL_AMOUNT_EXCEEDED | When the withdrawal value is grater than the maximum withdrawal constraint defined in the savings product or at savings account level. |
| 418 MAXIMUM_OVERDRAFT_LIMIT_EXCEEDED | When the overdraft value is greater than the maximum overdraft limit constraint defined in the savings product. |
| 419 OVERDRAFT_NOT_ALLOWED | When a patch for overdraft field is executed on a savings account with Overdraft disabled. |
| 420 MISSING_INTEREST_RATE_FROM_SAVINGS_PRODUCT | When creating loan account with auto-create settlement account but the savings product is missing the default interest rate. |
| 421 POSITIVE_SECURED_AMOUNT | When there is amount to be recovered from investment made in loan accounts. |
| 422 MINIMUM_OPENING_BALANCE_ACHIEVED | When trying to make a deposit on a fixed account but the minimum opening balance is already achieved. |
| 423 ACCOUNT_HAS_TRANSACTIONS | When trying to delete an account that already has logged transactions. |
| 424 INVALID_OVERDRAFT_INTEREST_CHARGE_FREQUENCY | When the received savings account has an Overdraft Interest Charge Frequency Method different than the product's. |
| 425 INVALID_OVERDRAFT_INTEREST_CHARGE_FREQUENCY_COUNT | When the received savings account has an Overdraft Interest Charge Frequency Count different than the product's, or the Overdraft Interest Charge Frequency Method doesn't support this field. |
| 426 RECOMMENDED_DEPOSIT_AMOUNT_INVALID | |
| 427 MISSING_TYPE_PARAMETER | When the 'type' parameter is missing from the request. |
| 428 INVALID_DEPOSIT_ACCOUNT_ID | When an invalid deposit/savings ID is provided. |
| 429 PRODUCT_SPECIFIES_OVERDRAFT_ALLOWED | When a savings account that does not allow overdraft is created, but the corresponding savings product allows overdraft. In this case, to achieve the desired behavior, the overdraft limit can be set to 0 instead. |
| 430 PRODUCT_SPECIFIES_OVERDRAFT_NOT_ALLOWED | When a savings account that allows overdraft is created, but the corresponding savings product doesn't allow overdraft. |
| 431 CURRENT_ACCOUNT_PRODUCT_DISABLED | When the Current Account Mambu Feature is disabled |
| 432 FIXED_DEPOSIT_PRODUCT_DISABLED | When the Fixed Deposit Mambu Feature is disabled |
| 433 COLLATERAL_FEATURE_DISABLED | When the Collateral Mambu Feature is disabled |
| 434 CREDIT_OFFICER_DISABLED | When the Credit Officer Mambu Feature is disabled |
| 435 DATA_EXPORT_DISABLED | When the Data Export Mambu Feature is disabled |
| 436 MAX_WITHDRAWAL_CANNOT_BE_NEGATIVE | When a given maxWithdrawalAmount is negative |
| 437 MAX_WITHDRAWAL_CANNOT_BE_ZERO | When a given maxWithdrawalAmount is zero |
| 438 WITHHOLDING_TAXES_DISABLED | When the Witholding taxes Mambu Feature is disabled |
| 439 FUNDING_SOURCE_DISABLED | When the Funding Source Mambu Feature is disabled |
| 440 RESET_DATA_DISABLED | When the Reset Data Mambu Feature is disabled |
| 441 SOLIDARITY_GROUP_DISABLED | When the Solidarity Group Mambu Feature is disabled |
| 442 SAVINGS_PLAN_DISABLED | When the Savings Plan Mambu Feature is disabled |
| 443 SAVINGS_ACCOUNT_DISABLED | When the Savings Account Mambu Feature is disabled |
| 444 REVOLVING_CREDIT_DISABLED | When the Revolving Credit Mambu Feature is disabled |
| 445 INDICATORS_DISABLED | When the Indicators Mambu Feature is disabled |
| 446 FIXED_TERM_LOAN_DISABLED | When the Fixed Term Loan Mambu Feature is disabled. |
| 447 FLAT_INTEREST_DISABLED | When the Fixed Flat Interest Method Mambu Feature is disabled. |
| 448 EFFECTIVE_INTEREST_RATE_DISABLED | When the Effective Interest Rate Mambu Feature is disabled. |
| 449 RISK_REPORTING_DISABLED | When the Risk Reporting Mambu Feature is disabled. |
| 451 INTEREST_FREE_LOAN_DISABLED | When the Interest Free Loan Mambu Feature is disabled. |
| 452 MISSING_DEPOSIT_ID | When calling GET for funded loan accounts, the error means that the ID of the deposit account was not provided |
| 499 UNKNOWN_SAVINGS_ACCOUNT_ERROR | An internal error has occurred accessing the savings account |
Loan/Savings accounts (500 - 599)
| Response Code | Description |
|---|---|
| 500 TRANSFER_CANT_BE_MADE | When the transfer between a savings of the client and loan of the same client or to another savings account is not possible |
| 501 CANNOT_MAKE_TRANSFER_TO_SOURCE_ACCOUNT | When a transfer is trying to be made and the source and the target accounts are the same |
| 502 INVALID_TARGET_ACCOUNTING_STATE | When a transfer is trying to be made, but the accounting state (activated/deactivated) is not the same for the source and target account |
| 504 TRANSFER_AMOUNT_IS_NOT_POSITIVE | When the amount that wants to be transferred is negative |
| 505 INVALID_PRODUCT_ID | The loan or deposit product ID cannot be found |
| 508 TRANSFER_AS_POSTDATED_PAYMENT | When the amount that wants to be transferred is going to be posted as a future payment on the loan account |
| 509 UNDEFINED_EXCHANGE_RATE_FOR_CURRENCY | When no exchange rate (buy or sell) has been found for a currency and a transaction should have use it |
| 510 INVALID_PRODUCT_KEY | When the key of the product is not valid |
| 511 CANNOT_MAKE_TRANSFER_TO_FUNDED_ACCOUNTS_WITH_ACCOUNTING_ENABLED | When trying to make a transfer to a loan account with investor funds and accounting enabled |
| 512 LINKED_ACCOUNT_DELETION_ERROR | When trying to delete an account that is currently linked to another account |
| 513 ACCOUNT_HAS_REMAINING_BALANCE | When trying to close an account that has non-zero balance |
| 514 CANNOT_MAKE_TRANSFER_TO_LOCKED_ACCOUNTS | When trying to make a transfer to a locked account |
| 515 CANNOT_DISBURSE_LOCKED_ACCOUNTS | When trying to disburse a locked loan account. |
| 516 DISBURSEMENT_DATE_AFTER_LAST_REPAYMENT_DUE_DATE | When trying to disburse a loan account after the due date of its last repayment |
| 517 INTEREST_RATE_NOT_AVAILABLE_FOR_INDEXED_RATES | Sending an interest rate although the interest rate source is an index interest rate. |
| 518 INTEREST_SPREAD_NOT_AVAILABLE_FOR_FIXED_RATES | Sending an interest spread value while the interest rate source is a fixed interest rate |
| 519 TRANCHES_EXPECTED_DISBURSMENT_DATES_NOT_ORDERED | When the tranches expected disbursement dates are not ascending ordered. |
| 520 TRANCHES_NOT_ALLOWED | When he tranches are not allowed for this type of product. |
| 521 TRANCHES_NOT_DEFINED | When tranches are used for this product, but they are not specified. Also returned if a call attempts to remove all tranches from a loan, since at least one tranch must be defined for this loan type. |
| 522 MORE_TRANCHES_THAN_ALLOWED | When the number of tranches provided exceed the product threshold. |
| 523 TOTAL_TRANCHES_AMOUNT_MORE_THAN_LOAN_AMOUNT | When total tranches amount does not match the loan amount. |
| 524 TOTAL_AMOUNT_NOT_EQUAL_WITH_LOAN_AMOUNT | When tranches amount not equal with the loan amount. |
| 525 TRANCHE_AMOUNT_SHOULD_BE_STRICT_POSITIVE | When tranches amounts should be strict positive. |
| 526 INVALID_TRANCHE_KEY | When the user imputed a tranche with an invalid encoded key. |
| 527 CANNOT_MODIFY_DISBURSED_TRANCHE | When trying to delete or edit an already disbursed tranche. |
| 528 DISBURSEMENT_DATE_BEFORE_NOT_REVERSED_TRANSACTION | When the disbursement date is before a non reversed transaction. |
| 529 CANNOT_MODIFY_TRANCHES_ON_RESCHEDULED_REFINANCED_ACCOUNTS | When trying to modify the tranches on a loan account which was rescheduled or refinanced. |
| 530 ALL_TRANCHES_ALREADY_DISBURSED | When trying to disburse a loan account with tranches and there are no more tranches to be disbursed. |
| 531 TRANCHES_CANNOT_BE_EDITED | When tranches cannot be edited at this endpoint. |
| 532 INTEREST_RATE_SHOULD_BE_ZERO_OR_EMPTY | When the interest rate is present for an interest-free loan. |
| 533 INTEREST_SPREAD_SHOULD_BE_ZERO_OR_EMPTY | When the interest spread is present for an interest-free loan. |
| 534 INCONSISTENT_DATE_WITH_NEXT_TRANCHE | When the provided disbursement date doesn't match with the next tranche expected disbursement date. |
| 535 INTEREST_RATE_CANNOT_BE_EDITED_FOR_TIERED_INTEREST_RATES | When an attempt is made to edit the interest rate and the account has tiered interest rates |
| 536 INTEREST_SPREAD_CANNOT_BE_EDITED_FOR_TIERED_INTEREST_RATES | When an attempt is made to edit the interest spread and the account has tiered interest rates |
| 537 INVALID_INTEREST_RATE_TIERS | When an account is posted with interest rate tiers different than the ones from the product |
| 538 INVALID_OVERDRAFT_INTEREST_RATE_TIERS | When an account is posted with overdraft interest rate tiers different than the ones from the product |
| 543 INTEREST_TYPE_NOT_ALLOWED | The selected interest type is not available for the product you are trying to create, check compatible interest methods in the table here |
Accounting (600 - 649)
| Response Code | Description |
|---|---|
| 600 INVALID_GL_ACCOUNT_ID | When attempting to access a gl account with an invalid ID |
| 601 INVALID_GL_ACCOUNT_TYPE | Unknown GL account type. Must be one of: Asset, Liability, Equity, Income, Expense |
| 602 JOURNAL_ENTRY_BEFORE_CLOSURE | Operations shouldn't be backdated after the books were closed for their assigned branch |
| 603 DEBITS_DO_NOT_MATCH_CREDITS | The debits amount entered for a journal entry don't match the credit amounts entered for it |
| 604 INVALID_JOURNAL_ENTRY_DATE | The date to log the journal entry does not exist or set in the future |
| 605 GL_ACCOUNT_IS_HEADER | The journal entry's target gl account has Header usage |
| 606 GL_ACCOUNT_DOES_NOT_SUPPORT_MANUALLY_ENTRIES | The journal entry's target gl account does not support manually entries |
| 607 NO_INTER_BRANCH_GL_ACCOUNT | There is no inter-branch GL Account defined. In this case changing the branch for active accounts with accounting enabled is not allowed |
| 608 INVALID_JOURNAL_TRANSACTION_ID | The journal entry's transaction id is invalid: empty or exceeds 32 characters |
| 609 DUPLICATE_JOURNAL_TRANSACTION_ID | The journal entry's transaction id is already in use |
| 610 INVALID_ACCOUNTING_DATE_ORDER | When the 'from' date is after the 'to' date. |
| 611 INVALID_ACCOUNTING_DATE_RANGE | When the given dates exceed an admitted range. |
| 612 JOURNAL_ENTRY_DATE_IN_THE_FUTURE | The date to log the journal entry is set in the future |
| 613 JOURNAL_ENTRY_DATE_IN_THE_PAST_BEFORE_THE_ALLOWED_LIMIT | The date to log the journal entry is set before the minimum (earliest) allowed. |
| 614 INVALID_BOOKING_DATE | The booking date (entry date for JE) is invalid |
| 615 BOOKING_DATE_BEFORE_VALUE_DATE | The booking date (entry date for JE) is after value date (entry date for the transaction) |
Currency (650 - 699)
| Response Code | Description |
|---|---|
| 650 INVALID_CURRENCY_CODE | When the code for the currency does not meet the ISO 4217 currency code standards |
| 651 CURRENCY_NOT_MATCHING | When trying to link two accounts (savings to loan, guaranty to loan etc) but the currencies are different |
| 652 ACCOUNT_CURRENCY_NOT_MATCH | When trying to add an account to a line of credit but it has a different currency than the one of the line of credit |
| 653 MISSING_CURRENCY | When trying to post a savings account for a product with multiple currencies but there is no currency provided for account |
| 654 INVALID_EXCHANGE_RATE_VALUE | When POSTing a sell/buy rate with a non-positive value. |
| 655 START_DATE_BEFORE_LAST_RATE_DATE | When POSTing a start date for new exchange rate that is before the last date the exchange rate was edited. |
Users (700 - 799)
| Response Code | Description |
|---|---|
| 700 INVALID_USER_NAME | The user name is invalid |
| 701 INVALID_USER_ID | The provided id does not belong to any user |
| 702 INVALID_CREDIT_OFFICER_KEY | When the key of the credit officer is not valid |
| 703 INCONSISTENT_CREDIT_OFFICER_WITH_BRANCH | When the given credit officer is not assigned to the given branch. |
| 704 MISSING_CREDIT_OFFICER_KEY | When the key of the credit officer is required but not provided. |
| 705 MISSING_BRANCH_KEY | When the key of the branch is required but not provided. |
| 706 MISSING_CENTRE_KEY | When the key of the centre is required but not provided. |
| 707 INVALID_USER_ROLE_KEY | When the provided key of the user role is invalid. |
| 708 USER_IS_LOCKED | When the user that makes the API request for creating another user is locked. |
| 709 INVALID_PASSWORD | When the password is invalid (it doesn't respect the security standard defined in the application). |
| 710 EMAIL_ADDRESS_ALREADY_REGISTERED_WITH_ANOTHER_USER | When email is already taken by another user. |
| 711 EMAIL_ADDRESS_FORMAT_IS_INVALID | When email address is invalid. |
| 712 USERNAME_ALREADY_EXISTS | When the user name is already un Mambu. |
| 713 MAX_USER_LIMIT_REACHED | When the tenant has reached the limit on user creation. |
| 714 CANNOT_MANAGE_USER_BRANCH | When a non admin user cannot manage the assigned branch of the user. |
| 715 NOT_ENOUGH_PRIVILDGES_FOR_CHANGING_USER_SETTINGS | When a non administrator is attempting to create another user but he doesn't have specific rights on that setting (Eg. if he cannot manage all branches, etc). |
| 716 ONLY_ONE_ROLE_ALLOWED | When a non administrator user selected more than one role. |
| 717 INVALID_TRANSACTION_LIMIT_TYPE | When creating a user with an unrecognized transaction limit type. |
| 718 NOT_ENOUGH_PRIVILEDGES_TO_CREATE_ADMIN_USER | When a regular user tries to create an administrator user. This is not allowed. |
| 719 CANNOT_HAVE_NEGATIVE_TRANSACTION_LIMITS | When creating a user with transaction limits and the amount provided are negative or zero. |
| 720 INVALID_VALUE_FOR_MANAGED_BRANCHES | When creating a user with inconsistent value for managed branches with can manage all branches property. |
| 721 CANNOT_HAVE_ADMIN_WITHOUT_FULL_BRANCHES_ACCESS | When creating an administrator user without can manage all branches set. |
| 722 CANNOT_HAVE_OFFICER_ADMIN_WITHOUT_MANAGE_OTHER_ENTITIES_ACCESS | When creating an officer administrator user with manage other credit officers entities unset. |
| 723 INCONSISTENT_CAN_MANAGE_BRANCHES_WITH_CAN_MANAGE_ENTITIES | When creating a user but with the value for can manage other branches and other entities inconsistent. |
| 724 MISSING_EMAIL_ADDRESS | When the email address is not provided |
| 725 MISSING_MOBILE_PHONE | When the mobile phone number is not provided |
Branches (800 - 849)
| Response Code | Description |
|---|---|
| 800 INVALID_BRANCH_ID | The branch identifier is invalid |
| 801 INVALID_BRANCH_KEY | When the key of the branch is not valid |
| 802 INVALID_MANAGED_BRANCH_ID | When the managed branch ID is invalid. |
| 803 BRANCH_IS_NOT_ACTIVE | When the given branch is inactive, so it cannot be used to create new entities |
Centres (850 - 899)
| Response Code | Description |
|---|---|
| 850 INVALID_CENTRE_KEY | When the key of the centre is not valid |
| 851 INVALID_CENTRE_ID | When the centre identifier is invalid |
| 852 INCONSISTENT_CENTRE_WITH_BRANCH | When the given centre is not assigned to the given branch |
| 853 CENTRE_IS_NOT_ACTIVE | When the centre is inactive (assignment of client/group cannot be done on inactive centre) |
Custom Information (900 - 949)
| Response Code | Description |
|---|---|
| 901 INCONSISTENT_VALUE_WITH_CUSTOM_FIELD_TYPE | When the value provided for a custom field does not match the custom field type (example given string instead of number) |
| 902 REQUIRED_CUSTOM_FIELD_MISSING | When the required custom field is missing |
| 903 INVALID_CUSTOM_FIELD_ID | When the given id for a Custom Field is null or is not set for any entity |
| 904 MAX_CUSTOM_FIELD_VALUE_LENGTH_EXCEEDED | When the given value for a Custom Field has a length which exceeds the maximum allowed limit |
| 905 INVALID_CUSTOM_FIELD_ENTITY_KEY | When a loan or savings account custom field is assigned to another product than the one for which the account was made |
| 906 VIEW_TYPE_NOT_MATCHING_RESOURCE | When a request is made on a resource like /loans but the requested viewtype is CLIENT |
| 907 VIEW_NOT_ACCESSIBLE_FOR_USER | When a request is made for a custom view, but the current user doesn't have access for it |
| 908 CUSTOM_FIELD_DEACTIVATED | When trying to add a custom field value for a deactivated custom field |
| 909 CUSTOM_FIELD_REQUIRED | When trying to delete a custom field value for a required custom field |
| 910 CUSTOM_FIELD_NOT_AVAILABLE_FOR_ENTITY | when a new custom field value was provided for a custom field that is not available for that client type |
| 911 INVALID_CUSTOM_FIELD_LINKED_ENTITY_KEY | When trying to store a linked custom field but the linked entity key provided is invalid |
| 912 DEPENDENT_CUSTOM_FIELD_VALUE_REQUIRED | When trying to store a value for a custom field that has dependencies but the dependent custom field has no values at the moment for this entity. |
| 913 INCONSISTENT_VALUE_WITH_SET_TYPE | When posting a grouped custom field value but the set is not grouped. |
| 914 GROUPED_INDEXES_NOT_CONSECUTIVE | When posting a grouped custom field value and the indexes are not consecutive within the posted custom field values. |
| 915 TO_MANY_VALUES_FOR_SAME_GROUPED_CUSTOM_FIELD | When posting grouped custom fields values and there are many same custom fields within the same set. |
| 916 INVALID_CUSTOM_FIELD_GROUP_INDEX | When posting grouped custom fields values without the property customFieldSetGroupIndex or invalid group index numeric value. |
| 917 INCONSISTENT_CUSTOM_FIELD_VALUE_WITH_PATTERN | When posting a free text custom field with a value that doesn't match with the expected pattern. |
| 918 DUPLICATE_CUSTOM_FIELD_VALUES | When posting duplicate values for same custom field. |
| 919 CUSTOM_FIELD_SET_CHANGE_NOT_ALLOWED | When changing the field set of a custom field is not possible. |
| 920 CUSTOM_FIELD_SET_NULL | When trying to save a custom field but it's set is null. |
| 921 CUSTOM_FIELD_USAGE_CHANGE_NOT_ALLOWED | When trying to change a custom field usage and it's not allowed. |
| 922 DATATYPE_OR_TYPE_CHANGED | When changing the type or the data type of a custom field is not allowed. |
| 923 CUSTOM_FIELD_NAME_NOT_UNIQUE | When trying to save a custom field but the name already exists. |
| 924 ENCODED_KEY_MUST_BE_EMPTY_ON_CREATE | When the encoded key is provided for create operations. |
| 925 CUSTOM_FIELDS_NEED_CHANNEL_PROVIDED | When trying to post a transaction with custom field but not specify the channel |
| 926 DUPLICATE_UNIQUE_VALUE | When the user provided a value for a unique custom field that already exists |
| 927 REFERRED_IN_CUSTOM_FIELD | When the entity is about to be deleted but it is referred to in a custom field as value |
| 928 TRANSACTION_TYPE_NOT_ACCEPTING_CUSTOM_FIELDS | When trying to get a custom field for a transaction whose type doesn't accept custom fields |
| 929 INVALID_CUSTOM_FIELD_KEY | When the user provides a custom field key that does not match the db value |
| 930 BUILT_IN_CUSTOM_FIELD_CHANGE_NOT_ALLOWED | When trying to change the values of built in customFields from API |
ID Documents (950 - 1000)
| Response Code | Description |
|---|---|
| 950 INVALID_ID_DOCUMENT | When the data set for a Identification Document is not valid (e.g. missing id or type) |
| 951 REQUIRED_ID_DOCUMENT_MISSING | When a required Identification Document is missing |
| 952 ADDING_OTHER_ID_DOCUMENTS_IS_DISABLED | When posting an other id document but this is disabled by administrator |
| 953 INVALID_ID_DOCUMENT_TEMPLATE_KEY | When the identification document template key does not exist or is invalid |
| 970 INVALID_DOCUMENT_ID | When the given id for a Document is null or is not set for any account |
| 971 INVALID_FILE_EXTENSION | When uploading a document if the file extension is not present or the document has more than one extension |
| 972 FILE_EXTENSION_NOT_ALLOWED | When uploading a document if the file extension is not present in the extensions white list |
| 973 INCONSISTENT_EXTENSION_WITH_FILE_CONTENT | When the file extension is inconsistent with the file metadata. Example: the file is jpg, but the extension in file name is pdf |
| 974 MALWARE_CONTENT_DETECTED | When our anti-virus finds that the file has malware content. Please note: Obfuscated PDF files will be rejected, since we cannot scan them for malware. |
| 975 INVALID_FILENAME | When the file name is invalid (e.g. when it contains invalid characters like &) |
| 976 NO_PROFILE_PICTURE_SET | When the profile picture is not set on the client account |
| 977 NO_PROFILE_SIGNATURE_SET | When the profile signature is not set on the client account. |
| 978 HAS_DOCUMENT_ATTACHED | When trying to delete an entity that has a document attached. |
| 979 UNSUPPORTED_IMAGE_TYPE | When the profile picture format is not supported. |
| 980 INVALID_TASK_ID | When the given ID for a task is null or not set |
| 981 INVALID_TASK_STATE_AND_COMPLETION_DATE | When the task is in COMPLETED state without completion date or in OPEN state with completion date |
| 982 INVALID_TASK_FIELD_CHANGE | When the user of the API tries to alter the id of the task |
| 983 INVALID_TASK_STATUS | When the task status supplied by the user is not a valid one (OVERDUE, COMPLETED, OPEN) |
| 984 INVALID_TASK_TITLE_LENGTH | When the task title exceeds the maximum length. |
| 985 HAS_TASK_ATTACHED | When trying to delete an entity that has a task attached |
| 986 EDITING_VIEW_TYPE_NOT_ALLOWED | When attempting to edit the type of a view, this being an illegal change |
| 987 INVALID_CUSTOM_FIELD_SET_ID | Invalid custom field set key or id |
| 988 TRANSACTION_LINKED_TO_A_REPAYMENT | When a payment due fee applied on due dates linked to a repayment transaction is trying to be reversed. |
Activities (1000 - 1049)
| Response Code | Description |
|---|---|
| 1000 MISSING_FROM_DATE | When getting activities and the from date is missing. |
| 1001 MISSING_TO_DATE | When getting activities and the from date is missing. |
| 1002 MAXIMUM_ONE_FILTER_ALLOWED | When getting activities and more than one filter specified (EG. clientID and branchID altogether). |
Tills (1100 - 1149)
| Response Code | Description |
|---|---|
| 1100 TILL_BALANCE_OUTSIDE_CONSTRAINTS | When the till balance goes outside the minimum / maximum constraints that are defined while opening a new till |
| 1101 TRANSACTION_IS_NOT_WITHIN_CHANNEL_CONSTRAINTS | When the amount, type or product, etc. associated with the transaction are not within the constraints defined at transaction channel level |
Addresses (1150 - 1199)
| Response Code | Description |
|---|---|
| 1150 INVALID_ADDRESS | When the address does not contain correct data (e.g. line1 is too long) |
| 1151 CLIENT_ROLE_DOES_NOT_ALLOW_ADDRESS | The default address fields are disabled for the client type. The default address can be enabled from Administration > General > Client Types |
| 1152 ADDRESS_CHANGE_NOT_ALLOWED | For clients/groups when at one point the client role allowed address but the new client role does not allow any. Cannot be changed if the client role does not allow addresses/ |
| 1153 INVALID_ADDRESS_LINE1 | |
| 1154 INVALID_ADDRESS_LINE2 | |
| 1155 INVALID_CITY | |
| 1156 INVALID_REGION | |
| 1157 INVALID_POSTCODE | |
| 1158 INVALID_COUNTRY |
Data Import (1200 - 1249)
| Response Code | Description |
|---|---|
| 1200 DATA_IMPORT_IN_PROGRESS | When an illegal operation is performed during a data import in progress |
| 1201 DATABASE_BACKUP_IN_PROGRESS | When triggering a database backup but one is already in progress. |
| 1202 DATABASE_BACKUP_NOT_FOUND | When downloading a backup but there is no backup file. |
| 1203 CLIENT_IN_MIGRATION | When trying to delete a client that is pending migration process. |
| 1204 INVALID_NUMBER_OF_SHEETS | When the number of sheets for an imported document is not correct. |
| 1205 UNDEFINED_SHEET | When the imported document contains an undefined sheet or requires a sheet. |
| 1206 WRONG_SHEET_POSITION | When the order of the sheets in the imported document is not correct. |
| 1207 INVALID_NUMBER_OF_COLUMNS_FOR_SHEET | When the number of columns for a sheet part of the imported document is not correct. |
| 1208 UNDEFINED_COLUMN | When the imported document contains an undefined column in one of its sheets or requires a column. |
| 1209 WRONG_COLUMN_POSITION | When the assignment constraints are not respected (default value when nothing specific can be extracted). |
Assignment (1250- 1299)
| Response Code | Description |
|---|---|
| 1250 INVALID_ASSIGNMENT | When trying to delete a client that is pending migration process. |
Index and Tax Rate (1300 - 1349)
| Response Code | Description |
|---|---|
| 1300 INVALID_INDEX_RATE_SOURCE_ID | The key specified is not a valid index rate encoded key |
| 1301 START_DATE_BEFORE_LAST_INDEX_REVIEWD_DATE | The start date is before the last index review date |
| 1302 INVALID_START_DATE | The start date is not unique within the same source |
| 1303 NO_INDEX_RATE_AVAILABLE | When there is no index rate available at the specified date. |
| 1304 NO_TAX_RATE_AVAILABLE | When there is no tax rate available at the specified date. |
Group Key (1350 - 1399)
| Response Code | Description |
|---|---|
| 1350 INCONSISTENT_GROUP_MEMBER_PARENT_KEY | The group member parent key is not the same with the group encoded key |
| 1351 INCONSISTENT_GROUP_MEMBER_ENCODED_KEY | The group member encoded key is not contained in the stored group members |
| 1352 INCONSISTENT_GROUP_ROLE_PARENT_KEY | The group role parent key is not the same with the group encoded key |
| 1353 INCONSISTENT_GROUP_ROLE_ENCODED_KEY | The group role encoded key is not contained in the stored group roles |
Lines of Credit (1400 - 1449)
| Response Code | Description |
|---|---|
| 1400 PRODUCT_LINE_OF_CREDIT_AFFILIATION_CONSTRAINT_MISMATCH | When the product requires a line of credit and the account is not part of a line of credit OR the product doesn't allow a line of credit, but the account has a line of credit set. |
| 1401 DISBURSEMENT_DATE_BEFORE_LINE_OF_CREDIT_START_DATE | When the loan disbursement (or expected disbursement) date is before the line of credit start date. |
| 1402 MATURITY_DATE_AFTER_LINE_OF_CREDIT_END_DATE | When the loan last repayment date is after the line of credit expiration date. |
| 1403 LINE_OF_CREDIT_AMOUNT_EXCEEDED | When the maximum line of credit amount would be exceeded if the account joined the line of credit |
| 1404 LINE_OF_CREDIT_REQUIRED_EXCEPTION | The product requires the account to be part of a credit arrangement |
| 1405 OVERDRAFT_EXPIRY_DATE_AFTER_LINE_OF_CREDIT_END_DATE | The overdraft expiry date cannot be after the line of credit end date |
| 1406 CANNOT_CREATE_ACCOUNT_WITH_LINE_OF_CREDIT | When a loan/savings account is created with a line of credit key set in the json. |
| 1407 LINE_OF_CREDIT_REQUIRES_OVERDRAFT_MAX_LIMIT | The overdraft maximum limit is required because the account is part of the line of credit and in a consuming state |
| 1408 LINE_OF_CREDIT_REQUIRES_OVERDRAFT_EXPIRY_DATE | The overdraft expiry date is required because the account is part of a Line of Credit and in a consuming state |
| 1409 INVALID_LINE_OF_CREDIT_ID | The ID or the encoded key used for GETing a line of credit is invalid. |
| 1410 ACCOUNT_ALREADY_ON_LINE_OF_CREDIT | When trying to add an account to a line of credit, but the account already has a line of credit defined. |
| 1411 INCONSISTENT_LINE_OF_CREDIT_CLIENT_WITH_ACCOUNT_OWNER | When the key of the line of credit is not the same as the holder key of the account. |
| 1412 ACCOUNT_IS_NOT_PART_OF_LINE_OF_CREDIT | When trying to delete an account but it is not part of the line of credit mentioned in the URL. |
| 1413 INVALID_LINE_OF_CREDIT_STATE | When trying to add accounts on a line of credit but the the state of the line is invalid. |
| 1414 HAS_LINE_OF_CREDIT | When trying to remove item that has line of credit. |
| 1415 LINE_OF_CREDIT_ID_ALREDY_IN_USE | When when trying to store a line of credit with an id that is already taken. |
| 1416 EXPIRE_DATE_BEFORE_START_DATE | When trying to store a line of credit with an expiration date before the start date. |
| 1417 INVALID_CLIENT_ROLE_PERMISSION_FOR_OPENING_LINES_OF_CREDIT | When trying to store a line of credit, but the client type does not allow opening line of credits. |
| 1418 MISSING_LINE_OF_CREDIT_START_DATE | When trying to store a line of credit with a missing start date. |
| 1419 MISSING_LINE_OF_CREDIT_EXPIRE_DATE | When trying to store a line of credit with a missing expire date. |
| 1420 MISSING_LINE_OF_CREDIT_AMOUNT | When trying to store a line of credit with a missing amount. |
| 1421 LINE_OF_CREDIT_AMOUNT_NOT_STRICTLY_POSITIVE | When trying to store a line of credit with an amount that is not strictly positive. |
Account Holder (1450 - 1499)
| Response Code | Description |
|---|---|
| 1489 INVALID_ACCOUNT_HOLDER_ID | |
| 1490 MISSING_ACCOUNT_HOLDER_KEY | When trying to store an entity and the account holder key is not defined. |
| 1491 MISSING_ACCOUNT_HOLDER_TYPE | When trying to store an entity and the account holder type is not defined. |
| 1492 ACCOUNT_HOLDER_NOT_FOUND | When trying to store an entity and the account holder is not found in system. |
| 1499 INVALID_ACCOUNT_HOLDER_STATE | The account holder is in an invalid state for the given operation. |
Organization (1500 - 1599)
| Response Code | Description |
|---|---|
| 1500 NO_ORGANIZATION_ICON | When trying to fetch organization branding icon and there is no picture set for this case. |
| 1501 NO_ORGANIZATION_LOGO | When trying to fetch organization branding logo and there is no picture set for this case. |
POST Comment (1600 - 1699)
| Response Code | Description |
|---|---|
| 1600 MISSING_TEXT | The required text for the object is missing. |
| 1601 MAX_TEXT_LENGTH_EXCEEDED | The maximum allowed size for the text in the parameter was reached. |
Revolving Credit (1900 - 1999)
| Response Code | Description |
|---|---|
| 1901 NUM_INSTALLMENTS_NOT_AVAILABLE_FOR_REVOLVING_CREDIT | When repaymentInstallments is specified but not available for revolving credit. |
| 1902 PRINCIPAL_PAYMENT_INCONSISTENT_WITH_PRODUCT | When principal payment settings from the account are inconsistent with the product. |
| 1903 SCHEDULE_PREVIEW_NOT_AVAILABLE_FOR_REVOLVING_CREDIT | When revolving credit account doesn't have a schedule. |
| 1904 AMOUNT_MORE_THAN_CURRENT_AVAILABLE_AMOUNT | When the disbursement amount is greater than the approved loan amount. |
| 1905 INCONSISTENT_WITH_CENTRE_MEETING_DAY | When the custom schedule due dates are not in the centre meeting day. |
| 1906 FIELD_IS_NOT_EDITABLE | When the custom schedule fields cannot be adjusted. |
| 1907 RESCHEDULED_REPAYMENT_BEFORE_DISBURSEMENT_DATE | When the first repayments date was moved before the disbursement date because of an non working day. |
2000 - 2049
| Response Code | Description |
|---|---|
| 2001 FIELD_NOT_ALLOWED | The client provided a field that is not allowed |
| 2002 OPERATION_NOT_ALLOWED_ON_FIELD | Client provided a patch operation that is restricted for that field |
| 2018 INVALID_FUND_ENCODED_KEY | When trying to post a loan account with fund which contains invalid guarantor key. |
| 2019 INVESTORS_TOTAL_AMOUNT_MORE_THAN_LOAN_AMOUNT | When total funds amount is more than the loan account amount. |
| 2020 INVALID_FUND_ID | When the id or the key used for an investor fund action is invalid |
| 2021 INACTIVE_FUND_ID | When an action is performed on an inactive fund |
| 2125 LOAN_ACCOUNT_NOT_FUNDED_BY_DEPOSIT_ACCOUNT | When the loan account is not funded by a deposit account |
Sell funding source investment (2050 - 2099)
| Response Code | Description |
|---|---|
| 2050 INVALID_FUNDED_ACCOUNT_STATE | Sell operation is done for a funded account in an invalid state (e.g. the loan ispending or closed) |
| 2051 FUND_SELL_WITH_NO_PURCHASES | When sell action is performed with no purchases |
| 2052 FUND_OVERSELL | Sell operation was attempted for an amount larger than the sold loan fraction |
| 2053 INVALID_SELLER_FUND_AMOUNT | Seller's fund amount is not positive |
| 2054 INVALID_SELLER_FUND_STATE | Seller's fund state is not active |
| 2055 INVALID_SELLER_FUNDING_ACCOUNT | Seller's funding account is not valid |
| 2056 INVALID_INVESTMENT_PERCENTAGES_FOR_AMOUNTS | Percentages determined by amounts are not valid. |
| 2057 FUND_SELF_SELL | The fund buyer savings account cannot be the same as the fund to sell owner savings account |
| 2061 INVALID_BUYER_FUNDING_ACCOUNT | Buyer's funding account key doesn't correspond to a proper funding savings account owned by buyer |
| 2062 DUPLICATE_BUYER_FUNDING_ACCOUNT | Buyer's funding account key is found more than once in the list of buyers |
| 2063 INVALID_BUYER_FUND_AMOUNT | Buyer's bought amount is invalid (negative, zero, nan) |
| 2064 INVALID_FUND_PURCHASE_PRICE | Buy price is not the same as the buyer's bought amount |
| 2065 INSUFFICIENT_BUYER_FUNDING_ACCOUNT_FUNDS | Buyer's funding account key doesn't have sufficient funds for buy action |
| 2099 INVALID_FILTER_VALUES | Values are invalid for the type of the data field specified |
2100
| Response Code | Description |
|---|---|
| 2100 INVALID_FILTER_SELECTION | When the value of filter selection is not a valid data field or custom field key when searching on the fly. |
| 2101 INVALID_FILTER_ELEMENT | When the value of filter element is not valid or supported and is not applicable for the type of the data field. |
| 2102 INVALID_FILTER_VALUE | When invalid value for the type of the data field. |
| 2103 INVALID_FILTER_SECOND_VALUE | When invalid second value - second value not provided when using BETWEEN filter element or provided but not for a between filter. |
| 2104 TOO_MANY_FILTERS_PROVIDED | When more filters are provided then the maximum supported number. |
| 2105 INVALID_FILTER_DATA_ITEM_TYPE | When the value of dataItemType property is not recognized (not a valid value). |
| 2106 INSUFFICIENT_FUNDS_ACCOUNT_BALANCE | When there is not enough deposit balance to be used as fund. |
| 2107 INSUFFICIENT_FUNDS_TOTAL_AMOUNT | When the the total amount of the funds is not enough. |
| 2108 FUNDS_NOT_ALLOWED | When trying to post a loan account with funds, but the product don't accept investors. |
| 2109 FUNDING_AMOUNT_MUST_BE_STRICTLY_POSITIVE | When trying to post a loan account with fund which contains negative or zero amount. |
| 2110 FUNDER_INTEREST_COMMISSION_CONSTRAINTS_VALIDATION | When trying to post a funding source with interest commission outside of boundaries |
| 2111 MISSING_FUNDER_INTEREST_COMMISSION | When trying to post a funding source with missing interest commission for a fixed interest commission product type |
| 2112 LOAN_ACCOUNT_NOT_FUNDED_BY_SAVINGS_ACCOUNT | When the loan account should be funded by an investor's savings account, but it is not. |
| 2113 INVALID_INTEREST_RATE_AGAINST_INTEREST_COMMISSION | When trying to post a loan account with funds and the account interest rate is less than the fund interest commission. |
| 2114 INVALID_SAVINGS_ACCOUNT_TYPE_FOR_FUNDING | When trying to post a loan account with funds and the savings account for funding is not an investor account. |
| 2115 DUPLICATED_SAVINGS_ACCOUNT_FOR_FUNDING | When trying to post a loan account with investor fund and investors have the same savings account key. |
| 2116 INVALID_FIXED_DAYS_OF_MONTH | When trying to post a loan account with invalid fixed days of month, like duplicated days or day number greater than 31. |
| 2117 INVALID_SORTING_COLUMN | When trying to post a search using on the fly search and the given sorting column is null, empty or invalid. |
| 2118 COLUMN_NOT_SORTABLE | When trying to post a search using on the fly search and the column is not sortable(DataField.FilteringCapabilities = FilteringCapabilities.UNFILTERABLE). |
| 2119 INVALID_SORTING_ORDER | When trying to post a search using on the fly search and the given sorting order is null, empty or invalid (not in SortingOrder enum). |
| 2120 ACCOUNT_TYPE_DOES_NOT_ALLOW_FIELD | When trying to change a field for an account that does not allow that field. |
| 2121 INVALID_GUARANTY_ENCODED_KEY | When trying to edit the guaranty of a loan account and an invalid guaranty key is encountered. |
| 2122 INVALID_GUARANTY_TYPE | When trying to edit the type of a guaranty (guarantor/asset/investor) with an invalid value. |
| 2123 INVALID_GUARANTOR_TYPE | When trying to edit the type of a guarantor (client/group) with an invalid value. |
| 2124 GUARANTY_KEY_TYPE_MISMATCH | When the guaranty key is not of the mentioned type. |
| 2125 LOAN_ACCOUNT_NOT_FUNDED_BY_DEPOSIT_ACCOUNT | When calling GET for funded loan accounts, the error means that the loan account you are trying to get is not funded by a deposit account |
2200
| Response Code | Description |
|---|---|
| 2200 INVALID_TEMPLATE_ID | When the template id provided is not valid. |
| 2201 INVALID_TEMPLATE_TYPE | When the type of the template provided to be processed through API doesn't match with the context. |
| 2202 MISSING_FIXED_DAYS_OF_MONTH | When the fixed days of month are missing. |
| 2203 FIXED_DAYS_OF_MONTH_NOT_ALLOWED | When the fixed day of month are provided but the product does not allow them . |
| 2204 REPAYMENT_FREQUENCY_NOT_ALLOWED | When the repayment frequency is provided but the product does not allow it. |
| 2205 REPAYMENT_PERIOD_COUNT_NOT_ALLOWED | When the repayment period count is provided but the product does not allow it. |
| 2206 APPLIED_INTEREST_BALANCE_CANNOT_BE_REALLOCATED | When the user tries to update the interest balance across repayments, between a repayment with interest applied and one without. |
| 2207 INVALID_NEW_TOTAL_LOAN_AMOUNT | When trying to reschedule a loan account without any write off transaction, and the loan amount of the new account isn't equal with original account principal balance. |
| 2208 NEGATIVE_WRITE_OFF_AMOUNT | When trying to reschedule or refinance a loan account and a write off transaction is requested, but a negative amount is provided. |
| 2209 CAPITALIZED_AMOUNTS_NOT_ALLOWED_DUE_TO_DIFFERENT_ACCOUNTING | When trying to reschedule or refinance a loan account with capitalized amounts to a new product that has a different accounting methodology than the current one. |
| 2210 TOP_UP_AMOUNT_IS_MANDATORY | When trying to refinance a loan account but not provide the top up amount. |
| 2211 RESTRUCTURE_DETAILS_ARE_MANDATORY | When trying to refinance a loan account and restructure details aren't provided. |
| 2212 NEGATIVE_TOP_UP_AMOUNT | When trying to refinance a loan account and the top up amount provided is negative. |
| 2214 CANNOT_REFINANCE_REVOLVING_CREDIT_LOAN | When trying to refinance a revolving credit loan |
| 2215 POSITIVE_CAPITALIZED_AMOUNTS_FOR_LOAN_FUNDED_NOT_ALLOWED | When rescheduling a loan with investor funds and positive capitalized amounts are defined. |
| 2216 WRITE_OFF_AMOUNT_FOR_LOAN_FUNDED_DIFFERENT_BY_BALANCE_AMOUNT | When trying to reschedule a loan account with investor funds and the write off outstanding balance amount is different than the current balance amount(interest/fees/penalty). |
| 2217 CURRENCY_NOT_AVAILABLE_FOR_PRODUCT | When trying to create a savings account with a currency which is not availble for the desired product type. |
| 2218 CURRENCY_NOT_EDITABLE | When trying to edit the currency of a savings account but it is linked to a loan account. |
| 2219 TELLER_CANNOT_POST_TRANSACTION_IN_MULTI_CURRENCY | When trying to post a transaction as teller in a currency different than the base one. |
| 2220 NOT_ENOUGH_PRINCIPAL_TO_CONTINUE_FEE_AMORTIZATION | When trying to reschedule/refinance a loan account and the transferred principal is less or equal than the remaining fee amount to amortize. |
Principal Payment Settings (2300 - 2399)
| Response Code | Description |
|---|---|
| 2300 SETTINGS_ONLY_AVAILABLE_FOR_REVOLVING_CREDIT_ACCOUNTS | When the loan account is not of revolving credit type but it does have any principal payment settings |
| 2301 INCONSISTENT_FLAT_AMOUNT_WITH_PRODUCT_CONSTRAINTS | When the loan product's settings constraints don't match the account's flat principal payment amount |
| 2302 INCONSISTENT_PERCENTANGE_WITH_PRODUCT_CONSTRAINTS | When the loan product's settings constraints don't match the account's outstanding principal payment percentage |
| 2303 AMOUNT_REQUIRED_FOR_FLAT_PRINCIPAL_PAYMENT_METHOD | When the account's flat principal payment amount is null but mandatory |
| 2304 PERCENTAGE_REQUIRED_FOR_PRINCIPAL_PAYMENT_PERCENTAGE_METHOD | When the account's principal payment percentage is null but mandatory |
| 2305 AMOUNT_ONLY_AVAILABLE_FOR_FLAT_PRINCIPAL_PAYMENT_METHOD | When the account's flat principal payment amount is set but unavailable |
| 2306 PERCENTAGE_ONLY_AVAILABLE_FOR_OUTSTANDING_PRINCIPAL_PERCENTAGE_METHOD | When the account's principal payment percentage is set but unavailable |
| 2307 INVALID_PRINCIPAL_PAYMENT_FLAT_AMOUNT_WITH_DECIMALS | When the account's flat principal payment amount is not valid with regards to the decimals settings |
| 2308 INVALID_PRINCIPAL_PAYMENT_PERCENTAGE_VALUE | When the account's principal payment percentage value is not a valid percentage value |
| 2309 CANT_EDIT_LOCKED_OPERATIONS_IN_LOCKED_CAPPING_STATE | When the locked operations are edited and the account is in locked capping state |
| 2310 CANT_UNLOCK_WHEN_INCOME_BALANCE_IS_OVER_PRINCIPAL_CAPPING_CONSTRAINTS | Error code for the case when the income balance(interest + fee + penalties) is over the principal capping constrains set on the product, the unlock is not allowed |
| 2311 CANNOT_BULK_REVERSE_INTERNAL_TRANSFER_REPAYMENT | When trying to reverse an internal transfer repayment as part of a bulk reversal operation. |
| 2312 CANNOT_BULK_REAPPLY_TRANSACTION_BECAUSE_LOCKED_TRANSACTIONS_LOGGED_AFTER_IT | When as part of a bulk reversal operation, a transaction is re-applied after a interest, fees or penalty locked transaction. |
| 2313 CANNOT_BULK_REAPPLY_POSTDATED_REPAYMENTS | When as part of a bulk reversal operation, a postdated repayment is re-applied. |
| 2314 CANNOT_BULK_REVERSE_ACTIVATION_TRANSACTION | Transaction cannot be backdated before the disbursement of a loan account. |
| 2315 CLOSURE_DATE_AFTER_MAX_ALLOWED_UNDO_CLOSURE_PERIOD | When the undo closure date is after account closure date + max allowed undo closure days. |
| 2316 CLOSURE_DATE_BEFORE_GL_ACCOUNT_CLOSURE | When there is a GL Accounts closure logged after the loan account closure date. |
| 2317 MISSING_ORGANIZATION_INTEREST_COMMISSION | When there is product without having default value set for organization interest commission and this value is not specified in the API call. |
| 2318 INSUFFICIENT_TRANSACTION_AMOUNT | When there isn't enough amount in the account to reverse the transaction |
| 2319 CANNOT_REVERSE_INTEREST_ON_DISBURSEMENT | When there are transaction to be adjusted for an account having the interest applied on disbursement, which isn't allowed |
| 2320 TRANSACTION_TYPE_IS_IRREVERSIBLE | The transaction we're attempting to adjust has a type that does not allow adjustments |
| 2321 INTEREST_APPLIED_WITH_NULL_AMOUNT | The transaction is an interest applied and has null amount |
| 2322 CANNOT_REVERSE_OFFSET_DEPOSIT_TRANSACTION | When trying to reverse a transaction for a linked offset deposit. |
| 2323 CANNOT_LOCK_CAPPING_ACCOUNT_INVALID_ACCOUNT_ID | Can't lock (capping) account because the account's id is invalid. |
| 2324 CANNOT_LOCK_CAPPING_ACCOUNT_INVALID_ACCOUNT_STATE_FOR_LOCK | Can't lock (capping) account because the account's state is not valid for locking. |
| 2325 INCOME_BALANCE_CONSTRAINTS_EXCEEDED | Income balance constraints would be exceeded if income transaction would be applied. |
| 2326 CANNOT_BULK_REVERSE_LOAN_FRACTION_SOLD | Loan fraction sold cannot be directly bulk reversed. |
| 2327 LATE_FEE_TRANSACTIONS_LOGGED_AFTER_REPAYMENT_TO_REAPPLY_ON_FIXED_ACCOUNT | When there are late fee transactions logged after a repayment transaction to reapply on a fixed loan account |
| 2328 FEE_CANNOT_BE_POSTED_ON_RECOMPUTED_SCHEDULE | When a late fee cannot be re applied on recomputed schedule after |
| 2329 INVALID_ORGANIZATION_INTEREST_COMMISSION | When organization interest commission does not represent a valid numeric value or does not comply with product security settings |
| 2330 ACCOUNT_ALREADY_LOCKED | When trying to lock an already locked account |
| 2331 CANNOT_BULK_ADJUST_ACTIVATION_TRANSACTION | Cannot bulk-adjust the activation transaction for a loan account |
2400
| Response Code | Description |
|---|---|
| 2400 INTEREST_RATE_CHANGED_TRANSACTION_NOT_ALLOWED | The LoanTransactionType.INTEREST_RATE_CHANGED transaction can't be applied |
| 2401 INTEREST_RATE_CHANGED_TRANSACTION_NOT_ALLOWED_FOR_LOAN_PRODUCT_TYPE | The LoanTransactionType.INTEREST_RATE_CHANGED transaction can be applied only for revolving credit products |
| 2402 INSTALLMENT_WITH_INTEREST_APPLIED_CANNOT_BE_EDITED | When the custom schedule has interest applied and an edit was tried. |
| 2403 UNABLE_TO_DETERMINE_DELETED_REPAYMENTS | When the we can not properly identify the deleted repayments. |
| 2404 PAID_OR_PURE_GRACE_INSTALLMENT_CANNOT_BE_DELETED | When a pure grace installment or a paid installment was deleted. |
| 2405 NON_CUSTOM_MADE_INTALLMENT_CANNOT_BE_DELETED_FOR_REVOLVING_CREDIT_ACCOUNT | When a non custom-made installment is deleted for a revolving credit account. |
| 2406 INVALID_NUMBER_OF_INSTALLMENTS | When the number of installments is not within the product constraints. |
| 2407 INVALID_PRINCIPAL_AMOUNT_WITH_DECIMALS | When a principal amount is not valid with regarding to the decimals settings. |
| 2408 INCONSISTENT_WITH_LINE_OF_CREDIT_VALID_UNTIL_DATE | When the due date (of repayment) is after the Line of Credit valid until date. |
| 2409 DUE_DATES_NOT_UNIQUE | When there are multiple installments with the same due date (edit repayment schedule). |
| 2410 NON_ZERO_PRINCIPAL_REPAYMENT_CANNOT_BE_DELETED | When a delete for a repayment that has not non zero principal due was tried. |
| 2411 NON_DYNAMIC_ACCOUNT_REPAYMENT_DELETION_NOT_ALLOWED | When there is a a delete for a repayment for non dynamic account (not allowed). |
| 2412 INVALID_LOAN_ACCOUNT_STATE_FOR_FUNDS_EDIT | When the loan account state is invalid for the case when the investor funds are edited. |
| 2413 ENTRY_DATE_AFTER_MATURITY_DATE_WITH_LATE_FEES_AND_BULK_REVERSAL | When the interest is applied after account maturity date and there are late fees and also it trigger a bulk reverse and re-apply of transactions. |
| 2414 DIFFERENT_ACCOUNTING_STATE_BETWEEN_INVOLVED_PRODUCTS | When the savings product has different accounting states. |
| 2415 ACCOUNT_ALREADY_LINKED | When the account is already linked with the provided savings account. |
| 2416 PRODUCT_DOES_NOT_ALLOW_LINKING | When the product does not allow linking of settlement accounts. |
| 2417 UNLINKABLE_SAVINGS_PRODUCT | When the savings product is not accepted by the loan product for linking. |
| 2418 INVALID_SAVINGS_ACCOUNT_HOLDER | When the linking should be done only between account under same account holder. |
| 2419 LINK_BETWEEN_ACCOUNTS_DOES_NOT_EXIST | When a link between the loan account and the savings account does not exist. |
| 2420 NON_NATIVE_GRACE_INSTALLMENT_CANNOT_BE_EDITED | When a non-native grace installment was edited. |
| 2421 NON_NATIVE_GRACE_INSTALLMENT_CANNOT_BE_DELETED | When a non-native grace installment was deleted. |
| 2422 INSUFFICIENT_ACCOUNT_BALANCE | When the account balance is insuficient for the given operation. |
| 2423 INVALID_SAVINGS_ACCOUNT_TYPE | When the savings account type is invalid for the given operation. |
| 2424 MATURITY_PERIOD_ALREADY_STARTED | When the maturity date period is already started on the account. |
| 2425 LOAN_PRODUCT_PRINCIPAL_PAID_INSTALLMENT_STATUS_MISMATCH | Principal paid installment status from loan account doesn't match the one from loan product. |
| 2426 CANNOT_DELETE_LINK_FOR_ACTIVATED_OFFSET_LOAN | A link cannot be deleted for an offset loan account that was activated. |
| 2427 INVALID_LANGUAGE | When the provided language is invalid(null or something else, the error soruce will provide the detailed reason). |
| 2428 INVALID_LINKED_SETTLEMENT_ACCOUNT_KEYS | When the list with the provided linked settlement account keys on a deposit account is invalid |
| 2429 SAVINGS_ACCOUNT_ALREADY_LINKED | When the settlement account is already linked to loan accounts from different branches |
| 2430 INSTALLMENT_WITH_PENALTY_APPLIED_CANNOT_BE_EDITED | When the custom schedule has penalty applied and an edit was tried |
| 2431 INSTALLMENT_DUE_DATE_MOVED_BEFORE_LAST_PENALTY_APPLIED_DATE | When the custom due date was moved before penalty applied |
| 2432 MATURITY_PERIOD_NOT_STARTED | When the maturity date period is not yet started on the account |
| 2440 RESEND_FAILED_NOTIFICATION_FAILED | When trying to resend a failed notification and it fails (due to different causes: invalid encoded key of notification message or other various reasons, incorrect notification configuration). |
| 2441 TRY_TO_RESEND_NON_FAILED_NOTIFICATION | When trying to resend a non failed notification. |
| 2442 DUPLICATED_NOTIFICATION_ENCODED_KEY | When trying to resend a list of notification message encoded keys and at least one key is duplicated. |
| 2443 MAXIMUM_NUMBER_OF_NOTIFICATIONS_TO_RESEND_EXCEEDED | When the maximum number of failed notifications to resend exceeds the set mambu property. |
| 2444 DUE_DATES_NOT_IN_ASCENDING_ORDER | When the generated schedule doesn't have the due dates in ascending order. This can happen due to first repayment settings, as offset and repayment rescheduling options. |
| 2445 ACCOUNT_PRODUCT_BRANCH_AVAILABILITY_MISMATCH | There is a mismatch between the account's assigned branch key and the branch(es) for which the product is available. |
| 2446 CLIENT_HAS_ACTIVE_ACCOUNTS_WITH_PRODUCT_BRANCH_AVAILABILITY_MISMATCH | In case a change to a client's (or group) assigned branch is done and that client(group) has active accounts that are unavailable for the new assigned branch |
| 2447 PRODUCT_HAS_ASSOCIATED_ACCOUNTS | The product has associated accounts |
| 2448 MAX_NUMBER_OF_FILTERS_REACHED(2448), | When the number of filters exceeds the maximum allowed |
| 2449 MAX_NUMBER_OF_COLUMNS_REACHED(2449), | When the number of columns exceeds the maximum allowed |
| 2450 USAGE_RIGHTS_ROLE_NOT_AVAILABLE(2450), | When the custom view is tried to be stored with a usage rights not available for it |
| 2452 CURRENCY_NOT_DEFINED(2452), | When the deposit product doesn't have a currency defined |
| 2453 BASE_CURRENCY_CANNOT_BE_REMOVED | When the deposit product is linked to a loan product, then the base currency cannot be removed from it |
| 2454 CURRENCY_IN_USE_CANNOT_BE_REMOVED | When the currency is in use by other deposit product, then it cannot be removed |
| 2455 CURRENCY_DOES_NOT_EXIST | When the specified currency code was not found (via API) |
Credit arrangement (return codes used in API V2.0) (2456 - 2499)
| Response Code | Description |
|---|---|
| 2456 INVALID_CREDIT_ARRANGEMENT_ID | When the id or the key used for GETing a credit arrangement is invalid |
| 2457 INVALID_CREDIT_ARRANGEMENT_STATE | When trying to create a credit arrangement and the state does not match internal controls |
| 2458 CREDIT_ARRANGEMENT_ID_ALREADY_IN_USE | When trying to store a credit arrangement with an id that is already taken |
| 2459 INVALID_CLIENT_ROLE_PERMISSION_FOR_OPENING_CREDIT_ARRANGEMENTS | When trying to store a credit arrangement, but the client type does not allow opening credit arrangements |
| 2460 CREDIT_ARRANGEMENT_AMOUNT_NOT_STRICTLY_POSITIVE | When trying to store a credit arrangement with an amount that is not strictly positive |
| 2461 PRODUCT_CREDIT_ARRANGEMENT_AFFILIATION_CONSTRAINT_MISMATCH | When the product requires a credit arrangement and the account is not part of a credit arrangement or the account doesn't allow a credit arrangement, but the account has a credit arrangement set |
| 2462 ACCOUNT_ALREADY_ON_CREDIT_ARRANGEMENT | When trying to add an account to a credit arrangement, but the account already has a credit arrangement defined |
| 2463 INCONSISTENT_CREDIT_ARRANGEMENT_CLIENT_WITH_ACCOUNT_OWNER | When the key of the credit arrangement is not the same as the holder key of the account |
| 2464 CREDIT_ARRANGEMENT_REQUIRES_OVERDRAFT_EXPIRE_DATE | when overdraft expire date is required because the account is part of a credit arrangement and in a consuming state |
| 2465 CREDIT_ARRANGEMENT_REQUIRES_OVERDRAFT_MAX_LIMIT | When overdraft max limit is required because the account is part of a credit arrangement and in a consuming state |
| 2466 CREDIT_ARRANGEMENT_AMOUNT_EXCEEDED | When the maximum credit arrangement amount would be exceeded if the account would join the credit arrangement |
| 2467 MATURITY_DATE_AFTER_CREDIT_ARRANGEMENT_END_DATE | When the loan last repayment date is after the credit arrangement expire date |
| 2468 OVERDRAFT_EXPIRY_DATE_AFTER_CREDIT_ARRANGEMENT_END_DATE | When the overdraft expiry date is after the credit arrangement expire date |
| 2469 DISBURSEMENT_DATE_BEFORE_CREDIT_ARRANGEMENT_START_DATE | When the loan disbursement (or expected disbursement) date is before the credit arrangement start date |
| 2470 CREDIT_ARRANGEMENT_REQUIRED_EXCEPTION | When the product requires a credit arrangement but the account is not part of a credit arrangement |
| 2471 ACCOUNT_IS_NOT_PART_OF_CREDIT_ARRANGEMENT | When trying to delete an account but it is not part of the credit arrangement mentioned in the URL |
| 2472 CREDIT_ARRANGEMENT_ILLEGAL_PARAMETER_MODIFICATION | When trying to modify some credit arrangement parameters, but due to credit arrangement state the modification is not permitted |
| 2473 CREDIT_ARRANGEMENT_HAS_NON_CLOSED_ACCOUNTS | When trying to close a credit arrangement that has non closed accounts |
| 2474 BASE_CURRENCY_NOT_UNIQUE | When adding a default currency but there is already a default in the system |
| 2475 CURRENCY_SYMBOL_LENGTH_OUTSIDE_CONSTRAINTS | When a currency symbol is outside its length constraints |
| 2476 INEXISTING_CURRENCY_SYMBOL | When no currency symbol is specified |
| 2480 INVALID_TO_INSTALLMENT_POSITION | When the installment value for a periodic payment is an invalid value (should be positive integer) |
| 2481 INVALID_PMT_VALUE | When the PMT value for a periodic payment is invalid (should be zero or positive amount) |
| 2482 PAYMENT_PLAN_NOT_AVAILABLE | When the payment plan is not available for the loan account |
| 2483 AT_LEAST_ONE_PERIODIC_PAYMENT_PLAN_MANDATORY | When at least one periodic payment should be defined in a payment plan |
| 2484 SUM_OF_PERIODIC_PAYMENTS_LESS_OR_EQUAL_WITH_LOAN_AMOUNT | When the sum of periodic payments defined in payment plan is less than or equal to the loan amount |
| 2485 PAYMENT_PLAN_ENTRIES_NOT_ORDERED | When the periodic payments of a payment plan are not in ascending order (starting position is greater than ending position for a periodic payment) |
| 2486 INTEREST_RATE_COMPUTATION_ERROR | When the interest rate cannot be computed based on a payment plan |
| 2487 INVALID_PERIODIC_PAYMENT_ENCODED_KEY | When an update is done on a non existing payment plan entry |
| 2488 DUPLICATED_PERIODIC_PAYMENT_ENCODED_KEY | When a payment plan update contains duplicate encoded keys |
| 2489 INVALID_INTEREST_CHARGE_FREQUENCY_METHOD_MUST_BE_NULL | InterestChargeFrequency is invalid (should be null for Fixed payment plan product) |
| 2490 INVALID_DAYS_IN_YEARS_METHOD_MUST_BE_NULL | DaysInYears is invalid (should be null for Fixed payment plan product) |
2500
| Response Code | Description |
|---|---|
| 2500 PRODUCT_ID_ALREADY_IN_USE(2500), | When the product ID is already in use |
| 2501 INVALID_ROUNDING_REPAYMENT_CURRENCY_FOR_PRODUCT(2501), | When rounding repayment currency is inconsistent with the product options |
| 2502 INVALID_COMMUNICATION_MESSAGE_ENCODED_KEY | When the provided encoded key for the communication message is invalid |
| 2503 INVALID_EMAIL_SUBJECT | |
| 2504 CANNOT_ADJUST_OFFSET_DEPOSIT_TRANSACTION | When trying to adjust a transaction for a linked offset deposit |
2600
| Response Code | Description |
|---|---|
| 2600 SDK_CLIENT_COULD_NOT_BE_GENERATED | When something went wrong while generating the SDK client and the client could be generated |
| 2601 SDK_CLIENT_LANGUAGES_COULD_NOT_BE_OBTAINED | When something went wrong while trying to obtain the available languages for SDK client generation |
| 2602 MAXIMUM_NUMBER_OF_COMMUNICATION_MESSAGES_TO_RESEND_EXCEEDED | When the maximum number of failed communication messages to resend exceeds the set Mambu property |
| 2604 RESEND_FAILED_COMMUNICATON_FAILED | When trying to resend a failed communication and it fails (due to different causes: invalid encoded key of the communication message or other various reasons such as incorrect communication message configuration) |
| 2605 DUPLICATE_ENCODED_KEY | When trying to resend a list of communication messages and at least one encoded key is duplicated |
| 2606 MESSAGE_STATE_MUST_BE_FAILED | When trying to resend a non failed communication |
| 2607 NO_MESSAGE_FOUND | When no message was found in a list of message encoded keys |
| 2608 MESSAGE_NOT_FOUND | When the message was not found for that specific encoded key |
| 2609 MISSING_ENCODED_KEY | When the message to be resend doesn't have the encoded key specified |
| 2610 URL_CONTAINS_QUOTES | WebHook URLs cannot contain quotes |
| 2611 MISSING_RECIPIENT | The message recipient is missing when required |
| 2612 RECIPIENT_NOT_ALLOWED | The message recipient is set but not allowed |
| 2613 INVALID_CLIENT_RECIPIENT | The client recipient is not valid |
| 2614 INVALID_CREDIT_OFFICER_RECIPIENT | The credit officer recipient is not valid |
| 2615 INVALID_GROUP_ROLE_RECIPIENT | The group role recipient is not valid |
| 2616 INVALID_CUSTOM_FIELD_RECIPIENT | The custom field recipient is not valid |
| 2617 INVALID_EVENT | The event of the template used for this message is not valid |
| 2618 INVALID_TARGET | The target of the template used for this message is not valid |
| 2619 INVALID_PLACEHOLDER | A placeholder from the template is not allowed |
| 2620 INVALID_FIELD_LENGTH | When the name or subject has invalid length |
| 2621 INVALID_WEBHOOK_REQUEST_TYPE | WebHook request type is not valid |
| 2622 URL_CONTAINS_INVALID_PLACEHOLDERS | WebHook URLs cannot contain specific placeholder, like Repayment schedule placeholder |
| 2623 UNABLE_TO_RECALCULATE_SCHEDULE | When the schedule recalculate fails |
| 2624 UNABLE_TO_APPRAISE_LOAN_ACCOUNT | When the appraisal of the loan account fails |
| 2625 TRANSACTION_MADE_BY_A_DISBURSEMENT_FEE | Transaction is an up-front disbursement fee type that can not be individually reversed |
| 2626 INVALID_TARGET_ACCOUNT_TYPE | When the target account is a term deposit (fixed deposit or savings plan) |
| 2627 NEGATIVE_TARGET_ACCOUNT_BALANCE | When the target account has negative balance. Disbursements cannot be transferred to overdraft accounts (can't pay an overdraft with another loan) |
| 2628 ZERO_DISBURSE_AMOUNT | When an account is trying to be disbursed to a savings account but with a zero amount |
| 2629 INVESTOR_FUNDED_LOAN_ACCOUNT | When an account is trying to be disbursed with external investor funds in a savings account |
| 2630 INVALID_TARGET_ACCOUNT_HOLDER_KEY | When the account holder of target account is not the same with the one from the loan account (disbursements can only be transfered from a client's loan to one of its deposits) |
| 2631 TRANSFER_NOTES_LENGTH_EXCEEDS_MAXIMUM_SIZE | When transfer notes are longer than the maximum allowed size. |
| 2632 CANNOT_MAKE_TRANSFER_FOR_FOREIGN_CURRENCY_IF_ACCOUNTING_ENABLED | When the user tries to make a transfer between 2 savings accounts and the source account has accounting enabled and a foreign currency |
Cards (2700 - 2799)
| Response Code | Description |
|---|---|
| 2700 CARD_REFERENCE_TOKEN_FORMAT_INVALID | When the card reference format is invalid (null or too long) |
| 2701 CARD_REFERENCE_TOKEN_ALREADY_IN_USE | This card token is already in use with another current or revolving credit account and cannot be used. |
| 2702 CARD_REFERENCE_HAS_ASSOCIATED_HOLDS_OR_TRANSACTIONS | When the card reference has associated authorization holds or card transactions upon deleting |
| 2703 CARD_REFERENCE_NOT_FOUND | When the card reference token not found in database |
| 2704 DUPLICATE_AUTHORIZATION_HOLD | When an authorization hold with the same card token and external reference ID already exists. |
| 2705 DUPLICATE_CARD_TRANSACTION | When a card transaction with the same card token and external reference ID already exists. |
| 2706 AVAILABLE_BALANCE_BELOW_ZERO | When the available balance drops below zero (becomes negative) |
| 2707 AUTHORIZATION_HOLD_NOT_FOUND | When the authorization hold was not found in database |
| 2708 INVALID_AUTHORIZATION_HOLD_STATE | When the operation is denied for authorization hold state |
| 2709 CARD_TRANSACTION_CANNOT_BE_ADJUSTED | If a transaction is card-originated, this cannot be reversed. If a reversal is intended, please consult our Support Page |
| 2711 CARD_TRANSACTION_NOT_FOUND | No original card transaction was found for: {cardReferenceToken=card1}, {externalReferenceId=ft2} |
| 2712 CARD_TRANSACTION_MAX_REVERSAL_AMOUNT_EXCEEDED | The amount exceeds transaction max available amount for reversal: {max available amount for reversal} |
| 2713 CARDS_FEATURE_DISABLED | The action cannot be completed until the cards features is enabled for your Mambu tenant. |
2800
| Response Code | Description |
|---|---|
| 2801 PRODUCT_MUST_BE_ACTIVE | When updating an account with an inactive product |
| 2802 TARGET_AMOUNT_IS_NEGATIVE | When savings account target amount is negative |
| 2803 MAX_WITHDRAWAL_AMOUNT_OUTSIDE_CONSTRAINTS | When max withdrawal amount does not match product |
| 2804 ACCOUNT_HOLDER_KEY_INVALID | The account holder key specified is not valid |
| 2805 ACCOUNT_HOLDER_TYPE_INVALID | The account holder type specified is not valid |
| 2806 INVALID_WITHHOLDING_TAX_SOURCE_KEY | The withholding tax source key is not a valid index rate of type Withholding Tax |
| 2807 INTEREST_RATE_OUTSIDE_CONSTRAINTS | The interest rate does not match product constraints |
| 2808 INVALID_INTEREST_PAYMENT_POINT | When the account has null interest payment point or different than the one from the product |
| 2809 INVALID_INTEREST_PAYMENT_DATES | When the account interest payment dates don't match the ones from the product |
| 2810 REQUIRED_OVERDRAFT_INTEREST_RATE | When the overdraft interest spread is required due to product settings |
| 2811 REQUIRED_OVERDRAFT_EXPIRY_DATE | When the overdraft expiry date is required due to product settings |
| 2812 REQUIRED_OVERDRAFT_LIMIT | When overdraft limit is required due to product settings |
| 2813 DEPOSIT_ACCOUNT_FIELD_NOT_EDITABLE | When a field on deposit account cannot be edited |
| 2814 DEPOSIT_PRODUCT_MISMATCH | When a field on deposit account does not match the product settings |
| 2815 ACCOUNT_TYPE_DOES_NOT_ALLOW_RECOMMENDED_DEPOSIT_AMOUNT | When account type does not allow recommended deposit amount |
| 2816 ACCOUNT_TYPE_DOES_NOT_ALLOW_MAX_WITHDRAWAL_AMOUNT | When account type does not allow max withdrawal amount |
| 2817 ACCOUNT_TYPE_DOES_NOT_ALLOW_TARGET_AMOUNT | When account type does not allow target amount |
| 2818 REQUIRED_INTEREST_RATE | When the interest rate is required due to product settings |
| 2819 INTEREST_RATE_SHOULD_BE_NULL | When interest rate should be null |
| 2820 OVERDRAFT_INTEREST_RATE_SHOULD_BE_NULL | When overdraft interest rate should be null |
| 2821 OVERDRAFT_INTEREST_SPREAD_SHOULD_BE_NULL | When overdraft interest spread should be null |
| 2822 INVALID_ACCOUNT_TYPE | When account type is invalid |
| 2823 INVALID_ACCOUNT_KEY | When account key is invalid |
3000
| Response Code | Description |
|---|---|
| 3000 INVALID_AMORTIZATION_PROFILE Amortization profile for the fee is not valid | |
| 3001 AMORTIZATION_PROFILE_NOT_ALLOWED | Amortization profile is not allowed by product settings |
| 3002 INVALID_AMORTIZATION_FREQUENCY | Amortization frequency for the fee is not valid |
| 3003 INVALID_AMORTIZATION_FREQUENCY_CUSTOM_INTERVAL_PERIOD_COUNT | Amortization frequency custom interval period count for the fee is not valid |
| 3004 INVALID_AMORTIZATION_SETTINGS | Amortization settings not valid or missing |
| 3005 AMORTIZATION_FREQUENCY_CUSTOM_INTERVAL_TOTAL_STEPS_NOT_ALLOWED | Amortization frequency custom interval total steps for the fee is not allowed |
| 3006 AMORTIZATION_FREQUENCY_CUSTOM_INTERVAL_PERIOD_UNIT_NOT_ALLOWED | Amortization frequency custom interval period unit for the fee is not valid |
| 3007 AMORTIZATION_FREQUENCY_CUSTOM_INTERVAL_PERIOD_COUNT_NOT_ALLOWED | Amortization frequency custom interval period count for the fee is not valid |
| 3008 INVALID_AMORTIZATION_FREQUENCY_CUSTOM_INTERVAL_TOTAL_STEPS | Amortization frequency custom interval total steps for the fee is not valid |
| 3009 INVALID_AMORTIZATION_FREQUENCY_CUSTOM_INTERVAL_PERIOD_UNIT | Amortization frequency custom interval period unit for the fee is not allowed |
| 3010 AMORTIZATION_SETTINGS_NOT_ALLOWED | Amortization settings not allowed (eg. for product type) |
| 3011 INVALID_INTEREST_RATE_TERMS | When interest rate terms is invalid |
| 3012 TRANSACTION_DISBURSEMENT_DATE_DOES_NOT_MATCH_WITH_TRANCH_EXPECTED_DATE | When the disbursement date provided doesn't match with the next tranch to disburse expected disbursement date |
3100 Transaction Channels
| Response Code | Description |
|---|---|
| 3100 DUPLICATE_TRANSACTION_CHANNEL_NAME | The provided name for transaction channel already exists |
| 3101 DUPLICATE_TRANSACTION_CHANNEL_ID | The provided ID for transaction channel already exists |
| 3102 TRANSACTION_CHANNEL_ID_CONTAINS_SPACES | The provided ID contains white spaces |
| 3103 INVALID_TRANSACTION_CHANNEL_LOAN_CONSTRAINTS | When trying to store a channel with invalid loan constraints |
| 3104 INVALID_TRANSACTION_CHANNEL_SAVINGS_CONSTRAINTS | When trying to store a channel with invalid savings constraints |
| 3105 INVALID_TRANSACTION_CHANNEL_ACCOUNT_USAGE | When trying to store a channel with an account usage different than of type DETAIL |
| 3106 CANNOT_DELETE_DEFAULT_TRANSACTION_CHANNEL | The default transaction channel should not get deleted |
| 3107 TRANSACTION_CHANNEL_IN_USE | Used transaction channels should not get deleted |
| 3108 TRANSACTION_CHANNEL_CANNOT_BE_DEACTIVATED | Thrown when trying to deactivate a transaction channel that should not be deactivated |
3200
| Response Code | Description |
|---|---|
| 3202 INCONSISTENT_TRANSACTION_USER_KEY_WITH_ACCOUNT_USER | When user assigned on the transaction is different than the user making the request |
| 3203 INCONSISTENCY_BETWEEN_CHANNEL_KEY_AND_ID | When the provided key of the transaction channel and the id does not match the same transaction channel |
| 3204 INCONSISTENT_TRANSACTION_PRODUCT_KEY_WITH_ACCOUNT_PRODUCT | When the provided product key on transaction is not consistent (equal) to the product key assigned on the account |
3300
| Response Code | Description |
|---|---|
| 3300 DUPLICATE_ID | When trying to store an entity and the id is already taken by other entity |
| 3301 DUPLICATE_NAME | When trying to store an entity and the name already exists. |
| 3303 ID_CONTAINS_SPACES | The id used in store operation contains spaces and it shouldn't |
| 3304 INVALID_EXTERNAL_ID | The external id from transactions is invalid |
| 3305 EXTERNAL_ID_ALREADY_EXISTS | Another transaction of the same financial source already has this external id |
| 3311 INVALID_ASSIGNMENT_FROM_NO_MEETING_DAY | When trying to assign an entity which is not assigned to a centre or is assigned to a centre without meeting day, to a centre with a meeting day in place |
| 3312 HOLDER_HAS_ACCOUNTS_IN_DIFFERENT_BRANCH_WITH_CENTRE_OR_CREDITOFFICER_MISMATCH | Account Holder has accounts in different branches for which the centre or the credit officer does not belong. |
| 3320 ACCOUNT_ALREADY_DISBURSED | The available amount has been reduced to below the amount already disbursed (the available amount is negative), and further disbursements will not be possible. |
3400
| Response Code | Description |
|---|---|
| 3400 AMORTIZATION_FREQUENCY_INTERVAL_TYPE_NOT_ALLOWED | Amortization interval type not allowed |
| 3401 AMORTIZATION_FREQUENCY_INTERVAL_COUNT_NOT_ALLOWED | Amortization interval count not allowed |
| 3402 INVALID_AMORTIZATION_FREQUENCY_INTERVAL_TYPE | Amortization frequency interval type for the fee is not valid |
| 3403 INVALID_AMORTIZATION_FREQUENCY_PREDEFINED_INTERVALS_UNIT | Amortization frequency predefined intervals unit for the fee is not valid |
| 3404 NON_POSITIVE_DEFAULT_INTEREST_RATE | When the default interest rate is not positive |
| 3405 NON_POSITIVE_MIN_INTEREST_RATE | When the min interest rate is not positive |
| 3406 NON_POSITIVE_MAX_INTEREST_RATE | When the max interest rate is not positive |
| 3407 INVALID_INTEREST_RATE_MIN_MAX_DEFAULT_TUPLE | When the tuple min max default for inerest rate is not valid |
| 3408 DEFAULT_MIN_MAX_NOT_AVAILABLE | When the min max default values for interest rate are not available |
| 3409 INTEREST_RATE_TERMS_ARE_READONLY | When the interesdt rate terms are not available |
| 3410 INTEREST_CALCULATION_BALANCE_METHOD_READONLY | Interest calculation balance method is readonly |
| 3411 INTERNAL_TRANSFER_CANNOT_USE_CUSTOM_FIELDS | Internal transfer transactions don't have a transaction channel and thus can't have custom fields. |
| 3412 INCONSISTENT_FEE_CALCULATION_METHOD_WITH_INCLUDE_FEE_IN_FLOOR_AMOUNT_OPTION_ENABLED | When the loan product doesn't support repayment principal amount percentage on fess with include fees in floor amount option enabled |
| 3413 INCONSISTENT_FEE_CALCULATION_METHOD_WITH_TOTAL_BALANCE_OPTION_ENABLED | When the loan product doesn't support repayment principal amount percentage on fess with total balance percentage option |
| 3414 INCONSISTENT_LATE_REPAYMENT_FEE_TRIGGER_WITH_TOTAL_BALANCE_OPTION_ENABLED | When the loan product doesn't support late fess with total balance percentage option |
| 3415 INACTIVE_ACCOUNT_BRANCH | Can store loan accounts only assigned to an active branch |
| 3416 INCONSISTENT_ACCOUNT_BRANCH_ASSOCIATION_CENTRE_OR_CREDITOFFICER_MISMATCH | When the other assignments on centre or credit officer become inconsistent due to branch association |
| 3417 INVALID_ACCOUNT_BRANCH_ASSIGNMENT_DUE_CENTRE_MEETING_DAY_MISMATCH | Only for fixed accounts, when a loan account's branch which is not assigned to a centre or is assigned to a centre without meeting day is tried to be assigned to a centre with a meeting day |
| 3418 CANNOT_CHANGE_LOAN_GROUP_BRANCH_FOR_A_SOLIDARITY_GROUP | When changing the branch while creating or editing a loan group for a solidarity group |
| 3419 CANNOT_CHANGE_LOAN_ACCOUNT_BRANCH_WHEN_RESHEDULE_REFINANCE | when trying to change the branch when reschedule or refinance a loan account |
| 3420 INVALID_FEE_APPLICATION | When the loan product's fee application is not valid |
| 3421 INVALID_FEE_AMORTIZATION_UPON_RESCHEDULE_REFINANCE_OPTION | When the loan product's fee amortization upon reschedule/refinance option is not valid |
| 3422 FEE_AMORTIZATION_UPON_RESCHEDULE_REFINANCE_OPTION_IS_MANDATORY | When the loan product's continue fee amortization value is mandatory for the fee |
| 3424 NOT_ADJUSTED_TRANSACTION_LOGGED_AFTER_CURRENT_ONE | When a transaction that is not adjusted is logged after the current one |
| 3425 CANNOT_ADJUST_INTEREST_ON_DISBURSEMENT | When an interest on disbursement cannot be adjusted |
| 3426 TRANSACTION_TYPE_DOES_NOT_ALLOW_ADJUSTMENT | When the type of transaction does not allow adjustment |
| 3427 TRANSACTION_ALREADY_ADJUSTED | When trying to adjust a transaction that has already been adjusted |
| 3423 FEE_TRIGGER_NOT_ALLOWED | When the fee trigger is not allowed for product setup |
| 3428 PAYMENT_DUE_FEES_ON_DUE_DATES_TRIGGER_NOT_ALLOWED | Payment due fees on due dates trigger is not allowed for current product setup |
| 3429 EDITING_PAYMENT_DUE_FEES_APPLIED_ON_DUE_DATES_NOT_ALLOWED | When editing payment due fees applied on due dates (for do not allow Payment Due Fee Applied on Due Dates reallocation at Edit Schedule) |
| 3430 DEPOSIT_INTEREST_FEATURE_DISABLED | Interest fields cannot be set when DEPOSIT_INTEREST feature is disabled |
3500 Federated Authentication
| Response Code | Description |
|---|---|
| 3500 CANNOT_CREATE_NEW_USER_IN_FEDERATED_CONTEXT | When you try to create a new user, and federated authentication is enabled. |
3600
| Response Code | Description |
|---|---|
| 3600 EMPTY_CUSTOM_FIELD_ID | Custom field id is empty |
| 3610 ACCOUNT_ALREADY_CLOSED | Account closed |
| 3611 INVALID_GUARANTEE_TYPE | Guarantee type is invalid |
| 3612 ORIGINAL_ACCOUNT_NOT_FOUND | There is no original account found, that rescheduled this one |
| 3613 INVALID_ORIGINAL_ACCOUNT_STATE | The original account is not in Closed Rescheduled/Refinanced state |
| 3614 INCONSISTENT_AMORTIZATION_ACCOUNTING_SETUP | The original account has a fee with amortizations and cannot be Rescheduled/Refinanced into another product |
| 3615 PAYMENT_DUE_FEES_ON_DUE_DATES_NOT_ALLOWED_AT_RESCHEDULE_REFINANCE | The original loan product or new selected product has payment due fees on due dates defined and loan account cannot be Rescheduled/Refinanced |
| 3620 CANNOT_APPLY_REPAYMENT_ON_ZERO_BALANCE_ACCOUNT | When the account has zero balance no repayments can be applied |
| 3621 LOCKED_BALANCE_NOT_ALLOWED | When locked balance is set and should not be modified |
| 3622 INEXISTING_TOLERANCE_CALCULATION_METHOD | When arrears tolerance calculation method is not present |
| 3623 ARREARS_TOLERANCE_DAY_OUTSIDE_CONSTRAINTS | When arrears tolerance calculation method is not present |
| 3624 INCONSISTENT_ARREARS_TOLERANCE_VALUES_WITH_ARREARS_TOLERANCE_METHOD | When the arrears tolerance calculation method and the arrears tolerance parameters do not match. |
| 3629 SAVINGS_PRODUCT_DOES_NOT_ALLOW_OFFSET_LINKING | A loan account cannot be linked to a deposit account that does not not allow offset linking. Check that the deposit account ID is correct or that the deposit product offers this functionality. |
| 3630 INVALID_SETTLEMENT_ACCOUNT_KEY | When a settlement account key is invalid |
| 3631 INVALID_SETTLEMENT_ACCOUNT_STATE | When a deposit account state is not valid for linking |
| 3632 INVALID_DATA_MIGRATION_EVENT_KEY | When there is no data migration event available for given identifier |
| 3633 ANOTHER_TASK_IN_PROGRESS | When there is another background task in progress |
| 3634 INVALID_DATA_IMPORT_TASK_KEY | When there is no data import task available for given identifier |
| 3640 DEPOSIT_ACCOUNT_LINKED_TO_LOAN_ACCOUNTS_ON_DIFFERENT_BRANCHES | When a deposit account is linked to another loan accounts which are on different branches |
| 3641 SAVINGS_ACCOUNT_LINKED_TO_LOAN_ACCOUNTS_ON_DIFFERENT_BRANCHES | When a savings account is linked to another loan accounts which are on different branches |
| 3642 INVALID_DEPOSIT_ACCOUNT_HOLDER | The linking should be done only between account under same account holder |
| 3643 UNLINKABLE_DEPOSIT_PRODUCT | The deposit product is not accepted by the loan product for linking |
| 3644 INEXISTING_DATE_CALCULATION_METHOD | When no date calculation method was specified |
| 3645 INEXISTING_NON_WORKING_DAYS_METHOD | When no non-working days method was specified |
| 3650 MESSAGE_SENDING_ERROR | When an error occurred while trying to send the background task message to the messaging system |
| 3651 CONNECTION_CLOSING_ERROR | When an error occurred while trying to close the connection with the messaging system |
| 3652 CONSUMER_SERVICE_STARTING_ERROR | Validation error for the case when starting message consumer service and it is already started |
| 3653 CONSUMER_SERVICE_ALREADY_STARTED | When an error occurred while trying to send the background task message to the messaging system |
| 3654 CONSUMER_UNSUBSCRIPTION_FAILED | When an error occurred while trying to un-subscribe from the queue |
| 3655 CONSUMER_SUBSCRIPTION_FAILED | When an error occurred while trying to subscribe the queue |
| 3660 INVALID_SUPPORT_ROLE_ASSOCIATION | The support role cannot be assigned to an admin or teller |
| 3661 INVALID_SUPPORT_ROLE_NAME | The support role name cannot be changed |
| 3662 INVALID_SUPPORT_ROLE_USER_RIGHTS | The user rights for the support role cannot be changed |
| 3663 INVALID_SUPPORT_ROLE_PERMISSIONS | The permissions for the support role must be view only |
3700
| Response Code | Description |
|---|---|
| 3700 LOAN_ACCOUNT_FIELD_NOT_EDITABLE | When a field on loan account cannot be edited |
| 3701 INCOMPATIBLE_ARREARS_TOLERANCE_METHOD_AND_PRODUCT_TYPE | When the chosen product type is incompatible with the chosen arrears tolerance method. |
| 3710 TRANSACTION_CHANNEL_NOT_ALLOWED_WHEN_DISBURSE_TO_DEPOSIT | When trying to disburse a loan account to a deposit account and the transaction channel key/id is provided |
| 3720 INVALID_TARGET_ACCOUNT_STATE_FOR_DEPOSIT | When the target account state doesn't allow deposit |
| 3730 FEE_AMOUNT_ALREADY_DEFINED_IN_PRODUCT | Fee amount cannot be specified because it is already defined on product |
| 3732 MANDATORY_FEE_AMOUNT | The provided fee's amount is mandatory |
| 3740 INVALID_SORTING_SELECTION | When value of sorting selection is not a valid data field or custom field id when searching on the fly |
| 3741 BLACKLISTED_CLIENT_NOT_EDITABLE | When attempting to update a blacklisted client |
| 3742 INVALID_STRING_VALUE | When attempting to update a field with unsupported characters |
| 3743 NOTIFICATION_STATE_IS_REQUIRED | Notification state is required |
| 3744 NOTIFICATION_EVENT_MESSAGE_IS_REQUIRED | Notification event message is required |
| 3750 INSTALLMENT_NUMBER_MANDATORY_FOR_FIXED_ACCOUNTS | Installment number is mandatory for fixed loan accounts |
| 3759 CLIENT_ID_ANONYMIZATION_ERROR | When there was an error while anonymizing client ID |
| 3751 INSTALLMENT_NUMBER_NOT_ALLOWED_FOR_DYNAMIC_ACCOUNTS | Installment number is not allowed for dynamic accounts |
| 3752 INVALID_INSTALLMENT_NUMBER | Installment number is outside constraints |
| 3753 CANNOT_APPLY_FEE_ON_PAID_INSTALLMENT | When attempting to apply a fee on a paid installment |
| 3754 MANDATORY_ACCOUNT_HOLDER_TYPE | The account holder type must be specified |
| 3760 CLIENT_DOES_NOT_HAVE_EXITED_STATE | When trying to anonymize a client which doesn't have EXITED state |
| 3761 UNSUBSCRIBE_CLIENT_FROM_NOTIFICATIONS_ERROR | When there was an error while unsubscribing client from notifications (when deleting client notification requests) |
| 3762 CLIENT_PERSONAL_INFORMATION_ANONYMIZATION_ERROR | When there was an error while anonymizing client personal data |
| 3763 CLIENT_LOAN_ACCOUNTS_ANONYMIZATION_ERROR | When there was an error while anonymizing client loan accounts |
| 3764 CLIENT_SAVINGS_ACCOUNTS_ANONYMIZATION_ERROR | When there was an error while anonymizing client savings accounts |
| 3765 CLIENT_LINES_OF_CREDIT_ANONYMIZATION_ERROR | When there was an error while anonymizing client lines of credit |
| 3766 CLIENT_GUARANTEES_ANONYMIZATION_ERROR | When there was an error while anonymizing client guarantees |
| 3767 CLIENT_NOTIFICATION_MESSAGES_ANONYMIZATION_ERROR | When there was an error while anonymizing client notification messages |
| 3768 CLIENT_ASSOCIATED_TASKS_ANONYMIZATION_ERROR | When there was an error while anonymizing client associated tasks |
| 3780 INVALID_API_KEY | When the api key found in request header is not valid |
| 3781 API_KEY_REFRESH_ERROR | When the api key found in request header is not valid |
| 3782 FILE_NOT_FOUND | When downloading a file that doesn't exist on remote storage |
| 3783 UPLOADED_FILE_NOT_FOUND | When the uploaded file is not found |
| 3784 MISSING_CLIENT_ROLE | When during GET Client Role call, the provided client is not associated with a Client Role. |
| 3790 NOT_ALLOWED_TO_CREATE_REOPEN_ACCOUNTS_ WITH_RECALCULATE_SCHEDULE_KEEP_SAME_TOTAL_REPAYMENT_AMOUNT |
Return code for the case when an user tries to create or reopen an account with Recalculate the Schedule, Keep the Same Total Repayment Amount prepayment recalculation method. |
6000
| Response Code | Description |
|---|---|
| 6000 HYBRID_GROUP_NOT_AVAILABLE_FOR_DBEI_CAPITALIZED_INTEREST | Loans with Declining Balance (Equal Installments) and Capitalized Interest are not available for Hybrid (solidarity) groups, only forIndividuals and forPureGroups. Set the forHybridGroups to false. |
| 6001 HYBRID_GROUP_NOT_AVAILABLE_WHEN_REDRAW_ENABLED | Loan products with a Redraw facility are not available for Hybrid (solidarity) groups. Set the forHybridGroups to false. |
| 6002 PRODUCT_LINKING_NOT_AVAILABLE_WHEN_REDRAW_ENABLED | Product linking is not available when the Redraw facility has been enabled. |
| 6003 FUNDING_SOURCES_NOT_AVAILABLE_WHEN_REDRAW_ENABLED | Loan accounts with a Redraw facility can not be financed by a p2p funding source. |
| 6004 TAXES_NOT_AVAILABLE_WHEN_REDRAW_ENABLED | It is not possible to apply taxes to an account with a redraw facility enabled. Set taxesOnInterestEnabled, taxesOnFeesEnabledand taxesOnPenaltyEnabled to false or remove them from your request. |
| 6005 REDRAW_AND_OFFSET_SETTINGS_ENABLED_SIMULTANEOUSLY | A loan account can only have either the redraw or offset facility enabled, not both. |
| 6006 HYBRID_GROUP_NOT_AVAILABLE_FOR_OFFSET_LOAN | Products with offset enabled are not available for hybrid (solidarity) groups. |
| 6007 INCONSISTENT_OFFSET_SETTINGS_WITH_PRODUCT_TYPE | Offset settings are not available for the specified product type. |
| 6008 INCONSISTENT_OFFSET_SETTINGS_WITH_OFFSET_FEATURE | Offset settings are not available when offset feature is disabled. |
| 6009 PRODUCT_LINKING_IS_MANDATORY_WHEN_OFFSET_ENABLED | Offset settings are enabled and product linking is not defined. |
| 6010 LINKED_DEPOSIT_PRODUCT_DOES_NOT_ALLOW_OFFSET | Linked deposit product doesn’t allow offset. |
| 6011 LINKED_DEPOSIT_PRODUCT_DOES_NOT_EXIST | Linked deposit product doesn’t exist. |
| 6012 FUNDING_SOURCES_NOT_AVAILABLE_WHEN_OFFSET_ENABLED | Funding sources are not supported when offset is enabled |
| 6013 TAXES_NOT_AVAILABLE_WHEN_OFFSET_ENABLED | Taxes are not supported when offset is enabled. |
| 6017 WITHDRAWAL_AMOUNT_GREATER_THAN_DUE_AMOUNT | This error can appear if Withdrawal Redraw Limitation has been enabled for a loan account with Redraw Balance enabled and the account holder attempts to withdraw an amount which will bring their total redraw balance to less than the amount due for the next monthly repayment. |
7000
| Response Code | Description |
|---|---|
7100 PREPAYMENT_RECALCULATION_METHOD_ON_REPAYMENT_NOT_ALLOWED_FOR_LOAN_ACCOUNT |
Loan account does not allow to choose prepayment recalculation method at repayment time, the repayment method is generally set at the product level. |
7217 INSTALLMENTS_ADJUSTMENT_DETAILS_NOT_EXPECTED |
When adjusting a transaction, installments adjustment details are expected only when the transaction type is either Fee Due Reduced or Penalty Due Reduced and product type is Fixed Term. |
7218 INSTALLMENTS_ADJUSTMENT_DETAILS_NOT_EXPECTED_BULK |
Installments adjustment details are not expected when adjustment affects multiple transactions. |
7219 INSTALLMENTS_ADJUSTMENT_DETAILS_MISSING |
When adjusting a transaction, installments adjustment details must be present in request body for Fixed Term loan product type and Fee / Penalty Due Reduced transaction type. |
7220 INSTALLMENT_KEY_NOT_FOUND |
When adjusting a transaction of type Fee / Penalty Due Reduced, for Fixed Term product type and the installment encoded key from input request body is invalid. |
7221 INSTALLMENT_KEY_DUPLICATED |
When adjusting a transaction of type Fee / Penalty Due Reduced, for Fixed Term product type and the installment encoded key appears multiple times in input request body. |
7222 INSTALLMENT_STATE_NOT_ALLOWED |
When adjusting a transaction of type Fee / Penalty Due Reduced, for Fixed Term product type and the installment received in the input request body is not in one of the editable states (PARTIALLY_PAID, LATE, PENDING). |
HTTP Status Codes
Mambu uses standard HTTP status codes; a few of the more frequent ones are described below:
| 200 OK / 201 Created | The request was successful. |
| 400 Bad Request | The request was invalid or could not be understood by the server (wrong syntax). Resubmitting the request will likely result in the same error. |
| 401 Unauthorized | The username and password credentials are missing or invalid for the given request. |
| 402 Payment Required | Your Mambu account is not in good standing. Please pay any outstanding invoices. |
| 403 Forbidden | Either the user is attempting to perform an action without having privileges to access them or the login credentials are correct. |
| 404 Not Found | The resource was not found. This may be returned if the given loan account, savings account. client or group does not exist. The response body will explain which resource was not found. |
| 500 Internal Server Error | The server encountered an error while processing your request and failed. |
| 502 Gateway Error | The load balancer or web server has trouble connecting to the Mambu app. Please try the request again. |
| 503 Service Unavailable | The service is temporarily unavailable. Please try the request again. Possible reason could be too many invalid authentication attempts in a row. |
Was This Article Helpful?
