ErrorCodes

Overview

This document provides a comprehensive guide to the error codes used in our API. Error codes are short strings that describe specific issues encountered during API requests. They help in diagnosing problems and guiding appropriate resolution steps.

Reviewing Errors

Our system logs every successful and failed API request. To review errors and monitor your integration, use the Developers section of the Dashboard. Each error includes a code with a brief explanation and can be linked to this list for further details.

Error Codes

Below is a list of possible error codes, along with descriptions and recommendations for resolution. Each error code is associated with specific conditions that can occur during interactions with our API.

Error Code Descriptions

ALREADY_MEMBER
Description: The sub-account is already a member of the community.
Resolution: Check the community member's status before attempting to add them again.
AIRTIME_NOT_SUPPORTED
Description: Airtime services are not supported.
Resolution: Verify that airtime services are enabled for your account and supported in the target region.
APPROVAL_REQUIRED
Description: The action requires approval before it can be performed.
Resolution: Follow the approval process outlined in the API documentation.
BANK_ACCOUNT_NOT_FOUND
Description: The specified bank account cannot be found.
Resolution: Ensure that the bank account details are correct and that the account exists in the system.
BANK_LOOKUP_FAILED
Description: A bank lookup operation failed.
Resolution: Verify the bank account details or country code and try the lookup operation again.
BENEFICIARY_ALREADY_EXISTS
Description: A beneficiary already exists in the system.
Resolution: Check if the beneficiary is already listed before creating a new entry.
BENEFICIARY_CREATION_FAILED
Description: Creating a beneficiary failed.
Resolution: Review the request parameters and ensure they comply with system requirements.
BENEFICIARY_UPDATE_FAILED
Description: Updating a beneficiary failed.
Resolution: Verify the update parameters and try the operation again.
CACHE_MISS
Description: Cache retrieval resulted in a miss.
Resolution: Check cache configuration and ensure that the data is being correctly stored and retrieved.
CHIMONEY_NOT_FOUND
Description: The specified chimoney object cannot be found.
Resolution: Ensure that the chimoney object data ( id,chiref) is correct and the data exists in the system.
CONTACT_SUPPORT
Description: The user needs to contact support for further assistance.
Resolution: Reach out to our support team for help with this issue.
CURRENCY_NOT_FOUND
Description: The specified currency cannot be found.
Resolution: Verify that the currency code is correct and supported by the system.
DELETION_NOT_ALLOWED
Description: Deletion of the resource is not allowed.
Resolution: Confirm if the resource can be deleted or if it requires special permissions.
DUPLICATE_ENTRY
Description: A particular data entry already exists.
Resolution: Check for existing entries and avoid creating duplicates.
EXCHANGE_RATE_FETCH_FAILED
Description: Fetching the exchange rate failed.
Resolution: Ensure that the exchange rate service is operational and retry the fetch request.
GENERIC_ERROR
Description: A generic, unspecified error occurred.
Resolution: Review the error message and try to identify the cause based on context.
INSUFFICIENT_FUNDS
Description: The wallet does not have enough funds to complete the transaction.
Resolution: Ensure sufficient funds are available before attempting the transaction.
INTERNAL_SERVER_ERROR
Description: An unexpected server-side issue occurred.
Resolution: Retry the request later and contact support if the issue persists.
INVALID_AMOUNT
Description: The amount specified in the transaction is invalid.
Resolution: Check the transaction amount and ensure it is within the allowed range.
INVALID_CHIMONEY
Description: The specifiedchimoney object is invalid.
Resolution: Verify the chimoney id or chiref and ensure it is correctly formatted.
INVALID_COUNTRY
Description: The specified country is invalid.
Resolution: Verify that the country code is correct and supported.
INVALID_CURRENCY
Description: The specified currency is invalid.
Resolution: Ensure that the currency code is correct and supported.
INVALID_EMAIL
Description: The specified email address is invalid.
Resolution: Check the email format and ensure it complies with standard email formats.
INVALID_MOMOCODE
Description: The specified mobile money code is invalid.
Resolution: Verify the mobile money code and ensure it is valid and supported.
INVALID_PHONE_NUMBER
Description: The specified phone number is invalid.
Resolution: Verify the phone number format and ensure it is correct.
INVALID_REQUEST
Description: The request is invalid.
Resolution: Review the request parameters and ensure they comply with the API requirements.
INVALID_SIGNATURE
Description: The request signature is invalid.
Resolution: Verify the signature and ensure it matches the one generated for the request.
INVALID_STATUS
Description: The specified status is invalid.
Resolution: Ensure that the status value is valid and supported.
LIMIT_EXCEEDED
Description: The maximum cash out amount or transaction limit has been exceeded.
Resolution: Check the limits and reduce the transaction amount or frequency.
MIN_AMOUNT_NOT_MET
Description: The minimum transaction amount has not been met.
Resolution: Verify the transaction amount and ensure it meets the minimum requirement.
MISSING_FIELD
Description: A required field is missing.
Resolution: Ensure all required fields are included in the request.
NO_TRANSACTION
Description: No transaction found.
Resolution: Ensure the transaction ID is correct and exists in the system.
NOT_DEBITED
Description: The transaction has not been debited.
Resolution: Verify the transaction status and try the operation again.
NOT_MEMBER
Description: The user is not a member of the required group or service.
Resolution: Check the user’s membership status and ensure they meet the requirements.
PAYMENT_FAILED
Description: A payment operation failed.
Resolution: Review the payment details and retry the operation.
PAYOUT_FAILED
Description: The payout operation failed.
Resolution: Verify payout details and retry. Contact support if the issue persists.
PERMISSION_DENIED
Description: Permission is denied for the operation.
Resolution: Verify user permissions and ensure they have the necessary access.
PROFILE_NOT_FOUND
Description: The specified profile cannot be found.
Resolution: Check the profile ID and ensure it exists.
QUOTE_EXPIRED
Description: The quote provided has expired.
Resolution: Generate a new quote and retry the operation.
QUOTE_GENERATION_FAILED
Description: Quote generation failed.
Resolution: Verify the request parameters and try to generate the quote again.
REDEEMED_TRANSACTION
Description: The transaction has already been redeemed.
Resolution: Check the transaction status and avoid re-redeeming.
REDEMPTION_FAILED
Description: Transaction redemption failed.
Resolution: Review the redemption request and ensure it meets all requirements.
REFUND_FAILED
Description: Refund operation failed.
Resolution: Verify refund details and ensure compliance with system requirements.
SIMULATION_FAILED
Description: Simulation of an operation failed.
Resolution: Verify the simulation parameters and try again.
SUBACCOUNT_NOT_FOUND
Description: The specified subaccount cannot be found.
Resolution: Ensure the subaccount ID is correct and exists.
TRANSACTION_ERROR
Description: A general transaction error occurred.
Resolution: Review transaction details and ensure they comply with system requirements.
TRANSACTION_NOT_FOUND
Description: The specified transaction cannot be found.
Resolution: Check the transaction ID and ensure it is correct.
TRANSACTION_STATUS_ERROR
Description: There is an error with the transaction status.
Resolution: Verify the transaction status and try to resolve the issue.
TRANSACTION_VERIFICATION_FAILED
Description: Transaction verification failed.
Resolution: Verify the transaction details and retry the operation.
UNPAID_TRANSACTION
Description: The transaction is unpaid.
Resolution: Check the payment status and ensure it is processed.
UNSUPPORTED_CURRENCY
Description: The specified currency is not supported.
Resolution: Use a supported currency and verify the currency code.
USER_NOT_FOUND
Description: The specified user cannot be found.
Resolution: Verify the user ID and ensure it exists in the system.
VOUCHER_ALREADY_USED
Description: The voucher has already been used.
Resolution: Check the voucher status and avoid using it again.
VOUCHER_INVALID
Description: The voucher is invalid.
Resolution: Verify the voucher details and ensure it is valid.
WALLET_NOT_FOUND
Description: No wallet found.
Resolution: Verify the wallet ID and ensure it exists.