Passer au contenu principal
GET
/
v3
/
mobile
/
check-ref
/
{ref}
Vérifier le Statut par Référence
curl --request GET \
  --url https://api.oneclickdz.com/v3/mobile/check-ref/{ref} \
  --header 'X-Access-Token: <api-key>'
{
  "success": true,
  "data": {},
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.oneclickdz.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Vue d’Ensemble

Suivez le statut d’une recharge mobile en utilisant le paramètre ref que vous avez fourni lors de l’envoi de la recharge. Cela est utile lorsque vous souhaitez vérifier le statut en utilisant vos propres identifiants de commande. Cet endpoint vous permet de suivre les commandes en utilisant la référence que vous avez fournie lors de la création de la recharge. Si vous n’avez pas fourni de référence, utilisez celle générée automatiquement retournée dans la réponse d’envoi.
Consultez la documentation Vérifier par ID pour des descriptions détaillées des statuts et des directives de gestion.

​
Paramètres de Chemin

​
ref
string
requis
Votre référence personnalisée depuis la requête /mobile/send

​
Réponse

Le format de réponse est identique à Vérifier par ID.
​
success
boolean
requis
Indique si la requête a réussi
​
data
object
requis
Objet de recharge avec statut, détails et informations de remboursement (le cas échéant). Consultez Vérifier par ID pour les descriptions complètes des champs.
​
meta
object
requis
Métadonnées avec horodatage au format ISO 8601

​
Exemples

curl https://api.oneclickdz.com/v3/mobile/check-ref/order-12345 \
  -H "X-Access-Token: YOUR_API_KEY"

​
Exemple de Réponse

{
  "success": true,
  "data": {
    "_id": "6901616fe9e88196b4eb64b0",
    "ref": "order-12345",
    "status": "FULFILLED",
    "plan_code": "PREPAID_DJEZZY",
    "MSSIDN": "0778037340",
    "topup_amount": 500,
    "balance_amount": 490,
    "created_at": "2025-10-29T00:35:59.378Z"
  },
  "meta": {
    "timestamp": "2025-10-29T00:36:15.606Z"
  },
  "requestId": "req_1730160975_xyz789"
}

​
Quand Utiliser Cet Endpoint

Demandes des Utilisateurs

Lorsque les utilisateurs demandent des informations sur leur commande en utilisant votre ID de commande

Gestion des Commandes

Intégrez avec votre système de suivi des commandes existant

Pages de Statut

Affichez le statut de la commande en utilisant des références orientées client

Support Client

Recherchez des commandes par numéros de référence client

​
Valeurs de Statut et Gestion

Consultez Vérifier par ID pour des descriptions détaillées des statuts et des instructions de gestion.

​
Réponse d’Erreur

404 - Non Trouvé : 
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Top-up with reference 'order-12345' not found"
  },
  "requestId": "req_1730160975_abc123"
}
Cela signifie qu’aucune recharge n’existe avec cette référence. Raisons possibles :
  • La référence n’a jamais été soumise
  • Faute de frappe dans la référence
  • La référence appartient à un autre compte

​
Bonnes Pratiques

Créez des références qui sont :
  • Uniques dans votre système
  • Faciles à identifier (ex. : order-{timestamp}-{userId})
  • Compatibles avec les URLs (pas de caractères spéciaux)
  • Recherchables dans votre base de données
Sauvegardez votre référence et le topupId de l’API :
await db.orders.update({
  orderId: 'order-12345',
  apiTopupId: response.data.topupId,
  apiTopupRef: response.data.topupRef
});
Cela vous permet de suivre avec l’un ou l’autre identifiant.
Si vous oubliez de fournir un ref, l’API en génère un. Sauvegardez-le :
const response = await sendTopup({ 
  plan_code: 'PREPAID_DJEZZY',
  MSSIDN: '0778037340',
  amount: 500
  // No ref provided
});

// API returns: { topupRef: "auto-gen-1730160975" }
await db.orders.update({
  orderId: order.id,
  apiRef: response.data.topupRef
});

​
Endpoints Associés

Vérifier par ID

Suivre avec l’ID interne de recharge

Envoyer une Recharge

Créer une nouvelle recharge

Lister les Recharges

Voir toutes les recharges