API Docs

Version History

Prerequisites

• For Sandbox (UAT)

Users should be onboarded on the iPOSpays sandbox (UAT) environment as a merchant and have a valid TPN.

• For Production (Live)

Users should be onboarded on the iPOSpays production environment as a merchant and have a valid TPN.

Generate an Authentication Token

To authenticate your API requests, you must include a valid token in the request header. This token is generated directly from the merchant portal.

Steps to Generate a Token:

Step 1: Log in to your merchant account via the iPOSpays Portal and go to the Settings section.

Step 2: Under the Generate Ecom/TOP Merchant Keys section:

• Select the appropriate TPN (Terminal Profile Number) from the dropdown list.
• Click Generate Token to create a new authentication token.
• The generated token will be displayed and must be used in your API request headers.

Need help? Watch this video tutorial for a guided walkthrough of the token generation process.

Endpoints and Request Method

Sample Request – Standard Card Transaction