Responses
Status Codes
| Error Code | Message | Description | Error Handling |
|---|---|---|---|
| 200 | OK response |
| Kindly refer to the Error Response Codes table and address the issue accordingly. |
| <error code> <message> | GraphQL request is invalid. | Please refer to the error codes below. | |
| 400 | Access to this resource is forbidden | Invalid FI ID or token. | Please review, regenerate token properly and pass in the correct FI ID. |
| X-Fiid is required | Missing FI ID. | Please review and pass in the correct FI ID. | |
| Timestamp is required | Missing timestamp. | Please review and pass in the correct timestamp. | |
| Signature is required | Missing signature. | Please review and pass in the correct signature. | |
| Timestamp not within valid range | Outdated or invalid timestamp. | Please review and pass in the correct timestamp. | |
| Invalid signature | Signature is invalid. | Please review and regenerate signature properly. | |
| 500 | Internal server error | PayNet internal server error. | Please contact PayNet for troubleshooting. |
Status List for I01 (Itemised) File Request
| Status | Description |
|---|---|
| new | File request received by PayNet |
| processing | File is being generated by PayNet |
| ready | File is ready to download |
| error | File request rejected *refer to the error response codes below |
Error Response Codes
| Error Code | Message | Description | Error Handling |
|---|---|---|---|
| E0001 | The query exceeds the retention period | The data retention on reports is 90 days. Getting data more than 90 days is not supported in the API. | Please limit your data request to no more than 90 days. If you require data beyond this period, kindly contact PayNet for assistance. |
| E0002 | S01, S02, D01, I01: The given date is in the future M01: The given month is in the future | Getting future date is not allowed. Example: today is 2025-02-15, trying to query data in 2025-02-16 is not allowed. | Please attempt the request again after the data becomes available. The data availability schedule is provided here for your reference. |
| E0003 | Data is not ready | Report data is not ready:
| Please continue to poll the data. If the data is still not ready for an hour, kindly contact PayNet for troubleshooting. |
| E0004 | The given value for $param is invalid: $value | Invalid or unsupported parameter value | Please review the pass-in parameters in the API. You can refer to the list of available fields here: MyDebit Specifications RPP Specifications |
| E0005 | Invalid date: $value, format should be yyyy-MM-dd with leading zero | The expected date format is yyyy-MM-dd, example: 2025-02-02 (with leading zero). | Please provide the date in the correct format. |
| E0006 | $field is required | Required parameter is not given in the query, example date is required when querying a daily report. | Please review the pass-in parameters in the API. You can refer to the list of available fields here: MyDebit Specifications RPP Specifications |
| E0007 | Invalid month format: $value, format should be yyyy-MM | The expected month format is yyyy-MM (for monthly report). | Please provide the month in the correct format. |
| E0010 | Duplicate field or alias is not allowed: %s | Duplicate fields detected. | Kindly remove the duplicate fields from the API. |
| E0011 | The query exceeds the month retention period | The data retention on monthly reports is 3 months. | Please limit your data request to no more than 3 months. If you require data beyond this period, kindly contact PayNet for assistance. |
| E0012 | Unprocessable entity | Unspecified content type / syntax error. | Please review the request format or structure, especially the GraphQL query. API explorer may be used for troubleshooting. |
| E0014 | Rate limit exceeded | The number of allowed requests has been exceeded within the defined time window. This typically occurs when the client sends too many requests in a short period. | Please attempt the request again after 1 minute. |
| E9999 | Internal server error | Internal server error in PayNet. | Please contact PayNet for troubleshooting. |
info
Should you experience other issues not included above, please get in touch with PayNet.