You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Prerequisites

  • Merchant account with Azupay
  • Your Azupay Secret and Distributable keys

Overview

The PayID solution adapted for commercial use by payment provider Azupay is pre-integrated into the CV ecommerce platform. Once enabled, it can be offered to customers as a payment option at checkout.    

Features

With the CV ecommece integation, the Azupay PayID bank transaction is automatically linked to an order/invoice number. Orders are automatically updated on receipt of payment status updates from Azupay.

Integration Features:

  • PayID offered as payment option at checkout (bank transfer in real-time)
  • Auto-linking of PayID transaction to order number (i.e., does away manual account reconciliation)
  • order auto-updates on receipt of Azupay payment updates (through API or webhook)
  • easy Azupay enabling, testing and setup in the CMS  
  • integration to Release Payments in the CMS (for rare cases of manual order releases) 
  • auto-send of email notifications at key stages of the PayID payment cycle (payment successful, pending and failed), 
  • ability to customise Azupay messaging on your platform to customers to suit your business needs.        


On this page:

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 

  1.  When a customer selects PayID during checkout, the system sends Azupay a payment request. A popup opens with Azupay-hosted information. This includes a unique single use Azupay PayID just for that specific order.

    Azupay PayID

    Azupay PayID is a string of characters that looks like an email address. Its 'username' is randomly generated but the domain name is meaningful to your business. (It can be your business domain name or another domain name given to Azupay.

    Here is an example: kew.i55@cvcommerce.com The username 'kew.i55' is randomly generated while 'cvecommerce.com' connects to the business.

    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, your customer can choose to pay by:
    1. copying the PayID and opening another tab or browser to access their bank account on the same device, or
    2. scanning the QR code with their mobile device and logging into their bank account there.

  3. Once in their bank account, they select to pay by PayID. They enter the PayID and the order amount and confirm payment. (The amount must be accurate.)

  4. Azupay receives payment confirmation from the payer's bank and sends a payment update to the CV ecommerce platform.

  5. On receipt of a 'COMPLETED' payment status, the popup closes and the order confirmation page is displayed.

Your Customer Experience


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

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


2. The shopper clicks Pay with PayID. The PayID popup opens with the PayID info directly hosted by Azupay. 

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

    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.

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

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

General Email Settings

  1. Default Payment Email Subject - This adds a phrase that appears in the Subject line of all PayID emails. Default: PayID Payment for {0}
     {0} - placeholder for Sales Order Number

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

  3. To save these settings, at the top of the page, click Save.



Related Resources

  • No labels

© Copyright 2001-2023 Commerce Vision Pty Ltd. Use of this site signifies your acceptance of Commerce Vision’s Terms & Conditions. CV Connect, the Commerce Vision logos, and other Commerce Vision marks are assets of Commerce Vision Pty Ltd.