Summary
This article describes how Quick Payment Links may be generated from systems outside of Aiwyn. It is technical in nature and necessary in order to generate a Quick Payment Link URL from a third-party system such as your practice management system or other non-Aiwyn vendor.
Included in this article:
- Base URL
- Supported query parameters
- Example URL with company name
- Example ULR with client number
- Additional notes
Base URL
Each Quick Payment Link starts with your tenant-specific base URL:
https://<your-tenant>.aiwyn.ai/client-portal/payments
For example, if your tenant is 'abcaccounting' then your Quick Payment Link base URL is:
https://abcaccounting.aiwyn.ai/client-portal/payments
Supported query parameters
The following optional query parameters can be appended to the base URL to pre-fill the payment form:
| Parameter | Description | Example value |
| companyName | Free-text company name (used only if client is not provided) | Acme Inc |
| amount | Pre-filled amount (numeric, no currency symbols) | 1000 |
| Pre-filled email address | client@email.com | |
| paymentDescription | Text displayed in the description field | Initial Invoice |
| client | Client number – the client reference value from your practice management system. If provided, it replaces companyName. | abc123 |
These parameters are optional and can be combined as needed. All values must be URL-encoded (e.g., spaces become %20, @ becomes %40).
Example URL with company name
https://abcaccounting.aiwyn.ai/client-portal/payments?companyName=Acme%20Inc&amount=1000&email=client%40email.com&paymentDescription=Initial%20Invoice
This will pre-fill:
- Company name: Acme Inc
- Amount: $1,000
- Email: client@email.com
- Payment description: Initial Invoice
Example ULR with client number
You may include the client number parameter to associate the payment with a known client in your practice management system. If this option is utilized, do not include 'companyName'.
https://abcaccounting.aiwyn.ai/client-portal/payments?client=abc123&amount=1000
This will pre-fill:
- Client number: abc123
- Amount: $1,000
Other notes:
- When the client parameter is provided, the companyName parameter is ignored
- This enables Aiwyn to automatically map the payment to the correct client for reporting and reconciliation
Additional notes
- Quick Payment Links are designed for use without a login, client or invoice requirement
- Payments via Quick Payment Links currently support USD only
- When the client parameter is provided, the companyName parameter is ignored
- These links are stateless and can be generated dynamically via your internal systems
Additional resources: