{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Whoosh Core API","link":"/","routeSlug":"/","relativePathFromDirectory":"index.md"},{"type":"link","label":"Amabills - Whoosh Core API","link":"/openapi","routeSlug":"/openapi"},{"type":"group","label":"Electricity","link":"/openapi/electricity","routeSlug":"/openapi/electricity","items":[{"label":"Confirm Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/electricity/confirmcustomer","routeSlug":"/openapi/electricity/confirmcustomer","metadata":{"seo":{"title":"Confirm Customer","description":"Verifies that a meter number exists and is eligible for electricity vending or bill payment. Call this before purchasing to avoid higher latency — if you vend with an unknown meter number the system runs an implicit lookup first."}},"httpPath":"/v2/Electricity/ConfirmCustomer"},{"label":"Purchase / Vend Token / Pay Bills","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/electricity/purchaseelectricity","routeSlug":"/openapi/electricity/purchaseelectricity","metadata":{"seo":{"title":"Purchase / Vend Token / Pay Bills","description":"Vends an electricity token (prepaid) or marks a payment against a postpaid running balance."}},"httpPath":"/v2/Electricity/Purchase"},{"label":"Check Balance","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/electricity/checkbalance","routeSlug":"/openapi/electricity/checkbalance","metadata":{"seo":{"title":"Check Balance","description":"Returns the authenticated merchant's current credit balance across all consumed prepaid VAS services. Optionally includes a transaction breakdown for a specified period."}},"httpPath":"/v1/Merchant/CheckBalance"}]},{"type":"group","label":"Bills","link":"/openapi/bills","routeSlug":"/openapi/bills","items":[{"label":"Confirm Customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/bills/confirmbillcustomer","routeSlug":"/openapi/bills/confirmbillcustomer","metadata":{"seo":{"title":"Confirm Customer","description":"Verifies that a postpaid municipal account number exists and returns its current running balance. Call this before Purchase to avoid higher latency — if you pay a bill for an unknown account number the system runs an implicit lookup first."}},"httpPath":"/v2/Bills/ConfirmCustomer"},{"label":"Purchase / Pay Bill","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/bills/purchasebill","routeSlug":"/openapi/bills/purchasebill","metadata":{"seo":{"title":"Purchase / Pay Bill","description":"Pays down a postpaid municipal account's running balance. Unlike Electricity/Purchase, no token or kWh amount is returned — only the account's remaining balance.The account is identified by accountNumber rather than meterNumber, and the request carries none of the prepaid/POS-only fields (arrears, sgc, tarrifIndex, krn) accepted by Electricity/Purchase.Use the idempotency field to safely retry failed requests without risk of duplicate payments."}},"httpPath":"/v2/Bills/Purchase"}]},{"type":"group","label":"VAS","link":"/openapi/vas","routeSlug":"/openapi/vas","items":[{"label":"Confirm VAS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vas/confirmvas","routeSlug":"/openapi/vas/confirmvas","metadata":{"seo":{"title":"Confirm VAS","description":"Confirm VAS"}},"httpPath":"/v1/VAS/Confirm"},{"label":"Purchase VAS","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/vas/purchasevas","routeSlug":"/openapi/vas/purchasevas","metadata":{"seo":{"title":"Purchase VAS","description":"Purchase VAS"}},"httpPath":"/v1/VAS/Purchase"}]},{"type":"group","label":"Traffic Fines","link":"/openapi/traffic-fines","routeSlug":"/openapi/traffic-fines","items":[{"label":"Query by ID Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/traffic-fines/viewtrafficfinebyid","routeSlug":"/openapi/traffic-fines/viewtrafficfinebyid","metadata":{"seo":{"title":"Query by ID Number","description":"Returns all recorded traffic fines for a given South African national ID number or Foreign ID number."}},"httpPath":"/v1/TrafficFine/ViewByIDnumber"},{"label":"Query by Business Registration Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/traffic-fines/viewtrafficfinebybrn","routeSlug":"/openapi/traffic-fines/viewtrafficfinebybrn","metadata":{"seo":{"title":"Query by Business Registration Number","description":"Returns all recorded traffic fines for a given business registration number (BRN)."}},"httpPath":"/v1/TrafficFine/ViewByBusinessRegistration"},{"label":"Query by Notice Number","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/traffic-fines/viewtrafficfinebynoticenumber","routeSlug":"/openapi/traffic-fines/viewtrafficfinebynoticenumber","metadata":{"seo":{"title":"Query by Notice Number","description":"Returns the details of a specific traffic fine by its AARTO notice number."}},"httpPath":"/v1/TrafficFine/ViewByNoticeNumber"},{"label":"Validate Traffic Fine Payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/traffic-fines/validatemarktrafficfinesaspaid","routeSlug":"/openapi/traffic-fines/validatemarktrafficfinesaspaid","metadata":{"seo":{"title":"Validate Traffic Fine Payment","description":"Validates that the proposed payment amount matches the expected gross amount for the selected fines. Call this before MarkTrafficFineAsPaid to confirm the correct amount."}},"httpPath":"/v1/TrafficFine/ValidateMarkTrafficFinesAsPaid"},{"label":"Mark Traffic Fines as Paid","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/traffic-fines/marktrafficfineaspaid","routeSlug":"/openapi/traffic-fines/marktrafficfineaspaid","metadata":{"seo":{"title":"Mark Traffic Fines as Paid","description":"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."}},"httpPath":"/v1/TrafficFine/MarkTrafficFineAsPaid"}]},{"type":"group","label":"Whoosh Payments","link":"/openapi/whoosh-payments","routeSlug":"/openapi/whoosh-payments","items":[{"label":"Create Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/whoosh-payments/putorderv2","routeSlug":"/openapi/whoosh-payments/putorderv2","metadata":{"seo":{"title":"Create Order","description":"Creates an order on the Whoosh platform and returns a Whoosh Payment Gateway hosted checkout URL to redirect the customer to for secure card payment."}},"httpPath":"/v2/putOrder"},{"label":"End of Day Ledger","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/whoosh-payments/whooshendofdayledger","routeSlug":"/openapi/whoosh-payments/whooshendofdayledger","metadata":{"seo":{"title":"End of Day Ledger","description":"Returns all MPGS transactions for the previous South Africa business day, including reconciliation metadata and any verification errors."}},"httpPath":"/v2/whooshEndOfDayLedger"},{"label":"Order Payment Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/whoosh-payments/whooshcheckorderpaymentstatus","routeSlug":"/openapi/whoosh-payments/whooshcheckorderpaymentstatus","metadata":{"seo":{"title":"Order Payment Status","description":"Verifies the payment status of a specific order by checking its associated MPGS payment sessions."}},"httpPath":"/v2/whooshCheckOrderPaymentStatus"}]}]}