Who is this article for? Read this if you require iframe support

Azupay, is in the process of migrating our client base to our new Pay By Bank App, which is our third generation app.
We are expecting to have iframe support and full feature parity to our second generation app delivered into our third generation app by April 2025. Our third generation app provides significant usability enhancements and support for pass key journeys to allow repeat low touch payments, and is recommended if you don't currently require iframe support. If you do require iframe support, you need to be aware of iframe specific configurations that are outlined in the second generation Checkout Documentation. Please ensure you let your implementation team know if you intend to be on the second generation of our checkout or require iframe support.

Introduction

Azupay's Pay by Bank UX solution has been designed to optimise the payer experience using PayID as a method for your customers to pay to you.

While PayID based payments offer great benefits the experience is new so an optimum UX is important to help your payers complete their journeys successfully. Based on our user research and understanding of payment behaviours, we have designed and tested this solution to maximise conversion rate of payments and reduce the integration effort required by you.

The Pay by Bank UX solution involves you sending Azupay a PaymentRequest API call, you showing your payer our PayID Checkout App UX and your system listening for updates from our webhooks. Our Pay by Bank UX solution has the following features:

• Fully screen responsive 
• Clear display of payment amount requested and description for payment for simple checkout experience
• QR code for users to scan so that payment information (PayID email address) is easily transferred to mobile device for faster and easier payments
• Allows for customisable logos, and URL redirection.

How do I use it?

1. Call the PaymentRequest API using the variantfield that corresponds to the UX you want to create.
2. In the response body of the POST /v1/paymentRequest call, there will be a field called PaymentRequestStatus.checkoutUrl
3. Present this URL to your customer using any means appropriate, you could:
   1. Surface in a new pop-out window
   2. Send the link via an email
   3. Send the link via an SMS
   4. Embed it into a QR code
4. Once the payment is completed the payer will see a confirmation

Key Configurations

The payment experience can be configured to suit the needs of your use case. In the table below configurations may be set by URL parameters, values in the API calls or set in your specific client configuration.

There are other Configurations explained elsewhere in these Guides and the API Reference. The list above is the subset having the most impact on overall experience and should be considered before you start your implementation journey.

Example Configurations

Dynamic PayID

This is a short-lived PayID that only accepts a single payment and is uniquely generated in real time as required. Once a payment for the exact amount of the PayID is made by a payer, the PayID is deregistered and no further payments to the PayID can be made.

This PayID setup is most suited to your customers making a one-off payment for goods or services and you want perfect instant match of payment to the purchase.

📘

Sounds technical but its the easiest configuration

This was the original Azupay product so just set your amount and off you go...

Configure like this:

• Set amount for each transaction in the API call
• Multipayment=FALSE and do NOT enter a value for PayID string
• Other configurations (e.g. expiry time) can be varied as suits your specific needs

Open Static PayID

This is an enduring PayID that accepts multiple payments of any amount at any time.

This PayID setup is most suited to account based payments where you want to know which of your customers have sent you money but you don't need specific amounts at specific times. Simply create a single Open Static PayID for each of your customers. Examples include topping up digital wallets or adding credit to a customer account.

👍

Hint: Encourage your customers to save their PayID in their banking app

For faster repeat payments they can use the same PayID each time

Configure like this:

• Multipayment = TRUE
• Expiry Time either empty or a far future date (e.g. 1 year away)
• Optional: set PayID string to something short but meaningful to your customer, e.g. their initials plus 4 random digits @ your domain.
• Other configurations (e.g. URL Type) can be varied as suits your specific needs

Static Recycled PayID

This is a recurring PayID that accepts specified amounts periodically. When the specified amount is received the PayID is deregistered (preventing further payments to it), until you make another Payment Request using the same PayID at which point it becomes available again to be paid to with a new target amount.

This PayID setup is most suited to customers with periodic or usage-based recurring billing. Simply make a Payment Request with Amount and PayID string specified, ensure you use the same PayID string for each customer every time. Your customer will pay to the same PayID every time they receive a bill and each time they do so they will get a description of the amount owing for that specific bill and there will be controls to ensure they don't overpay or accidentally pay it twice. Improve customer satisfaction and reduce contact centre calls!

👍

Hint: Encourage your customers to save their PayID in their banking app

For faster repeat payments they can use the same PayID each time

Configure like this:

• Multipayment = TRUE
• Expiry Time either empty or a far future date (e.g. 1 year away)
• Set Amount
• Set a PayID string for each of your customers and keep a record of it
• Optional: set PayID string to something short but meaningful to your customer, e.g. their initials plus 4 random digits @ your domain
• Important: every time you call the Payment Request for a specific customer you must always use the same PayID string for that customer

Example match type experiences

There are various scenarios managed by the Pay by Bank UX solution.

Specific amount requested

This happens when the PaymentRequest is NOT a multiPayment and amount value set when creating the payment request

Any amount accepted

This happens when the PaymentRequest is a multiPayment and there is no amount value set when creating the payment request

Incorrect amount paid

This happens when the PaymentRequest is NOT a multiPayment and the payer pays the wrong amount. Will indicate that the full amount was refunded and ask for the correct payment to be done.

Under payment

This happens when the PaymentRequest IS multiPayment, has a paymentAmount and the payer pays less than the amount required.
In this case the checkout widget will indicate that there is a remaining balance to be paid.

Overpayment

This happens when the PaymentRequest is multiPayment, has a paymentAmount and the payer pays more than the amount required.
In this case the checkout widget will indicate the payer that there was a refund for the excess and will take them to the confirmation page.
This is considered a success scenario.

Expired payments

The Pay by Bank UX solution polls for expired payments, which means once a customer fails to make a payment within the time set by you, the payment request expires and can no longer accept payments. The PayID associated with the payment request is deregistered. You can set the payment expiry time in the paymentExpiryDatetime field in PaymentRequest.

Redirect after payment

If you supply a query string parameter called redirectURL at the end of URL supplied in PaymentRequestStatus.checkoutUrl, then we will redirect your user to this URL after the payment has been received. The redirectURL must be url encoded. For example:

https://pay.azupay.com.au/v3/checkout/ZDk2YzkxYTUyYjYzYTIwMzk3?redirectURL=https%3A%2F%2Fwww.mywebsite.com%3Fmyparam%3Dsomething

The payer will be redirected to https://www.mywebsite.com?myparam=something

If you use the iframe version, the page will send events with changes on the Payment Request status so you can use these events to remove the iframe instead. Keep reading for more information about how to use the events generated by the iFrame.

Cancel redirect

The page will display a Cancel button if you supply a query string parameter cancelRedirectURL. The PayID associated with the payment request is deregistered when a user clicks Cancel.

The cancelRedirectURL must be url encoded. For example:

https://pay.azupay.com.au/v3/checkout/ZDk2YzkxYTUyYjYzYTIwMzk3?cancelRedirectURL=https%3A%2F%2Fwww.mywebsite.com%3Fpage%3Dhome

When the user clicks the Cancel button, then we will redirect your user to this URL (i.e. https://www.mywebsite.com?page=home