Transferts
Envoyer un transfert
Jeton : action transfert, valable 5 min
HPAY_CLIENT et HPAY_HPAY reçoivent la carte et le PIN de l'expéditeur : ils sont réservés aux terminaux agréés, comme le paiement. Après 5 PIN faux en 15 minutes, la carte est en pause 15 minutes (2111).
Trois types, choisis par transfert_type. MARCHAND_CLIENT : le point de vente envoie de l'argent depuis son solde vers un téléphone ; le bénéficiaire reçoit un code de retrait. HPAY_CLIENT : même chose, payé avec la carte HPay du client. HPAY_HPAY : de carte HPay à carte HPay. Les 15 clés doivent toujours être envoyées ; celles qui ne servent pas au type choisi restent vides.
Paramètres (JSON)
main_api_keyrequisstring |
Votre clé API. |
api_public_keyrequisstring |
Votre clé publique. |
tokenrequisstring |
Jeton obtenu par /token/ avec l'action indiquée. |
moderequisstring |
test ou live, comme vos clés. |
actionrequisstring |
transfert |
marchant_idrequisstring |
Numéro du point de vente (1 à 15 caractères). |
amountrequisnumber |
Montant envoyé, dans la devise de l'expéditeur. |
transaction_idrequisstring |
Votre référence unique. |
transfert_typerequisstring |
MARCHAND_CLIENT, HPAY_CLIENT ou HPAY_HPAY. |
sender_hpay_cardpeut être videstring |
Carte de l'expéditeur (HPAY_CLIENT, HPAY_HPAY). |
sender_hpay_card_pinpeut être videstring |
PIN de l'expéditeur (HPAY_CLIENT, HPAY_HPAY). Ne jamais l'enregistrer. |
benef_hpay_cardpeut être videstring |
Carte du bénéficiaire (HPAY_HPAY). |
benef_telephonepeut être videstring |
Téléphone du bénéficiaire (MARCHAND_CLIENT, HPAY_CLIENT). |
benef_country_namepeut être videstring |
Pays du bénéficiaire, en toutes lettres (MARCHAND_CLIENT, HPAY_CLIENT). |
benef_full_namepeut être videstring |
Nom du bénéficiaire, facultatif. |
transaction_code est le code que le bénéficiaire présentera pour retirer l'argent. Remettez-le-lui vous-même (reçu, message) : ne comptez pas sur le SMS seul. HPAY_HPAY crédite directement la carte du bénéficiaire et ne renvoie pas de code.
curl -X POST https://api.hpay.cash/transfert/ \
-H "Content-Type: application/json" \
-d '{
"main_api_key": "YOUR_API_KEY",
"api_public_key": "YOUR_PUBLIC_KEY",
"token": "FRESH_TOKEN",
"mode": "test",
"action": "transfert",
"marchant_id": "1001",
"amount": "5000.00",
"transaction_id": "2026111800051",
"transfert_type": "MARCHAND_CLIENT",
"sender_hpay_card": "",
"sender_hpay_card_pin": "",
"benef_hpay_card": "",
"benef_telephone": "50937000000",
"benef_country_name": "Haiti",
"benef_full_name": "Jean Pierre"
}'{
"main_api_key": "YOUR_API_KEY",
"api_public_key": "YOUR_PUBLIC_KEY",
"token": "FRESH_TOKEN",
"mode": "test",
"action": "transfert",
"marchant_id": "1001",
"amount": "5000.00",
"transaction_id": "2026111800051",
"transfert_type": "MARCHAND_CLIENT",
"sender_hpay_card": "",
"sender_hpay_card_pin": "",
"benef_hpay_card": "",
"benef_telephone": "50937000000",
"benef_country_name": "Haiti",
"benef_full_name": "Jean Pierre"
}{
"success": true,
"message": "Money sent to 50937000000 Jean Pierre succesfully. …",
"transaction_id": "2026111800051",
"amount_transfered": "5000.00",
"fees": "…",
"total_paid": "…",
"destination": "Haiti",
"sender_currency": "HTG",
"beneficiary_currency": "HTG",
"submerchant_commission": "…",
"gestionnaire_commission": "…",
"commercial_commission": "…",
"transaction_code": "…",
"token_used": "…",
"transaction_date": "2026-11-18 17:10:00",
"mode": "test",
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
300 | 200 | Clé API inconnue. |
301 | 200 | Jeton invalide. |
302 | 200 | Jeton expiré. |
401 | 200 | Le mode ne correspond pas à vos clés. |
500 | 200 | Clé secrète ou publique incorrecte. |
600 / 603 | 200 | Jeton émis pour une autre action. |
601 | 200 | Point de vente inconnu. |
602 | 200 | Point de vente non activé. |
604 | 200 | transaction_id déjà utilisé. |
30 / 10000 | 200 | transfert_type inconnu, ou informations du bénéficiaire vides. |
31 | 200 | Carte de l'expéditeur invalide (ou point de vente inconnu pour MARCHAND_CLIENT). |
32 | 200 | Carte ou point de vente non activé. |
33 | 200 | PIN incorrect (ou point de vente suspendu pour MARCHAND_CLIENT). |
2111 | 429 | 5 PIN erronés en 15 minutes : carte en pause 15 minutes. |
34 | 200 | Compte HPay de l'expéditeur non confirmé. |
30010 | 200 | Carte de l'expéditeur et du bénéficiaire identiques. |
36 | 200 | Solde insuffisant. |
37 | 200 | Bénéficiaire introuvable (HPAY_HPAY). |
3900 | 200 | Pays de destination inconnu. |
44 | 200 | Devise du bénéficiaire non prise en charge. |
Payer un code de retrait
Jeton : action withdraw-code, valable 5 min
Le bénéficiaire d'un transfert présente son code au point de vente, qui lui remet l'argent en espèces. HPay crédite le point de vente du montant, converti dans sa devise. Un code ne sert qu'une fois.
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). |
payment_coderequisstring |
Le code présenté par le bénéficiaire. |
Vérifiez l'identité du bénéficiaire (nom et téléphone renvoyés) avant de remettre l'argent. Après une coupure, ne rejouez pas : contrôlez d'abord l'historique des transferts.
curl -X POST https://api.hpay.cash/withdraw/withdraw_code/ \
-H "Content-Type: application/json" \
-d '{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"payment_code": "CODE_FROM_TRANSFER"
}'{
"api_key": "YOUR_API_KEY",
"token": "FRESH_TOKEN",
"marchant_id": "1001",
"payment_code": "CODE_FROM_TRANSFER"
}{
"success": true,
"message": "Retrait validé avec succès.",
"details": {
"id_transfert": "…",
"montant_original": "5000.00",
"montant_converti": "5000.00",
"taux_conversion": 1,
"gain_hpay": "…",
"nouveau_solde_sous_marchand": "…",
"devise_originale": "HTG",
"devise_convertie": "HTG",
"expediteur": {
"nom": "…",
"prenoms": "…",
"telephone": "…",
"email": "…"
},
"beneficiaire": {
"nom": "Jean Pierre",
"telephone": "50937000000"
}
},
"error_code": 0
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
100 | 200 | Corps JSON invalide. |
30 | 200 | Clé API inconnue. |
403 | 200 | Point de vente introuvable. |
404 | 200 | Code invalide ou déjà utilisé. |
505 | 200 | Expéditeur introuvable : contactez HPay. |
500 / 501 | 200 | Erreur de conversion ou d'enregistrement : contactez HPay avant de réessayer. |
Historique des transferts
Sans jeton
Lecture seule, sans jeton. Les 9 clés doivent être envoyées. Attention, les dates s'appellent ici from_date et to_date.
Paramètres (JSON)
main_api_keyrequisstring |
Votre clé API. |
api_public_keyrequisstring |
Votre clé publique. |
marchant_idrequisstring |
Le point de vente. |
moderequisstring |
test ou live, comme vos clés. |
transfert_typerequisstring |
MARCHAND_CLIENT, HPAY_CLIENT, HPAY_HPAY ou ALL. |
from_datepeut être videstring |
Début inclus, AAAA-MM-JJ. |
to_datepeut être videstring |
Fin incluse, AAAA-MM-JJ. |
transaction_idpeut être videstring |
Filtre : une référence. |
transaction_codepeut être videstring |
Filtre : un code de retrait. |
curl -X POST https://api.hpay.cash/transfertHistory/ \
-H "Content-Type: application/json" \
-d '{
"main_api_key": "YOUR_API_KEY",
"api_public_key": "YOUR_PUBLIC_KEY",
"marchant_id": "1001",
"mode": "live",
"transfert_type": "ALL",
"from_date": "2026-11-01",
"to_date": "2026-11-18",
"transaction_id": "",
"transaction_code": ""
}'{
"main_api_key": "YOUR_API_KEY",
"api_public_key": "YOUR_PUBLIC_KEY",
"marchant_id": "1001",
"mode": "live",
"transfert_type": "ALL",
"from_date": "2026-11-01",
"to_date": "2026-11-18",
"transaction_id": "",
"transaction_code": ""
}{
"info": {
"success": true,
"message": "…",
"transaction_mode": "live",
"error_code": 0
},
"history": [
{
"transaction_id": "2026111800051",
"transaction_code": "…",
"mode": "live",
"transfert_type": "MARCHAND_CLIENT",
"transaction_date": "2026-11-18 17:10:00",
"beneficiary_info": {
"nom": "Jean Pierre",
"telephone": "50937000000"
},
"transaction_data": {
"amount_sent": "5000.00",
"fees": "…",
"total": "…",
"currency_from": "HTG",
"currency_to": "HTG",
"country_destination": "Haiti",
"amount_received": "…",
"…": "…"
}
}
]
}Erreurs propres à ce point d'accès
| error_code | HTTP | Cause |
|---|---|---|
30 | 200 | transfert_type inconnu. |
300 | 200 | Clé API ou clé publique incorrecte. |