Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

PayID is an electronic bank transfer payment option that completes transactions more quickly than standard direct debit. The PayID solution by payment provider Azupay is integrated into the CV ecommerce platform. Once enabled, it can be offered to customers as an order payment option at checkout.    

Info
iconfalse
titlePrerequisites
  • Merchant account with Azupay
  • Your Azupay Secret and Distributable keys



Panel

On this page:

Table of Contents


Step-by-step guide

1.  Enable and Configure EFT Payments at the System level: 

  1. Login to the CMS.
  2. Navigate to 'Settings' --> 'Settings'.
  3. Select the 'Orders' tab.
  4. Select the 'Credit Cards' tab.
  5. Tick 'Allow EFT Payment'.
  6. Tick the 'Hold Bpay & EFT Payment' setting if required.
    • Holding EFT payments ensures a Cash Receipt is not created until the payment is released in the 'Release Payments' screen (see How to release EFT and BPAY Payments for instructions).
  7. Populate EFT Bank Details:
    • EFT Bank Name
    • EFT Bank BSB
    • EFT Bank Account No
  8. Tick 'Enable EFT for Online Orders' (unless EFT should be accepted for Account Payments only).
  9. Tick 'Integrate EFT/BPAY Orders Immediately' if required.
    • This enables EFT orders to integrate to PRONTO immediately, rather than being held online until the payment is released via 'Release Payments'.
  10. Click 'Update' to save changes.
    Image Removed
     

2. Add the 'Release Payments' page to the CMS 'Other' menu.  

  • In the CMS, navigate to 'Advanced Content' --> 'Resources'. 
  • In Resource Maintenance, search for 'adminpage' - this should return 'rcCssAdminPageAdditions'.
  • Click 'Modify'.
  • Enter 'ReleaseCustPayments.aspx' in the Resource Value (if there are values already present, separate them with a comma).
  • Click 'OK' to save. 
    Image Removed
  • The 'Release Payments' page will now show in the 'Other' menu of the CMS. 
    Image Removed
    Tip
    titleTIP

    If the Release Payments page does not appear in your 'Other' menu after following these steps, it may not exist in your Administrator menu (CSSADMIN).

    You will need to add 'ReleaseCustPayments.aspx' to your Admin menu so the CMS can access it. See Add a New Menu Item for instructions.

    Image Removed

    3. Customise the EFT Payment Email:

    1. In the CMS, navigate to 'Content' --> 'Emails'.
    2. Select the 'EFT Payment Detail Email' template.
    3. Click 'Edit' on the EFT Payment Detail widget. 
    4. Update instruction text and other email content as required. Widget documentation can be found here - EFT Payment Detail Widget.
      Image Removed 
    5. Test output using the 'Test Email' button in the template. 
      Image Removed 

    Optional Settings

    It may be desirable to deny EFT access to certain roles, leaving them with credit card payment options only. Similarly, a particular role can be configured to use different EFT payment details from the system default.

    Warning

    Keep in mind that Role settings will override the System settings.

    To Update Role Level EFT Settings:

    1. In the CMS, navigate to 'Users' --> 'Roles'.
    2. Select the required role via radio button. 
    3. Select the 'Functions' tab.
    4. Click 'Modify'.
    5. Update the role-based EFT options as required:
      • EFT Role Payment Mode:
        • Enable role-based EFT - enables EFT payments for the role, utilising the role-level EFT settings (overriding system settings).
        • Deny EFT to users in this Role - excludes users in this role from accessing EFT payment functionality, even if it is enabled at the System level. 
      • EFT Payment Instructions Template - n/a for BPD sites - leave blank.
      • EFT Bank Details Resource Code - the Resource Code for the system resource containing the format string used to render EFT bank details for this role.
      • EFT Bank Name
      • EFT Bank BSB
      • EFT Bank Account No  
    6. Click 'OK' to save. 
      Role-based EFT OptionsImage Removed 
    Tip

    Not using BPD and the CMS? Find instructions for our classic sites here - EFT Payments (classic sites).

    Related help

    Enable Azupay PayID

    1. In the CMS, go to Settings → Settings → Feature Management → Payment & Checkout → EFT, BPAY & PayID Payments.

    2. Click Configure.
      Image Added

    3. In the EFT, BPAY and PayID Payment Settings page, click on the Azupay tab.
      Image Added
    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
      titleProduction 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.


    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. 

    Image Added

    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

    Content by Label
    showLabelsfalse
    max5
    spacesKB
    showSpacefalse
    sortmodified
    reversetrue
    typepage
    cqllabel = "payment" and label = "cms" and type = "page" and space = "KB"
    labelspayment settings cms