Component settings reference
REDA Pay ships a handful of components you place on pages: the payment entry (NewPayOrder), the save-a-method entry (NewPayMethod), the second screens each opens, the result pages for portals, and a PayButton. Each exposes settings in the right-hand panel of Lightning App Builder (internal pages) or Experience Builder (portal and public pages). This page lists every setting. For how to place a component, see Add REDA Pay to record pages and Let customers pay in your portal.
The components appear under Custom - Managed in the component list, by name.
How settings combine
A setting on a component can only narrow what the Processing Account and the Pay Customer allow; it cannot widen it. Values passed in the page address (see URL parameters reference) override the component's settings. So, for any option:
what the screen offers = account rules ∩ customer rules ∩ component settings, overridden by URL parametersNewPayOrder — the payment entry
| Setting | Default | Effect |
|---|---|---|
| Enable Scheduling Order | on | Show the Schedule button |
| Enable Order Link | on | Show the Create Link button |
| Limit Profile Selection | blank | Comma-separated Pay Profile Codes. Blank: every active profile the user may see. One code: that profile is used without asking |
| Limit Processing Account Selection | blank | Comma-separated Processing Account Codes, same rule |
| Allow Pay Method Type - Card | on | Offer the Card tab, if the account and customer allow cards |
| Allow Pay Method Type - Bank Account | on | Offer the Bank tab, same condition |
| Allow Transfer Type - Receipt (Cash-In) | on | Allow receipts from this page |
| Allow Transfer Type - Disbursement (Cash-Out) | on | Allow disbursements from this page (the user still needs Enable Disbursements) |
| Disable EMD Payments | off | Hide the Earnest Money Deposit switch |
| Do NOT Charge Convenience Fee | off | Orders from this page carry no convenience fee |
| Attribute 1 … Attribute 4 | blank | Text copied onto every order created from this page, for your own automation and reports |
| Customer Notes | blank | Intended to show a note on the screen. In this release the setting has no effect; pass the note with the URL parameter rpay__cnotes instead |
| Is Portal | off | Tick on Experience Cloud pages. Switches the component to portal navigation and portal record resolution |
| Portal Record Identifier | User-Contact | On a portal: whether the logged-in user's Contact or Account is the parent record for the payment |
| Portal Payment Page | blank | API name of the portal page that holds NewPayOrderRequest |
| Portal Success Page | blank | API name of the page that holds NewPayOrderResult for success |
| Portal Error Page | blank | API name of the page that holds NewPayOrderResult for errors |
| Portal Return URL | blank | Where Cancel and the review's Cancel go on a portal; can be any address, including your own website |
| Skip Geo-Location Capture | off | Do not ask the browser for location (do not combine with an account that enforces it) |
The settings panel. Every line here is explained in the table above.
NewPayOrderRequest — the payment screen
No settings. Place it on the portal page named in Portal Payment Page. Internally it opens by itself.
NewPayOrderResult — the portal result page
| Setting | Effect |
|---|---|
| Is Success (a single checkbox) | Tick on the page named in Portal Success Page; leave unticked on the page named in Portal Error Page. The component shows "Success — Your order is successfully processed. Order Reference: P-000000" or "Error — Error encountered while processing order. Error Log: …" accordingly |
NewPayMethod — the save-a-method entry
| Setting | Default | Effect |
|---|---|---|
| Limit Profile Selection | blank | Comma-separated Pay Profile Codes, as above |
| Default Pay Method | on | The saved method becomes the customer's default |
| Allow Pay Method Type - Card | on | Offer cards |
| Allow Pay Method Type - Bank Account | on | Offer bank accounts |
| Allow Transfer Type - Receipt (Cash-In) | on | The method may be used for receipts |
| Allow Transfer Type - Disbursement (Cash-Out) | on | The method may be used for disbursements |
| Customer Notes | blank | Same as above: no effect in this release; use rpay__cnotes |
| Is Portal, Portal Record Identifier | off, User-Contact | As for NewPayOrder |
| Portal Method Input Page | blank | API name of the portal page that holds NewPayMethodRequest |
| Portal Success Page, Portal Error Page, Portal Return URL | blank | As for NewPayOrder, with NewPayMethodResult on the result pages |
| Default Currency | — | USD or CAD, pre-filled as the currency of a new bank account |
NewPayMethodRequest and NewPayMethodResult
NewPayMethodRequest has no settings. NewPayMethodResult has the same single checkbox as NewPayOrderResult and shows "Your payment method is successfully processed." or "Error encountered while processing payment method. Error Log: …".
PayButton — a button that opens an address
| Setting | Required | Effect |
|---|---|---|
| Button Label | yes | The text on the button |
| Button URL | yes | The address to open. On a record page the record's Id is appended as rpay__rid=<Id> |
| Button Variant | yes | Salesforce button style: base, neutral, brand, brand-outline, destructive, destructive-text, inverse, success |
RedirectToURL — for screen flows
A small component for your own screen flows with one setting, Navigation URL: when the flow reaches it, it navigates to that address. REDA Pay's Add Pay Method flow uses it to open the save-a-method screen.
Typical configurations
| Page | Settings |
|---|---|
| Staff Lead page, application fees by card | Allow Bank off; Enable Scheduling Order off; Enable Order Link off |
| Staff Account page, receipts and payouts | Defaults |
| Resident portal payment page, bank only | Is Portal on; Portal Record Identifier User-Contact; Allow Card off; Enable Order Link off; Portal Payment Page, Success Page, Error Page and Return URL set |
| Public payment-link page | Is Portal on; Portal Payment Page, Success Page, Error Page and Return URL set. Links carry their own method and fee restrictions |
| Portal save-a-method page | Is Portal on; Portal Method Input Page, Success Page, Error Page and Return URL set |
Mistakes to avoid
| Mistake | What happens | Fix |
|---|---|---|
| Is Portal left off on a portal page | Navigation after the first step fails or returns to the wrong place | Tick Is Portal and set the portal pages |
| Portal page names typed as labels | REDA Pay cannot find the page | Use the page's API name from Experience Builder's page properties |
| Allow Card and Allow Bank both off | The screen has no tabs | Allow at least one |
| Expecting Customer Notes to show | Nothing appears | Use rpay__cnotes in the address |
| Limiting profiles by name instead of code | No profile matches | Use the Pay Profile Code |