API Documentation

channel authentication

channel authentication is a request from a registered channel to authenticate on the platform. The Status field in the response will contain the value CHANNEL_AUTHENTICATED for a successfully authenticated channel. Use the channelid in all subsequent transaction requests.

Other response statuses are;
UNABLE_TO_ESTABLISH_SESSION: authentication was successful but the channel session could not be established
INVALID_APIKEY_AND_OR_PASSWORD: the apikey or password or both might be invalid

Endpoint: https://koroma.co.za/v1/transact

Payload:

The fields required for authentication using the transact interface are:

1. apikey - the registered channel API Key
2. password - the registered channel's corresponding password

1. Note that, the platform does not require you to send request header information
2. Authenticate your channel and receive a channelid for transacting
3. Once authenticated, you can start transacting

 https://koroma.co.za/v1/transact
	
JSON Request
{
    "apikey": "",
    "password": ""
}

JSON Response
{
    "channelid": "",
    "status": "",
    "submitTimeUtc": "",
    "errorInformationReason": "",
    "errorInformationMessage": ""
}
						

Back to top