Set up a Payment Details external link

Markdown

View as Markdown

Use Type Payment Details when you want a public link that takes clients to your customer portal so they can add or update payment details, and pay outstanding bills, without signing into OnboardMe.

When to use this type

Choose this to put a billing portal link on your website, in an email signature, or in an SMS. Clients confirm who they are, then continue to your connected payment provider (Pinch, Apxium, or Stripe, depending on your region).

You can also email a client a portal link from their client record or from the Payment Status Dashboard. That flow is covered in Customer billing portal.

Before you start

  • Connect a payment provider: Pinch or Apxium (Australia), or Stripe (UK and New Zealand).

  • The Payment Details type only appears in the Type list when Pinch or Apxium is connected, or when you are editing an existing Payment Details link.

  • Clients should already exist in OnboardMe with an email if you want them matched to an existing account in the portal.

  1. Go to Templates, then open External Links.

  2. Click New Link.

  3. Enter a Name your team will recognise (for example "Website payment portal").

  4. Set Type to Payment Details.

  5. Optionally choose a Notification employee. That person is emailed when a client completes payment details from this link.

  6. Leave Disable link off so the link stays active.

  7. Click Save.

This type does not use Send immediately, Requestor, or a client-facing invitation email. The client works in the portal on the page, rather than waiting for an onboarding or proposal email.

Save and share

  1. After you save, copy Public link, or use Copy on the External Links table.

  2. Payment Details links use the customer portal path (for example /customerPortal?key=...), not the standard /externalLink path used by other types.

  3. Add the URL to your website, or share it by email or SMS. Clients do not need an OnboardMe login.

OnboardMe can also create the practice Payment Details link for you the first time you send a portal email from a client record, if one does not exist yet.

What the client sees

The page is branded as your Customer portal. From a general public link, the client confirms their identity (email plus matching details from your records, including name and business or tax identifiers for your region), then continues.

Once in the portal they can:

  • See amounts owing and overdue invoices

  • Pay one invoice or several at once, where your practice allows it

  • Add or update card and/or direct debit through your connected provider

  • Set up payment details even if they currently owe nothing

When a customer adds a new payment method, OnboardMe emails the notification employee you selected (if any).

For the full portal experience, including emailed portal links and session length, see Customer billing portal.

Was this article helpful?

Still need help?

Contact us

External Links