atk
    Simplified payment gateway integration
  1. Home
  2. API Docs
  3. atk UI

API Documentation

payment authorization


Authorizes the amount for the transaction.

Replace the cardnumber with cardpan or cardtoken where applicable (e.g tokenized card)

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

Payload:

  1. channelid - the channel identifier received at successful authentication
  2. clientrefcode - the payment transaction identifier
  3. cardnumber - the payment card number
  4. cardmonth - two-digit month in which the payment card expires in the format 01/1-12
  5. cardyear - four-digit year in which the payment card expires
  6. cardcvv - card Verification Number
  7. amount - order amount (decimals are separated by ".")
Test/Usage:
  1. Note that, the platform does not require you to send request header information
  2. Request a payment authorization with the card details and amount
  3. Receive the payment gateway response in a flat structure
 https://koroma.co.za/v1/transact
	
JSON Request
{
    "channelid": "",
    "clientrefcode": "",
    "amount": "",
    "cardnumber": "",
    "cardmonth": "",
    "cardyear": "",
    "cardcvv": ""
}

JSON Response
{
    "channelid": "",
    "clientReferenceInformationCode": "",
    "id": "",
    "reconciliationId": "",
    "Status": "",
    "SubmitTimeUtc": "",
    "errorInformationReason": "",
    "errorInformationMessage": "",
    "errorInformationField": "",
    "errorDetailsReason": "",
    "linksAuthReversalMethod": "",
    "linksAuthReversalHref": "",
    "linksSelfMethod": "",
    "linksSelfHref": "",
    "linksCaptureMethod": "",
    "linksCaptureHref": "",
    "orderInformationAuthorizedAmount": "",
    "orderInformationCurrency": "",
    "paymentAccountInformationCardType": "",
    "paymentInformationScheme": "",
    "paymentInformationIssuer": "",
    "paymentInformationBinCountry": "",
    "processorInformationMerchantNumber": "",
    "processorInformationApprovalCode": "",
    "processorInformationResponseCode": "",
    "processorInformationNetworkTransactionId": "",
    "processorInformationTransactionId": "",
    "processorInformationAVSCode": "",
    "processorInformationAVSCodeRaw": "",
    "pointOfSaleTerminalId": "",
    "issuerInformationResponseRaw": "",
    "riskInformationLocalTime": "",
    "riskInformationScoreResult": "",
    "riskInformationScoreFactorCodes": "",
    "riskInformationScoreModelUsed": "",
    "riskInformationIdentityChange": "",
    "riskInformationProfileName": "",
    "riskInformationProfileEarlyDecision": "",
    "riskInformationProfileSelectorRule": "",
    "consumerAuthenticationInfoToken": ""
}
Back to top