PayPal Integration in ERPNext
ERPNext integrates with PayPal to securely process online payments. Once configured, customers can make payments through PayPal, while ERPNext automatically creates the required Payment Gateway and accounting records for seamless transaction management.
Summary
- Accept online payments using PayPal.
- Supports both Sandbox and Live environments.
- Automatically creates Payment Gateway and Payment Gateway Account.
- Creates a Bank-type account in the Chart of Accounts.
- Supports multiple international currencies.
Prerequisites
- A valid PayPal Business account or PayPal Developer account.
- PayPal API Username, API Password, and API Signature.
- Administrator access to ERPNext.
Access PayPal Settings
Navigate to:
Explore > Integrations > PayPal Settings
Configure PayPal
- Open PayPal Settings.
- Enter the following credentials:
- API Username
- API Password
- API Signature
- If you want to test payments, enable Use Sandbox.
- Save the configuration.
- Enable the PayPal integration.
What Happens After Enabling?
- A Payment Gateway record is created automatically.
- A new Bank account is added to the Chart of Accounts.
- A Payment Gateway Account is generated for payment configuration.
Payment Gateway Account
The Payment Gateway Account acts as the central configuration point for PayPal payments. From here, you can:
- Select the accounting ledger used for PayPal transactions.
- Configure the default Payment Request email template.
- Manage payment gateway settings without modifying the PayPal credentials.
Chart of Accounts Entry
When PayPal is enabled, ERPNext automatically creates a Bank-type account in the Chart of Accounts to record incoming PayPal payments.
Supported Transaction Currencies
| Supported Currencies |
|---|
| AUD, BRL, CAD, CZK, DKK, EUR, HKD, HUF, ILS, JPY, MYR, MXN, TWD, NZD, NOK, PHP, PLN, GBP, RUB, SGD, SEK, CHF, THB, TRY, USD |
Get PayPal Sandbox Credentials
- Log in to your PayPal Developer account.
- Navigate to the Accounts section.
- Create a new Business Sandbox account.
- Open the account profile.
- Copy the following credentials:
- API Username
- API Password
- API Signature
- Enter these values into ERPNext PayPal Settings.
Note
Sandbox credentials are intended only for testing transactions. Switch to Live credentials before accepting real customer payments.
Get Live PayPal API Credentials
- Log in to your PayPal Business account.
- Open your Profile.
- Go to My Selling Tools.
- Select API Access.
- Choose the option to generate API credentials.
- Copy the API Username, Password, and Signature.
- Update these credentials in ERPNext and disable Use Sandbox.
Result
After completing the setup, ERPNext can securely accept PayPal payments, manage payment requests, and automatically record transactions in the accounting system.