KOROMA
  1. Home
  2. API Docs

API Documentation

auth


auth is a service authentication request from a registered service to the platform. A registered consumer service should always auhenticate to gain access to the payment interfaces. A successfully authenticated service will receive a serviceid for use in subsequent API calls. The consumer is advised to check the atkerr parameter to fully ascertain the response status

Authenticated sessions must be ended at service shut down as the platform does not support interactive logins

Endpoint: https://koroma.co.za/auth

Payload:

  1. apikey - the registered service/application unique API Key
  2. passphrase - the registered service/application's corresponding passphrase
Test/Example:
  1. Authenticate your service/application and receive a serviceid for transacting as follows:
 https://koroma.co.za/auth
	
JSON Request
{
   "apikey": "39d1e9a8-0027-4ff1-bc13-44dfc1f8aabb",
   "passphrase": "passphrase123"
}



JSON Response
{
  "channelid": "a59b8e5dfd89cc751c6986d7faf9e0f94e82240177c7b288ba4661e...",
  "usertype": "CHANNEL",
}
Back to top