Versions Compared

Key

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


Info
iconfalse
titleFor Order Payments Only

This

reference guide

article relates only to single use PayID order payments.

Currently,

Azupay PayID currently cannot be used for account payments.

 For an order payment, the unique

Learn more: Azupay PayID

Azupay PayID & Orders

An Azupay PayID is a unique single

payment PayID that is linked to

use 'email address' generated at checkout for a specific payment request for a specific order (number).

 

Learn more: Azupay PayID

About PayIDs on the CV ecommerce Platform

PayID use for order payments have built-in attributes to let a buyer make a one-off payment of a specific order. A generated PayID

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

Image Added


PayID Properties

A PayID for order payment 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
    • NOTE - Bank security checks can delay payment completion and a PayID

needs to
    • must be active when the bank sends payment confirmation to Azupay. 

    • If

the
    • a PayID is deactivated, payment is automatically rejected (refunded back to source) by Azupay.  

requested for deactivation by your site when
  • set to be deleted by certain events:

    • the user

selects the
    • clicks Cancel

button
    • on the Azupay popup during checkout

    • the user session times out (session time outs)

    • the PayID expiry date/time passes.




Panel

Topics:

Table of Contents
indent18px



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
titleWhat is the Payment Request ID?

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, 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 PayID transaction and status, check the payment in the the Azupay Dashboard.

    Expand
    titleExample...

    Image Added


    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 Each updates the buyer 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 updates without having to log in to the Azupay dashboard to check

    The All emails will always 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

    Content by Label
    showLabelsfalse
    max20
    spacesKB
    showSpacefalse
    sortmodified

    Azupay PayID Emails 

    Related Resources

    reversetrue
    typepage
    excludeCurrenttrue
    cqllabel = "azupay" and type = "page" and space = "KB" and title ~ "'Azupay PayID payments'"
    labelspayment settings cms

    Content by Label
    showLabelsfalse
    max20
    spacesKB
    showSpacefalse
    sortmodified
    reversetrue
    typepage
    excludeCurrenttrue
    cqllabel = "widget" and type = "page" and space = "KB" and title ~ "'checkout payment optionspayid'"
    labelspayment settings cms

    Content by Label
    showLabelsfalse
    max20
    spacesKB
    showSpacefalse
    sortmodified
    reversetrue
    typepage
    excludeCurrenttrue
    cqllabel = "azupaywidget" and type = "page" and space = "KB" and title ~ "'checkout payment options'"
    labelspayment settings cms