Virements bancaires
Enregistrer un compte bancaire
Jeton : action addBank, valable 5 min
Enregistre le compte bancaire sur lequel un point de vente veut recevoir ses virements. Les 8 champs sont obligatoires.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
bank_namerequisstring |
Nom de la banque. |
bank_numrequisstring |
Numéro de compte. |
bank_adresserequisstring |
Adresse de la banque. |
bank_paysrequisstring |
Pays de la banque. |
bank_ibanrequisstring |
IBAN ou code SWIFT. |
curl -X POST https://api.hpay.cash/sousMarchandAddBank/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"bank_name": "Banque Exemple",
"bank_num": "000123456789",
"bank_adresse": "Port-au-Prince",
"bank_pays": "Haiti",
"bank_iban": "EXMPHTPP"
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"bank_name": "Banque Exemple",
"bank_num": "000123456789",
"bank_adresse": "Port-au-Prince",
"bank_pays": "Haiti",
"bank_iban": "EXMPHTPP"
}{
"success": true,
"message": "Le compte bancaire a été ajouté avec succès",
"new_bank_details": {
"bank_id": 12,
"…": "…"
},
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
703 | 200 | Point de vente introuvable. |
704 | 200 | Ce compte (banque + IBAN/SWIFT) existe déjà. |
705 / 706 / 707 | 200 | Enregistrement impossible : contactez HPay. |
Lister les comptes bancaires
Jeton : action list-banks, valable 5 min
Renvoie les comptes bancaires d'un point de vente, avec leur bank_id.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
curl -X POST https://api.hpay.cash/sousMarchandAddBank/subMarchandAccountList/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001"
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001"
}{
"success": true,
"message": "Liste des comptes bancaires récupérée avec succès",
"data": [
{
"bank_id": 12,
"bank_name": "Banque Exemple",
"…": "…"
}
],
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
703 | 200 | Point de vente introuvable. |
404 | 200 | Aucun compte bancaire. |
Supprimer un compte bancaire
Jeton : action delete-bank, valable 5 min
Supprime un compte bancaire d'un point de vente.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
bank_idrequisnumber |
Identifiant renvoyé par la liste des comptes. |
curl -X POST https://api.hpay.cash/sousMarchandAddBank/subMarchandDeleteAccount/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"bank_id": 12
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"bank_id": 12
}{
"success": true,
"message": "Le compte bancaire a été supprimé avec succès",
"deleted_bank_details": {
"…": "…"
},
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
703 | 200 | Point de vente introuvable. |
704 | 200 | Compte bancaire introuvable pour ce point de vente. |
705 | 200 | Suppression impossible. |
Demander un virement
Jeton : action add-withdraw, valable 5 min
Demande le virement d'une partie du solde d'un point de vente vers l'un de ses comptes bancaires. La demande est ensuite traitée par HPay : elle passe de « en attente » à « validée ». Une seule demande en attente à la fois par point de vente.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
bank_idrequisnumber |
Le compte bancaire de destination. |
amountrequisnumber |
Montant, au plus le solde du point de vente. |
curl -X POST https://api.hpay.cash/sousMarchandAddBank/subMarchandAddWithdraw/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"bank_id": 12,
"amount": "150000.00"
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"bank_id": 12,
"amount": "150000.00"
}{
"success": true,
"message": "Demande de retrait enregistrée avec succès",
"withdrawal_id": "…",
"bank_details": "…",
"pending_requests": [
"…"
],
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
703 | 200 | Point de vente introuvable. |
704 | 200 | Solde insuffisant. |
705 | 200 | Compte bancaire introuvable pour ce point de vente. |
707 | 200 | Une demande est déjà en attente. |
Suivre les virements
Jeton : action all-withdraw, valable 5 min
Liste les demandes de virement d'un point de vente. statut : 0 en attente, 1 validée, 2 annulée ; null pour toutes.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
statutpeut être videinteger | null |
Filtre : 0, 1, 2, ou null. |
curl -X POST https://api.hpay.cash/sousMarchandAddBank/subMarchandWithdrawAll/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"statut": null
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"statut": null
}{
"success": true,
"message": "Liste des demandes récupérée avec succès",
"sub_marchant_info": {
"sous_num": "1001",
"sous_nom": "Caisse 1",
"sous_tel": "…"
},
"data": [
{
"idrestitution": "…",
"montant": "150000.00",
"frais": "0.00",
"total": "150000.00",
"reference": "…",
"statut": "0",
"date_trans": "2026-11-18 17:30:00"
}
],
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
703 | 200 | Point de vente introuvable. |
404 | 200 | Aucune demande. |
Annuler un virement en attente
Jeton : action cancel-withdraw, valable 5 min
Annule la demande en attente du point de vente (il n'y en a qu'une à la fois). Une demande déjà validée ne peut plus être annulée.
Paramètres (JSON)
api_keyrequisstring |
Votre clé API. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
curl -X POST https://api.hpay.cash/sousMarchandAddBank/subMarchandDeleteWithdraw/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001"
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001"
}{
"success": true,
"message": "Demande de retrait annulée avec succès.",
"sub_marchant_info": {
"sous_num": "1001",
"sous_nom": "Caisse 1",
"sous_tel": "…"
},
"annulled_request": {
"idrestitution": "…",
"montant": "150000.00",
"frais": "0.00",
"total": "150000.00",
"reference": "…",
"statut": "2",
"date_trans": "…",
"bank_paiement": "…"
},
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
703 | 200 | Point de vente introuvable. |
404 | 200 | Aucune demande en attente. |
500 | 200 | Annulation impossible. |