www.payment-service-api.azapay.ng Open in urlscan Pro
193.203.164.161  Public Scan

Form analysis
0 forms found in the DOM

Text Content

 * Introduction
 * Routes
 * Deployment


PAYMENT SERVICE


WHAT IS THE PAYMENT SERVICE?

Payment service is a system that receive and manages transfer transactions. It
depend on the auth and business services respectively as a core dependency. Both
services serves as means of authentication and authorization.


ROUTES


BANKS

GET("/banks") or POST("/banks")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							


CUSTOMERS

GET("/customers") or POST("/customers")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"filter":"boolean | required"
	"more":"boolean | required"
	"pageNumber": 1, // required
	"batchNumber": 10, // required
	"sort": "required", // ASC | DESC
	"orderBy" :"required", // go to GET("/allowed-query/fields/customers") to see accepted fields
	"groups": [{
		"filterGroupCondition":"required" // AND | OR
		"filterSearchCondition":"required" // AND | OR
		"filters": [{
			"filterOption": "eq",
			"field": "", // go to GET("/allowed-query/fields/customers") to see accepted fields
			"value": "user input",
			"dataType": "string" // string | number | bool | date | dateTime
		}]
	}]
}
								
							

GET("/customers/details/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

POST("/customers/create")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"businessId": "required",
	"bankId": "required",
	"transactionReference": "required",
	"amount": "number | required",
	"duration": "number | required",
	"firstName": "required",
	"lastName": "required",
	"email": "required",
	"phoneNumber": "",
	"address": ""
	"refundBankId": "required"
	"refundBankAccountNumber": "required"
}
								
							

PUT("/customers/update/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"firstName": "",
	"lastName": "",
	"email": "",
	"phoneNumber": "",
	"address": ""
}
								
							

DELETE("/customers/delete/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							


CUSTOMER ACCOUNTS

GET("/customer-accounts") or POST("/customer-accounts")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"filter":"boolean | required"
	"more":"boolean | required"
	"pageNumber": 1, // required
	"batchNumber": 10, // required
	"sort": "required", // ASC | DESC
	"orderBy" :"required", // go to GET("/allowed-query/fields/customer-accounts") to see accepted fields
	"groups": [{
		"filterGroupCondition":"required" // AND | OR
		"filterSearchCondition":"required" // AND | OR
		"filters": [{
			"filterOption": "eq",
			"field": "", // go to GET("/allowed-query/fields/customer-accounts") to see accepted fields
			"value": "user input",
			"dataType": "string" // string | number | bool | date | dateTime
		}]
	}]
}
								
							

GET("/customer-accounts/details/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

PUT("/customer-accounts/update/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"RefundBankId": "",
	"RefundBankAccountNumber": ""
}
								
							

DELETE("/customer-accounts/delete/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							


PAYMENT LINKS

GET("/payment-links") or POST("/payment-links")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"filter":"boolean | required"
	"more":"boolean | required"
	"pageNumber": 1, // required
	"batchNumber": 10, // required
	"sort": "required", // ASC | DESC
	"orderBy" :"required", // go to GET("/allowed-query/fields/payment-links") to see accepted fields
	"groups": [{
		"filterGroupCondition":"required" // AND | OR
		"filterSearchCondition":"required" // AND | OR
		"filters": [{
			"filterOption": "eq",
			"field": "", // go to GET("/allowed-query/fields/payment-links") to see accepted fields
			"value": "user input",
			"dataType": "string" // string | number | bool | date | dateTime
		}]
	}]
}
								
							

GET("/payment-links/details/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

POST("/payment-links/create")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"businessId": "required",
	"bankId": "required",
	"amount": "number | required",
	"duration": "number | required",
	"firstName": "required",
	"lastName": "required",
	"email": "required",
	"phoneNumber": "",
	"address": ""
}
								
							

PUT("/payment-links/update/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"refundBankId": "required"
	"refundBankAccountNumber": "required"
}
								
							

DELETE("/payment-links/delete/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							


STELLA VA

GET("/stella-va") or POST("/stella-va")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"filter":"boolean | required"
	"more":"boolean | required"
	"pageNumber": 1, // required
	"batchNumber": 10, // required
	"sort": "required", // ASC | DESC
	"orderBy" :"required", // go to GET("/allowed-query/fields/stella-va") to see accepted fields
	"groups": [{
		"filterGroupCondition":"required" // AND | OR
		"filterSearchCondition":"required" // AND | OR
		"filters": [{
			"filterOption": "eq",
			"field": "", // go to GET("/allowed-query/fields/stella-va") to see accepted fields
			"value": "user input",
			"dataType": "string" // string | number | bool | date | dateTime
		}]
	}]
}
								
							

GET("/stella-va/details/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

GET("/stella-va/create")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"businessId": "required",
	"bankId": "required",
	"firstName": "required",
	"lastName": "required"
}
								
							

GET("/stella-va/create-timed-account")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"businessId": "required",
	"bankId": "required",
	"firstName": "required",
	"lastName": "required",
	"amount": "required",
	"duration": "required",
	"refundBankId": "required",
	"refundBankAccountNumber": "required"
}
								
							


