To effectively manage errors in i-payout API responses, follow these steps:
- Evaluate HTTP Status Code:
- Success: A status code of
200indicates success. Proceed with response handling. - Error: Any status code not on the
200range signals an error. Refer to the HTTP Status Codes documentation for specifics.
- Success: A status code of
- Inspect the
isSuccessData Field:- If
true, the API call succeeded. Examine the data object for relevant information specific to the API call. - If
false, the API call failed. To understand the reason for the failure, proceed to the following step.
- If
- Analyze Failure Details:
- Status Code: Check the
statusCodefield in the response to identify the nature of the error. Consult the Status Code Values table below for detailed explanations. - Message: The
messagefield provides a human-readable explanation that might hint at the error's cause. - Log Identifier: The
logIdentifierfield contains an identifier useful for debugging. Record this identifier for any necessary communication with i-payout support.
- Status Code: Check the
Note:Make sure to keep track of important details, especially the
logIdentifier, to help quickly solve any problems if you contact our technical support.
Below is the list of the available status codes in the i-payout system:
| STATUS CODE | SHORT DESCRIPTION | LONG DESCRIPTION |
|---|---|---|
| 0 | OK | Successful API call. |
| -1 | Internal Error | An internal error has occurred. Please try again. |
| -2 | User not found | The user is not found. Please check the username value sent. |
| -3 | General Error | A general error has occurred. Please try again. If the issue continues, please contact i-payout. |
| -5 | Account not found | Account not found. Please try different account credentials. |
| -7 | Invalid client credentials | Invalid client credentials. Please validate account credentials. |
| -12 | A user with this username already exists | The username you are trying to create already exists. Please try another unique username. |
| -15 | Insufficient funds | Insufficient funds for this transaction. Please try a lesser amount or load sufficient funds to support this transaction and try again. |
| -26 | Invalid card number | The card number is not valid. Please try a valid card number. |
| -37 | Cannot find Pal by such an email | An account associated with this email address cannot be found. Please verify. |
| -53 | Invalid Merchant | The merchant account is not configured appropriately. |
| -56 | No records found | There are no records found associated. |
| -57 | Pending | The transaction is pending and cannot be acted upon until completion. |
| -58 | Processing | The transaction is being processed and, therefore, cannot be acted upon until completed. |
| -60 | Invalid Country Code | The country code specified is not supported. Please see the Country / Currency Support page. |
| -61 | Access permission is required to use this function | This function requires access permission, which is not associated with the credentials utilized. |
| -62 | Invalid server configuration | The server is not properly configured for this function. |
| -63 | Invalid request response parameter | A request/response parameter is not valid. |
| -64 | Invalid API input parameter, Model Validation Failed | An input parameter cannot be properly parsed. |
| -65 | Parameter required | A required parameter was not sent. |
| -66 | Invalid currency | The currency specified is not supported. Please see the Country / Currency Support page. |
| -67 | Invalid amount | The amount specified is not valid. |
| -68 | Invalid URL | The URL specified is not formatted properly or is not supported. |
| -71 | Missing header parameter | An HTTP Header parameter was not specified and is required. |
| -72 | Invalid parameter | Invalid parameter. |
| -73 | Merchant not found | The merchant account specified was not found. |
| -75 | IP address generation Issue | Unable to generate an IP address to support this function. |
| -75 | Fee value not found for customer | A fee value, which is required, has not been configured for this customer. |
| -76 | Unauthorized api call | This API call is not authorized. |
| -77 | Invalid field value length | A parameter sent has a field length that exceeds the maximum length. |
| -78 | Country not allowed | The country specified is not supported. Please see the Country / Currency Support page. |
| -79 | IP not allowed | The IP address that sent this request is not allowed. |
| -79 | IP blacklisted | The IP address that sent this request is not allowed. |
| -80 | Rate limit exceeded | Too many API calls have been made in a short time, and this request has been automatically declined. |
| -82 | FX conversion rate issue | Unable to complete foreign exchange conversion. |
| -83 | Error in deleting a record | Unable to delete this record. |
| -84 | ReferenceId already exists | This referenceId already exists. Please try a unique referenceId. |
| -84 | Batch already closed | This batch has already been closed and can no longer be utilized. |
| -85 | Cannot create a new batch for e-wallet load | Unable to create a new batch for eWallet Load. Please try again. |
| -86 | User cannot be created | This user cannot be created. |
| -87 | Old and new user mismatch | The usernames must match. Please correct and try again. |
| -88 | File not exists | The file does not exist. |
| -89 | Error parsing private key file | Unable to parse private key file. |
| -90 | Invalid e-wallet registration | The eWallet cannot be registered. |
| -92 | Invoice capabilities disabled | Function attempted without appropriate configuration. |
| -93 | Invalid recurring payment status | Recurring payment was attempted but not allowed on this resource. |
| -94 | Invalid recurring payment status | Recurring payment was attempted but not allowed on this resource. |
| -95 | User not accepted fees | The user has not accepted the fees, so this transaction must be declined. |
| -96 | Credit card processor payment issue | There is an issue processing this credit card transaction. |