Skip to main content

Quick Payment Links: URL link structure

Maggie Shipley
Updated

This page gives the base URL, the supported query parameters and the encoding rules for building an Aiwyn payment link outside Aiwyn, for the developer or administrator generating links from a practice management system or other third-party tool.

Base URL

Item Value Notes
Base URL pattern https://<your-tenant>.aiwyn.ai/client-portal/payments <your-tenant> is the firm's own Aiwyn tenant name
Worked example, tenant abcaccounting https://abcaccounting.aiwyn.ai/client-portal/payments Every Quick Payment Link for a firm begins with that firm's base URL

Supported query parameters

All parameters are optional and may be combined.

Parameter What it is Example value Values and limits
companyName Free-text company name shown on the payment form Acme Inc Free text. Ignored when client is supplied.
amount Pre-filled payment amount 1000 Numeric, no currency symbols. USD only.
email Pre-filled payer email address client@email.com Must be URL-encoded.
paymentDescription Text displayed in the payment description field Initial Invoice Free text.
client Client number — the client reference value from the firm's practice management system abc123 Takes precedence over companyName. Must match an existing Client Number in order to have the payment associated with that client.

Value encoding

All parameter values must be URL-encoded.

Character Encoded as
Space %20
@ %40

Example links

Case URL What is pre-filled
Company name supplied https://abcaccounting.aiwyn.ai/client-portal/payments?companyName=Acme%20Inc&amount=1000&email=client%40email.com&paymentDescription=Initial%20Invoice Company name Acme Inc; amount $1,000; email client@email.com; payment description Initial Invoice
Client number supplied https://abcaccounting.aiwyn.ai/client-portal/payments?client=abc123&amount=1000 Client number abc123; amount $1,000

Scope and behavior

Property What is the case
Login Not required
Existing client or invoice record Not required
Currency USD only
State Links are stateless and can be generated dynamically by an internal system
Parameter precedence When client is provided, companyName is ignored
Reconciliation effect Supplying client allows Aiwyn to map the payment to the correct client automatically for reporting and reconciliation
Link expiry Option to have the link expire after certain number of uses.
Reuse Yes, if no expiry has been dictated upon custom link creation.
Payment methods offered on a Quick Payment Link All payment method firm current accepts

Related

  • Send a Quick Payment Link from Outlook
  • Accepted payment methods
  • Supported currencies
  • How Aiwyn payments work