PAYMENT TRANSACTIONS

GET("/payment-transactions") or POST("/payment-transactions")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"filter":"boolean | required"
	"more":"boolean | required"
	"pageNumber": 1, // required
	"batchNumber": 10, // required
	"sort": "required", // ASC | DESC
	"orderBy" :"required", // go to GET("/allowed-query/fields/payment-transactions") to see accepted fields
	"groups": [{
		"filterGroupCondition":"required" // AND | OR
		"filterSearchCondition":"required" // AND | OR
		"filters": [{
			"filterOption": "eq",
			"field": "", // go to GET("/allowed-query/fields/payment-transactions") to see accepted fields
			"value": "user input",
			"dataType": "string" // string | number | bool | date | dateTime
		}]
	}]
}
								
							

GET("/payment-transactions/details/:id")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

GET("/payment-transactions/create")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							

REQUEST BODY

								
{
	"businessId": "required",
	"customersId": "",
	"status": "required",
	"amount": "required",
	"narration": "required",
	"senderAccountNumber": "required",
	"senderAccountName": "required",
	"receiverAccountNumber": "required",
	"receiverAccountName": "required"
}
								
							


STATS

GET("/stats/dashboard/:businessId")

REQUEST HEADER

								
{
	 "x-auth-token": "required" or "x-api-token": "required"
}
								
							


DEPLOYMENT


DOCKER

Docker is a set of platform as a service products that use OS-level
virtualization to deliver software in packages called containers. The service
has both free and premium tiers. The software that hosts the containers is
called Docker Engine.


VPS

VPS can stand for virtual private server, which is a type of hosting service
that uses virtualization technology. VPSs are virtual machines that run their
own operating system and have their own dedicated resources, including CPU, RAM,
storage, and bandwidth.


NGINX

Nginx is a web server that can also be used as a reverse proxy, load balancer,
mail proxy and HTTP cache.


DOCKERFILE

A Dockerfile is a that contains instructions for building a Docker image. Docker
images are used to create Docker containers, which are isolated, lightweight,
and portable execution environments. Dockerfiles are made up of a series of
commands, each of which tells Docker how to build the image. The commands are
executed in order, and each one builds upon the previous one.


DOCKER COMPOSE FILE

A Docker Compose file is a file that defines and runs multi-container Docker
applications. With Compose, you can create a YAML file to define the services
and networks for your application. Then, with a single command, you can create
and start all the services from your configuration. To create a Docker Compose
file, you need to define the services that make up your application. Each
service is defined by a YAML block that specifies the image, ports, volumes, and
other configuration options for the container.


CI/CD PIPLINE

The .gitlab-ci.yml file is a YAML file that defines project configuration in
GitLab CI. It is placed at the root of the repository. The .gitlab-ci.yml file
defines:

 * Scripts that should run during the CI/CD pipeline
 * Scheduling
 * Additional configuration files and templates
 * Dependencies
 * Caches
 * Commands GitLab should run sequentially or in parallel
 * Instructions on where the application should be deployed to