PayHazeDocsTableau de bord

Analyse

Appeler un outil

POST/v1/analyst/tools/{name}payments:read

Needs payments:read. Tools: figures, payments, routing, observation, experiments, recovery (GET /v1/analyst lists them with their arguments). Arguments are one JSON object of strings; an unknown tool or argument is refused. The answer carries the result, the report it comes from (reference) and a notice that texts in it are data. No tool writes; the caller sees only the space it may read.

En-têtes

AuthorizationBearer pos_test_…obligatoire
Clé de serveur. Jamais dans un navigateur.
X-Merchant-IDstringobligatoire
L’espace marchand concerné (mrc_…).
X-Environment"test"obligatoire
Seule valeur acceptée tant que la production n’est pas ouverte.

Paramètres

iddans le cheminobligatoire

Réponses

200Réussi
400Requête invalide
401Clé absente ou invalide
403Autorisation ou espace refusé
404Ressource introuvable
409Conflit avec une demande existante
429Trop de demandes, réessayez plus tard
503Service momentanément indisponible

Une erreur ne vaut jamais paiement. Le corps donne code, message, request_id et retry_action ; renvoyez la même Idempotency-Key si retry_action le propose.