Skip to main content

How Can I Create a Payment Portal Link with a Prefilled Amount and Reference?

Your payment portal link can be prefilled with an amount and a reference by adding query parameters. Amounts are in dollars, and prefilled values are locked for your customer.

Your payment portal link can be sent as-is, letting your customer enter their own amount, or you can prefill it so the amount and reference are already filled in when the page opens. Prefilling removes a step for your customer and makes sure the payment comes back tagged with the invoice number or job number you expect.

Overview: Prefilling Payment Links

You prefill a payment portal link by adding query parameters to the end of your merchant payment portal URL.
​

This is useful for:

  • Invoices, where the amount and invoice number are already known

  • Fixed-price services such as consultations, deposits, or event bookings

  • Any workflow where you want the payment to come back with a reference you can match

How to Build a Prefilled Link

  1. Start with your payment portal URL. This was provided during setup, for example https://yourcompany.nickelpayments.com/ and can be found via the Invoices tab
    ​

  2. Add a question mark, then your first parameter. For the amount, that is ?amount=1250.75
    ​

  3. Join any additional parameters with an ampersand. For the reference, that is &orderReference=INV-12345
    ​

  4. Share the finished link by email, text, or wherever you normally send it.

The finished link looks like this:

https://yourcompany.nickelpayments.com/?amount=1250.75&orderReference=INV-12345
​

Opening it shows $1,250.75 in Enter a payment amount and INV-12345 in Reason for payment, ready to pay.
​

Note: amount is in dollars, not cents. amount=1000 means $1,000.00, not $10.00.
​

Available Parameters

Parameter

Fills

Example

amount

Enter a payment amount

amount=1250.75

orderReference

Reason for payment

orderReference=INV-12345

What Your Customer Sees

A prefilled amount and reference are locked. Your customer can see them but cannot change them, so the payment always comes back for the amount and reference you sent.
​

Tip: If you would rather the prefilled amount act as a starting point your customer can edit, reach out to us and we can enable editable amounts on your account.
​

Formatting Rules

  • Amounts are in dollars. Decimals are fine (amount=1250.75).

  • Encode spaces and symbols. A space becomes %20, an ampersand becomes %26, and a percent sign becomes %25. Spaces are perfectly acceptable in a reference, they just need to be encoded in the URL.

  • Commas and a leading number sign are removed from the reference, so #INV-1,234 arrives as INV-1234.

Common Use Cases

  • Invoicing: Attach a link to each invoice carrying the exact amount payable and the invoice number.

  • Consultations and deposits: Send a fixed-amount link ahead of the appointment.

  • Event bookings: Give attendees a direct payment link for a fixed-price event.

FAQs

Can I use this for recurring payments?

No. This is for one-time payments where the amount and reference are fixed. For recurring billing, use a recurring invoice instead.
​

Can my customer change the prefilled amount?

Not by default. A prefilled amount and reference are locked. Contact us if you want editable amounts turned on for your account.
​

Does this work if I use my own domain?

Yes. If your portal is on a custom domain, add the parameters to that URL exactly the same way.
​

What characters can I use in the reference?

Letters, numbers, spaces, dashes, and most other characters are accepted. Just make sure spaces and symbols are URL-encoded, as described in Formatting Rules above.
​

How do I know my link is working?

Open it in a browser before sending it. The amount and reference should already be filled in on the page.
​

Need help?

If you have questions, please chat with our team via the Help Center when you login to the platform.

Did this answer your question?