Here you will learn how users established by Merchants can operate with GlobalPay Merchant Dashboard – the web application where users can create or configure their websites, initiate refunds, operate the transactions (actions possible: view, filter, search, export in Excel format) and request and activate new payment methods for their account.
Upon the Registration process we have created for you a Dashboard TEST Account and an Online Boarding Account, with the same user email and password. Once you are registered you will be able to operate the transactions from your Dashboard Account at https://dashboardtest.smart2pay.com/ and also you can proceed in further completing the Onboarding process.
For test purposes, users will only have full access to the Payments tab in their Dashboard TEST Account. The others tabs and features will only be available in production environment.
After registration you can always access your Documentation, Dashboard TEST or Online Boarding Account by clicking on the appropriate link at the bottom of the page:
Please keep in mind that the features enabled at this stage are for test purposes only! In order to go live with the technical implementation of the payment methods acceptance and to start processing live transactions you must request access to a Live Dashboard account.
Payments List
Once you log in to Dashboard Account you are redirected to the Payments tab. Here you can see the complete list of all the transactions made with the payment methods assigned to your merchant account. You have the possibility to search for specific payments using different search filters, to see the details of the payment invoice and fee, and to export your payments into an Excel file.
Search filters
When you access the Payments tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search payments by: ID (the payment id in the GlobalPay system), Merchant Transaction ID (the payment id in your system), Method Transaction ID (used for transaction tracking and matching with customer receipt or bank statement), Method, Amount, Currency, Has Split Payments, Country, Status, Interval (from – to) and Site Alias.
In order to find a specific transaction, you need to fill at least one of the following search filters: ID, Merchant Transaction ID and/or Interval.
Payment Details
After you have found the transaction you’ve been looking for, using the proper search filters, just click on it to see the specific details of that payment.
A new window will open containing the general details for that Payment ID and also providing details about specific sections, like: Credit Card, 3D Secure, Fraud Check, Reporting, Flags, Reason Codes, Dispute and Invoicing.
Please note that Credit Card, 3D Secure and Dispute sections are specific and will only appear for credit card transactions!
Export transactions
The list of payments can be exported (filtered or not) to an .xls file. Click on the Export to EXCEL button at the end of the list of payments.
The downloaded file contains the following information: ID, Merchant Transaction ID, Originator Transaction ID, Input Date/Time, Amount, Currency, Status, Method Name, Status ID, Method ID, Method Transaction ID, Payment status date/time, SiteID, Site Alias, Country, ReasonCode and Reason.
The column Payment status date/time represents the time when the last final status was updated for that transaction.
Payment Details
Go to Payments tab from the main Dashboard menu and use the search filters to find a specific payment. After you have found the transaction you have been looking for, using the proper search filters, just double click on it to see specific details for that payment.
A new window will open containing the general details for that Payment ID and also providing details about specific sections, like: Reporting, Flags, Reason Codes and Invoicing.
Please note that Credit Card, 3D Secure and Dispute sections are specific and will only appear for credit card transactions!
The dashboard Payment Details allows the user to always find specific information in order to be informed and keep track of his day-to-day operations and transactions.
General provides detailed information for the following fields: ID of the transaction, Merchant Transaction ID, Input Date Time, Merchant ID, Merchant Site ID, Method ID, Merchant Alias, Merchant Site Alias, Method Name, Amount, Currency, Status, Available Amount, Captured Amount, Return URL, Description, Originator Transaction ID, Customer Name, Customer Email, Country, Specific Details, Method Transaction ID.
Fraud Check provides detailed information for the following fields: Status, Score and Reason.
Reporting provides detailed information for the following fields: Notification Date Time, Last Notified Status.
Flags provides detailed information for the following fields: Request Version, Request Type ID.
Reason Codes provides detailed information for the following fields: Reason Code and Reason.
Invoicing provides detailed information for the following fields: Invoiced as attempt on, Invoiced as success on, Gross Settlement Amount, Settlement Currency, Exchange Rate, Transaction Fee, General Fee, Issued Fee, Attempt Fee, LocalVat Fee, Repatriation Fee, VAT.
For credit card transactionsCredit Card, 3D Secure and Dispute sections are specific and will only appear for credit card transactions!
General provides detailed information for the following fields: ID of the transaction, Merchant Transaction ID, Input Date Time, Merchant ID, Merchant Site ID, Method ID, Merchant Alias, Merchant Site Alias, Method Name, Amount, Currency, Status, Available Amount, Captured Amount, Return URL, Description, Statement Descriptor, Originator Transaction ID, Country, Language, Specific Details, Method Transaction ID, Authorization Code.
Credit Card provides detailed information for the following fields: Masked Card Number, Card Expiration Month, Card Expiration Year, Card Holder Name, Credit Card Brand, Credit Card Sub-Brand, Credit Card Token.
3DSecure provides detailed information for the following fields: 3D Secure Check, 3D Secure CAVV, 3D Secure ECI.
Fraud Check provides detailed information for the following fields: Fraud Status Code, Fraud Score, Fraud Status ID, Fraud Response Description, Fraud Response Code, Fraud Counter, Fraud Check Mode.
Reporting provides detailed information for the following fields: Notification Date Time, Last Notified Status, Reported As Authorized Date, Reported As Captured Date, Reported As Charged Back Date.
Flags provides detailed information for the following fields: Request Version, Capture, Retry Counter.
Reason Codes provides detailed information for the following fields: Reason Code and Reason.
Dispute provides detailed information for the following fields: ID of the transaction, Status, Notification Date Time, Last Notified Status, Amount, Currency, Dispute Date Time, Created Date Time, Reason Code, Reason Code Name.
Invoicing provides detailed information for the following fields: Invoiced as attempt on, Invoiced as success on, Gross Settlement Amount, Settlement Currency, Exchange Rate, Transaction Fee, General Fee, Issued Fee, Attempt Fee, LocalVat Fee, Repatriation Fee and VAT.
Captures provides detailed information for the Capture ID: CreatedDateTime, Amount, Currency, CaptureAvailableAmount, PaymentStateDefID, Status, ReasonCode and Reason..
Initiate refunds
Our REST API allows you to refund any type of transaction, no matter of the payment method that was used.
For a complete list of refund types and refund type/types per payment method, please visit our Refund types section.
Full and/or partial refunds and can be initiated in two ways:
one via API, which is described in our Refunds API section: Create a refund;
one through GlobalPay Merchant Dashboard, which is described next.
Native Type – refund flow
Full or partials native refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
For the transactions where only full refund is accepted the Refund Amount will be the same with the Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A particular case is for Klarna payment methods where in order to initiate a refund you will need to provide the below additional parameters:
Merchant Article ID
Quantity
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see and verify the complete list of all of your refunds in the Refunds tab.
SEPA Bank Transfer Type –Refund flow
Full or partials SEPA Bank Transfer refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
In order that SEPA Bank Transfer refunds to be processed correctly you will have to fill the below details for customer and for customer bank account:
Customer Name
Customer IBAN
Bank Code/BIC
For more information about the refund types that require additional parameters, please see our section Refund types from Refunds API.
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
SWIFT Bank Transfer Type – refund flow
Full or partials SWIFT Bank Transfer refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
In order that SWIFT Bank Transfer refunds to be processed correctly you will have to fill the below details for customer and for customer bank account:
Customer Name
Customer Account Number
Bank Code/BIC
A particular case is for Brazil where SWIFT Bank Transfer refunds will require these additional parameters:
Customer Name
Customer Account Number
CPF Account Holder
Bank Name
Bank Code
Bank Agency Code
For more information about the refund types that require additional parameters, please see our section Get information for a refund from Refunds API.
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
Manual Support Work No Info Type – refund flow
Full or partials Manual Support Work No Info are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
SEPA Bank Transfer No Info Type – refund flow
Full or partials SEPA Bank Transfer No Info refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
In order to process the SEPA Bank Transfer No Info refunds, we will use the customer/customer bank account details stored in our system (this is the reason why no additional details/info is required).
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
SWIFT Bank Transfer No Info Type – refund flow
Full or partials SWIFT Bank Transfer No Info refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
In order to process the SWIFT Bank Transfer No Info refunds, we will use the customer/customer bank account details stored in our system (this is the reason why no additional details/info is required).
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
Full or partial Manual Support Work Details Needed refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with Success status.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
In order to correctly process Manual Support Work Details Needed refunds for Indonesia payment methods, you will have to fill in additional details for customer and customer bank account:
Customer Name;
Bank Name;
Bank Address;
SWIFT Code;
Account Number.
A particular case is for Japan (Konbini payment method) where Manual Support Work Details Needed refunds will require these additional parameters:
Customer Name;
Customer Account Number;
Bank Name;
Branch Number;
Description.
For more information about the refund types that require additional parameters, please see our section Refund types from Refunds API.
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
Local Bank Transfer 2 API – refund flow
Full or partials Local Bank Transfer 2 API refunds are made by using Initiate Refund button from Payments tab.
The Initiate Refund button is displayed only for transactions with status Success.
A pop-up window with the transaction details will be displayed. The Refund Merchant Transaction ID is automatically generated. You can change this ID by introducing your ID value.
If you want to perform a full refund you will have to fill Refund Amount with the same amount as Payment Amount.
In the case you want to perform a partial refund you have to fill the Refund Amount with a smaller amount than the Payment Amount. You can perform more than one refund for a transaction with the limitation that the sum of partial refunds to be smaller or equal than the initial paid amount.
The refunds for most LATAM payment methods are made by our local provider. In order for the refund to be processed the customer bank details are required and there are 2 possibilities:
the Customer bank details are sent in full in the request. In this case, the refund should be processed within 48 hours.
the Customer bank details are not sent in request. However, in this case, the local provider will contact the customer in order to obtain the bank details so the refund can be performed.
The refunds for India payment methods, do not require sending the customer’s bank details at all.
A confirmation message, that the refund request has been successfully sent, will be displayed:
You can see the complete list of all of your refunds in the Refunds tab.
Refunds List
Access the Refunds tab in order to see and verify your refund transactions. Here you can see the complete list of all of your refund transactions. You have the possibility to search for a specific refund using different search filters, to see the details of the refund invoice and fee, and to export your refunds into an Excel file.
Search filters for refunds
When you enter the Refunds tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search refunds by ID (the refund ID in GlobalPay system), Merchant Transaction ID (the transaction ID in your system), Interval (from – to), Initial Payment ID (the payment ID in GlobalPay system for which the refund was initiated), Method Name, Amount, Currency, Status, Refund Type, and Alias.
Please note that for SmartCards transactions there are specific additional search filters that will appear, like: Acquirer Ref Number!
In order to find a specific transaction, you will need to fill at least one of the following search filters: ID, Merchant Transaction ID and/or Interval.
Refund Details
After you have found the refund you’ve been looking for, using the search filters, just click on it to see the specific details of that refund.
A new window will open containing the general details for that Payment ID and also providing details about specific sections, like: Reporting, Reason Codes, Initial Payment details and Invoicing.
Export refund transactions
The list of refund payments can be exported (filtered or not) to an .xls file. Click on the Export to EXCEL button at the end of the list of refunds.
The file contains the following information: ID, Merchant Transaction ID, Originator Transaction ID, Input Date/Time, Initial Payment ID, Amount, Currency, Status, Status ID, Method, Method ID, SiteID, Site Alias, Refund Type, Method Transaction ID, ReasonCode and Reason.
Refund Details
Go to Refunds tab from the Dashboard and use the search filters to find a specific refund. After you have found the transaction you have been looking for, using the search filters, just double click on it to see specific details of that payment.
A new window will open containing the general details for that Payment ID and also providing details about specific sections, like: General information, Reporting, Reason Codes, Initial Payment details and Invoicing.
The dashboard Refund Details allows the user to always find specific information in order to be informed and keep track of his day-to-day transactions and refunds.
General provides detailed information for the following fields: ID of the transaction, Initial Payment ID, Input Date Time, Merchant ID, Merchant Site ID, Method ID, Merchant Alias, Merchant Site Alias, Method Name, Amount, Currency, Status, Merchant Transaction ID, Originator Transaction ID, Type, Description, Specific Details and Method Transaction ID / ARN.
Reporting provides detailed information for the following fields: Notification Date Time and Last Notified Status.
Reason Codes provides detailed information for the following fields: Reason Code and Reason.
InitialPayment provides detailed information for the following fields: ID, Merchant Transaction ID, Input Date Time, Amount, Currency, Status, Available Amount, Method ID, Method Name and Country.
Invoicing provides detailed information for the following fields: Invoiced as refund on, Gross Settlement Amount, Settlement Currency, Exchange Rate, Refund Fee and VAT.
For refunds of credit card transactions we will also be providing specific details, like: General information, Reporting, Reason Codes, Initial Payment details and Invoicing.
General provides detailed information for the following fields: ID of the transaction, Initial Payment ID, Input Date Time, Merchant ID, Merchant Site ID, Method ID, Merchant Alias, Merchant Site Alias, Method Name, Amount, Currency, Status, Merchant Transaction ID, Originator Transaction ID, Description, Statement Descriptor, Specific Details, Method Transaction ID / ARN.
Reporting provides detailed information for the following fields: Notification Date Time and Last Notified Status.
Reason Codes provides detailed information for the following fields: Reason Code and Reason.
Initial Payment provides detailed information for the following fields: ID, Merchant Transaction ID, Originator Transaction ID, Input Date Time, Amount, Currency, Status, Available Amount, Method ID, Method Name and Country.
Invoicing provides detailed information for the following fields: Invoiced as refund on, Gross Settlement Amount, Settlement Currency, Exchange Rate, Refund Fee and VAT.
Payouts Balances
Access the Payouts Balances tab in order to see and verify your payouts balances. Here you will find a complete list of all of your payouts balances. You have the possibility to search for a specific payout balance using different search filters.
Search filters
When you access the Payouts Balances tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search payouts by Method, Currency and Site Alias.
Payouts List
Access the Payouts List tab in order to see and verify your payouts. Here you will find a complete list of all of your payouts. You have the possibility to search for a specific payout using different search filters, to see the details of the payouts, and to export your payouts into an Excel file.
Search filters
When you access the Payouts tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search payouts by ID (the payment id in the GlobalPay system), Merchant Transaction ID (the payout id in your system), Method Transaction ID (used for transaction tracking and matching with customer receipt or bank statement), Method, Amount, Currency, Country, Status, Interval (from – to) and Site Alias.
Payouts Details
After you have found the transaction you’ve been looking for, using the search filters, just click on it to see the specific details of that payout.
A new window will open containing the general details for that Payout ID and also providing details about specific sections, like: General information, Credit Card, Reporting, Flags and Reason Codes.
Export transactions
The list of payouts can be exported (filtered or not) to an .xls file. The file contains the following information: ID, MerchantTransactionID, InputDateTime, Amount, Currency, Status, MethodName, StatusID, MethodID, MethodTransactionID, SiteID, Alias and Country.
Payout Details
Go to Payouts List tab from the dashboard and use the search filters to find a specific payout. After you have found the transaction you have been looking for, using the search filters, just double click on it to see specific details of that payout.
A new window will open containing the general details for that Payout ID and also providing details about specific sections, like: General information, Credit Card, Reporting, Flags and Reason Codes.
The dashboard Payout Details allows the user to always find specific information in order to be informed and keep track of his day-to-day operations and payouts.
General provides detailed information for the following fields: ID of the transaction, Merchant Transaction ID, Input Date Time, Merchant ID, Merchant Site ID, Method ID, Merchant Alias, Merchant Site Alias, Method Name, Amount, Currency, Status, Statement Descriptor, Originator Transaction ID, Country, Specific Details and Method Transaction ID.
Credit Card provides detailed information for the following fields: Masked Card Number, Card Expiration Month, Card Expiration Year, Card Holder Name, Credit Card Brand, Credit Card Sub-Brand.
Reporting provides detailed information for the following fields: Notification Date Time, Last Notified Status.
Flags provides detailed information for the following fields: Request Version.
Reason Codes provides detailed information for the following fields: Reason Code and Reason.
Preapprovals List
Access the Preapprovals tab in order to see and verify your preapprovals. Here you will find a complete list of all of your preapprovals. You have the possibility to search for a specific preapproval using different search filters, to see the details of the preapproval and all the payments associated with the preapproval.
Search filters
When you access the Preapprovals tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search preapprovals by ID (the preapproval id in the GlobalPay system, a unique number that identifies the preapproval in the GlobalPay system; you will need to store this id in order to initiate recurring payments.), Merchant Preapproval ID (the preapproval id in your system), Status, Method, Site Alias and Interval (from – to).
Preapprovals Details
After you have found the transaction you’ve been looking for, using the search filters, just click on it to see the specific details of that preapproval.
A new window will open containing the general details for that Preapproval ID and also providing details about all the payments associated with that preapproval.
Preapprovals Details
Go to Preapprovals tab from the dashboard and use the search filters to find a specific preapproval. After you have found the transaction you have been looking for, using the search filters, just double click on it to see specific details of that preapproval.
A new window will open containing the general details for that Preapproval ID and also providing details about all the payments associated with that preapproval.
The dashboard Preapprovals Details allows the user to always find specific information in order to be informed and keep track of his day-to-day operations and preapprovals.
General provides detailed information for the following fields: ID of the preapproval, Merchant Preapproval ID, Status, Method ID,Site ID, Site Alias, Merchant Alias, Merchant ID, Input Date Time, Description, Details, Maximum Amount, Currency, Method Option ID, Frequency, Mandate Reference.
Payments contains a list of all the payments associated with that preapproval and provides detailed information for the payment’s following fields: Payment ID, Merchant Transaction ID, Amount, Currency, Status, Method, Root Provider Transaction ID, Site, Country.
Disputes List
Access the Disputes tab in order to see and verify your disputes. Here you will find a complete list of all of your payments that are disputed by the customer. You have the possibility to search for a specific dispute using different search filters, to see the details of the disputes, and to export your disputes into an Excel file.
Search filters
When you access the Disputes tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search disputes by ID (the dispute id in the GlobalPay system), Initial Payment ID, Method, Amount, Currency, Status, Interval (from – to) and Site Alias.
Disputes Details
After you have found the transaction you’ve been looking for, using the search filters, just click on it to see the specific details of that dispute.
A new window will open containing the general details for that disputes ID and also providing details about specific sections, like: Reporting, Reason Codes, Initial Payment.
Export transactions
The list of disputes can be exported (filtered or not) to an .xls file. Click on the Export to EXCEL button at the end of the list of payments.
The downloaded file contains the following information: ID, Input Date/Time, Payment ID, Originator Transaction ID, Amount, Currency, Status, Status ID, Method, Method ID, Site ID, Site Alias, Reason Code and Reason.
Disputes Details
Go to Disputes tab from the dashboard and use the search filters to find a specific dispute. After you have found the transaction you have been looking for, using the search filters, just double click on it to see specific details of that dispute.
A new window will open containing the general details for that Dispute ID and also providing details about specific sections, like: Reporting, Reason Codes and Initial Payment.
The dashboard Dispute Details allows the user to always find specific information in order to be informed and keep track of his day-to-day operations and disputes.
General provides detailed information for the following fields: ID of the dispute, Initial Payment ID, Input Date Time, Merchant ID, Merchant Site ID, Method ID, Merchant Alias, Merchant Site Alias, Method Name, Amount, Currency and Status.
Reporting provides detailed information for the following fields: Notification Date Time and Last Notified Status.
Reason Codes provides detailed information for the following fields: Reason Code and Reason.
Initial payment provides detailed information for the following fields: ID, Merchant Transaction ID, Originator Transaction ID, Input Date Time, Amount, Currency, Status, Available Amount, Method ID, Method Name and Country.
REST API Configuration
In the Configuration section, the user can add and configure multiple websites for his account (REST API tab), set up his preferred payment methods to use (Payment Methods tab), and choose the look and feel of the payment page (User Interface tab).
Once you login to your Dashboard Account go to Configuration tab -> REST API, where you will be able to add and configure multiple websites.
You can have multiple websites from where you can initiate payments to GlobalPay system, each website having its own SiteID parameter.
The SiteID parameter will be generated by our system and it will allow us to identify the location from where the payment was initiated and the URL where we will notify you of the payment status. By using this parameter, you will be allowed to manage multiple websites under the same merchant account.
You can configure the SiteIDs from the REST API Configuration tab in the Configuration section.
You can also use various filters in order to easily identify each website, like: SiteID, Alias, URL, NotificationURL and IPlist.
Four possible actions can be performed for a website using the following buttons from the Actions column: Show ApiKey, Generate New API Key, Set IPs and Delete site.
Add Website
In order for you to add a new website you need to click on the Add a New Site button. A new window will appear and you need to enter the Alias for your site (an alternative name that identifies the website in the GlobalPay system), the URL of your site, the Notification URL where you want to receive the notifications for the payments initiated from that website, and the IP List. After you entered a valid URL, a Notification URL and an Alias, press OK and a SiteID will be generated for you.
Generate API Key
After the creation of the new merchant site, no API Key is generated for the new SiteID. In order to generate a new API Key, you need to press the Generate New API Key button from the Actions column of your new SiteID. You can see the generated API Key by pressing the Show API Key button .
Please make sure the API Keys are kept secret and regenerate at once if security has been compromised! It is recommended to use a different API Key for each SiteID to authenticate to the REST API.
Once an API Key for the SiteID is generated, this is the API Key used to authenticate to REST API for each payment initiated from that website and for each notification send to the NotificationURL set for that website.
The API Key is an important part of the payment flow; it is used to authenticate to the REST API. For more information, please visit our Authentication section.
Set IPs
You can configure the IPs for each SiteID from the REST API Configuration section in the Actions column. In order for you to whitelist your IP you need to click on the Set IPs button in the Actions column. A new window will appear and you need to enter a valid IP. After you enter the IP press the OK button.
Delete Website
You can delete a SiteID by pressing the Delete site button from the Actions column.
Payment Methods
Here you will find a complete list of all the payment methods, you can easily verify the list of payment methods assigned to your merchant account or to request and activate new payment methods of your choice.
When you access the Payment Methods tab you will see a complete list of all the payment methods available for your merchant account. You have the possibility to search for specific payment methods using different search filters and to see the description for each payment method.
You can search for a specific payment method using the search filters available: payment method’s status, name, description, guaranteed status and countries available.
A very important step during the configuration process is setting up your payment methods. In this section you will be able to configure the preferred way to receive your payments and setup your desired payment methods. The payment methods are selected for an account when the account is created, but they can also be changed at any time needed.
There are a few possible actions available, in order for you to have a better management over your merchant account, that are explained below:
Request a new payment method:
Using the first search filter from the top of the page, choose Can Request option from the dropdown list. A list of all the available payment methods that you can request for your account will appear.
Once you find the desired payment method, click the “+” Request sign in front of it to add it to your account,
A confirmation message will be displayed.
After you have requested the payment method, you need to wait for Smart2pay approval of the payment method. Also, you can check the list of all your requested payment methods by using the first search filter from the top of the page. Choose Approval in Progress option from the dropdown list and a list of all your requested payment methods for your account will appear.
Activate a payment method:
Using the first search filter from the top of the page, choose Can Activate option from the dropdown list. A list of all the payment methods assigned to your account that you can activate will appear.
Once you find the desired payment method, click the Activate option in front of it to activate it.
A confirmation message will be displayed.
You need to wait for Smart2pay approval for the activation of the payment method. Also, you can check the list of all your payment methods that are waiting activation by using the first search filter from the top of the page. Choose Activation in Progress option from the dropdown list and a list of all your payment methods waiting activation will appear.
Deactivate a payment method:
Using the first search filter from the top of the page, choose My Methods option from the dropdown list. A list of all the payment methods activated for your account will appear.
If you want to deactivate a specific payment method, click the Deactivate option in front of it.
A confirmation message will be displayed.
Ask for availability of a payment method:
For some payment methods you need to ask our support team for more details regarding its availability. You can check the list of all the payment methods that need further guidance from our support team by using the first search filter from the top of the page. Choose Ask Availability option from the dropdown list and a list of all the payment methods that need further guidance from our support team will appear.
Unavailable payment methods:
Some payment methods may be currently unavailable due to different external factors. You can check the list of all the unavailable payment methods by using the first search filter from the top of the page. Choose Unavailable option from the dropdown list and a list of all the unavailable payment methods will appear.
Rejected payment methods:
If the request of a payment method will have a negative outcome we will let you know. You can check the list of all the rejected payment methods by using the first search filter from the top of the page. Choose Rejected option from the dropdown list and a list of all the rejected payment methods will appear.
User Interface Configuration
The UIConfiguration tab from Merchant Dashboard is your tool to configure the look and feel of the payment page.
In order to create or edit new skins or change the merchant logo, you need to have assigned a role with at least the following access rights: UIConfiguration-View and UIConfiguration-Update.
When you access the UIConfiguration tab you will see a complete list with the skins of all the websites assigned to your account.
Select Site
You have the possibility to select a specific website using the Current Site drop down list, in order to view the skins assigned to it.
After selecting the required website you can view the skin by using the Preview function. You can see the ID of the skin in the top-right (e.g. 116) and the possible actions available on a skin: Preview, Edit and Delete. By sending in the initial post SkinId=116, the new skin will be used for the current payment.
After you select the Preview state, the possible actions available for a specific skin are: Edit and Delete.
Edit Skin
You have the option to display the payment page with full redirect (in a standalone page), in a lightbox on top of your website or in an IFrame embedded in your website. You can also add custom CSS code to change other components of the payment page. For more information regarding payment page customization, check our dedicated section here.
Create a Skin
The skins are created in the UIConfiguration page by clicking Create a Skin button.
You have the possibility to create a new skin for GlobalPay system, choosing to display the payment page with full redirect (in a standalone page), in a lightbox on top of your website or in an IFrame embedded in your website and you can add custom CSS code to change other components of the payment page.
You can dynamically instruct GlobalPay to display a certain skin, by specifying in the initial POST a value for the SkinID parameter. For more information, check our section Hosted Payment Page Skinning.
You have the possibility to create a new skin for SmartCards system, choosing to display the payment page with full redirect (in a standalone page), in a lightbox on top of your website or in an IFrame embedded in your website and adding custom CSS code to change other components of the payment page. Also you can choose the amount’s location inside the form: Form Top or Pay Button.
Upload All Sites Logo
You can upload a logo that the customers will see on the payment page and that will apply to all the websites assigned to your account:
select All from the Current Site drop down list;
go to All Sites Logo default picture and use the Upload button;
click Choose File, navigate to where the logo is stored on your disk, select the logo, click the Open button in the File Upload modal window;
click on the Upload button.
Change Site Logo
You can also change the current logo for a specific website. For a new logo that will apply only for that specific website:
select the desired website using the Current Site drop down list;
go to Site Logo picture and click on the Change button;
click Choose File, navigate to where the logo is stored on your disk, select the logo, click the Open button in the File Upload modal window;
click on the Upload button.
Delete Site Logo
To delete an existing logo for a specific website:
select the desired website using the Current Site drop down list;
go to the Site Logo picture and click on the Delete button.
Roles Administration
The first user created for a merchant (the one created from the registration form) has a default role assigned. This role (Administrator) has all the access rights existent in the GlobalPay system.
Please note that access to this Roles Administration section is only available in production environment!
Click on Add a New Role button and you can create a new role. In the new form that opens, in the General section, you need to provide a role name and a description to the role.
In the Access Rights section you can assign access rights for the new role. When finished, click Save and your role will be created. The role you have just created is visible in the grid. You can create as many roles as you like.
If you want to remove or add new access rights to a role, or simply modify the name or the description you can click on the Edit button from the grid. And, of course, you can delete the roles you don’t need anymore using the Delete button from the grid.
Users Administration
When entering this section you will see in the grid your user and all the users you have created. These are all the users associated with your Merchant ID.
Please note that access to this Users Administration section is only available in production environment!
Click on Add a New User button and you can create a new user. In the new form that opens, in the General section, you need to provide a User Name and a User Email.
In the Roles section you can assign specific roles for the new user. You can assign to the new user one or more of the roles you have previously created.
In the Sites section you can assign specific websites to the new user. When finished, click Save and your new user will be created. Click Save and the new user will be saved and he will receive an email with the password. The User you have just created is visible in the grid. You can create as many users as you like.
Please note that a new user can also be created via API by submitting a POST HTTP request.
If you want to change user name or user email, remove or add roles or update the websites assign to an already created user, you need to click on the Edit button in the grid.
And, of course, you can delete the user accounts that do not serve you anymore using the Delete button from the grid.
In the Edit section you can also generate a new password for that specific user. When clicking Generate new password an email will be sent to that user with the new password.
Please be aware that if you assign a user a certain role (that contains specific access rights), that user will only have access to that restricted area defined by that role (and implicitly by the access rights).
Example:
You provide User1 with Role1 that includes NotificationURL-Update access right and Signature-Update access right. This means that User1 will only see two tabs when entering the dashboard: Account and Configuration. And he will have the right to generate a new signature and modify the Notification URL.
An update access right implicitly contains the view access right.
Example:
If the user has only one role that only contains the access right Signature-Update, that user will be able to see the Signature section and update the signature.
If the user has only one role that contains only Signature-view, that user will be able to access the Signature section, but won’t be able to update the signature.
Settlement Cycles
In order to view and access the Invoicing tab you need to have assigned to your dashboard user account the proper access rights (Invoicing-view).
Nuvei is managing a complex schedule of settlements, and depending on the payment methods you are using, you can be settled in various cycles with various cutoffs.
By accessing the Invoicing tab->Settlement Cycles view, you can see important information on the invoicing/settlement cycles, invoice date, cutoffs and if any invoices are expected to be delayed. You have the possibility to search for specific cycle using different criteria.
Search filters
When you access the Invoicing tab->Settlement Cycles view, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search invoices by using the following filters:
Invoice Type
Invoice Type
Definition
Settlement Invoice – contains the fees and the payments; Settlement Report: contains only the payments; and Invoice: contains only the fees
: Settlement Invoice – contains the fees and the payments; Settlement Report: contains only the payments; and Invoice: contains only the fees;
Invoice Cut Off
Invoice Cut Off
Definition
The time period for which the transactions will be invoiced
: the time period for which the transactions will be invoiced;
Settlement Currency
Settlement Currency
Definition
The currency in which the settlement was made
: the currency in which the settlement was made;
Site Alias
Site Alias
Definition
The merchant identification name in our financial system according to his SiteID previously configured
: the merchant identification name in our financial system according to his SiteID previously configured;
Method
Method
Definition
The name of the payment method used and assigned for a specific settlement cycle
: the name of the payment method used and assigned for a specific settlement cycle;
Next Invoice Date
Next Invoice Date
Definition
The date when the next invoice is to be generated
Next Invoice Date: the date when the next invoice is to be generated;
Next Invoice Interval
Next Invoice Interval
Definition
The interval when the next invoice is to be generated
: the interval when the next invoice is to be generated;
On Hold
On Hold
Definition
If set to no, invoices will be automatically generated and process by the system. If set to yes, it will be manually processed by our financial team when certain conditions are met
: if set to no, invoices will be automatically generated and process by the system. If set to yes, it will be manually processed by our financial team when certain conditions are met.
Method Balance
By accessing the Method Balance tab, you can see for each method the converted balance from the transaction (merchant) currency to the settlement currency in the calculated amount field.
Please note that the converted balance value from the calculated amount field is an approximate value based on the current exchange rate.
This means, you have the possibility to see the currency and the amount for a specific method in which you have initiated the payment and the amount for that specific method in the settlement currency.
Search filters
When you access the Method Balance tab, the Search Filters section is expanded. In order to collapse it just click the arrow on the right of the screen.
You can search methods by using the following filters:
Method Name
Method Name
Definition
The name of the payment method used and assigned for a specific settlement cycle
: the name of the payment method used and assigned for a specific settlement cycle;
Merchant Currency
Merchant Currency
Definition
The currency in which the merchant has made the payment
: the currency in which the merchant has made the payment;
Settlement Currency
Settlement Currency
Definition
The currency in which the settlement will be made
: the currency in which the settlement will be made.
Invoices
By accessing the Invoices tab, you can see all of your invoices and when they were generated. You can also search and view a specific invoice by introducing either the invoice number or the total amount in the appropriate text boxes.
You can search invoices by using the following filters:
Interval
Interval
Definition
The time period in which a specific invoice was generated
– the time period in which a specific invoice was generated;
ID
ID
Definition
The ID of the invoice
– the ID of the invoice;
Invoice Number
Invoice Number
Definition
The number of the invoice
– the number of the invoice;
Total
Total
Definition
The total amount of the invoice
– the total amount of the invoice.
You have the possibility to download a specific invoice in XLS, PDF or CSV format or to download all of the invoices into the appropriate format. Invoices will be sent on email, and they can also be generated in CSV format in SFTP upon request.
Show ApiKey, 
Generate New API Key, 
Set IPs and 
Delete site.
