Aller au contenu
HPay Developers
English
Référence de l'API marchande

Cartes

Vérifier une carte

POSThttps://api.hpay.cash/checkCard/

Jeton : action check-card, valable 5 min

Réservé aux terminaux de paiement agréés

Ce point d'accès reçoit la carte et le code PIN du client. Il est réservé aux terminaux physiques (TPE) agréés par HPay, où le client tape lui-même son PIN. Pour un site web ou une application, utilisez la passerelle de paiement : vous n'y touchez jamais au PIN.

Vérifie qu'une carte est utilisable (numéro, PIN, date d'expiration facultative), sans débiter ni enregistrer quoi que ce soit. Ne renvoie jamais le solde, le numéro complet ni les coordonnées du client. Ce n'est pas une autorisation de paiement.

Paramètres (JSON)

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 check-card
hpay_cardrequisstring Numéro de la carte HPay (16 chiffres, commence par 57).
hpay_card_pinrequisstring Code PIN saisi par le client sur le terminal. Ne jamais l'enregistrer.
expiry_datepeut être videstring Facultative : MM/AAAA, MM/AA, AAAA-MM, AAAA-MM-JJ ou JJ/MM/AAAA. Seuls le mois et l'année comptent.

Gardez fingerprint pour reconnaître la même carte plus tard sans conserver son numéro, et check_id pour le support. Sur une erreur 2110, HPay ne dit jamais si c'est le numéro, le PIN ou la date qui est faux ; attempts_left indique les essais restants.

curl -X POST https://api.hpay.cash/checkCard/ \
  -H "Content-Type: application/json" \
  -d '{
  "api_key": "YOUR_API_KEY",
  "api_public_key": "YOUR_PUBLIC_KEY",
  "token": "FRESH_TOKEN",
  "mode": "live",
  "action": "check-card",
  "hpay_card": "5700 1234 5678 3456",
  "hpay_card_pin": "••••",
  "expiry_date": "10/2027"
}'
Réponse
{
  "success": true,
  "message": "Card verified",
  "error_code": 0,
  "check_id": "CHK-00001234",
  "transaction_mode": "live",
  "card": {
    "status": "active",
    "masked_number": "5700 **** **** 3456",
    "holder": "Camille D.",
    "expires_at": "2027-10-05",
    "currency": "HTG",
    "fingerprint": "fp_9c1e4a7b2d0f83a6c5e1b904"
  }
}

Erreurs propres à ce point d'accès

error_codeHTTPCause
2100403Adresse IP non autorisée pour cette clé.
2101400Le numéro n'a pas 16 chiffres.
2102400Le numéro ne commence pas par 57.
2103400Le PIN n'a pas 4 ou 5 chiffres.
2104400Format de date invalide.
2110200Informations de carte incorrectes.
2111429Carte bloquée après trop d'essais (retry_after en secondes).
2112429Trop de requêtes ou d'échecs depuis votre clé.
2120200Carte suspendue.
2121200Carte pas encore activée.
2122200Carte expirée.
2123200Compte du client non validé, suspendu ou clôturé.
2150503Service momentanément indisponible.

Suite : Transferts →