API Reference
Portal API Reference
Endpoints consumed by ReadyZone captive portals.
Base addresses
| Service | URL |
|---|---|
| API Core | https://core.readyzone.space |
| Checkout | https://pay.readyzone.space |
Available endpoints
GET · Zone name
Return the public zone name/label for portal branding.
GET · List plans
List active plans for the zone.
GET · Checkout page
Open ReadyZone checkout page for standard OM/MoMo payment.
POST · Guest purchase
Start guest checkout (without account) and create payment transaction.
GET · Verify payment
Check transaction status and sync local state.
GET · Username availability
Check ReadyZone username availability before purchase.
GET · Recover credentials
Recover guest credentials from notification contact or payment phone.
GET · Support contact
Retrieve a zone’s public support contact details.
GET · Public announcements
Load announcements displayed on the captive portal.
GET · Public advertisements
Load advertisements displayed on the captive portal.
GET · Public services
Load services offered by the zone.
POST · Portal analytics
Record captive portal usage events.
POST · Ticket activation
Validate a ticket before hotspot login.
POST · Promo code validation
Validate a promotional code for a plan.
GET · Free offers
List free offers available in a zone.
POST · Start free offer
Start a free-offer request with or without OTP.
POST · Verify free offer
Verify the OTP and assign the free offer.
Template variables
Portal templates use the following values during generation:
{{apiBaseUrl}}: Core API base URL used to build/api/...requests.{{companyReference}}: public zone reference used in API paths and parameters.{{cloudBaseUrl}}: ReadyZone Cloud base URL used, among other things, to build/checkout/{planId}links.
The portal can also receive these values through window.HOTSPOT_RUNTIME_CONFIG, window.COMPANY_API_BASE, window.COMPANY_REF, and window.CLOUD_URL. Runtime values take precedence over values injected during generation.
Payment rules
The portal must follow the purchase button display rules.