Getting Started

Explore our guides to manage and disburse payments on our online portal for our merchants. Explore the Tabs on the top (Administration, Manager, Operator) to review all the actions each role can perform.

There are three user roles for an account on the portal. Each role has access to a different set of actions and reports.

Administration

The user has access to all transaction reporting, funding reports, billing report, portal settings, user account management, bulk payee upload and funding account balance.

Manager

The user can manage user or team member accounts, approve transactions that are above threshold and perform disbursements. The manager can only view transactions they have submitted or the team members they manage have submitted.

Operator

The user can perform disbursements and only view transactions they have submitted.

Dashboard

Navigate to the Dashboard page by selecting Dashboard from the navigation menu on the left.

On the Dashboard page, the following data is available for viewing:

Data Description
Transaction Count Number of transactions performed during the specified transaction period
Total Transaction Volume Total dollar amount of transactions performed during the specified transaction period
Account Balance Overall merchant account balance
Transaction Volume Graph showing number of transactions performed daily during the specified transaction period
Services Graph showing total dollar amount of transactions performed using each service during the specified transaction period
Payees Graph showing the number of transactions performed by new payees and existing payees during the specified transaction period

To specify a transaction period, select the period you wish to view from the dropdown menu located on the top right of the Transaction Volume graph.

To view the number of transactions performed on a particular day, hover over the bar representing that day in the Transaction Volume graph to reveal a popup window with the data.

To view the total dollar amount of transactions performed using a particular service, hover over the segment representing that service in the Services graph to reveal a popup window with the data.

To view the number of transactions performed by each payee group, hover over the segment representing the payee group in the Payee graph to reveal a popup window with the data.

User Management

View users

Navigate to Manage Users by selecting User Management drop-down list from the menu on left.

To display a specific user, search by first name, last name, email, employee code or user role using the search bar located at the top left of the user table.

To view additional details about a user such as user status and manager information, click on the Eye icon in the Actions column.

Click on the user's column label of your choice to display the list in ascending order according to the column chosen.

Choose the number of rows displayed by selecting a number on the Show dropdown list.

Add user

Click on Add user button located at the top right.

Enter user Information as specified on the form. All fields with * are mandatory and must be completed to proceed. Select Add button to add a new user. A user can be assigned a Operator or Manager Role. A Operator account must be associated to a Manager. The new user added will receive an email and/or SMS to setup their account.

Edit user

Click on Edit button at the right side of the Eye button. Update user Information. Select Update button to save updated Operator’s information.

Add bulk users

Navigate to Add Bulk Users by selecting User Management drop-down list from the menu on left.

Click on Browse button to find your User CSV file. Once found, click on Upload button. You can download a sample file by selecting Download Sample File link. Added users will be displayed on the Manage Users page found under the User Management drop-down list from the menu on the left.

Payee Management

View payees

Navigate to Manage Payees by selecting Payee Management drop-down list from the navigation menu on the left.

To view all individual payees, select the Individual tab from the menu located above the payee table. To view business payees, select the Business tab.

Click on the payee's column label of your choice to display the list in ascending order according to the column chosen.

Choose the number of rows displayed by selecting a number on the Show dropdown list.

To display a specific payee, search by payee ID, first name, last name, email or phone number using the search bar located at the top left of the payee table.

To view additional details about a payee such as birth date, address, custom fields and KYC information, click on the Eye icon in the Actions column.

To export payee data into a CSV file, click on the Export CSV button located at the top right of the page. If the Individual tab has been selected, only individual payees will be exported into the file. If the Business tab has been selected, only business payees will be exported.

Edit payee

Click on the Edit icon - located to the right of the Eye icon in the Actions column - to navigate to the Edit Payee page.

Note: for SelfPay payees, the edit feature will not be accessible unless the payee’s information has been updated with date of birth, address and, if required, KYC information.

On the Edit Payee page, a form will be displayed with payee information. Update payee information as needed and click on the Update button to save changes.

Delete payee

Click on the Trash Can icon - located to the right of the Edit icon in the Actions column - to permanently delete a payee.

Add bulk payees

Navigate to Add Bulk Payees by selecting Payee Management drop-down list from the navigation menu on the left.

Click on the Download Sample File link to download a sample file to populate with payee data.

Click on the Browse button to find the CSV file that has been populated with payee data.

