Mark Traffic Fines as Paid

Request

Marks one or more traffic fines as paid on behalf of a customer. The merchant declares that they received the gross amount (net fine + vendor fee) from the customer and wishes to clear the fines with AARTO.

Calling this endpoint will result in a Whoosh invoice for the gross transaction value of all fines marked paid, issued at the end of each billing cycle.

Recommended: Call ValidateMarkTrafficFinesAsPaid first to confirm the correct amount before calling this endpoint.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

paymentReferencestringrequired

Merchant-side reference to tie the result to an order.

Example:"myreference"

paymentTypestringrequired

How the transaction was paid.

Enum:"CARD""EFT"

Example:"CARD"

finesPaidArray of objects(MarkFineAsPaidCommand)required

List of fines paid to the merchant to be cleared with AARTO.

curl -i -X POST \
  https://docs.amabills.co.za/_mock/openapi/v1/TrafficFine/MarkTrafficFineAsPaid \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "paymentReference": "myreference",
    "paymentType": "CARD",
    "finesPaid": [
      {
        "noticeNumber": "0240060000000458",
        "amount": 1614,
        "currency": "ZAR"
      }
    ]
  }'

Responses

Mark as paid response.

Bodyapplication/json

successinteger

Enum:01

referencestring

The paymentReference echoed back.

resultobject or null(MarkTrafficFinesAsPaidResult)

Transaction result. null when success is 0.

errorobject or null(ErrorMessage)

Error details. null when success is 1.

Response

{
  "success": 1,
  "reference": "myreference",
  "result": {
    "orderId": "b89a1717-5266-43c7-93cc-7e51c0fe01fb",
    "grossAmntPaid": 1614,
    "netFinesAmntPaid": 1600,
    "vendorFeeAmntPaid": 14,
    "merchantFeePaid": 7.5,
    "finesPaid": [ … ]
  }
}