[FEAT]: Super Admin - Get All Payments with Pagination

[onielsteve2003]

Description:

Implement an API endpoint for retrieving all payments. This endpoint allows authenticated super admin users to fetch all payments with pagination support.

Endpoint Feature:

1. This endpoint enables authenticated super admin users to fetch all payments.
2. Supports pagination to manage the number of payments returned per request.

Acceptance Criteria:

• [ ] The endpoint should be accessible at GET /api/v1/payments.
• [ ] The endpoint should accept HTTP GET requests.
• [ ] The endpoint should return a paginated list of payments with their details.
• [ ] The endpoint should return a 200 OK status code with the payment details in the response body.

Request Example:

GET /api/v1/payments?page=1&limit=10 Content-Type: application/json

Response Example:

{
  "status": "success",
  "status_code": 200,
  "data": [
    {
      "payment_id": "1",
      "amount": 100.00,
      "user_id": "666434838cc76672",
      "date": "2024-07-21T12:34:56Z"
    },
    {
      "payment_id": "2",
      "amount": 200.00,
      "user_id": "666434838cc76672",
      "date": "2024-07-20T11:33:55Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_pages": 5,
    "total_items": 50
  }
}

Data Validation:

Input Validation:

• Confirm that page, limit, and offset are provided and valid.
• If page or limit is not provided, use default values (e.g., page=1 and limit=10).

Output Validation:

• Ensure the response format is correct and includes appropriate status codes and messages.
• If there is an error in retrieving the payments (e.g., database connection issues), the API should return a 500 Internal Server Error status code with an appropriate message:

{
  "status": "unsuccessful",
  "status_code": 500,
  "message": "Failed to retrieve payments. Please try again later."
}

Authentication and Authorization:

Authentication:

• Verify that the user is authenticated before allowing access to the endpoint.
• Example: Use middleware to check for a valid authentication token.

Authorization:

• Ensure that only super admin users can access the payments.
• Example: Check user roles or permissions to confirm authorization.

Error Handling:

Error Responses:

• Define error responses for common failure scenarios.
• Example: If the database connection fails, return a 500 status code with an error message.

{
  "status": "unsuccessful",
  "status_code": 500,
  "message": "Failed to retrieve payments. Please try again later."
}

Edge Cases:

• Consider edge cases such as no payments available.
• Example: Handle scenarios where no payments exist and return a 404 Not Found status code with an appropriate message.

{
  "status": "unsuccessful",
  "status_code": 404,
  "message": "No payments found."
}

Test Requirements:

Unit Tests:

• Write unit tests to validate the logic for retrieving all payments.

Integration Tests:

• Ensure end-to-end functionality is tested with integration tests.

[AdeGneus]

Good issue. Not setting the pagination parameters shouldn't be an error technically, unless you want pagination to always be strictly handled at the backend always

[onielsteve2003]

Okay no problem, Noted that down