README.md

Payment Integration Utils

This app provides core utilities to build bank integrations in ERPNext. It includes common roles, workflows, custom fields, and other helpers. Use it as a base for secure online payment handling with minimal setup.

✨ Features

• Common Payment Authorization Roles: Predefined roles for secure payment handling.
• Payment Authentication: Built-in support for two-factor authentication (2FA).
• Reusable Workflows: Ready-to-use workflows for bank payments.
• Custom Fields: Flexible fields to support various integration needs.
• Utilities: Tools to streamline online payment processes.
• Bulk Payments Action: Efficiently handle bulk payments.

Note: Currently only INR (Indian Rupee 🇮🇳) currency payments are supported.

📦 Installation

Prerequisites

• ERPNext Version-15 or above.

Installation Methods

☁️ Frappe Cloud

1. Sign up for a Frappe Cloud free trial.
2. Create a new site with Frappe Version-15 or above.
3. Install ERPNext and Payment Integration Utils from the Apps Marketplace.

🐳 Docker

Use this guide to deploy Payment Integration Utils by building your custom image.

Sample Apps JSON:

export APPS_JSON='[
  {
    "url": "https://github.com/frappe/erpnext",
    "branch": "version-15"
  },
  {
    "url": "https://github.com/resilient-tech/payment_integration_utils",
    "branch": "version-15"
  }
]'

export APPS_JSON_BASE64=$(echo ${APPS_JSON} | base64 -w 0)

⌨️ Manual

1. Set up a Frappe site using this guide.
2. Install the app using Bench CLI:

bench get-app https://github.com/resilient-tech/payment_integration_utils.git --branch version-15

• Install the app on your site:

bench --site SITE_NAME install-app payment_integration_utils

🛠️ Usage

Extend or override existing payment logic to suit your bank’s requirements.

For an example implementation, see RazorpayX Integration.

📚 Documentation

Read the full documentation here.

🤝 Contributing

• Issue Guidelines
• Pull Request Requirements

📜 License

GNU General Public License (v3)