Page History

Azupay PayID & Orders

A PayID is a unique single

use 'email address' generated for a specific payment request for a specific order (number). The customer uses the PayID to make a PayID bank transfer in their bank account. 

Learn more: Azupay PayID

About PayIDs on the CV ecommerce Platform

PayID use Use of PayID for order payments have has built-in attributes to let a buyer make make sure it can only be used for a one-off payment of for a specific order.

A generated PayID is:  

• unique: 'email' string is 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). (You can change the expiry in CMS Azupay settings. But note that bank security checks can delay payment completion and a PayID needs to be active when the bank sends payment confirmation to Azupay. If the PayID is deactivated, payment is automatically rejected (refunded back to source) by Azupay.  

• requested

  for deactivation

  to be deleted by your site when:

• complete - the PayID was used to successfully pay for the order and Azupay has received confirmation from the payer's bank
• waiting - the PayID was generated against the order; Azupay has not yet received confirmation from the payer's bank  

  • the user selects the Cancel button on the Azupay popup during checkout

  • the user session times out (session time outs)

  • the expiry

    date/time passes.

PayID Payment Statuses

Azupay marks one of these statuses against a generated PayID instance:

• • passes.

NOTE - For single use PaymentRequest, once the payment has been completed, the associated PayID is de-registered automatically and deleted after 12 months. You can still search for it after 12 months in the Azupay dashboard.

PayID & Order Payments

When your customer selects to pay by PayID, your 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 PayID
• the payment request ID
• request creation date and time
• payID expiry date/time
• payment request status (WAITING)

At checkout, the customer sees only the PayID but that is only one part of the whole PayID request record. The record has a unique identifier - Payment Request ID.

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, payment should be tracked and verified it is best to track or verify payment using the Payment Request ID. This ID is tied always linked to a specific PayID and is always included when in any payment data is update sent or received by Azupay.

NOTE - The Payment Request ID is not displayed to the customer on the Azupay popup during checkout. Only the PayID is displayed. But when the buyer successfully pays using that PayID, the bank transfer is recorded in Azupay against the Payment Request ID.       

Azupay Dashboard

A PayID payment can always be tracked on your Azupay dashboard. Payment details include:

• the Payment Request ID
• sales order number (generated by your system)
• current payment status.  

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 bank transfer transaction, use the Azupay Dashboard.

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 PaymentRequest that is in WAITING status

• EXPIRED - no acceptable payment was received before the PaymentRequest expired
• RETURN_IN_PROGRESS - a payment was received but is in the midst of being returned to the source account
• RETURN_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 PayID payment events occur. They provide your customer with their PayID payment record for their purchase and any needed status updates. You can also set these emails to be bcc'ed to relevant team members so they are alerted to receive updates without having to log in to the Azupay dashboard to check. 

All emails include the PayID and its Payment Request ID for internal tracking and payment enquiries by customers.  See: Azupay PayID Emails 

Release Payments

Coming soon

Your team members can check the status of an Azupay payment manually release or reject a PayID payment, or check its status by using the Release Payments feature. Payment details can be found by entering the order Search by receipt number or order/invoice number. Payment details should include the Payment Request ID.

Related Resources