Error Codes (Disbursement API)

All Disbursement API errors returned are either HTTP status code 400 or 500, and will have an Error JSON string field in the response.

{
    "Error": "Transaction Failed - Not Authorised"
}

Disbursement and Transaction Errors

Error Message	Explanation
Insufficient Funds	The paying wallet has insufficient funds to complete the transaction.
Voucher Already Spent	The transaction failed because the specified voucher has already been redeemed.
Not Authorised	The actor is not authorized to perform this action in this community.
Mismatched Disbursement Totals	The disbursement failed because the sum of successfully processed records or fees does not equal the expected total amount.
Wallet Payment Failed	A general error occurred while attempting to process a payment from the specified wallet.
Voucher Payment Failed	A general error occurred while attempting to process a payment from the specified voucher.
Voucher is Not a Cash Voucher	The specified voucher is not a cash voucher and cannot be used for this type of transaction.

State and Lifecycle Errors

Error Message	Explanation
Disbursement Already Processed	The disbursement cannot be run more than once and has already been processed.
Disbursement Already Confirmed	The disbursement cannot be confirmed because it has already been confirmed. The error will specify the confirmation timestamp.
Disbursement Not Yet Released	The action cannot be performed because the disbursement has not been released yet.
Disbursement Already Refunded	A refund cannot be processed for this disbursement because it has already been reversed.
Invalid Date/Time Format	A timestamp provided in the request is invalid. The expected format is YYYY/MM/DD HH:MM.
Invalid Disbursement UUID	The DisbursementID provided is not a valid Version 4 UUID.
Invalid State for Confirmation	The disbursement cannot be confirmed because it is not in a valid state. It must be ‘Awaiting Confirmation’.
Invalid Voucher Number	The VoucherNo provided is invalid.
Refund Processing Error	A general error occurred while attempting to process a refund for the disbursement or a specific transaction.

Input Data and Validation Errors

Error Message	Explanation
Invalid Voucher Data in File	All or some vouchers listed in the provided CSV are invalid. A corresponding errors.csv file will contain more detailed information per voucher line.
Invalid Amount	The amount specified for a transaction is invalid or is not greater than zero.
Invalid CSV Record Format	A record in the CSV file has fewer than the four required fields.
Invalid MSISDN	The recipient’s MSISDN is invalid. This may be due to invalid characters (only digits are allowed), an unsupported country code, or an incorrect length for the specified country.
Invalid ID Number	The recipient’s ID number is invalid.
MSISDN Does Not Match ID Number	The provided MSISDN and ID number do not belong to the same user.
Voucher Type or Package Does Not Exist	The specified VoucherType or VoucherPackage is invalid or does not exist.
Recipient Does Not Have Wallet	The recipient cannot receive the disbursement voucher, because they do not have an associated wallet.
Recipient User Does Not Exist	The specified recipient user does not exist in the system.
User Cannot Be Virally Created	The specified user cannot be created virally within this community.
Recipient Blocked or Closed	The transaction failed because the recipient’s account is either blocked or closed and cannot receive funds.
Viral User Voucher Limit	The transaction failed because the recipient is a viral user who is only permitted to receive one voucher.
Query Returned No Results	A query to retrieve data returned zero results. This may indicate a filter is being applied to an invalid field.
Query Too Complex	A query to retrieve data used a sort or filter that was too complex. See Sort and Filter Rules.

System-Level Errors

Error Message	Explanation
No Valid Routes for Voucher	The transaction failed because there are no valid payment routes defined for the specified voucher.
Failed to Retrieve Voucher Routes	The system encountered an error while attempting to retrieve routing information for the voucher.
Invalid Request	A required field, such as VoucherNo or OAuthToken, was not specified in the request.
Invalid or Expired Authentication Token	The provided OAuth or Bearer token is invalid, expired, or not yet active.
System Entity Does Not Exist	A specified entity (e.g., a community or user) could not be found.
File Not Found	The system could not find the required vouchers.csv file at the expected location.
Internal System Error	An internal error occurred, such as a database read failure, schema mismatch, or issue allocating resources.