FradexPay Card API

Authentification Production

Toutes les requêtes API (à l'exception de /sign-in et /health) nécessitent une authentification via vos clés API.

POST /api/sign-in Obtenir ses clés API

Corps de la requête :

Champ	Type	Requis	Description
email	string	✅	Email du compte marchand
password	string	✅	Mot de passe

curl -X POST "https://api.fradexpay.com/api/sign-in" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "merchant@fradex.com",
    "password": "your_secure_password"
  }'

→ Réponse (succès) :

{
  "success": true,
  "user": {
    "api_key": "pk_live_9a2b3c4d5e6f7g8h9i0j",
    "api_secret": "sk_live_8h7g6f5e4d3c2b1a0z9y",
    "api_enabled": 1
  },
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
}

→ Réponse (erreur - identifiants invalides) :

{
  "success": false,
  "error": "Invalid credentials",
  "code": 401
}

🔐 Headers requis Pour tous les endpoints après authentification

Header	Valeur exemple	Obligatoire
X-API-Key	pk_live_9a2b3c4d5e6f7g8h9i0j	✅ Oui
X-API-Secret	sk_live_8h7g6f5e4d3c2b1a0z9y	✅ Oui
Content-Type	application/json	✅ Oui

Ne partagez jamais vos clés API. En production, elles donnent accès à des fonds réels.

📡 Codes d'erreur HTTP

Code	Signification	Exemple de réponse
200	Succès	`{"success":true,"data":{...}}`
400	Requête invalide	`{"success":false,"error":"Missing parameter: card_id"}`
401	Non autorisé	`{"success":false,"error":"Invalid API credentials"}`
402	Solde insuffisant	`{"success":false,"error":"Insufficient balance"}`
404	Ressource non trouvée	`{"success":false,"error":"Card not found"}`
422	Validation échouée	`{"success":false,"error":"Amount must be at least 10"}`
500	Erreur serveur	`{"success":false,"error":"Internal server error"}`

🏥 Health Check

GET/healthVérifier l'état du service (public)

curl -X GET "https://api.fradexpay.com/api/API/health"

→ Réponse :

{
  "status": "healthy",
  "timestamp": "2026-05-28T10:00:00Z",
  "version": "1.0.0",
  "service": "FradexPay Card API"
}

📊 Account Limits

GET/limitsVoir les limites du compte (quotas journaliers/mensuels)

curl -X GET "https://api.fradexpay.com/api/API/limits" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

✅ → Réponse réelle de l'API (28/05/2026) :

{
  "success": true,
  "message": "API Limits - Transaction limited to 300 USD, no card creation limits",
  "data": {
    "transaction_limits": {
      "per_transaction_max": 300,
      "per_transaction_min": 1,
      "currency": "USD"
    },
    "recharge": {
      "daily": {
        "used": 0,
        "max": "UNLIMITED",
        "remaining": "UNLIMITED"
      },
      "monthly_amount": {
        "used": 0,
        "max": "UNLIMITED",
        "remaining": "UNLIMITED"
      },
      "monthly_count": {
        "used": 0,
        "max": "UNLIMITED",
        "remaining": "UNLIMITED"
      }
    },
    "card_creation": {
      "daily": {
        "used": 0,
        "max": "UNLIMITED",
        "remaining": "UNLIMITED"
      },
      "monthly": {
        "used": 0,
        "max": "UNLIMITED",
        "remaining": "UNLIMITED"
      },
      "cards_count": {
        "used": 0,
        "max": "UNLIMITED",
        "remaining": "UNLIMITED"
      },
      "per_transaction_max": "300 USD"
    }
  },
  "timestamp": "2026-05-28T19:51:14+00:00"
}

Interprétation des limites :
• Transaction max : 300 USD par opération
• Transaction min : 1 USD
• Recharges : Pas de limites (quotidiennes ou mensuelles)
• Création de cartes : Pas de limites (quotidiennes ou mensuelles)

