Authentification
L'API marchande sert à vos serveurs et à vos terminaux de paiement agréés. Pour encaisser sur un site ou dans une application, commencez par la passerelle de paiement. Voir la passerelle
Conventions
POSThttps://api.hpay.cash/…/
- Toutes les requêtes sont en POST, corps JSON, en-tête Content-Type: application/json. Le chemin se termine par une barre oblique et respecte les majuscules.
- Envoyez exactement les clés listées : une clé en trop ou en moins est refusée (erreurs 5 et 10). Une clé marquée « peut être vide » doit quand même être envoyée, avec "".
- Une valeur requise ne peut pas valoir 0 ou "0" : elle serait considérée comme vide (erreur 20).
- Montants dans l'unité de la devise, avec un point décimal : 5.50 et non 5,50 ni 550.
- Un jeton par opération, demandé juste avant, avec l'action correspondante. Un jeton « payment » ne sert pas à rembourser.
- Exception : la passerelle (/checkout/) et les Recharges HPay (/topup/) n'utilisent pas de jeton. Vos trois clés sont envoyées dans chaque requête, uniquement depuis votre serveur.
- Vérifiez toujours success et error_code (0 = succès). Beaucoup d'erreurs arrivent avec le statut HTTP 200. Certaines lectures placent ces champs dans un objet info.
- Après une coupure ou une erreur 500, vérifiez l'état réel (historique) avant de recommencer une opération d'argent.
- En mode test, l'argent ne bouge pas mais les opérations sont enregistrées.
Erreurs communes
Ces codes peuvent être renvoyés par tous les points d'accès qui utilisent un jeton (sauf le remboursement, qui a sa propre numérotation).
| error_code | Cause | Que faire |
|---|---|---|
5 | Nombre de clés incorrect. | Envoyer exactement les clés listées. |
10 | Clé inattendue. | Vérifier l'orthographe des clés. |
20 | Valeur requise vide. | Remplir la valeur ; le champ concerné est nommé dans message. |
30 | Clé API inconnue. | Vérifier api_key / main_api_key. |
31 | Jeton tronqué ou invalide. | Redemander un jeton. |
32 | Jeton expiré. | Redemander un jeton. |
41 | Mode différent de celui de vos clés. | Aligner mode. |
50 | Clé secrète ou publique incorrecte. | Vérifier vos clés. |
60 | Jeton émis pour une autre action. | Demander un jeton avec la bonne action. |
Obtenir un jeton
POSThttps://api.hpay.cash/token/
Chaque opération demande un jeton récent, propre à l'action. Il est créé avec vos trois clés et reste valable 5 minutes (15 minutes pour les lectures). Demandez-en un nouveau avant chaque opération.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
api_secret_keyrequisstring |
Votre clé secrète. |
api_public_keyrequisstring |
Votre clé publique. |
moderequisstring |
test ou live, comme vos clés. |
actionrequisstring |
L'opération visée, indiquée sur chaque point d'accès : payment, refund, history, get_balance, submarchant, newaccount, deposit, withdraw, check-card, transfert, withdraw-code, addBank, list-banks, delete-bank, add-withdraw, all-withdraw, cancel-withdraw. |
curl -X POST https://api.hpay.cash/token/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"api_secret_key": "YOUR_SECRET_KEY",
"api_public_key": "YOUR_PUBLIC_KEY",
"mode": "test",
"action": "payment"
}'{
"api_key": "YOUR_API_KEY",
"api_secret_key": "YOUR_SECRET_KEY",
"api_public_key": "YOUR_PUBLIC_KEY",
"mode": "test",
"action": "payment"
}Réponse
{
"success": true,
"message": "Token generated",
"token": "TVlYb2ZhZ0x…",
"livetime": "3mn",
"time_generated": 1763474820,
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
30 | 200 | Clé API inconnue. |
40 | 200 | Le mode ne correspond pas à vos clés. |
50 | 200 | Clé secrète ou publique incorrecte. |
60 | 200 | Action inconnue. |