User Manual: Payment Request - ERPNext
1. Overview
The Payment Request feature in ERPNext facilitates structured and controlled initiation of payments against sales and purchase documents. It supports both inward (customer) and outward (supplier) payment requests and integrates with payment gateways, enabling online transactions.
2. Key Features
- Supports both Inward (customer) and Outward (supplier) requests.
- Auto-fetches relevant bank and party details.
- Integration with payment gateways (Stripe, Razorpay, etc.).
- Auto-creation of Payment Entry.
- Subscription support with multiple plan allocations.
- Email/SMS-based payment notifications.
- Option to trigger payments via phone for POS transactions.
- Validations on payment limits, currencies, and duplicate entries.
3. Pre-Requisites
- Valid reference document (Sales Order, Invoice, etc.).
- Configured Payment Gateway Account.
- Linked Bank Account and Mode of Payment.
- Email ID of customer or phone number (for phone payment).
- Proper role-based access rights.
4. Step-by-Step Usage
- Go to Accounts > Payment Request.
- Click on New.
- Select Payment Request Type (Inward or Outward).
- Choose Reference Doctype and Reference Name.
- Select Party Type and Party.
- Fill in Mode of Payment, Email/Phone, and Bank Account.
- Ensure Grand Total is auto-fetched correctly.
- Set Print Format and Message if sending email.
- Save and Submit the document.
- Email is sent or phone request is triggered as per channel selected.
5. Script Customizations
- JS hooks auto-fetch gateway message and account.
- Custom buttons:
- Resend Payment Email (Inward)
- Create Payment Entry (Outward)
- Auto-fetch subscription plans if subscription is enabled.
- Backend validations and payment URL generation in controller.
6. Troubleshooting (Common Errors and Resolutions)
| Error | Reason | Resolution |
|---|---|---|
| "Reference document required" | Reference fields not filled | Select the correct Reference Doctype and Name |
| "Amount cannot be zero" | No outstanding or wrong reference | Check the linked document for values |
| "Duplicate Payment Entry exists" | Already paid or entry created | Cancel existing PR or verify entries |
| "Payment Gateway mismatch" | Plan gateway differs from PR gateway | Update plan or change PR gateway account |
| "No Payment URL generated" | Missing gateway config | Ensure proper gateway and credentials set |
7. User Roles and Permissions
| Role | Access |
|---|---|
| Accounts User | Create, Edit, View, Submit |
| Accounts Manager | All + Cancel, Amend, Payment Entry creation |
| System Manager | Full access including configuration |
8. Key Notes
- Only one active Payment Request is allowed per reference unless prior one is cancelled.
- Payment URL is generated only for Inward requests and Email/Phone channels.
- Ensure
create_pr_in_draft_statusis enabled in Accounts Settings if testing. - Integration with Subscription Plan supports auto allocation and rate validation.
9. What Business Process Pain Point Does It Help Remove
- Avoids manual follow-up for payments by automating reminders.
- Ensures validation and structured handling of multiple payment scenarios.
- Prevents overpayment and duplicate transactions through validation.
- Facilitates seamless payment experience via integrated gateway links.
- Tracks payment status and links with accounting entries automatically.