Page History

About PayID & Azupay

PayID is an electronic bank transfer payment option that completes bank-to-bank payments more quickly than standard direct debit, often in real-time. It also

avoids the need to give out the payee's bank account details.

You might have used the

PayID version offered by most banks

to pay someone. You log into your bank account and

enter the payee's account-linked mobile phone number instead of their bank acount and BSB

. Learn more: PayID

Unlike a

one-

off PayID that

links the payee's account by mobile phone number, Azupay

PayID

ties a bank transfer

transaction to a specific order (order/invoice number) placed on your ecommerce store. This

means deposits in your bank account do not need to be manually reconciliated against placed orders. 

Learn more: Azupay PayID

Azupay & CV ecommerce 

Customer experience

1. In the Payment step during checkout, the shopper selects to pay by PayID.

   Image Added

2.  When your customer selects the Pay with PayID button, the system sends Azupay a payment request.
   
   

3. A popup opens with Azupay-hosted information. This includes a unique single use Azupay PayID just for that specific order.
   

   Info
   title About the Azupay PayID
   Azupay PayID is a string of characters that looks like an email address. Its 'username' is randomly generated but the domain name

1. is meaningful to your business. (It can be your business domain name or another domain name

1. given to Azupay. Here is an example

1. : kew.i55@cvcommerce.com

1. The username 'kew.i55' is randomly generated while 'cvecommerce.com'

1. connects to the business

1. .

1. Image Added The 'email' PayID is really for the customer's use. It is linked to the Client Transaction ID, a reference for that particular payment request. If the customer pays for the order using this PayID instance, the transaction is recorded against the Client Transaction ID. This information is available in your Azupay account dashboard.

   
   

2. With their order still in checkout with the Azupay popup open, your customer can make the bank transfer by:
   1. copying the PayID and opening another tab or browser to log into their bank account on the same device, OR
   2. scanning the QR code into their mobile device and logging into their bank account there.
      
      
3. In their bank account, they select to pay by PayID. They enter the unique PayID and the order amount and confirm payment. (NOTE - The amount must be accurate or payment will be rejected.)
   
   
4. Azupay receives payment confirmation from the payer's bank

1. and sends a payment update to

1. the CV ecommerce platform

Your Customer Experience

1. In the Payment step during checkout, the shopper selects to pay by PayID.

Image Removed

All PayID text and labels can be edited in the Checkout Payment Options Widget.

1. .
   
   
2. On receipt of a 'COMPLETED' payment status, the popup automatically closes and the order confirmation page is displayed.
   
   
3. The customer receives a PayID payment successful email and the order is subject to your usual order progression procedures.  

Receiving Azupay Payment Updates

The system is pre-integrated to use the Azupay API to request/receive data or else a webhook to receive payment updates. See: Azupay API Referene     

Step-by-step guide

Enable Azupay PayID

1. In the CMS, go to Settings → Settings → Feature Management → Payment & Checkout → EFT, BPAY & PayID Payments.
   
   
2. Click Configure.
   
   
   
3. In the EFT, BPAY and PayID Payment Settings page, click on the Azupay tab.
   
   
4. Toggle ON Enable/Disable PayID payment on your site. TIP - Use the Override system to enable PayID for a restricted set of users. 
   
   
5. In Payment, set to Orders Only.
   
   
6. In Mode, set to Sandbox if testing or Production for PayID to be live.
   
   
7. In Azupay Webhook End Point, enter the following: /api/AzupayWebHookHandler
   
   
8. Depending on what was entered in step 6, go to Production Settings or Sandbox Settings.
   
   

9. Enter the Settings for either Production or Sandbox. NOTE - These details come from Azupay.
   - Client ID
   - API Secret Key
   - API Distributable Key
   - URL - NOTE - Sandbox URL is: https://api-uat.azupay.com.au/v1
   
   

   Warning
   title Production API Secret Key
   The Production API Secret Key must be stored and handled carefully. Azupay recommends that the key be visible only to authorised users in your organisation. The Secret Key can be used to make outbound payments to any Australian bank account.

   
   
   

10. (optional) In Payment Description, enter a description that will be included in transaction details of payments customers make. NOTE - Your business name and the order number automatically populates.
        

11. In Order PayID Expiry, enter how long (in minutes) a generated PayID is active before it is deactivated.
    

    Info

    A minimum of 1440 minutes (24 hours) should be entered. This ensures the PayID remains valid should there be delays in payment processing. For example, payment response may be delayed due to security checks by the customer's bank. Azupay automatically deregisters a PayID after 48 hours of no response.  Regardless of the PayID Expiry entered here, the CV ecommerce platform will request PayID deactivation if the user's session ends without a response from Azupay. Once deactivated, a PayID cannot be used for the payment.

    
    

12. Save the settings. At the top of the page, click Save.
    
    
13. To test the settings entered can successfully communicate with Azupay, click Test Settings.  

Edit Email Templates and Settings (optional)

PayID payment notifications are automatically sent to customers who paid by PayID and their payment is in a specific status. 

• PayID Payment Successful - Payment is confirmed by Azupay as 'completed'; a pending payment has been changed from 'pending' or 'waiting' to 'completed' manually in Release Payments.
• PayID Payment Pending - The customer has clicked the 'Confirm Payment' button in the Azupay modal during checkout BUT Azupay has not verified payment is 'completed'.   
• PayID Payment Unsuccessful - A pending PayID payment never received a 'completed' status from Azupay and the PayID has been deregistered; the payment has been changed to unsuccessful manually in Release Payments. 
• PayID Payment Refunded - When a PayID payment needs to be refunded and you log into the Azupay portal to process these refund, a notification is passed through from Azupay and your site sends through this email to the end user indicating the refund has been processed

You can access each email template from this page by clicking on each template. 

Image RemovedImage Added

General Email Settings

1. Default Payment Email Subject - This adds a phrase that appears in the Subject line of all PayID emails except the refund email. Default: PayID Payment for {0}
    {0} - placeholder for Sales Order Number
   
   
2. Default Payment Refunder Email Subject - This adds a phrase that appears in the Subject line of the refund PayID email. Default: PayID Refund for {0}
    {0} - placeholder for Sales Order Number
   
   
3. BCC Emails to Internal Recipients (optional)
   1. Toggle ON Send PayID Emails to Internal Recipients
   2. Type in an email address, then press Enter. TIP - Multiple email addresses can be added.
      
      
4. To save these settings, at the top of the page, click Save.

Manually Release or Cancel PayID Orders 

For most payments, the automated PayID payment flow will work as expected. Payments are either completed or failed, and pending orders are updated. Order status will change automatically based on payment status. On the rare occasion where a PayID payment needs to be manually done, use the Release Payments feature. A payment can be approved or rejected. Approving a payment will release an order that is on hold. Rejecting a payment will cancel the order. NOTE - Payments for integrated orders cannot be changed using Release Payments.        

Related Resources