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

atk@Work

channel authentication


Below is a sample request and response payload for a successful channel authentication.

Endpoint:

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

Payload: 
Request
{
    "apikey": "b6c39269-c6d5-4ce4-aa55-c8d867ff85e1",
    "password": "test***"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "Status": "CHANNEL_AUTHENTICATED",
    "SubmitTimeUtc": "2025-09-25T08:28:59Z",
    "errorInformationReason": "",
    "errorInformationMessage": ""
}
Back to top

payment authorization


Below is a sample request and response payload for a successful payment authorization.

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientrefcode": "05361dd20b0172a64be69",
    "amount": "6888.88",
    "cardnumber": "4111111111111111",
    "cardmonth": "12",
    "cardyear": "2029",
    "cardcvv": "736"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientReferenceInformationCode": "05361dd20b0172a64be69",
    "id": "7587892335456366903813",
    "reconciliationId": "RMWRIFWU8TX6",
    "Status": "AUTHORIZED",
    "SubmitTimeUtc": "2025-09-25T08:33:53Z",
    "errorInformationReason": "",
    "errorInformationMessage": "",
    "errorInformationField": "",
    "errorDetailsReason": "",
    "linksAuthReversalMethod": "POST",
    "linksAuthReversalHref": "/pts/v2/payments/7587892335456366903813/reversals",
    "linksSelfMethod": "GET",
    "linksSelfHref": "/pts/v2/payments/7587892335456366903813",
    "linksCaptureMethod": "POST",
    "linksCaptureHref": "/pts/v2/payments/7587892335456366903813/captures",
    "orderInformationAuthorizedAmount": "6888.88",
    "orderInformationCurrency": "ZAR",
    "paymentAccountInformationCardType": "001",
    "paymentInformationScheme": "VISA DEBIT",
    "paymentInformationBin": "",
    "paymentInformationAccountType": "",
    "paymentInformationType": "",
    "paymentInformationIssuer": "CONOTOXIA SP. Z O.O",
    "paymentInformationBinCountry": "PL",
    "processorInformationMerchantNumber": "000000000123456",
    "processorInformationApprovalCode": "831000",
    "processorInformationResponseCode": "00",
    "processorInformationNetworkTransactionId": "016150703802094",
    "processorInformationTransactionId": "016150703802094",
    "processorInformationAVSCode": "Y",
    "processorInformationAVSCodeRaw": "Y",
    "pointOfSaleTerminalId": "00123456",
    "issuerInformationResponseRaw": "0110322000000E1000020000000000006888880925083353076286524D575249465755385458363833313030303030000159004400223134573031363135303730333830323039344730363400103232415050524F56414C0006564943524320",
    "riskInformationLocalTime": "10:33:53",
    "riskInformationScoreResult": "18",
    "riskInformationScoreFactorCodes": "",
    "riskInformationScoreModelUsed": "default_cemea",
    "riskInformationAddress": "",
    "riskInformationGlobalVelocity": "",
    "riskInformationSuspicious": "",
    "riskInformationIdentityChange": "Standard mid-market profile",
    "riskInformationProfileName": "Standard mid-market profile",
    "riskInformationProfileEarlyDecision": "ACCEPT",
    "riskInformationProfileDestinationQueue": "",
    "riskInformationProfileSelectorRule": "Default Active Profile",
    "riskInformationRulesDecision": "",
    "riskInformationRulesName": "",
    "consumerAuthenticationInfoToken": "Axj/7wSTm1co5LiR6EIFABsZSm16UmNXquKlhsnkIy9jMQCnkIy9jMVjFKgvhSUhk0ky9GMHM1OBOTm1co5LiR6EIFAAwgXD",
}
Back to top

payer authentication - SetUp (Frictionless)


Below is a sample request and response payload for a frictionless payer authentication

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientrefcode": "PASetupe2baf16b",
    "amount": "5555.55",
    "cardnumber": "4012888888881881",
    "cardmonth": "2",
    "cardyear": "2028",
    "cardcvv": "856",
    "cardtype": "001"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientReferenceCode": "1758790973281",
    "id": "7587909732036297903812",
    "status": "COMPLETED",
    "submitTimeUtc": "2025-09-25T09:02:53Z",
    "consumerAuthenticationInfoAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJkOTM1MmUxMS05YTM3LTQ2MzktYTdlMC0zMDNkMWViNjBmZTQiLCJpYXQiOjE3NTg3OTA5NzMsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTc1ODc5NDU3MywiT3JnVW5pdElkIjoiNjU5NmUxMmMzYWE2NTI0MGQwMjJjZjI3IiwiUmVmZXJlbmNlSWQiOiIxN2VmYTIwMC03MzMzLTQ1M2QtYWI5OS0zZjhmYjU5YzM0N2QifQ.P8Bw6n5i7Hm4XM1KKnkxO9rFqWLicBr9eiFcOU78_90",
    "consumerAuthenticationInfoDDCUrl": "https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect",
    "consumerAuthenticationInfoReferenceId": "17efa200-7333-453d-ab99-3f8fb59c347d",
    "consumerAuthenticationInfoToken": "AxizbwSTm1dmstF5AE7EABsBTyEZfqPkApKQyaSZejGDmamCyAAABQ86"
}
Back to top

