Flutter ePayco Payments
Python Flask - ePayco REST API
To use this Flutter plugin, you must run the Flask REST API.
This repository contains the code and configuration files to run the ePayco Payments REST API using Docker.
Prerequisites
Before getting started, make sure you have the following prerequisites:
- Docker installed on your operating system.
- Your ePayco API Key and Private Key. Make sure to have them handy.
Setup Instructions
Follow these steps to set up and run the ePayco Payments REST API with Docker:
- Open the
.env
file and add the following lines, replacingYOUR_API_KEY
andYOUR_PRIVATE_KEY
with your actual ePayco API Key and Private Key.
EPAYCO_API_KEY=YOUR_API_KEY
EPAYCO_PRIVATE_KEY=YOUR_PRIVATE_KEY
-
Save the
.env
file. -
Open a terminal or command prompt and navigate to the root directory of your project.
-
Run the following command to start the Docker container:
$ docker-compose up --build -d
This command will build the Docker image and start the container in detached mode.
Wait for the container to start up. Once it's running, you can access the API.
Open your web browser and navigate to http://127.0.0.1:1616/ or the domain where it was deployed.
This will open the ePayco Payments REST API in your browser.
You can now use the API endpoints to create, retrieve, update, and delete payments using the provided documentation.
Additional Notes If you deployed the Docker container to a different domain, replace 127.0.0.1:1616 in step 7 with the appropriate URL.
Ensure that your API Key and Private Key in the .env file are correct and properly formatted.
Remember to keep your API Key and Private Key secure and avoid sharing them publicly.
POSTMAN API Documentation
For detailed information on the available endpoints and how to use them, refer to the ePayco Payments REST API Documentation.
https://documenter.getpostman.com/view/18896773/2s93shzpLb#intro
About
Developed by: Paul Realpe
Email: paulmrg461@gmail.com
Phone: 3148580454
Libraries
- core/exceptions/api_exception
- core/helpers/http_adapter
- core/utils/constants/epayco_constants
- core/validators/input_validators
- domain/datasources/datasources
- domain/datasources/epayco/cash_payment_datasource
- domain/datasources/epayco/credit_card_payment_datasource
- domain/datasources/epayco/pay_subscription_datasource
- domain/datasources/epayco/pse_payment_datasource
- domain/entities/epayco/bank_list_response
- domain/entities/epayco/card_request
- domain/entities/epayco/cash_methods_response
- domain/entities/epayco/cash_payment_request
- domain/entities/epayco/cash_payment_response
- domain/entities/epayco/credit_card_payment_request
- domain/entities/epayco/credit_card_payment_response
- domain/entities/epayco/pay_subscription_response
- domain/entities/epayco/pse_payment_request
- domain/entities/epayco/pse_payment_response
- domain/entities/epayco/subscription_request
- domain/entities/organization_entity
- domain/entities/plan_entity
- domain/entities/subscription_entity
- domain/entities/transaction_entity
- domain/entities/user_entity
- domain/repositories/epayco/cash_payment_repository
- domain/repositories/epayco/credit_card_payment_respository
- domain/repositories/epayco/pay_subscription_respository
- domain/repositories/epayco/pse_payment_respository
- domain/repositories/repositories
- flutter_epayco_payments
- infrastructure/datasources/datasources
- infrastructure/datasources/epayco/cash_payment_datasource_impl
- infrastructure/datasources/epayco/credit_card_payment_datasource_impl
- infrastructure/datasources/epayco/pay_subscription_datasource_impl
- infrastructure/datasources/epayco/pse_payment_datasource_impl
- infrastructure/repositories/epayco/cash_payment_repository_impl
- infrastructure/repositories/epayco/credit_card_payment_repository_impl
- infrastructure/repositories/epayco/pay_subscription_repository_impl
- infrastructure/repositories/epayco/pse_payment_repository_impl
- infrastructure/repositories/repositories
- infrastructure/use_cases/epayco/epayco_service