Once a file has been selected, click on the Upload button to save payees.

Portal settings

Set notifications

Navigate to Notifications by selecting Portal Settings drop-down list from the menu on left. Toggle on or toggle off Allow SMS or Allow Email and click on Update button to enable users and payees to receive notifications via email and/or SMS.

Edit SMS notfications

Toggle on Allow SMS and click on Update button to reveal Edit SMS notifications link. Click on Edit SMS notifications link to navigate to the SMS notifications page. To display a specific SMS notification, search by name or body. To edit an SMS notification, click on the Edit icon from the Actions column. Update the SMS notification as needed and click on Update button to save changes.

Edit Email notifications

Toggle on Allow Email and click on Update button to reveal Edit email notifications link. Click on Edit Email notifications link to navigate to the Email notifications page. To display a specific email notification, search by name, subject or body. To edit an email notification, click on the Edit icon from the Actions column. Update the email notification as needed and click on Update button to save changes. To view an email notification, click on the Eye icon in the Actions column.

Configure settings

Navigate to Settings by selecting Portal Settings drop-down list from the menu on left. You can view and edit fields such as Approval Amounts, Low Balance Threshold, Logo, Favicon, Session Timeout, Login Attempts. Toggle on or toggle off Enable to Two Factor Authentication to enable or disable authentication before logging into the portal. After editing desired fields, select Update button to save changes.

The following Fields are available for view.

Field Name Description
Approval Amount Any amount greater will require Manager Approval
Low Balance Threshold Minimum balance amount
Session Timeout Specified minutes before automatic logging out of the portal
Login Attempts Number of attempts before account lockout

View custom fields

Navigate to Custom Fields by selecting Portal Settings drop-down list from the menu on left. To display a specific custom field search by label, page, datatype, descriptor. Select the Custom Fields’ column label of your choice to display the list in ascending order according to the column chosen. Choose the number of rows displayed by selecting a number on Show dropdown list.

Add a custom field

Click on Add Custom Fields button at the top of the list on the right side. Enter Custom Field Information as specified on the form.

Field Name Description
Label The name of the new custom field
Associate With The custom field will be related to either a Payee record or a transaction record
Is Required If yes checked off, custom field will be mandatory
Use Custom Field as Descriptor Custom field can be added as a dynamic suffix and will be appear on the payees bank statement. Only one Custom field can be added as a descriptor.
Data Type The type of custom field

Finally, select Add button to add a new custom field.

Delete a custom field

Select the red trash can icon on the left side of Edit icon to delete a custom field. This is not recommended as it may remove historical data.

Reports

View funding report

Navigate to Funding Report by selecting Reports drop-down list from menu on left. Select a specific previous date by using the date picker. Only funding details for previous dates are calculated. Once a date has been specified, select Filter to view Funding Details.

The following Fields are available for view.

Field Name Description
SOD Balance Start Of the Day balance
PreFunding Deposits Balance Added
Settled Transactions Transaction completed
Aggregate Exceptions Failed Transactions
EOD Balance End Of the Day balance

View monthly billing

Navigate to Monthly Billing by selecting the Reports drop-down list from the navigation menu on the left.

Select a month using the month picker at the top. Once a month has been specified, click on the Filter button to retrieve billing information for that particular month.

The following fields are available for viewing depending on the services used:

Field Name Description
Invoice Id Unique Invoice Identifier
Program Setup One-time fee for setup and activation of services.
Service Fee Fee collected to pay for services provided.
Mastercard Unit Price Cost per Mastercard transaction performed.
Mastercard Total Transactions Number of Mastercard transactions performed.
Mastercard Total Total billed amount for Mastercard transactions performed.
VISA Unit Price Cost per VISA transaction performed.
VISA Total Transactions Number of VISA transactions performed.
VISA Total Total billed amount for VISA transactions performed.
EFT Unit Price Cost per Electronic Fund Transfer performed.
EFT Total Transactions Number of Electronic Fund Transfers performed.
EFT Total Total billed amount for Electronic Fund Transfers performed.
Total Card Load Fees Total billed amount for prepaid cards loaded.
Total Card Issuance Fees Total billed amount for prepaid cards issued.
Cards Issued Number of prepaid cards issued.
Cards Reloaded Number of prepaid cards loaded.
Card Load Fee Cost per prepaid card loaded.
Card Issuance Fee Cost per prepaid card issued.
Subtotal Total billed amount excluding tax.
Tax (HST) Total tax charged.
Total Total billed amount.