payer authentication - Enrolment Check


Below is a sample request and response payload for a frictionless payer authentication enrolment check
The enrolment check will return a payment authorization response.

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientrefcode": "1758790973281",
    "referenceId": "17efa200-7333-453d-ab99-3f8fb59c347d",
    "firstName": "Shopper",
    "lastName": "Holic",
    "email": "shopper.holic@koroma.co.za",
    "locality": "Durban",
    "postalCode": "0003"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientReferenceInformationCode": "1758790973281",
    "id": "7587912235326091503813",
    "reconciliationId": "RMWRIFWU8U5V",
    "Status": "AUTHORIZED",
    "SubmitTimeUtc": "2025-09-25T09:07:03Z",
    "errorInformationReason": "",
    "errorInformationMessage": "",
    "errorInformationField": "",
    "errorDetailsReason": "",
    "linksAuthReversalMethod": "POST",
    "linksAuthReversalHref": "/pts/v2/payments/7587912235326091503813/reversals",
    "linksSelfMethod": "GET",
    "linksSelfHref": "/pts/v2/payments/7587912235326091503813",
    "linksCaptureMethod": "POST",
    "linksCaptureHref": "/pts/v2/payments/7587912235326091503813/captures",
    "orderInformationAuthorizedAmount": "5555.55",
    "orderInformationCurrency": "ZAR",
    "paymentAccountInformationCardType": "001",
    "paymentInformationScheme": "VISA CREDIT",
    "paymentInformationBin": "",
    "paymentInformationAccountType": "",
    "paymentInformationType": "",
    "paymentInformationIssuer": "JSC CREDIT AGRICOLE BANK",
    "paymentInformationBinCountry": "UA",
    "processorInformationMerchantNumber": "000000000123456",
    "processorInformationApprovalCode": "831000",
    "processorInformationResponseCode": "00",
    "processorInformationNetworkTransactionId": "016150703802094",
    "processorInformationTransactionId": "016150703802094",
    "processorInformationAVSCode": "Y",
    "processorInformationAVSCodeRaw": "Y",
    "pointOfSaleTerminalId": "00123456",
    "issuerInformationResponseRaw": "0110322000000E1000020000000000005555550925090703077498524D575249465755385535563833313030303030000159004400223134573031363135303730333830323039344730363400103232415050524F56414C0006564943524320",
    "riskInformationLocalTime": "11:07:03",
    "riskInformationScoreResult": "8",
    "riskInformationScoreFactorCodes": "",
    "riskInformationScoreModelUsed": "default_cemea",
    "riskInformationAddress": "",
    "riskInformationGlobalVelocity": "",
    "riskInformationSuspicious": "",
    "riskInformationIdentityChange": "Standard mid-market profile",
    "riskInformationProfileName": "Standard mid-market profile",
    "riskInformationProfileEarlyDecision": "ACCEPT",
    "riskInformationProfileDestinationQueue": "",
    "riskInformationProfileSelectorRule": "Default Active Profile",
    "riskInformationRulesDecision": "",
    "riskInformationRulesName": "",
    "riskInformationRulesExecutionTiming": "",
    "consumerAuthenticationInfoAccessToken": "",
    "consumerAuthenticationInfoDDCUrl": "",
    "consumerAuthenticationInfoReferenceId": "",
    "consumerAuthenticationInfoToken": "Axj/7wSTm1dvl4wL6yjFABsZSm16UmNXquKrWsnkIy/qEICnkIy/qENjFIeiNSUhk0ky9GMHM1OFmTm1dvl4wL6yjFAA+QKB",
}
Back to top

payer authentication - SetUp (Challenge)


Below is a sample request and response payload for a StepUp authentication through payer chanllenge

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientrefcode": "PASetup5361dd20b0172a64be69",
    "amount": "7888.88",
    "cardnumber": "4111111111111111",
    "cardmonth": "12",
    "cardyear": "2029",
    "cardcvv": "736",
    "cardtype": "001"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientReferenceCode": "1758789794035",
    "id": "7587897939796112703814",
    "status": "COMPLETED",
    "submitTimeUtc": "2025-09-25T08:43:14Z",
    "consumerAuthenticationInfoAccessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI1MmZhOWU5ZC1lYTk4LTQxOTEtYWQ1Yi03MWQxOGI0YWNkMWMiLCJpYXQiOjE3NTg3ODk3OTQsImlzcyI6IjVkZDgzYmYwMGU0MjNkMTQ5OGRjYmFjYSIsImV4cCI6MTc1ODc5MzM5NCwiT3JnVW5pdElkIjoiNjU5NmUxMmMzYWE2NTI0MGQwMjJjZjI3IiwiUmVmZXJlbmNlSWQiOiIwMTU3MjFmOS04MTY0LTQ1OGMtYmUxNC1lNWNjYWNmN2Y5NDAifQ.kb85UYnC9eVCpVuYwm9Mq-ZFOfO2XittH8UcWfOkUwQ",
    "consumerAuthenticationInfoDDCUrl": "https://centinelapistag.cardinalcommerce.com/V1/Cruise/Collect",
    "consumerAuthenticationInfoReferenceId": "015721f9-8164-458c-be14-e5ccacf7f940",
    "consumerAuthenticationInfoToken": "AxizbwSTm1c8zdaZqAFGABsBTyEZfG0gApKQyaSZejGDmamAmAAAzg5g"
}
Back to top

