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.

1 Merchant Sites Configuration

You can also use various filters in order to easily identify each website, like: SiteID, Alias, URL, NotificationURL and IPlist.

1 Search filters

Four possible actions can be performed for a website using the following buttons from the Actions column: 27 Show ApiKey, 26 Generate New API Key, 24 Set IPs and 29 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.

1 Add a new site

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 26 from the Actions column of your new SiteID. You can see the generated API Key by pressing the Show API Key button 27.

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.

1 Reset API Key

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 24 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.

Set IPs

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.

75

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.

75

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.

83

75

After you select the Preview state, the possible actions available for a specific skin are: Edit and Delete.

75

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.

75

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.

76

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.

76

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.

76

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.

76

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.

76