View transaction report

Navigate to Transactions by selecting Reports drop-down list from menu on left. Select From and To date to specify transaction period. Once dates have been specified, select Filter. Export the transaction report by clicking Export CSV button. To clear filter select Refresh.

The following Fields are available for view.

Field Name Description
Date of Transaction Date of the transaction performed
Transaction ID Unique Transaction’s Identifier
Disbursement Number Debit card number, EFT bank account number, Prepaid card Hash
Payee Receiver of Funds
Payment Type Debit card/EFT/Prepaid card
Disbursement Country Country where the disbursement is performed
Destination Country Country where the amount is sent
Amount Amount Sent
Currency Country currency
Status Current Status
Message Details of Status
Digital Card Program View Complete Details of Transaction

Transaction status list

Status Message Description
Submitted Disbursement is in process You have initiated a transaction and disbursement information is successfully written in the company's database.
Success Disbursement is accepted Your disbursement information is sent to Mastercard and is accepted.
Settled Disbursement is settled Funds have been settled.
Not Submitted Disbursement is incomplete You have initiated a transaction and later stopped it in between.
Not Submitted Constraint checks failed You have entered invalid data in fields for Payee Information.
Not Enough Balance Merchant does not have enough balance You have processed a transaction with amount higher than the available balance.
Pending Review AML check failed and will be checked manually AML check is in progress
Approval Pending Approval from Manager is pending You have processed a transaction with amount higher than approval amount set and should be approved by manager.
Approval Rejected Disbursement approval has been rejected Your Manager has rejected the Disbursement.
Transaction Limit Exceeded Transaction limit exceeded You have processed a transaction with amount higher than transaction limit set per transaction.
Refused Not authorized No valid API key provided.
Refused Unknown Disbursement ID The Disbursement ID provided is not valid
Error Resource error There is an unavailability of resources to process payment.
Failed Resource error Web server is not accessible.
Failed System error There is an unavailability of resources to process payment.
Failed Invalid input length Merchant Category Code is Missing
Failed Invalid input format Values contained an invalid character
Failed Missing required input You have not entered the mandatory data fields for the Payee.
Failed Limit exceeded You have exceeded the limit for the transaction.
Failed Account not eligible for receiving funds Receiver’s account is not eligible to receive funds.
Failed Amount exceeds network limit Daily limit for total transaction amount has been exceeded.
Failed Invalid card type Payee Card is not supported.
Failed Reversal The disbursement has been reversed.
Failed Chargeback Chargeback was initiated by the Issuer
Failed Representment A financial transaction originated by an Acquirer to partially or wholly recover funds charged back to the Acquirer by an Issuer.
Failed Network error A relevant Receive Network reconciles a transaction differently than how it was processed
Failed Cut-off timing A Relevant Receive Network did not settle on the expected cutoff date.
Failed Amount mismatch Partial approvals are not supported for payments by the relevant Receive Network; however, if a transaction settles in an unexpected currency, this exception reason will appear.
Declined Declined Multiple reasons a disbursement has been declined.

Merchant Information

View merchant information

Navigate to Merchant Info from menu in the lower left. You can find the Overall Balance, Apt-Send info and merchant information. Select Apt-Send info to view the available balance and transaction information. Select merchant information to view primary information, address and contact information.

Send Bulk Disbursement

Select disbursement method

Navigate to Send Bulk Disbursement by selecting Send Disbursements drop-down list from the navigation menu on the left.

Select a disbursement method from the available options. After selection, click on the Next button to proceed to the Download Template step.

Download template

Click on the Download Import Template button to download a zip folder containing a template file to populate with payment data. The zip folder will also contain a readme file with instructions on how to fill out the template file. Please ensure you read the readme file thoroughly before filling out the template file. When this step is completed, click on the Next button to proceed to the Upload CSV File step.

Upload CSV file

Click the file you wish to upload with the left mouse button, then, without releasing the button, drag it to the upload area marked by the dotted box, and release the mouse button to drop it.

Alternatively, click the browse button to open the file selection dialog, find the file you wish to upload, select it and click on the Open button.

