Skip to content

Format des reponses

Toutes les reponses de l'API Zayono suivent un format JSON uniforme.

Structure

json
{
  "message": "Description de l'operation",
  "data": { ... },
  "errors": null
}
ChampTypeDescription
messagestringMessage decrivant le resultat de l'operation
dataobject | nullDonnees retournees (null en cas d'erreur)
errorsobject | nullDetails des erreurs de validation (null en cas de succes)

Reponse de succes

json
{
  "message": "Payment initialized successfully.",
  "data": {
    "id": "9e5f6a7b-8c9d-4e3f-a1b2-c3d4e5f6a7b8",
    "status": "initiated",
    "amount": 1000,
    "currency": "XOF",
    "created_at": "2025-05-15T10:30:00+00:00"
  },
  "errors": null
}

Reponse d'erreur

json
{
  "message": "Validation failed.",
  "data": null,
  "errors": {
    "amount": ["The amount field is required."],
    "currency": ["The currency must be 3 characters."]
  }
}

Codes HTTP

CodeSignification
200Succes
201Ressource creee
202Acceptee (traitement asynchrone en cours)
400Requete invalide
401Non authentifie
403Interdit (compte suspendu)
404Ressource non trouvee
409Conflit (doublon, etat invalide)
410Ressource expiree
422Erreur de validation
429Trop de requetes
500Erreur serveur
502Erreur de l'agregateur

Conventions

  • Tous les montants sont des nombres decimaux (ex: 1000.00)
  • Toutes les dates sont au format ISO 8601 (ex: 2025-05-15T10:30:00+00:00)
  • Tous les identifiants sont des UUID v4
  • Les devises utilisent le format ISO 4217 a 3 lettres (ex: XOF, XAF)
  • Les pays utilisent le format ISO 3166-1 alpha-2 (ex: BJ, CI)

Documentation officielle de l'API Zayono