Skip to content
/
End of Day Ledger

End of Day Ledger

Request

Returns all MPGS transactions for the previous South Africa business day, including reconciliation metadata and any verification errors.

No request body is required. The merchant is identified automatically from the x-api-key header.

Security
ApiKeyAuth
curl -i -X POST \
  https://docs.amabills.co.za/_mock/openapi/v2/whooshEndOfDayLedger \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successfully retrieved previous business day transactions.

Bodyapplication/json
successboolean

true when the request was processed successfully.

Example:true
merchantIdstring

Merchant identifier derived from the API key.

Example:"MERCH-001"
timezonestring

Always Africa/Johannesburg.

Example:"Africa/Johannesburg"
businessDatestring, (date)

The reconciled business date (YYYY-MM-DD).

Example:"2024-04-01"
periodStartstring, (date-time)

Start of the business day as an ISO timestamp.

Example:"2024-04-01T00:00:00+02:00"
periodEndstring, (date-time)

End of the business day as an ISO timestamp.

Example:"2024-04-01T23:59:59+02:00"
generatedOnstring, (date-time)

Timestamp when this response was generated.

Example:"2024-04-02T06:05:00+02:00"
transactionCountinteger

Total number of transactions returned.

Example:42
totalAmountnumber

Sum of all transaction amounts.

Example:8750
verificationErrorCountinteger

Number of verification errors encountered.

Example:0
transactionsArray of objects(TransactionDto)

List of MPGS transactions for the business day.

verificationErrorsArray of objects(VerificationErrorDto)

List of verification errors, if any.

Response
{
  "success": true,
  "merchantId": "MERCH-001",
  "timezone": "Africa/Johannesburg",
  "businessDate": "2024-04-01",
  "periodStart": "2024-04-01T00:00:00+02:00",
  "periodEnd": "2024-04-01T23:59:59+02:00",
  "generatedOn": "2024-04-02T06:05:00+02:00",
  "transactionCount": 2,
  "totalAmount": 300,
  "verificationErrorCount": 0,
  "transactions": [
    { … },
    { … }
  ],
  "verificationErrors": []
}