bench get-app https://github.com/garyfrancodev/mdx_pay_connector

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=garyfrancodev%2Fmdx_pay_connector)](https://frappegems.com/gems/apps/garyfrancodev/mdx_pay_connector)

MDX Pay Connector

Frappe app that integrates any Frappe or ERPNext site with mdx_pay payment orchestration.

What it does

Install this app on any Frappe-based system and configure it to accept payments via mdx_pay. It works with any DocType — Sales Invoice, Sales Order, custom DocTypes, etc.

The key concepts are:

• MDX Pay Profile: company/merchant connection, encrypted API key and accounting defaults.
• MDX Pay Rule: maps one DocType payment flow to a profile and payment parameters.

Installation

# Get the app
bench get-app mdx_pay_connector

# Install on your site
bench --site your-site.local install-app mdx_pay_connector

Quick Start

1. Create a Profile

Open /app/mdx-pay-setup, add a profile and enter:

• Frappe/ERPNext company
• API URL (your mdx_pay instance)
• API Secret Key (from mdx_pay backoffice)
• Webhook Secret (for signature verification)
• Default provider
• Mode of Payment and bank account

One site can contain several profiles when it operates multiple companies or merchants.

2. Create a Payment Rule

Go to MDX Pay Rule → New:

Field	Example
Source DocType	Sales Invoice
MDX Pay Profile	My Company Test
Amount Field	outstanding_amount
Currency Field	currency
Description Template	Pago {{ doc.name }} - {{ doc.customer_name }}
External Reference	name
Payment Method	qr
Provider	banco_economico
Button Label	Cobrar QR
Show Condition	{{ doc.outstanding_amount > 0 }}

3. Use It

Open any submitted Sales Invoice with outstanding balance → click "Cobrar QR" → QR appears → customer scans → payment confirmed automatically.

Architecture

Your Frappe/ERPNext Site
├── MDX Pay Profile      → Company/merchant connection and accounting
├── MDX Pay Rule         → DocType-to-profile payment mapping
├── MDX Pay Payment      → Payment log per document
└── MDX Pay Webhook Log  → Inbound event audit trail
         │
         │ HTTP API (Bearer mdx_sk_...)
         ▼
    mdx_pay (FastAPI)

MDX Pay Settings remains available for global security options and backwards compatibility.

On-Event Actions

Configure automatic actions when payments complete:

• update_field: Set a field value (e.g., custom_payment_status → Paid)
• run_method: Call a server method
• changeworkflowstate: Transition document workflow state

Webhook Setup

Configure this URL as the webhook endpoint in your mdx_pay backoffice:

POST https://your-site.com/api/method/mdx_pay_connector.api.receive_webhook

License

MIT