Technical integration
Embedded checkout only
Please note that right now the only integration type supported for Australia is the Embedded Checkout v2 (hosted checkout, including Pay by Link will be available in Australia at the end of June 2024).
Technical integration with Volt Gateway to support payments in Australia is the same as in every other country, but with some market-specific requirements. This guide provides step-by-step instructions for an efficient and successful integration for Australia and PayTo.
To make your first AUD payment
- Generate access credentials in your Fuzebox account
- Authenticate with the API
- Create the payment request and render the checkout component on your page
- Setup notifications to receive updates about payment status
Configuration options
- Manage the “Pay” button outside of the checkout component
1. Fuzebox account
To start your technical integration, you’ll first need to create an account for Fuzebox, our merchant portal, and then generate some access credentials.
2. Authenticate
Before making any API requests you need to first authenticate with the access credentials you created in Fuzebox.
| Find out more about API authentication | View in API Docs |
3. Create your first payment
The next step for Australia is to call the /dropin endpoint using the POST method.
In the request, make sure to send the required parameters:
{
"currencyCode": "AUD",
"amount": "10000", // The amount of the transaction in 1/100 units (pence, cents etc)
"type": "OTHER", // or any other type supported in Australia, according to your business profile
"uniqueReference": "123456789", // Unique reference for the payment from the merchant, must contain only alphanumeric characters
"additionalDescription": "Purchase for new shoes at Shoes.com - brand ABC", //payment description allowing to pass some additional data. It is sent to PayTo platform, presented in shoppers bank as payment and payment agreement description.
"shopper": {
"reference": "user-13489", // Your unique reference for the shopper, can contain alphanumeric characters plus selected symbols as shown in the pattern
"firstName": "Joe",
"lastName": "Smith"
}
}Initialising and configuring the drop-in component
In order to initialise Volt checkout Drop-in component follow the integration as described in the Volt Embedded Checkout (v2) guide.
Render Volt Embedded Checkout
Render the component as described in the Volt Embedded Checkout (v2) guide.
Completing the payment
The shopper enters one of the two possible identifications to complete the payment
- PayID – the default method of account identification using an email address or mobile phone number. Shoppers can easily set this up at their bank.
- BSB & Account Number – for shoppers who don’t yet have a PayID
Once the shopper clicks the “Pay” button, Volt will be handling the payment. The checkout will wait for payment status updates until it succeeds or fails.
Note: Please note that for payments in AUD we don’t support different countries and languages. During the component initialisation you can pass any value in language or country but they will have no effect on the payment request.
4. Notifications
Volt notifications work the same way for AUD payments as in Europe, the UK and Brazilian flows. You should integrate them to your system according to the notification guide so that we can inform you when the payment has been successful (or otherwise).
Find out more about notifications
For the Australian embedded checkout, you should wait until you receive a notification that the payment status has changed to COMPLETED and redirect your shopper as appropriate.
In common with other countries, you should not release goods or services until you’ve received the RECEIVED notification. Or, if you’re not using Volt Connect, until you have verified that the funds have been received into your own bank account.
5. Using the Pay button
To gain more control on the “Pay” button placement use the following Pay button placement guide. (Scroll down on this page to the section “Use your own pay button”)
If your checkout page has a “Pay” button already, you may want to hide the “Pay” button rendered by our Drop-in component. It should not be possible to submit the payment until the user inputs the required account identification field (PayID, or BSB and Account Number). The drop-in component emits events informing about the current state of user input to control whether the “Pay” button should be active or not.
Pay button visibility
For payments in AUD there is an additional parameter allowing you to control the “Pay” button visibility. As the whole process is conducted in the iFrame you will be informed when the Pay button should be hidden/deactivated as the payment is processed.
This is achieved using payButton.style.visibility attribute.
paymentComponent.on('change', function(event) {
payButton.disabled = !event.complete
payButton.style.visibility = event.processing ? "hidden" : "visible"
});Additional configuration options, allowing to customize the look-and-feel of the embedded checkout can be found in the optional configuration manual.
Customisation options
At the moment, we don’t support any of the customisation options regarding colours of the UI elements for the Australian checkout.