Payment Gateway Account
The configuration for integrating ERPNext with third-party payment gateways such as Stripe, PayPal, Razorpay, and others is stored in a Payment Gateway Account.
It contains the credentials (API key, Client ID, and Webhook secret) and other data required for ERPNext to process invoices, Website Checkout, and Payment Requests for online payments.
Features
- Manage several gateway accounts, such as PayPal Live, Stripe Sandbox, and Stripe Live.
- Keep test and live credentials distinct.
- When required, enable or disable accounts.
- To enable secure callbacks, set the webhook secret.
- Restrict each gateway’s supported currencies; * Map default receivable accounts for precise accounting.
Configuration
- Go to Setup > Integrations > Payment Gateway Account.
- To add a new Payment Gateway Account, click New.
- Type the data in:
- Gateway Provider: Choose the payment processor (such as PayPal or Stripe).
- Account Name: Provide a distinctive name, such as Stripe-Live.
- Mode: Select Live (for production) or Sandbox (for testing).
- API Key / Secret Key: Copy and paste your provider dashboard credentials.
If applicable, use the Webhook Secret to confirm incoming webhooks.
- Default Receivable Account: Assign the account that will receive the credit for payments.
- When you’re ready to use the account, activate it.
- Gateway Provider: Choose the payment processor (such as PayPal or Stripe).
- Save the document.
- Configure the webhook URL to point to ERPNext on your provider dashboard.
Example:
```javascript https://your-site.com/api/method/your_app.api.payment_webhook ```
How It Works
When a client uses a Payment Request or Website Checkout to make a payment:
- ERPNext reroutes them to the gateway’s checkout page.
- Payment is made by the client.
- ERPNext receives a webhook from the payment gateway.
- After verifying the webhook, ERPNext designates the sales invoice or payment request as Paid.
- It automatically creates a Payment Entry against the related account.
