Add REDA Pay to record pages: the Pay button
Staff take payments from the records they already work on — a Lead applying for a unit, a Contact paying a deposit, an Account settling an invoice. REDA Pay gives you three ways to open the payment screen from a record page, and you choose per object. Each entry point can pre-set the profile, account, methods and buttons the screen offers, so a leasing team's button and an owner-services button can behave differently.
- The Pay Profile and Processing Account are configured and active — see the Setup roadmap.
- You hold the Salesforce permission to edit Lightning pages (a System Administrator has it) and REDA Pay - Admin User.
- Staff who will use the button hold REDA Pay - User.
Choose an entry point
| Entry point | What it is | Choose it when |
|---|---|---|
| PayButton component | A button on the record page that opens the payment screen in full page, carrying the record's Id | You want a clear button and may pre-set options through the address it opens |
| NewPayOrder component | The payment screen itself, placed on the record page or a tab | You want the screen inline, with its options set in App Builder |
| A custom button or quick action that opens the screen's address | Your own button, built in Object Manager, pointing at the payment screen's address with parameters | You already manage buttons that way, or need the screen as a quick action |
All three open the same screen and the same rules apply. The difference is only where the settings live.
Option 1 — The Pay button
- Open a record of the object, for example a Lead, click the gear icon and choose Edit Page. Lightning App Builder opens.
- In the Components list, under Custom - Managed, find PayButton and drag it where you want the button — the top of the page, or a tab.
- Set its properties:
| Property | Enter |
|---|---|
| Button Label | What staff read, for example Receive Payment |
| Button URL | The payment screen's address: /lightning/cmp/rpay__NewPayOrder, optionally followed by ? and parameters that fix the profile, account, methods or buttons — see below |
| Button Variant | Salesforce's button style: brand for a blue primary button, neutral for a plain one, and so on |
- Save, and Activate the page for the org, app or profiles that should see it.
When pressed, the button appends the record's Id to the address (rpay__rid=<Id>) and opens the screen. The record becomes the payment's parent record: REDA Pay finds or creates its Pay Customer and links the Pay Order to it.
A Pay button on a Lead. One press opens the payment screen for that Lead.
Pre-setting the screen through the address
Add parameters to Button URL to decide what the screen offers. Examples:
| Button URL | Effect |
|---|---|
/lightning/cmp/rpay__NewPayOrder | Everything the user, customer and account allow |
/lightning/cmp/rpay__NewPayOrder?rpay__ttype=rcpt | Receipts only — no disbursement question |
/lightning/cmp/rpay__NewPayOrder?rpay__ttype=rcpt&rpay__bank=0 | Receipts by card only |
/lightning/cmp/rpay__NewPayOrder?rpay__ttype=rcpt&rpay__nosch=1&rpay__nolnk=1 | Pay now only — no Schedule or Create Link buttons |
/lightning/cmp/rpay__NewPayOrder?rpay__ppid=<Pay Profile Id>&rpay__pid=<Processing Account Id> | Skip the profile and account questions |
/lightning/cmp/rpay__NewPayOrder?rpay__amount=250&rpay__fixamt=1&rpay__cnotes=Application%20fee | A fixed $250 with a note — an application-fee button |
The full list is in URL parameters reference. Values in the address win over the component's own settings.
Option 2 — The payment screen on the page
- In Lightning App Builder for the record page, drag NewPayOrder (under Custom - Managed) onto the page — usually into its own tab such as Payments, because the screen needs the width.
- Set its properties in the right-hand panel: which transfer types, methods and buttons to allow, whether to limit the profiles and accounts by code, EMD and fee switches, and up to four attributes to stamp on the order. Every property is explained in Component settings reference. Leave Is Portal unticked on internal pages.
- Save and Activate.
The screen opens as soon as the tab is shown and works out the profile, customer and account from the record.
Option 3 — A custom button or quick action
If your team prefers Object Manager buttons:
- Setup → Object Manager → Lead → Buttons, Links, and Actions → New Button or Link.
- Choose Detail Page Button, behaviour Display in existing window, content source URL, and the formula
/lightning/cmp/rpay__NewPayOrder?rpay__rid={!Lead.Id}plus any parameters. - Add the button to the page layout.
A quick action of type Lightning Component can host NewPayOrder as well; it opens the first step in a dialog, and the payment screen then opens in full page.
Which objects to cover
| Object | Typical use | Suggested address |
|---|---|---|
| Lead | Application fees, holding deposits | Receipts only |
| Contact | Rent, deposits, fees from a resident | Receipts only |
| Account | Invoices from a company; payouts to a vendor or owner | Receipts and disbursements; the user's own switch decides which they may do |
| Opportunity | Deposits on a sale | Add rpay__oppid={!Opportunity.Id} together with rpay__rid of the Contact or Account, so the order links to the opportunity |
The parent record must be an Account, Contact or Lead — the objects REDA Pay knows how to turn into a Pay Customer. For an Opportunity, the button passes the related Contact or Account as the parent and the Opportunity as a link.
Mistakes to avoid
| Mistake | What happens | Fix |
|---|---|---|
| Button URL without the leading slash | The address does not resolve | Start with /lightning/cmp/ |
| Looking for the component under its product name | App Builder lists the managed components by their names: PayButton, NewPayOrder | Look under Custom - Managed |
| Placing the Pay button on an object other than Account, Contact or Lead | "Bad Request. Parent record not found." or "Transaction not allowed for SObject: …" | Pass an Account, Contact or Lead Id with rpay__rid |
| Page activated for the wrong app | Staff do not see the button | Check the activation (Org Default, App Default or App and Profile) |
| Staff without REDA Pay - User | The screen fails to load | Assign the permission set |
FAQ
Yes — for example Collect Application Fee with a fixed amount and Receive Payment without. Each is its own Pay Button component with its own address.
Test it on the devices your team uses before relying on it; the payment screen is designed for a browser window.
No. The screen's labels are fixed; the button label you set applies only to the Pay button on the page.
Where to go next
- Take a payment — what happens after the button is pressed.
- Component settings reference
- URL parameters reference