To remove the currently selected file, click the Remove button located to the right of the file name.

When this step is completed, click on the Next button to proceed to the Review Disbursement Data page.

Review disbursement data

Prior to processing the bulk disbursement, review the disbursement data and ensure that all fields are accurate. Once the fields have been verified, click on the Process Disbursement button.

Process disbursement

Clicking on the Process Disbursement button will trigger a dialog box asking you to verify the total bulk disbursement amount. This amount is the total sum of all the individual disbursements uploaded using the csv file. Once the amount has been verified, check the box to indicate that you have reviewed the disbursement data and that you understand that the funds cannot be reversed once a disbursement is processed. After the box has been checked, click on the Process Disbursement button to submit the payment.

Upon submission, a message will be displayed indicating the disbursement’s status. For further details about each disbursement, click on the Go to Transactions button to navigate to the Transactions page.

Manage Team Members

As a manager you can invite and manage other team members. Each team member will be assigned the Operator role and are referenced as Operators on the platform.

View Operators

Navigate to Manage Operator from menu on left. To display a specific Operator search by first name, last name, email or employee code. To view details about a Operator, click on the Eye button in Actions column. Select the column header of your choice to display the list in ascending or descending order. Choose the number of rows displayed by selecting a number on Show dropdown list.

Add Operators

To invite a team member, select the Add Operator button at the top located on the top right side. Enter team member Information as specified on the form. All fields with * are mandatory and must be completed to proceed. Finally, select Add button to add a new Operator. Once the Add button has been selected, the team member or Operator added will receive and email to setup their disbursement portal account.

Edit Operators

Click on Edit icon from the Actions column. Update Information as required on the form. Select Update button to update team members account information.

Manage Transactions

You can approve or reject disbursement transactions as a Manager. Only disbursement transactions that are processed by your team members will be assigned to you for approval. The threshold amount of the transaction for approval will be specified by the platform Administrator.

View pending approval disbursements

Navigate to Pending disbursements by selecting Disbursements dropdown from menu on left. You can now view the details for the disbursement transaction for approval. Select the eye icon to view the full details for the disbursement transaction.

Approve pending disbursement

Click on Approve Icon or Reject Icon button in Actions column to accept or reject specific disbursements. Once Approve or Reject button selected, confirm your decision. The transaction will remain on hold and in Approval Pending Status until the transaction is approved or rejected.

View transaction reports

Navigate to Transactions by selecting Disbursements dropdown from menu on left. Select From and To date to specify transaction period. Once dates have been specified, select Filter. To clear filter select Refresh.

The following Fields are available for view. Select the eye icon under Actions to view the complete details for the transaction.

Field Name Description
Payee Receiver of Funds
Disbursement Amount Amount Sent
Date/Time Time of Transaction
Status Current Status
Message Details of Status
Actions View Complete Details of Transaction

Transaction status list

Status Message Description
Submitted Disbursement is in process You have initiated a transaction and disbursement information is successfully written in the company's database.
Success Disbursement is accepted Your disbursement information is sent to Mastercard and is accepted.
Settled Disbursement is settled Funds have been settled.
Not Submitted Disbursement is incomplete You have initiated a transaction and later stopped it in between.
Not Submitted Constraint check failed You have entered invalid data in fields for Payee Information.
Not Enough Balance Merchant does not have enough balance You have processed a transaction with amount higher than the available balance.
Pending Review AML check failed and will be checked manually AML check is in progress
Approval Pending Approval from Manager is pending You have processed a transaction with amount higher than approval amount set and should be approved by manager.
Approval Rejected Disbursement approval has been rejected Your Manager has rejected the Disbursement.
Transaction Limit Exceeded Transaction limit exceeded You have processed a transaction with amount higher than transaction limit set per transaction.
Refused Not authorized No valid API key provided.
Refused Unknown Disbursement ID The Disbursement ID provided is not valid
Error Resource error There is an unavailability of resources to process payment.
Failed Resource error Web server is not accessible.
Failed System error There is an unavailability of resources to process payment.
Failed Invalid input length Merchant Category Code is Missing
Failed Invalid input format Values contained an invalid character
Failed Missing required input You have not entered the mandatory data fields for the Payee.
Failed Limit exceeded You have exceeded the limit for the transaction.
Failed Account not eligible for receiving funds Receivers account is not eligible to receive funds.
Failed Amount exceeds network limit Daily limit for total transaction amount has been exceeded.
Failed Invalid card type Payee Card is not supported.
Failed Reversal The disbursement has been reversed.
Failed Chargeback Chargeback was initiated by the Issuer
Failed Representment A financial transaction originated by an Acquirer to partially or wholly recover funds charged back to the Acquirer by an Issuer.
Failed Network error A relevant Receive Network reconciles a transaction differently than how it was processed
Failed Cutoff timing A Relevant Receive Network did not settle on the expected cutoff date.
Failed Amount mismatch Partial approvals are not supported for payments by the relevant Receive Network; however, if a transaction settles in an unexpected currency, this exception reason will appear.
Declined Declined Multiple reasons a disbursement has been declined.

