Validate Traffic Fine Payment

Request

Validates that the proposed payment amount matches the expected gross amount for the selected fines. Call this before MarkTrafficFineAsPaid to confirm the correct amount.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

paymentReferencestringrequired

Merchant-side reference for this order.

Example:"myreference"

paymentTypestringrequired

Enum:"CARD""EFT"

Example:"CARD"

finesPaidArray of objects(MarkFineAsPaidCommand)required

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

Responses

Payment validation response.

Bodyapplication/json

successinteger

Enum:01

amntProposednumber

The amount that was proposed for validation.

referencestring

The paymentReference echoed back.

resultobject or null(ValidatePaymentResult)

Query result. null when success is 0.

errorobject or null(ErrorMessagePayment)

Unified error type returned in the error field of all Traffic Fine responses when success is 1.

Response

{
  "success": 1,
  "amntProposed": 574,
  "reference": "myreference",
  "result": {
    "amntToPay": 574,
    "difference": 0,
    "isCorrectAmount": true
  }
}