APEXX Portal Guidelines V1.0


Modules


  • Login
  • Forgot Password
  • Dashboard
  • Administration
  • Organisation management
  • User Management
  • Transaction Management
  • Transaction Actions






Login



  • Provide valid Email address and Password and click on “Login” button to successfully login into APEXX Portal.

  • Click on Forgot Password link to reset your password



Forgot Password


  • Click on Forgot Password link on Login screen which will redirect user to Forgot Password screen

  • To Reset Password users need to enter the valid registered email address. After entering the valid email address “Send Reset Instruction” button will be enabled.

  • When the user clicks on the “Send Reset Instruction” button, email with reset password link will be provided to the user.

  • When user will click on the provided link the Reset Password email, He will be redirected to Reset Password Screen



  • User should enter the password as per given instructions on the Reset Password screen, User’s password will be reset when the user will click on Set new password after entering the valid password in New password and Confirm New password field.

  • After Resetting password, the user will be able to login with the New password.



Administration Organisation Management


Organisation List

  • This screen will provide the list of available organisations falls under the logged in user’s hierarchy.

  • Country 

    • Filters the list based on select Country.

    • Example: If user selects United Kingdom then the list of the organisations will only display the Organisations in this country

  • Parent Organisation

    • Filters the list based on the selected Parent Organisation.

    • Dropdown will display the list of organisations which fall under the logged in user’s Organisation.

  • Search 

    • It will search as a universal search which searches based on Organisation name and Parent Organisation Name.

  • Add Organisation

    • It will open one pop up from the right side of the page to add new organisation



Add Organisation

  • In this pop-up fields will be available to add new organisations.    



  • Fill up the mandatory data and click on the “Save” button to successfully add a new organisation.

  • Clicking on “Cancel” will redirect users to the Organisation List screen.


View Organisation Details

  • Clicking on any organisation available in the organisation list screen will redirect the user to View Organisation Details screen where the user can see the detailed data of the selected organisation.








  • At the bottom of the screen there are three buttons available.

    • Edit

    • Disable

    • Clone




Edit Organisation

  • By clicking on the Edit button on “View Organisation Details” screen system will redirect users to Edit Organisation Screen.


  • In the Edit screen below fields are not Editable

    • ID

    • Parent Organisation

    • Country

  • Clicking on the “Save” button will save the edited data.

  • Clicking on the “Cancel” button will not save any edited data and redirect the user back to the View Organisation Details screen.


Disable Organisation

  • It will disable the organisation and all the other organisations which falls under that organisation’s hierarchy.

  • In the Organisation List there will be “grey dot” displayed against disabled organisation which is shown in the image.




    


Clone Organisation

  • When the user click on the “Clone” button in View Organisation details screen on Pop-up will open from the right side of the screen with the details filled of the current organisation, which will work same as the Add organisation functionality.





  • Clicking on the “Save” button will create the new organisation and Clicking on “Cancel” button will close the clone organisation screen and redirect back to the View organisation details screen.




User Management

User List

  • This screen will provide the list of available User falls under the logged in user’s hierarchy.

  • Role

    • Filters the list based on select Role.

    • Ex: If user select : Administration then the list of the Users will only display the Users which have Administration as their role.

  • Organisation

    • Filters the list based on the selected Organisation.

    • It will display the list of Users which fall under the Selected Organisation

  • Search 

    • It will search as a universal search which searches based on User name and Email Id.

  • Add User

    • It will open one pop up from the right side of the page to add a new User.





Add User

  • In this pop-up fields will be available to add new organisations.    


  • Fill up the mandatory data and click on the “Save” button to successfully add a new User.

  • Clicking on “Cancel” will redirect users to the User List screen.



View User Details

  • Clicking on any User available in the User list screen will redirect the user to View User Details screen where the user can see the detailed data of the selected User.

  • Clicking on organisation name will redirect user to Organisation details page



  • At the bottom of the screen there are three buttons available.

    • Edit

    • Disable

    • Clone



Edit User

  • By clicking on the Edit button on “View User Details” screen system will redirect users to Edit User Screen.

  • Users can edit all the details except the ID.

  • Users can also assign multiple roles to other users.

  • Clicking on the “Save” button will save the edited data.

  • Clicking on the “Cancel” button will not save any edited data and redirect the user back to the View Organisation Details screen.



Disable User

  • It will disable User.

  • In the User List there will be “grey dot” displayed against disabled User which is shown in the image.


