Skip to content
ReadyZone Docs
API Reference

Guest purchase

Start guest checkout (without account) and create payment transaction.

POST /api/payments/guest-buy-plan

Access : Public (API anti-abuse checks apply)

Operator use case

“Instant Payment” button: walk-in customer pays quickly without account creation.

Parameters

  • key (query, optional depending on configuration)

Request body

{
  "planId": "e6fd2c2b-1234-4a7e-8a6a-12ab34cd56ef",
  "paymentPhone": "+237690201423",
  "notificationContact": "client@example.com",
  "username": "AA:BB:CC:DD:EE:FF",
  "password": "Strong@Pass123",
  "promoCode": "READY10"
}
AttributeTypeRequiredDescription
planIdstring (UUID)YesPlan to purchase.
paymentPhonestringYesMobile Money number used for payment.
notificationContactstringNoNotification email or phone. The payment phone may be used when absent.
usernamestringNoRequested Wi-Fi username. Generated when absent.
passwordstringNoRequested password, minimum 6 characters. Generated when absent.
promoCodestringNoPromotional code to apply.

Response body

{
  "message": "Achat invité initié avec succès",
  "purchaseId": "purchase_uuid",
  "merchandTransactionId": "GR-TX-XXXXXXXXXX",
  "notchTransactionId": "np_xxxxx",
  "notchMessage": "Confirm the payment on your phone",
  "paymentUrl": "https://...",
  "isGuestPurchase": true
}
AttributeTypeDescription
messagestringInitialization result message.
purchaseIdstring (UUID)Local purchase identifier.
merchandTransactionIdstring or nullMerchant reference used for tracking.
notchTransactionIdstring or nullPayment provider reference.
notchMessagestring or nullInstruction returned by the provider.
paymentUrlstring or nullPayment link when supported by the method.
isGuestPurchasebooleanWhether the purchase was made without an account.

For a business failure, the response may contain status: "failed" and an error message instead of a usable transaction.

Status codes

  • 201 Created
  • 400 Bad Request (invalid data)
  • 404 Not Found (plan not found)
  • 422 Unprocessable Entity (invalid or unprocessable payment data)
  • 429 Too Many Requests (anti-abuse limit)

On this page