KOROMA
  1. Home
  2. API Docs

API Documentation

captures


capture is an end-of-day transaction which submits a batch of all of the day's payment transactions. For developer integrating with the platform in a shared deploymemnt model, this API is available as a backend implement that the developer will not need to interact with.

In the enterprise deployment model, the documentation will be release to the customer to enable overnight payment capture.

This API is best implements with a button click that triggers a collection and submission of the day's transactions. There is only one paycapture request for the whole platform regardless on the number of concurrent application developed and running on top of it.

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

Payload:

  1. serviceid - the developer/application serviceid received in login response
  2. clientrefcode - a unique merchant generated identifier
  3. captureurl - the capture URL received in payment authorization
  4. amount - the transaction amouont to be captured for payment
  5. currency - the transaction currency
Test/Example:
  1. https://koroma.co.za/transact

 https://koroma.co.za/transact
	
JSON Request
{
    "serviceid": "ff8d263b70b4555cb16216b9e983d6503885337653f320ed802167f...",
    "clientrefcode": "f540a5ce8f7d3b9e0905e",
    "captureurl": "/pts/v2/payments/7421159094306267704805/captures",
    "amount": "19009.10",
    "currency": "USD"
}
JSON Response
{
    "serviceid": "ff8d263b70b4555cb16216b9e983d6503885337653f320ed802167f...",
    "clientReferenceCode": "f540a5ce8f7d3b9e0905e",
    "captureId": "7421160381586674504807",
    "reconciliationId": "76556331",
    "selfMethod": "GET",
    "selfHref": "/pts/v2/captures/7421160381586674504807",
    "voidCaptureMethod": "POST",
    "voidCaptureHref": "/pts/v2/captures/7421160381586674504807/voids",
    "captureAmount": "19009.10",
    "captureCurrency": "USD",
    "captureStatus": "PENDING",
    "SubmitTimeUtc": "2025-03-16T09:07:18Z",
    "errorInfoReason": "",
    "errorInfoMessage": ""
}
Back to top