API service that authenticates users and provide airtime payments using XpressPay API. Please note that this api runs on port 8080 with baseurl{http://localhost:8080}

This repository contains the implementation of an API service for a payment company. The primary functionalities include user authentication using JSON Web Tokens (JWT) and facilitating airtime payments through the Virtual Top-Up (VTU) API. This API service has swagger-ui implementation which can be accessed at /swagger-ui/index.html#/

Before running the application, ensure that you fill in the required information in the application.properties file and also in the maven-surefire-plugin configuration.environmentVariables in the plugins section of the pom.xml file when testing. Below are the necessary configurations.

spring.datasource.url=your_database_url spring.datasource.username=your_database_username spring.datasource.password=your_database_password

jwt.secret=your_secret_key jwt.expiration-time=3600000 # Set your preferred expiration time in milliseconds

xpress.public.key=your_public_key xpress.private.key=your_private_key

The authentication API is implemented using JWT for secure and efficient user authentication. It ensures that only authorized users can access the payment services.

• /api/v1/auth/signup - Allows users to create an account.
• /api/v1/auth/login - Validates user credentials and issues a JWT upon successful authentication.

To create an account, make a POST request to /api/v1/auth/signup with the required user information.

{
  "firstname": "string",
  "lastname": "string",
  "email": "string",
  "phoneNo": "string",
  "password": "string"
}

For authentication, send a POST request to /api/v1/auth/login with the user's credentials. The response will include a JWT token, which should be included in the headers of subsequent requests for authorization.

{
  "email": "string",
  "password": "string"
}

The airtime payment functionality is achieved by consuming the BILLER SERVICES API BY XPRESS PAYMENTS. Before using this feature, users are required to create an account on the Biller Service Test environment portal. Please refer to the documentation for the necessary information.

• /api/v1/topup - Initiates an airtime payment transaction.

To make an airtime payment, send a POST request to /api/v1/topup, pass destination phone number and amount in requesst body and pass the airtime type in the query parameters. Ensure that you include the JWT token obtained during authentication in the request headers for authorization.

{
  "phoneNumber": "08033333333",
  "amount": 100
}

NOTE: These are the applicable test parameters for each Operator as provided in test details documentation MTN 08033333333 GLO 08055555555 9Mobile 09099999999 Airtel 08022222222

Unit tests have been implemented to ensure the reliability of the codebase. The tests cover at least 50% of the code to verify the correctness of the authentication and airtime payment functionalities.

Execute the following command to run the unit tests:

mvn compile test