API Reference
Start typing to search…

Using the 'Try It!' Feature

The 'Try It!' feature appears on the API reference page for each API request, allowing you to test the request without leaving this site. This section walks you through using this feature, and it provides an example of testing a Payment Gateway API 'Sale' request as a merchant.


Prerequisites

Merchants:

Partners:

Perform the tasks below to use the 'Try It!' feature.


1. Select a function

Use the left-hand navigation on this site to navigate to the API request you wish to test.

💰

Example: Sale Request

In the left-hand navigation, expand 'Payment Gateway' and select 'Sale (Auth + Capture).'


2. Check the base path

Make sure you are using the Sandbox environment. Under 'URL,' check that the Base URL is shows https://api-test.qualpay.com. Use the 'Base URL' drop-down menu to select the correct base path, if needed.

💰

Example: Sale Request

Select https://api-test.qualpay.com/pg. This generates the URL https://api-test.qualpay.com/pg/sale.

📘

NOTE: The Base URL also indicates whether the resource is part of the Platform (platform) or Payment Gateway (pg) API:

  • Platform - The Platform API provides access to the features of the QualPay platform like customer boarding, reporting, and recurring billing. URLs include platform after the first /.
  • Payment Gateway - The Payment Gateway API provides the functionality related to submitting transactions for processing and handling protected data. URLs include pg after the first /.

3. Input request data

Input your request data by doing one of the following:

  • Manual entry - Go through the parameter fields and input data for the request, paying attention to 'required' fields and conditional requirements.
  • Auto-populate - If it is available for your function, you can auto-populate the request with sample data. To do so, click the 'EXAMPLES' drop-down menu in the box of sample code, then select 'Request Example.' Fill in any parameter fields that require authenticating information, such as merchant_id.
💰

Example: Sale Request

Click 'EXAMPLES' and then 'Request Example.' Put your merchant ID in the merchant_id field. If you are a Qualpay Partner testing on behalf of a merchant, you should also put your vendor ID in the vendor_id field.



4. Input credentials

Input your testing credentials as follows (see Prerequisites to get your credentials):

  • If you are a merchant, enter your API key in the password field.
  • If you are a vendor, enter your vendor API key in the password field. (The vendor ID is also referred to as the integrator ID.)
💰

Example: Sale Request

Enter your merchant API key in the password field.


5. Try It!

Select 'Try It!' in the box of sample request code.

💰

Example: Sale Request

Select 'Try It!'


The test response will appear in the 'RESPONSE' box, below the sample request code.