Custom Payment Links – Required parameters

Written By dev@payadvantage.com

Last updated 5 months ago

Payment portal give you a powerful and flexible way to accept payments from your customers without needing a developer. You can create custom payment links that are easily:

Embedded in emails, on invoices or your website
Pre-filled with customer info and payment details
Used to register new customers
Shared for BPAY, Credit Card, or PayID payments

What Are Custom Payment Links?

Your Payment portal is your business’s unique payment web page. By using custom payment links, you can easily create a dynamic link for customers to pay.

A custom payment link generator is available in Pay Advantage portal to easily learn how to create these links. This tool is intended to be used for discovery and experimental purposes.

Enter in a description and amount and you will see the link created on the right hand side of the screen. Adding a customer will add further parameters to the url the link to the customer. The link will update each time changes are made.

To create a QR code for the link, click generate payment link.

Since the parameters are part of the url, it is possible they can be manipulated by customers. For example they can change the amount, and the link will now open with that new amount.

If you would like to lock the URL so that it cannot be manipulated, select the Enable Link Protection toggle.

Payment portal link and subdomain

You can find your Custom Payment Link URL here: Settings → Configure Payments → Payment Portal Subdomain

Example of a custom payment link:

https://hosted.payadvantage.com.au/[clienttoken]/pay?paymentdescription=Purchase%20from%20ABC%20Corp&paymentamount=100.00

Or use the shortened version:

https://[clienttoken].pad.live/pay?paymentdescription=Purchase%20from%20ABC%20Corp&paymentamount=100.00

✅ Tip: You can customise your [clienttoken] to your brand name (e.g., BestGymEver.pad.live) via Settings → Configure Payments → Payment Portal Subdomain

All Available Parameters

You can pass values into your link to pre-fill or trigger certain behaviors:

The full list of acceptable parameters are:

Field Name	Value & Usage
`paymentamount`	The amount to be processed (excluding any on-charged fees). Required.
`paymentdescription`	Appears on the payment list and receipt as well as emails sent to customer. Required. Maximum length of 50 characters.
`paymentref`	Used for identifying payments via the API. Only saved if a credit card payment. Maximum length of 50 characters. This is included on the payment as externalid.
`customerref`	You can attach your own customer reference to a customer record. Maximum length of 20 characters. This will be matched against existing customers.
`externalid`	The id of the customer as it is in your external system. Only available to view/access via API. Maximum length of 20 characters. This will be matched against existing customers.
`isbusiness`	Use 1 for business customer, or 0 for regular customer.
`businessname`	Leave blank if not a business. Maximum length of 50 characters.
`firstname`	Maximum length of 50 characters.
`lastname`	Maximum length of 50 characters.
`email`	Must be a valid email address between 1 and 200 characters.
`phone`	Can only be numbers(integers) and should include the country code. ie 61421000000

Values must be separated by the "&" symbol and spaces between words must be entered as "%20" i.e. "&businessname=Peters%20Plumbing" will pre-populate the form with the business name "Peters Plumbing".

Redirect After Payment (Optional)

You can configure a redirect URL after payment. This will be available for the customer to click the "next" button once the payment is complete which will redirect to the URL provided.

Settings → Configure Payments → Return URL

Use the query parameters sent from the redirect URL to show information about the payment on your website:

https://yourwebsite.com/thankyou?pa_id=ABC123&pa_receiptnumber=XYZ456

Returned values include:

pa_ID	Always returned
pa_CustomerRef	Always returned
pa_BpayBillerCode	Only for BPAY
pa_BpayCRN	Only for BPAY
pa_receiptnumber	Only for Apple Pay, Google Pay, Credit Card, PayTo or PayID
pa_directdebitcode	Only for Payment Plan

Example of returned redirection URL query string:

https://mywebsite.com/MyHandler?pa_id=ABC123&_pa_bpayref=0123456789&pa_BpayBillerCode=12345&pa_BpayCRN=999999999

Knowing when a payment has been made

There are three ways to be notified that a payment has been made via the payment portal.

Email notification - Adding an email notification to your user profile in Pay Advantage will allow you to receive emails each time a payment is made via the payment portal.

Push notification - Adding an push notification to your user profile in Pay Advantage will allow you to receive mobile app notifications each time a payment is made via the payment portal.

Webhooks - For those more savvy with technical systems. You can register for a webhook, and each time you receive a payment we will send your API the details about that payment. Go here for more information.