URL parameters reference
The payment entry (NewPayOrder) and the save-a-method entry (NewPayMethod) read instructions from the address they are opened with. That is how a Pay button fixes the amount of an application fee, how a vendor's bank-details link knows which Account it belongs to, and how a portal page can pre-select a profile. A value in the address wins over the same setting on the component — see Component settings reference.
Before you start — parameters are added after ? and separated with &. Values with spaces or punctuation must be URL-encoded (a space becomes %20). Record Ids are the 15- or 18-character Salesforce Ids.
The internal payment address is /lightning/cmp/rpay__NewPayOrder; on a site it is the page that holds the entry component, for example https://yourcompany.my.site.com/portal/s/new-pay-order.
Parameters for the payment entry (NewPayOrder)
Who and where
| Parameter | Value | Meaning |
|---|
rpay__rid | Record Id | The parent record — an Account, Contact or Lead. On a record page the PayButton adds it for you. Required unless the page is a portal page that resolves the logged-in user, or rpay__oid is present |
rpay__custid | Pay Customer Id | Use this Pay Customer instead of looking one up from the parent record |
rpay__ppid | Pay Profile Id | Use this profile without asking |
rpay__pid | Processing Account Id | Use this account without asking |
rpay__pfid | Processing Account Id | Route the convenience fee to this account |
rpay__lid, rpay__cid, rpay__aid, rpay__oppid | Lead, Contact, Account, Opportunity Id | Link the order to these records in addition to the parent record |
rpay__oid | Encrypted order Id | Opens an existing payment link. REDA Pay builds this into every Link URL; never construct it yourself |
What kind of payment
| Parameter | Value | Meaning |
|---|
rpay__ttype | rcpt or disb | Fix the direction: receipt or disbursement |
rpay__otype | imm, schd or lnk | Fix the order type: pay now, schedule, or payment link |
rpay__card | 1 or 0 | Allow or hide cards |
rpay__bank | 1 or 0 | Allow or hide bank accounts |
rpay__noimm | 1 | Hide the Pay button |
rpay__nosch | 1 | Hide the Schedule button |
rpay__nolnk | 1 | Hide the Create Link button |
rpay__noemd | 1 | Hide the Earnest Money Deposit switch |
Amount, fees and notes
| Parameter | Value | Meaning |
|---|
rpay__amount | A number, e.g. 250 or 1250.50 | Pre-fill the amount. A value that is not a number is ignored |
rpay__fixamt | 1 | The amount cannot be changed (shown as text). Use with rpay__amount |
rpay__nofee | 1 | No convenience fee on this order |
rpay__cfee | A number | Replace the calculated convenience fee with this amount |
rpay__cnotes | Text | Customer Notes, shown to the payer and stored on the order |
rpay__att1 … rpay__att4 | Text | Attribute 1–4 on the order, for your own automation and reports |
rpay__geoskip | 1 | Do not ask the browser for location |
Parameters for the save-a-method entry (NewPayMethod)
| Parameter | Value | Meaning |
|---|
rpay__rid | Record Id | The parent record (Account, Contact or Lead). Required together with, or instead of, rpay__custid |
rpay__custid | Pay Customer Id | The customer the method belongs to |
rpay__ppid | Pay Profile Id | Use this profile without asking |
rpay__ttype | rcpt or disb | What the method may be used for |
rpay__default | 1 or 0 | Make the saved method the customer's default |
rpay__card, rpay__bank | 1 or 0 | Allow or hide each type |
rpay__curr | USD or CAD | Pre-fill the bank account currency |
rpay__cnotes | Text | A note shown on the screen |
rpay__lid, rpay__cid, rpay__aid | Ids | Link the method to these records |
Worked examples
| Goal | Address |
|---|
| Application-fee button on a Lead: $75, cannot be changed, card or bank, pay now only | /lightning/cmp/rpay__NewPayOrder?rpay__amount=75&rpay__fixamt=1&rpay__ttype=rcpt&rpay__nosch=1&rpay__nolnk=1&rpay__cnotes=Application%20fee (the PayButton adds rpay__rid) |
| Payout button on an Account, fixed to one account | /lightning/cmp/rpay__NewPayOrder?rpay__ttype=disb&rpay__ppid=a00…&rpay__pid=a01… |
| Link to create a payment link only, no fee, bank only | /lightning/cmp/rpay__NewPayOrder?rpay__rid=003…&rpay__otype=lnk&rpay__nofee=1&rpay__card=0 |
| Vendor bank-details link on your public site | https://yourcompany.my.site.com/public/s/process-method-link?rpay__rid=001…&rpay__ttype=disb&rpay__default=1&rpay__card=0 |
| Portal page that pre-selects a profile for every resident | Put rpay__ppid=a00… in the address the portal navigation uses, or set Limit Profile Selection on the component |
A custom button formula on Lead reads, for example:
/lightning/cmp/rpay__NewPayOrder?rpay__rid={!Lead.Id}&rpay__amount=75&rpay__fixamt=1&rpay__ttype=rcpt
Rules of precedence
- A URL value overrides the component setting for the same option.
- Neither can offer more than the Processing Account and the Pay Customer allow; they only remove options.
- A profile or account passed by Id must be active and belong together; otherwise the screen cannot use them.
rpay__oid (a payment link) takes over: the order's own amount, fee choice and method restrictions apply and only Pay is available.
Mistakes to avoid
| Mistake | What happens | Fix |
|---|
Forgetting rpay__rid on a method link | "Bad Request. Parent record not found." | Add the Account, Contact or Lead Id |
rpay__amount=100e or $100 | The amount is ignored and left editable | Digits and a decimal point only |
rpay__fixamt=1 without an amount | Nothing to fix; the payer types the amount | Add rpay__amount |
Passing a Pay Profile Code in rpay__ppid | Not found | rpay__ppid takes the record Id; codes go in the component's Limit Profile Selection |
Where to go next
