KOROMA
  1. Home
  2. API Docs

API Documentation

reversals


reversals is a payment authorization reversal request to the payment gateway.
It should be preceeded by a search to retrieve the information for this payload.
It will fail if initiated for or by a merchant that did not request the authorization payment

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

Payload:

  1. serviceid - the developer/application serviceid received at application start up
  2. clientrefcode - unique merchant generated order reference number
  3. reversalurl - the reversal href returned in payment authorization
  4. amount - the transaction amount, decimals are separated by "."
  5. reason - reason for the reversal transaction"."
Test/Example:
  1. Reverse a previous payment authorization by using reversals as follows:
 https://koroma.co.za/transact
	
JSON Request
{
    "serviceid": "40491ca3ff49edf8079dce4b263529fbc4fdc77151bd27be93bdfe...",
    "clientrefcode": "be93bdfe23448b5a3647ba4a59dcf1678e",
    "reversalurl": "/pts/v2/payments/7418140636896348904806/reversals",
    "amount": "959.10",
    "reason": "Testing atkpayments reversals api integration interface"
}

JSON Response
{
    "serviceid": "40491ca3ff49edf8079dce4b263529fbc4fdc77151bd27be93bdfe...",
    "clientReferenceCode": "be93bdfe23448b5a3647ba4a59dcf1678e",
    "reversalId": "7418144101366459904805",
    "reversalMethod": "GET",
    "reversalHref": "/pts/v2/reversals/7418144101366459904805",
    "orderCurrency": "USD",
    "reversalAmount": "959.10",
    "reversalCurrency": "USD",
    "reversalStatus": "REVERSED",
    "SubmitTimeUtc": "2025-03-12T21:20:10Z",
    "processorCode": "00",
    "failedReason": "",
    "failedMessage": "",
    "errorInfoReason": "",
    "errorInfoMessage": "",
    "detailsReason": "",
    "detailsField": ""
}
Back to top