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
In the Payment step during checkout, the shopper selects to pay by PayID.
A popup opens with Azupay-hosted information. This includes a unique single use Azupay PayID just for that specific order.
| Info | ||
|---|---|---|
| ||
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. |
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.)
Azupay receives payment confirmation from the payer's bank and sends a payment update to the CV ecommerce platform.
On receipt of a 'COMPLETED' payment status, the popup automatically closes and the order confirmation page is displayed.
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
In the CMS, go to Settings → Settings → Feature Management → Payment & Checkout → EFT, BPAY & PayID Payments.Click Configure.
In Payment, set to Orders Only.
In Mode, set to Sandbox if testing or Production for PayID to be live.
In Azupay Webhook End Point, enter the following: /api/AzupayWebHookHandler
Depending on what was entered in step 6, go to Production Settings or Sandbox Settings.
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 | ||
|---|---|---|
| ||
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. |
In Order PayID Expiry, enter how long (in minutes) a generated PayID is active before it is deactivated.
| Info |
|---|
|
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
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
BCC Emails to Internal Recipients (optional)
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.The shopper copies the email address, logs into their bank account and makes a bank transfer for the order. Instead of entering your bank account details, they just have to enter the PayID email address.
How CV ecommerce uses a PayID: a PayID email address is always linked to a specific order and payment amount for a one-off payment.
Your store name, order and amount is displayed to payer after PayID is entered during online banking
PayID Properties
A PayID for order payment is:
unique: 'email' string randomly generated by Azupay for a specific payment request tied to a specific order
single-use: can only be used once successfully before being deactivated
amount-controlled: payer entered bank transfer amount must match the payment request's
time-limited: unused PayID will expire and be deactivated
Azupay's maximum and default expiry is 48 hours (2880 mins)
CV ecommerce's default expiry is is 48 hours (2880 mins). NOTE - Bank security checks can delay payment completion and a PayID must be active when the bank sends payment confirmation to Azupay.
If a PayID is deactivated, payment is automatically rejected (refunded back to source) by Azupay.
set to be deleted by certain events:
the user clicks Cancel on the Azupay popup during checkout
the user session times out (session time outs)
the PayID expiry date/time passes.
| Panel | ||||
|---|---|---|---|---|
Topics:
|
PayID & Order Payments
When your customer selects to pay by PayID, the system sends Azupay a request that contains:
- your Azupay client ID
- the client transaction ID (order number)
- payment description (reference added in the Azupay dashboard about payment. Default: your business + order number)
- payment amount
Azupay's response contains the above and also:
- the payment request ID
- a unique PayID
- request creation date and time
- PayID expiry date/time
- payment request status of 'WAITING'
| Info | ||
|---|---|---|
| ||
Think of the PayID email address as a customer-facing tool. It lets a shopper pay for their order by bank transfer without the need to know or enter your full bank account details. In fact, they only see the PayID. But for official record-keeping as a payment method, a lot of other details are recorded. For your team and CV ecommerce's payment and order systems, it is important to know which PayID email address was used or not used for which order. It is possible for a shopper to have generated more than one PayID against an order. (Don't worry, only one PayID can be active againsts one order at any time.) And a PayID is eventually deregistered and deleted. Then there are the interests of other stakeholders invested in the payment transaction, i.e., Azupay, the payer's bank, your bank, etc. For each PayID generated, Azupay records a bunch of details that is or can be of use for payment, or later on if payment or non-payment needs to be traced. The Payment Request ID is the official record identifier name that keeps together all the details of a PayID email address. You can use it to officially track a PayID payment to an order. CV ecommerce also records the Payment Request ID as part of an order payment record. |
PayID Payment Tracking
It is possible for more than one PayID to be generated per order. For example, the user selects to pay by PayID and the payment request generates a PayID. They click Cancel, automatically deactivating that PayID. They select PayID as payment again. A new PayID request is generated with a new PayID.
To track which payment request was used to pay for an order, it is best to track or verify payment using the Payment Request ID. This ID is always linked to a specific PayID and is included in any payment update sent or received by Azupay. In CV ecommerce, it is added in PayID payment notification emails to customers and as part of the PayID payment record on the Release Payments page.
For full details of the PayID transaction and status, check the payment in the the Azupay Dashboard.
| Expand | ||
|---|---|---|
| ||
|
PayID Payment Statuses
Azupay marks one of these statuses against a generated PayID instance:
COMPLETE- the PayID was used to successfully pay for the order and Azupay has received confirmation from the payer's bank- NOTE - the PayID Payment Request record with 'complete' status also includes: completed date/time, amount received, payer entered reference (if any)
WAITING- the PayID was generated against the order BUT Azupay has not yet received confirmation from the payer's bank AND the PayID has not expired.NOTE - you can only delete a
PaymentRequestthat is inWAITINGstatus
EXPIRED- no acceptable payment was received before the PaymentRequest expiredRETURN_IN_PROGRESS- a payment was received but is in the midst of being returned to the source accountRETURN_COMPLETE- the payment was returned to the source account
PayID Emails
The system provides four PayID customer notification emails that are auto-scheduled to send when certain payment events occur. Each updates the buyer with their PayID payment record and any status updates. You can also set these emails to be bcc'ed to relevant team members.
All emails include the PayID for internal tracking and payment enquiries by customers. See: Azupay PayID Emails
Release Payments
Coming soon
Your team members can manually release or reject a PayID payment, or check its status by using the Release Payments feature. Search by receipt number or order/invoice number. Payment details include the Payment Request ID.
Related Resources
| Content by Label | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Content by Label | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| Content by Label | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|