How mymi14s/frappe_paystack works
Frappe Paystack adds Paystack collection and payout bookkeeping to Frappe/ERPNext. The main workflow creates a payment log and checkout link, accepts a Paystack charge, then records the capture as a Payment Entry; webhook handling also supports refunds and settlement payouts. Separate branches cover POS, saved cards, subscriptions, customer self-service, reconciliation, and reporting. Edges follow README statements and visible source references; several feature implementations are unsampled, so their internals and unverified links are omitted.
Main entry points: api.py Payment and webhook API · paystack_actions.bundle.js Desk payment actions · payment_request.py Payment Request · paystack_payment_log.py Payment Log and booking
Components 25
Payment collection
- Gateway settings
frappe_paystack/frappe_paystack/doctype/paystack_gateway_setting/paystack_gateway_setting.py - Desk payment actions
frappe_paystack/public/js/paystack_actions.bundle.js - POS payment flow
frappe_paystack/utils/pos_payment.py - Webshop checkout
frappe_paystack/public/js/paystack_cart_guard.bundle.js - Payment Request
frappe_paystack/utils/payment_request.py - Payment Log and booking
frappe_paystack/frappe_paystack/doctype/paystack_payment_log/paystack_payment_log.py - Checkout page
frappe_paystack/public/js/paystack_checkout.js - Checkout route
frappe_paystack/www/paystack-checkout/index.py - Payment and webhook API
frappe_paystack/api.py - Payment QR codes
frappe_paystack/utils/qr.py
Payment operations
- Saved authorizations
frappe_paystack/frappe_paystack/doctype/paystack_customer_authorization/paystack_customer_authorization.py - Refund processing
frappe_paystack/frappe_paystack/doctype/paystack_refund_log/paystack_refund_log.py - Subscription collection
frappe_paystack/utils/subscription.py - Customer payment portal
frappe_paystack/utils/portal.py - Portal route
frappe_paystack/www/my-payments/index.py
Finance and reconciliation
- Payout settlement
frappe_paystack/utils/settlement.py - Payment retry sweep
frappe_paystack/utils/sweep.py - Payment reconciliation
frappe_paystack/utils/reconciliation.py - Reconciliation API
frappe_paystack/utils/reconciliation_api.py - Reconciliation page
frappe_paystack/frappe_paystack/page/paystack_reconciliation/paystack_reconciliation.js
Reports and monitoring
- Activity report
frappe_paystack/frappe_paystack/report/paystack_activity/paystack_activity.py - Payment and settlement reports
frappe_paystack/frappe_paystack/report
Other components
- Customer
- Desk and POS staff
- Paystack
Connections 28
- Desk and POS staff → Desk payment actions: starts payment
README.md - Desk payment actions → Payment Request: requests payment
README.md - Desk payment actions → Payment and webhook API: creates link
frappe_paystack/api.py - Desk payment actions → Payment QR codes: shows QR
README.md - Payment Request → Payment Log and booking: creates log
README.md - POS payment flow → Payment and webhook API: initializes charge
README.md - Webshop checkout → Payment Request: routes checkout
README.md - Payment and webhook API → Payment Log and booking: records capture
frappe_paystack/api.py - Payment and webhook API → Paystack: initializes transaction
frappe_paystack/api.py - Paystack → Payment and webhook API: sends webhook
README.md - Payment and webhook API → Checkout route: sets callback
frappe_paystack/api.py - Customer → Checkout page: pays
README.md - Checkout page → Payment and webhook API: starts checkout
README.md - Checkout route → Checkout page: serves page
frappe_paystack/www/paystack-checkout/index.py - Payment and webhook API → Saved authorizations: stores authorization
frappe_paystack/api.py - Desk payment actions → Saved authorizations: charges saved card
README.md - Payment and webhook API → Refund processing: processes refunds
frappe_paystack/api.py - Payment and webhook API → Payout settlement: handles payout event
frappe_paystack/api.py - Subscription collection → Payment Request: collects invoices
README.md - Customer → Portal route: opens payments
README.md - Portal route → Customer payment portal: loads payment data
frappe_paystack/www/my-payments/index.py - Payment Log and booking → Payment retry sweep: retries capture
frappe_paystack/frappe_paystack/doctype/paystack_payment_log/paystack_payment_log.py - Reconciliation API → Payment reconciliation: runs checks
frappe_paystack/utils/reconciliation_api.py - Reconciliation page → Reconciliation API: requests reconciliation
- Desk and POS staff → Reconciliation page: reviews results
README.md - Desk and POS staff → Activity report: reviews activity
README.md - Desk and POS staff → Payment and settlement reports: runs reports
README.md - Gateway settings → Payment and webhook API: provides settings