What you can do with Hosted Pages

Hosted pages can be configured to:

• Allow credit card payments to existing customers who have a BPAY CRN
• Allow new customers to register and pay any amount they choose
• Embed a link in your website or email and pass in parameters such as a payment description, payment amount, new customer details or use an existing customers reference number.
• Accept Xero Pay Now requests

Hosted Page URL

This is your unique webpage within Pay Advantage for accepting payments. The exact URL can be found in the client portal under Integrations > Hosted Pages > Customer Portal Token URL and will look something like:

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

which can be shorted to the below (both URL styles are supported).

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

You can also create a more personalised touch by creating your own sub-domain which will then be your [clienttoken] value. (This can be set through Integrations > Payment Portal)

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

NOTE: if using a payment portal, remove the /pay at the end of the link to allow your customers to provide their own payment amount and description. For more information: https://help.payadvantage.com.au/hc/en-us/articles/360001214355-Hosted-Pages-Payment-Portal 

You should also configure your branding and what payment options you want to make available in your payment portal such as BPAY, credit card or payment plans. See Getting Started with Hosted Pages

Once properly configured customer can start making payments directly through your portal.

Taking payments by setting parameters

Adding parameters allows you to set known values such as the payment amount/description, pre-fill customer information or link to an existing customer. As a minimum you should ALWAYS pass in [paymentamount] and [paymentdescription] values. Failing to pass in the parameters correctly might result in an error or the customer being redirected to the payment portal home page. 

*Note that to use a space in a url you enter this as %20

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

<a href="https://[clienttoken].pad.live/pay?paymentdescription=Purchase%20from%20ABC%20Corp&paymentamount=100.00 " target="_blank">Enter your Link Text Here</a>

Once the customer follows the above link they will be prompted to register their phone number and email and can then proceed to making a payment. You can also append other parameters to pre-fill a customers information.

The full list of acceptable parameters are:

paymentamount

paymentdescription

paymentref

customerref

externalid

isbusiness

businessname

firstname

lastname

email

phone

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". 

A typical string to pre-fill a payment for a new business customer would look like: 

https://[clienttoken].pad.live/pay?paymentamount=[value]&paymentdescription=[value]&isbusiness=[value]&businessname=[value]&email=[value]&phone=[value]

https://BestGymEver.pad.live/pay?paymentamount=5&paymentdescription=New%20Membership&isbusiness=1&businessname=MyBusinessName&email=test@test.com&phone=61444000000

Or for a new consumer would look like: 

https://[clienttoken].pad.live/pay?paymentamount=[value]&paymentdescription=[value]&isbusiness=[value]&firstname=[value]&lastname=[value]&email=[value]&phone=[value]

https://BestGymEver.pad.live/pay?paymentamount=5&paymentdescription=New%20Membership&isbusiness=0&firstname=John&lastname=Smith&email=test@test.com&phone=61444000000

Creating a payment link for an existing customer

• If you would like to link to an existing customer that has already been created through the Pay Advantage API this can be done by setting either the customerref or externalid fields.
• The customerref field is a field that can be set through the portal for each customer. 
• The externalid field can only be set through the API. When setting these values you should ensure you enforce uniqueness otherwise issues may arise.
• You should also not pass in any other fields that identify the customer such as the business name or email. If you do we will check if the information matches an existing customer and if it does this will result in a new customer being created.
• If the existing customer doesn't already have an email and phone registered they will be prompted to enter this.

Example of creating a payment using [externalid]

https://[clienttoken].pad.live/pay?paymentamount=[value]&paymentdescription=[value]&externalid=[value]

Redirection

After a customer has been generated you have to option to redirect the user to a page of your choice. This is triggered by the customer clicking a "Next" button on the form.

You can also append the following values to the redirection URL query, some of the values are only returned if that payment type was used.

Example of returned redirection URL query string:

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

Let your customer generate a BPAY Reference Code

Send customers to your hosted pages site URL above. Once there they will be able to:

• Register as a customer under your Pay Advantage account
• Receive a BPAY reference and instructions on how to make a BPAY payment

• Once the customer registration is complete your customer has the option of requesting the BPAY details to be emailed to them.