Aller au contenu
ReadyZone Docs
Référence API

Validation d’un code promo

Valider publiquement un code promotionnel pour un forfait.

POST /api/referral/promo-codes/validate

Accès : Public

Corps de requête

{
  "code": "WELCOME10",
  "planId": "plan_uuid",
  "companyRef": "readyzone-center-12345"
}

code et planId sont obligatoires. companyRef est recommandé lorsque le code est saisi depuis un portail de zone.

AttributTypeObligatoireDescription
codestringOuiCode promotionnel saisi par le client.
planIdstring (UUID)OuiForfait ciblé.
companyIdstring (UUID)NonIdentifiant interne de la zone.
companyRefstringNonRéférence publique de la zone.
beneficiaryUserIdstring (UUID)NonBénéficiaire, utilisé notamment pour empêcher l’auto-utilisation.

Réponse

La réponse indique si le code est valide et retourne les informations de remise applicables au forfait.

Le portail doit traiter la réponse comme une décision d’éligibilité et ne pas calculer lui-même le montant remisé.

Codes de statut

  • 200 OK
  • 400 Bad Request (code ou forfait invalide)
  • 404 Not Found (code introuvable)
  • 422 Unprocessable Entity (code expiré, épuisé ou non applicable)

Sur cette page