payer authentication - Enrolment Check


Below is a sample request and response payload for a StepUp authentication through payer chanllenge

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientrefcode": "1758789794035",
    "referenceId": "015721f9-8164-458c-be14-e5ccacf7f940",
    "firstName": "Deve",
    "lastName": "Loper",
    "email": "deve.loper@koroma.co.za",
    "locality": "Johannesburg",
    "postalCode": "0001"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientReferenceCode": "1758789794035",
    "id": "7587900998906105503813",
    "status": "PENDING_AUTHENTICATION",
    "submitTimeUtc": "2025-09-25T08:48:20Z",
    "errorInformationReason": "CONSUMER_AUTHENTICATION_REQUIRED",
    "errorInformationMessage": "The cardholder is enrolled in Payer Authentication. Please authenticate the cardholder before continuing with the transaction.",
    "paymentInformationBin": "411111",
    "paymentInformationType": "VISA",
    "consumerAuthenticationInfoToken": "AxjzbwSTm1dHrBUmGyBFABsBTyEZfRKqximBMwpKLtaSZejGDmamAmAA/wHV",
    "consumerAuthenticationInfoAuthTransactionId": "IdUhl36vMSeh0YBwcCK0",
    "consumerAuthenticationInfoSCAOutageExemptionInd": "0",
    "consumerAuthenticationInfoVeresEnrolled": "Y",
    "consumerAuthenticationInfoEcommerceIndicator": "",
    "consumerAuthenticationInfoThreeDSServerTransactionId": "d7d658b7-0dc5-4d5a-8888-8610b03d5f36",
    "consumerAuthenticationInfoDirServerTransactionId": "8cb862be-98b5-4515-a70a-8665286b7e43",
    "consumerAuthenticationInfoChallengeRequired": "N",
    "consumerAuthenticationInfoAcsTransactionId": "7753f732-e72f-4a1c-b3fd-c727cbeb87d6",
    "consumerAuthenticationInfoAcsReferenceNumber": "CardinalACS",
    "consumerAuthenticationInfoAcsOperatorID": "MerchantACS",
    "consumerAuthenticationInfoAcsUrl": "https://0merchantacsstag.cardinalcommerce.com/MerchantACSWeb/creq.jsp",
    "consumerAuthenticationInfoStepUpUrl": "https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp",
    "consumerAuthenticationInfoPareq": "eyJtZXNzYWdlVHlwZSI6IkNSZXEiLCJtZXNzYWdlVmVyc2lvbiI6IjIuMi4wIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiJkN2Q2NThiNy0wZGM1LTRkNWEtODg4OC04NjEwYjAzZDVmMzYiLCJhY3NUcmFuc0lEIjoiNzc1M2Y3MzItZTcyZi00YTFjLWIzZmQtYzcyN2NiZWI4N2Q2IiwiY2hhbGxlbmdlV2luZG93U2l6ZSI6IjAyIn0",
    "consumerAuthenticationInfoParesStatus": "C",
    "consumerAuthenticationInfoSpecVersion": "2.2.0"
}
Back to top

authorization reversal


Below is a sample request and response payload for an authorization reversal

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientrefcode": "5c8e108d650cba45cae49f1e2b",
    "amount": "6888.88",
    "reversalurl": "/pts/v2/payments/7587892335456366903813/reversals"
}

Response
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205",
    "clientReferenceCode": "5c8e108d650cba45cae49f1e2b",
    "id": "7587895041836683103813",
    "method": "GET",
    "href": "/pts/v2/reversals/7587895041836683103813",
    "reversedAmount": "6888.88",
    "status": "REVERSED",
    "submitTimeUtc": "2025-09-25T08:38:24Z",
    "responseCode": "00",
    "message": "",
    "field": ""
}
Back to top

payment capture


Below is a sample request and response payload for a payment capture

Endpoint:

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

Payload: 
Request
Pending update...

Response
Pending update...
Back to top

channel logout


Below is a sample request and response payload for a channel logout

Endpoint:

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

Payload: 
Request
{
    "channelid": "05361dd20b0172a64be69d473a329eb5c8e108d650cba45cae49f1e2baf16b4891863d1479b7d38bdd304f1c7eb24cd10acd4177c1b0eccf2d45a3e99490b205"
}

Response
{
   "status": "CHANNEL_EXITED",
   "submitTimeUtc": "2025-09-25T09:29:47Z"
}
Back to top