How to Send Disbursements

Setup your account

Open the email from My Disbursements and click on the Setup your account link. Enter your new password and confirm password, then click on the Create Password button.

Sign in

Navigate to the Merchant Portal URL. Enter your email and password, then click on the Sign in button.

Tip: Click on the password eye icon to enable you to check what you are typing for your password.

Note: To reset your password, click on the Forgot Password? link. Enter your email address and select Send Reset Link. Follow the instructions in the email to reset password.

Select payee

Navigate to the Send Disbursement page by selecting Send Disbursement from the navigation menu on the left.

To add a new payee, toggle the New Payee? switch to Yes.

To select an existing payee, click on the Search for Existing Payee drop-down menu and enter the payee's name or email.

Set the amount

Enter the amount to be sent to the payee in the Amount field.

Select disbursement method

For new payees, select a disbursement method from the available options under Disbursement Methods.

For existing payees, existing disbursement methods may be available for selection. To choose an existing disbusement method, click on Choose Disbursement Methods.

Select an existing disbursement method, then click on the Continue button. (Make sure to review existing disbursement method details with the payee prior to selecting.)

Once a disbursement method has been selected, click on the Next button to proceed to the next page.

Enter new payee information

Enter payee information as specified on the form. All fields with * are mandatory and must be completed to proceed. All statements must be read to the payee and verbal consent is required to mark the statement checked. Once information has been entered, click on the Next button to proceed to the next page.

Enter new payee KYC

Enter all additional payee information required for the Know Your Customer (KYC) as specified on the form. All fields with * are mandatory and must be completed to proceed. Collect valid ID from the payee and enter information. Verify the photo on the ID for likeness with the payee and make sure the document is not expired. As the Operator collecting the information, check the box to indicate that you have met with the payee and verified their ID. Once information has been entered, click on the Next button to proceed to the next page.

Enter payment card details

Enter the payment Card Number and Valid Thru date, then click on the Next button to proceed to the next page.

Verify transaction

Prior to disbursing funds to the payee, verify that all the payment details are correct. Once verified, click on the Process Disbursement button.

Process disbursement

Clicking on the Process Disbursement button will trigger a dialog box asking you to verify the payee name and the disbursement amount. Once the disbursement information has been verified, check the box to indicate that you have reviewed the disbursement details and that you understand that the funds cannot be reversed once a disbursement is processed. After the box has been checked, click on the Process Disbursement button to submit the payment.

Upon submission, a message will be displayed indicating the disbursement’s status. For further details about the disbursement, click on the Go to Transactions button to navigate to the Transactions page.

How to Request a Payment

There are a multitude of options available to receive payments regardless of the Role assigned to the account. Listed here are outlines of what is possible in the Receive Payments portal.


Navigating the Receive Payments Portal Dashboard

Receive Payments

The Receive Payments dashboard is a powerful tool that offers a robust array of information, segmented into numerous metrics. The dashboard can be accessed by clicking the Receive option in the upper-left corner of the portal and then clicking on the Dashboard function.

Transaction Count - The transaction count is the number of transactions completed during the indicated period.

You can change this information by changing the transaction volume period value in the drop-down.

Total Transaction Volume - The total transaction volume is the total value of transactions, in dollars, for the selected pay period.

Account Balance - The account balance metric measures the overall merchant balance for the selected pay period.

Transactional Volume - This displays the total number of transactions completed during the specified pay period. You can see a numeric value displayed for the day by hovering over the bar on the graph.

