Skip to content

This is a containerized API built with Typescript and Express to illustrate how to integrate payment to an API.

Notifications You must be signed in to change notification settings

frankly034/online-payment-api

Repository files navigation

Online Payment API

With the growth of the internet and innovations over time. It has become evident that payment for goods and services happening over the internet has become a norm.

This is a dockerized API built with Typescript and Express to illustrate how to integrate payment to an API. See playlist

Table of Contents

Basic Payment Flow

Payment systems are built pretty much alike with almost the same flow.

  • Generate a secure payment authorization link.
  • Direct users to the generated link to authorize payment through card or bank payment authorization details.
  • Verify payment using the payment reference from the previous step.
  • Provide value for verified payment.

Features

Postman Documentation

To explore the APIs see documentation Screenshot 2023-04-05 at 23 29 11

Concepts Employed

  • Typescript - interfaces, generics and type definitions
  • Express middlewares and controller
  • Containerization - Docker
  • 3rd party API integration

Built With

  • Express
  • Postgres
  • Sequelize
  • Docker

REQUIRED INSTALLATIONS

  • Node
  • Docker desktop

Installation of This Repository

Once you have installed the requiered packages shown on the Required Installations, proceed with the following steps

Ensure you have docker desktop installed and running

Clone the Repository,

your@pc:~$ git clone https://github.com/frankly034/online-payment-api.git

Move to the downloaded folder

your@pc:~$ cd online-payment-api

Run with docker-compose

your@pc:~$ docker-compose up

Future Improvements

  • Add tests
  • Add data validation
  • Add thank you email to donors

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Acknowledgements

About

This is a containerized API built with Typescript and Express to illustrate how to integrate payment to an API.

Topics

Resources

Stars

Watchers

Forks