By using basic API's to generate a URL string for Hosted Pages you can create and link to customer payments from your website.
The following options can be appended to the URL query to pre fill information on the Customer Page. If no information is passed in user will be promoted to enter new customer information.
*Note [paymentamount] and [paymentdescription] are required to accept credit cards or payment plans (provided these have been enabled in settings)
URL Query Parametres
The basic URL you will need to add to for your hosted pages has a unique [clienttoken] for your business.
https://hosted.payadvantage.com.au/[clienttoken]/pay
|
Field Name |
Value & Usage |
isbusiness |
isBusiness=1 if business, isBusiness=0 if consumer. |
businessname |
Leave blank if not a business. Maximum length of 50 characters. |
firstname |
Maximum length of 50 characters. |
lastname |
Maximum length of 50 characters. |
|
|
Must be a valid email address between 1 and 200 characters. |
phone |
Can only be numbers(integers), Maximum length of 10 characters. |
customerref |
You can attach your own customer reference to a customer record.Maximum length of 20 characters. (This will not override the autofill customer setting for customer reference numbers) |
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. |
paymentamount |
The amount to be processed (excluding any on-charged fees). Required to accept Credit Card + Payment Plans. |
paymentdescription |
Appears on the payment list and receipt as well as emails sent to customer. Required to accept Credit Card + Payment Plans. Maximum length of 50characters. |
paymentref |
Used for identifying payments via the API. Only saved if a credit card payment. Maximum length of 50 characters. |
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 should end up looking like this:
https://hosted.payadvantage.com.au/[clienttoken]/pay?&description=[value]&businesname=[value]&email=[value]
Linking to the URL without any additional values other than your [clienttoken] will take the customer to a registration page where they can add themselves to your Pay Advantage customer list and generate a BPAY reference.
Redirection
After a BPAY CRN has been successfully 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:
| pa_ID | Always returned |
| pa_CustomerRef | Always returned |
| pa_BpayBillerCode | Only for BPAY |
| pa_BpayCRN | Only for BPAY |
| pa_receiptnumber | Only for Credit Card |
| pa_directdebitcode | Only for Payment Plan |
Example of returned redirection URL query string:
https://mywebsite.com/BPAYHandler?pa_id=ABC123&_pa_bpayref=0123456789&pa_BpayBillerCode=12345&pa_BpayCRN=999999999
Optional Customer Email
Once the customer registration is complete your customer has the option of requesting the BPAY details to be emailed to them.
Comments
0 comments
Please sign in to leave a comment.