Services - This is a graph that displays the total number of transactions, in dollars, processed during the selected pay period. You can also see the total dollar amount processed by transactions listed by service. This information is in the circle graph labeled services in the upper right corner.

Highlighting a specific segment of the circle graph will display the type of service utilized.

Payees- This graph projects the number of transactions performed by all payees during the selected pay period. Payee information is displayed as a circle graph in the bottom right corner.

You can view the number of transactions actioned by each payee group by highlighting the segment of the circle graph associated with each group.

Receiving Payments Through the Receive Payments Portal

Receive Payments

You can request payments through the AptPay portal. To do so, click on the Receive Payments drop-down and select Receive Payment.

New Payor

If this is a new payer, click on the New Payor switch.

Provide the monetary amount requested.

Select if you are requesting money or if you are receiving payment and click Next to proceed. Depending on what you have chosen, you can now follow the instructions listed in either Requesting Money or Receiving Payment.

Existing Payor

If this is an existing payer, leave the switch deselected for New Payor.

Click on the drop-down menu labeled Search for existing payor. You can search for specific records by typing in the record desired.

A pop-up will appear asking you to confirm that this is the correct information. Click Close.

Select if you are requesting money or if you are receiving payment and click Next to proceed.

Depending on what you have chosen, you can now follow the instructions listed in either Requesting Money or Receiving Payment.

Requesting Money

Fill out the information requested by the form.

Once complete, click on Next to proceed.

You will be then brought to a confirmation page, where you can review the transfer. Once satisfied, click on Process Disbursement to complete the transaction.

You will be prompted to confirm the request. Click the check box to confirm that the details provided are correct and click Process Payment.

You should receive a Receive Payment Submitted notification if the transaction was successfully processed. Click on Go to Transactions to redirect to the Transactions notification page.

Receiving Payment

To create a payment reception request, click on Receive Payment.

You will be brought to a screen to confirm the request. If the information looks correct, click Process Payment.

After confirming that the details are correct, click the checkbox that acknowledges the information has been reviewed and click Process Disbursement to finish processing.

You should receive a Receive Payment Submitted notification if the transaction was successfully processed. Click on Go to Transactions to redirect to the Transactions notification page.

Receiving Bulk Payments Through the Disbursement Portal

Receiving Bulk Payments

To receive bulk payments, click on Receive Bulk Payment located inside the Receive Payments drop-down menu.

You will be asked for the method used to receive the payment request. As of this writing, only direct funds transfers are supported. Click Next.

Click Download Import Template. This will download an excel file that you will need to populate.

Click on the pop-up that appears in the bottom-left corner of your browser to open the file.

Populate the fields requested by the spreadsheet.

Once completed, save the excel file. Back in the portal, click Next to continue.

Click browse.

This will open a pop-up. Navigate to where you saved the excel file and click Open to load the file.

This will load the file. Click Next.

This will prompt you to review the data inside the file. If correct, click Process Disbursement.

After confirming that the details are correct, click the checkbox that acknowledges the information has been reviewed and click Process Disbursement to finish processing.

You should receive a Payment Submitted notification if the transaction was successfully processed. Click on Go to Transactions to redirect to the Transactions notification page.

Viewing Transaction Data in the Receive Payments Portal

To view transaction data for received payments, click on Transactions located inside the Review Payments drop-down.

This will display a list of transactions processed during the specified time period. If no date range is specified, the time frame will default to today’s date.

To change the reported date range, click on the calendar options in the upper left corner.

When satisfied with the range, click on Filter to process the report.

Transaction data is organized into several fields, which are listed and defined below:

Field Name Description
Payor The name of the payor.
Receive Payment Amount Amount received for the transaction.
Submitted Date / Time Returns date and time in which transaction was submitted.
Status Current status of the processed request.
Message If there are additional details for the status of the request, it will be displayed here.

You can view additional details for each transaction by clicking on the Eye icon to the right of the recrd.

This will provide a new window that will provide additional details.

These fields are listed and defined below:

Field Name Description
Payor The name of the payor.
Amount Amount received for the transaction.
Currency Type of currency utilized. The information is displayed as a three-letter code.
Payment Method The type of payment method used.
Status Current status of the processed request.
Message If there are additional details for the status of the request, it will be displayed here.
Transaction Number Unique identifier used to track request in the system.
Paid At Date and time in which transaction was paid.