💰 Wallet Balance

GET/balanceSolde USDT (BP20)

curl -X GET "https://api.fradexpay.com/api/API/balance" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

→ Réponse :

{
  "success": true,
  "data": {
    "currency": "USDT",
    "network": "BP20",
    "balance": "1250.50",
    "available": "1250.50"
  }
}

📦 Card Products

GET/products

curl -X GET "https://api.fradexpay.com/api/API/products" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

→ Réponse :

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 20,
        "name": "Visa Elite Card",
        "min_amount": 10,
        "max_amount": 999999999,
        "description": "Visa Elite Card - Recommended",
        "fee_percentage": 10
      }
    ],
    "total": 1
  }
}

💳 Create Virtual Card

POST/card/create

Paramètre	Type	Requis	Description
product_id	integer	✅	ID du produit (ex: 20)
amount	integer	✅	Montant à créditer (min 1, max 300 USD)

curl -X POST "https://api.fradexpay.com/api/API/card/create" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"product_id": 20, "amount": 100}'

→ Réponse (succès) :

{
  "success": true,
  "message": "Card created successfully",
  "data": {
    "card_id": 55,
    "card_number": "441357****6116",
    "balance": "100.00",
    "status": "Active",
    "amount_credited": 100,
    "fee_charged": 10,
    "total_debited": 110
  }
}

→ Réponse (solde insuffisant) :

{
  "success": false,
  "error": "Insufficient balance. Required: 110 USDT, Available: 50 USDT",
  "code": 402
}

Montant maximum par transaction : 300 USD (selon limites de l'API)

🔐 Get CVV & Expiry (OTP Flow)

Sécurité renforcée : Un OTP est requis pour accéder aux données sensibles.

POST/card/request-otp-directÉtape 1 : Demander OTP

curl -X POST "https://api.fradexpay.com/api/API/card/request-otp-direct" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"card_id": 55}'

→ Réponse :

{
  "success": true,
  "message": "OTP generated successfully",
  "data": {
    "request_id": "otp_67f8a3b2c1d4e",
    "card_id": 55,
    "otp_code": "123456",
    "expires_in": 600,
    "expires_at": "2026-05-28T15:30:00Z"
  }
}

POST/card/verify-otpÉtape 2 : Vérifier OTP et obtenir CVV

curl -X POST "https://api.fradexpay.com/api/API/card/verify-otp" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"card_id": 55, "request_id": "otp_67f8a3b2c1d4e", "otp": "123456"}'

→ Réponse (succès - données déchiffrées) :

{
  "success": true,
  "message": "Card details decrypted successfully",
  "data": {
    "card_id": 55,
    "card_number": "441357****6116",
    "full_card_number": "4413571234566116",
    "cvv": "123",
    "expiry": "12/28",
    "balance": "100.00",
    "status": "Active"
  }
}

→ Réponse (OTP invalide ou expiré) :

{
  "success": false,
  "error": "Invalid or expired OTP",
  "code": 401
}

📋 List Cards

GET/card/listAvec filtrage optionnel

curl -X GET "https://api.fradexpay.com/api/API/card/list?status=Active" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

→ Réponse :

{
  "success": true,
  "data": {
    "cards": [
      {
        "id": 55,
        "card_number": "441357****6116",
        "balance": "100.00",
        "status": "Active",
        "created_at": "2026-05-28T10:00:00Z",
        "closed_at": null
      }
    ],
    "total": 1
  }
}

⚡ Recharge Card

POST/card/recharge

curl -X POST "https://api.fradexpay.com/api/API/card/recharge" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"card_id": 55, "amount": 50}'

→ Réponse :

{
  "success": true,
  "message": "Card recharged successfully",
  "data": {
    "card_id": 55,
    "card_number": "441357****6116",
    "previous_balance": 100.00,
    "new_balance": 150.00,
    "amount_added": 50,
    "fee_charged": 5,
    "total_debited": 55
  }
}

