Skip to content

Latest commit

 

History

History
148 lines (111 loc) · 3.46 KB

README.md

File metadata and controls

148 lines (111 loc) · 3.46 KB
Raw

fake-payment-gateway

Dummy payment gateway for testng purposes. Can pay using card details as well as using the phone number.

fake-payment-gateway, that handle

  • payment via card details
  • payment via phone number
  • each payment send email notification for customer
  • can fetch all card/ phone payment history

Tech

fake-payment-gateway uses:

Installation

  1. download the project.

    git@github.com:ShalithaCell/fake-payment-gateway.git

    or

    https://github.com/ShalithaCell/fake-payment-gateway.git

  2. Goto inside to 'fake-payment-gateway' folder and run the command.

     npm install

  3. Configure email sender

    • create .env file in project root folder. execute following command,

      In windows

      cd > .env

      In Mac/ Linux

       touch .env

    • add following code to the .env file with your email address credentials,

      MAIL_SENDER_IDENTITY="please enter your email address here"
MAIL_SENDER_PASSWORD="please enter your email password here"

    • make sure you should enable, less secure apps in gmail account. * How to enable less secure apps

  4. Run the Project

    npm run start

How to use

  • Before integration the fake-payment gateway, please simulate the api end-points using the postman. You can find the Postman collection inside the doc folder.

You can get all api end-points invoking the following link,

  1. For card payment

    {
    "app_name": "ABC",
    "service": "Electronic Items",
    "customer_email":"shalithax@gmail.com",
    "card_type  ": "VISA",
    "card_holder_name": "Example",
    "card_number": "4242424242424242",
    "expiryMonth": "01",
    "expiryYear": "2020",
    "cvv": "123",
    "amount": "5000.00",
    "currency": "USD"
}

  2. For payment using phone number

    {
    "app_name": "ABC",
    "service": "Electronic Items",
    "customer_email":"shalithax@gmail.com",
    "phone_number  ": "0771940055",
    "phone_holder_name": "shalitha",
    "amount": "5000.00",
    "currency": "USD"
}

  3. Get card payment transaction history

  4. Get phone payment transaction history

Development

Want to contribute? Great!

  • I'm here for your pull-request.

The best way to contribute is by spreading the word about the library:

  • Blog it
  • Comment it
  • Fork it
  • Star it
  • Share it

License

MIT

Free Software, Hell Yeah!