Clone User

  • When the user clicks on the “Clone” button in View User details screen on Pop-up will open from the right side of the screen with the details filled of the current User Except Email id field will be empty, which will work the same as the Add User functionality.



  • Clicking on the “Save” button will create the new User and Clicking on “Cancel” button will close the clone User screen and redirect back to the View user details screen.



Roles of Users and Authorities


  • Super User

    • Dashboard

    • View transactions

    • Capture, Cancel, Refund

    • Organisation (Add, Clone, Update, Disable)

    • User (Add,Clone, Update, Disable)

  • Administration

    • View transactions

    • Capture, Cancel, Refund

    • Organisation (Add, Clone, Update, Disable)

    • User (Add, Clone, Update, Disable)

  • Reporter

    • View transactions

  • Dashboard

    • Only Dashboard access

  • Operations

    • View transactions

    • Organisation (Add, Clone, Update, Disable)

    • User (Add, Clone, Update, Disable)

  • Customer Service

    • View transactions

    •  Cancel, Refund



Transaction Management


Transaction List Screen


  • This Screen will display all the transactions.

  • Currency

    • This will filter all the transactions based on the selected currency in the dropdown

  • Payment Method 

    • -This will filter all the transactions based on the selected Payment method in the dropdown

  • Account

    • This will filter all the transactions based on the selected Account in the dropdown

  • Staus

    • This will filter all the transactions based on the selected status of the transaction in the dropdown

  • Additional data

    • this dropdown will add the new columns such as 

      • Organisation

      • Processor

      • Card number


  • Search :

    •  User have drop down available to search using two criteria

      • Transaction id

      • Merchant Reference

  • System will display transaction of current day only, to search different days transaction user can select the dates from date range selector


Transaction Details

  • System will open popup from the right side of the screen which will display all the details of the transaction

  • On the top of the tab it will display Account name

  • These details will be displayed below account name

    • Card details (Masked)

    • Payment Method

    • Amount and Currency

    • Card will not display if payment is no done using the Card 

Example (APMs like Afterpay, Alipay)

  • There will be two tabs available in that popup

    • Overview

    • Actions




Transaction Overview

  • In this tab there are three sections available

  • In first section these below details will be available

    • Transaction ID

    • Reference

    • Processor

    • Channel


  • In second section Authentication details will be available




















Transaction Actions

Cardpay Transaction Updates

  • User can perform these below actions in Action tab of transaction

    • Capture Transaction

    • Void Transaction

    • Refund Transaction


Capture Transaction (Card pay)

  • User can do full and partial both types of the capture from action tab

  • To do the Full capture the transaction there is one amount field is available where amount of the transaction will be pre-loaded to capture, User only need to click on the capture button for Full Capture.

  • For Partial Capture User needs to change the amount manually in the field and then click on Capture.


Void Transaction


  • To void transaction User just need to click on the “Void Transaction” button.



Refund Transaction



  • To Refund the transaction user needs to enter the Amount and reason and then click on the Refund button.

  • For Full refund user needs to enter the full transaction amount and for partial refund user needs to enter Less than captured or full transaction amount.




AfterPay Transaction Updates

Capture Transaction

  • Full Capture

  • Partial Capture


Full Capture

    



  • To Full Capture there are not any fields are mandatory for AfterPay

  • User can full capture using these methods

    • By directly clicking “Full capture” without entering any values in fields

    • By entering Gross amount only

    • By entering Gross amount and Net Amount both


Partial Capture

    


  • To Partial capture the user needs to click on the add item, and fill the mandatory fields and click on “Capture button”.

  • Net Unit price required when user don’t provide the Vat Percent vice versa Vat percent is required when user don’t provide the Net Unit price


Full Void

    


  • To Full Void there are not any fields are mandatory for AfterPay

  • User can fully Void using these methods

    • By directly clicking “Full Void” without entering any values in fields

    • By entering Gross amount only

    • By entering Gross amount and Net Amount both


Partial Void

    


  • To Partial Void user needs to click on the add item, and fill the mandatory fields and click on the “Void Transaction button”.

  • Net Unit price required when users don’t provide the Vat Percent vice versa Vat percent is required when users don’t provide the Net Unit price.


Full Refund

    


  • User can fully refund the transaction just by clicking on “Full Refund” button without selecting the capture and item block


Partial Refund


    


  • For Partial Refund, the user needs to select the Capture and add the item details for the selected capture.

Viewing Refunds

The Transaction overview does not list refunded amounts separately. In order to view the amounts refunded to a given transaction, please navigate to Dashboards - Refund.






RELATED ARTICLES

How do I reconcile my bank statements with the data in the APEXX portal?