📜 Card Transactions

GET/card/transactions

curl -X GET "https://api.fradexpay.com/api/API/card/transactions?card_id=55&page=1&limit=20" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

→ Réponse :

{
  "success": true,
  "data": {
    "card": {
      "id": 55,
      "card_number": "441357****6116",
      "balance": "150.00"
    },
    "transactions": [
      {
        "id": "txn_001",
        "type": "Authorization",
        "amount": "25.50",
        "currency": "USD",
        "merchant": "Amazon Web Services",
        "status": "Settled",
        "authorization_date": "2026-05-28T14:30:00Z",
        "settlement_date": "2026-05-28T15:00:00Z"
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 1,
      "total_pages": 1
    }
  }
}

🚫 Cancel Card

POST/card/cancel

curl -X POST "https://api.fradexpay.com/api/API/card/cancel" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"card_id": 55}'

→ Réponse :

{
  "success": true,
  "message": "Card cancellation requested successfully",
  "data": {
    "card_id": 55,
    "refund_amount": 150.00,
    "status": "Closing",
    "message": "The refund will be processed within 1-3 business days"
  }
}

Le solde restant est automatiquement remboursé sous 1 à 3 jours ouvrés.

Webhooks Production

Recevez des notifications HTTP en temps réel sur vos endpoints.

POST/webhook/registerEnregistrer un webhook

Paramètre	Type	Description
url	string	URL HTTPS qui recevra les événements
events	array	Événements : card.created, card.recharged, card.cancelled, transaction.settled, transaction.failed

curl -X POST "https://api.fradexpay.com/api/API/webhook/register" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://votre-domaine.com/webhook/fradex",
    "events": ["card.created", "card.recharged", "transaction.settled"]
  }'

→ Réponse :

{
  "success": true,
  "message": "Webhook registered successfully",
  "data": {
    "webhook_id": "wh_abc123def456",
    "url": "https://votre-domaine.com/webhook/fradex",
    "events": ["card.created", "card.recharged", "transaction.settled"],
    "created_at": "2026-05-28T10:00:00Z"
  }
}

GET/webhook/listLister les webhooks actifs

curl -X GET "https://api.fradexpay.com/api/API/webhook/list" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET"

→ Réponse :

{
  "success": true,
  "data": {
    "webhooks": [
      {
        "id": "wh_abc123def456",
        "url": "https://votre-domaine.com/webhook/fradex",
        "events": ["card.created", "card.recharged", "transaction.settled"],
        "status": "active"
      }
    ],
    "total": 1
  }
}

DELETE/webhook/deleteSupprimer un webhook

curl -X DELETE "https://api.fradexpay.com/api/API/webhook/delete" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"webhook_id": "wh_abc123def456"}'

→ Réponse :

{
  "success": true,
  "message": "Webhook deleted successfully"
}

📨 Exemple de payload reçu (card.recharged)

{
  "event": "card.recharged",
  "timestamp": "2026-05-28T14:32:10Z",
  "signature": "sha256=8a9b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0t",
  "data": {
    "card_id": 55,
    "card_number": "441357****6116",
    "previous_balance": 100.00,
    "new_balance": 150.00,
    "amount_added": 50,
    "fee_charged": 5
  }
}

Chaque webhook inclut un header X-Webhook-Signature (HMAC-SHA256) pour valider l'authenticité. Vérifiez toujours la signature avant de traiter l'événement.

Base URL (Production)

Authentification Production

📡 Codes d'erreur HTTP

🏥 Health Check

📊 Account Limits

💰 Wallet Balance

📦 Card Products

💳 Create Virtual Card

🔐 Get CVV & Expiry (OTP Flow)

📋 List Cards

⚡ Recharge Card

📜 Card Transactions

🚫 Cancel Card

Webhooks Production

📨 Exemple de payload reçu (card.recharged)