Skip to main content

Getting Started

After completion of the onboarding process, you will be granted access to two environments; Sandbox and Production.

Sandbox will allow you to test the integration by simulating transactions scenarios and callbacks.

Production is where the real business payments happen.

Base URLS

The bases URLs are different for Sandbox and Production environments. The services endpoints will be available under the services guides in the product guides sections.

EnvironmentBase URL
Sandboxhttps://sandbox.api.gateway.lipad.io
Productionhttps://api.gateway.lipad.io

Using the Merchants Portal

From the merchants portal you can:

  • Set up callback URLs
  • Generate and manage API Keys
  • See all accepted payments
  • See financial statements
  • Manage account users
  • Control access levels
  • And much more

The dashboard URLS are as follows

EnvironmentDashboard URL
Sandboxhttps://sandbox.dashboard.lipad.io
Productionhttps://dashboard.lipad.io

APIs Authentication

All APIs use tokens for authentication. An x-access-token header is required for all calls to the APIs. The API keys for the tokens will be generated from the Merchant Portal.

Access token generation request:

curl -i -X POST \
https://sandbox.api.gateway.lipad.io/v1/auth \
-H 'Content-Type: application/json' \
-d '{
"consumer_key": "xxxxxxxxxx",
"consumer_secret": "xxxxxxxxxx",
}'

Succes Response

{
"access_token": "access_token",
"expiresIn": 6000
}

Error Response

{
"statusCode": 401,
"message": "Invalid Authentication Credentials",
"error": "Unauthorized"
}

Important: The API tokens are different between sandbox and production accounts. When moving from sandbox to production, a new API token must be generated using environment specific keys & urls. Please store the API secrets safely.

Setting up callbacks

The API is asynchronous, we recommend implementing a callback handler in your application to find out about the final status of your payments as soon as they are processed.

Testing the integration

For different test scenarios, head to testing

Note: It is not possible to see the authorization flows (i.e., entering the PIN prompt) in sandbox.