📚 Documentation API

Intégrez QuickPayLink dans votre application

REST APIJSONOAuth 2.0

Authentification

Toutes les requêtes API doivent inclure votre clé API dans le header Authorization.

Authorization: Bearer sk_live_your_api_key_here

💡 Comment obtenir votre clé API ?
Rendez-vous dans votre Dashboard → Paramètres → API pour générer une nouvelle clé. Les clés sont liées à votre plan d'abonnement et ont des limites de requêtes différentes.

Langage:
POST/api/v1/payment/create

Créer un lien de paiement

Limites par plan:
Starter: 50 requêtes/moisBusiness: IllimitéEnterprise: Illimité + priorité

Request Body:

{
  "amount": "number",
  "currency": "string (EUR|USD|GBP)",
  "description": "string (optional)",
  "payment_methods": "array (optional) [\"stripe\", \"paypal\"]"
}

Code Example:

curl -X POST https://qpayl.com/api/v1/payment/create \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": "number",
  "currency": "string (EUR|USD|GBP)",
  "description": "string (optional)",
  "payment_methods": "array (optional) [\"stripe\", \"paypal\"]"
}'

Response:

{
  "success": true,
  "payment_code": "123456",
  "payment_url": "https://qpayl.com/pay?code=123456"
}
GET/api/v1/payment/:code

Récupérer les détails d'un paiement

Code Example:

curl -X GET https://qpayl.com/api/v1/payment/:code \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  

Response:

{
  "id": "uuid",
  "amount": 100,
  "currency": "EUR",
  "status": "pending|completed|failed",
  "created_at": "2026-02-02T10:00:00Z"
}
GET/api/v1/payments

Lister tous vos paiements

Code Example:

curl -X GET https://qpayl.com/api/v1/payments \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  

Response:

{
  "payments": [],
  "total": 150,
  "limit": 50,
  "offset": 0
}
POST/api/v1/webhook

Recevoir les notifications de paiement

Request Body:

{
  "event": "payment.completed",
  "payment_id": "uuid",
  "amount": 100,
  "currency": "EUR",
  "timestamp": "2026-02-02T10:00:00Z"
}

Code Example:

curl -X POST https://qpayl.com/api/v1/webhook \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "event": "payment.completed",
  "payment_id": "uuid",
  "amount": 100,
  "currency": "EUR",
  "timestamp": "2026-02-02T10:00:00Z"
}'

Response:

Webhooks

Configurez des webhooks pour recevoir des notifications en temps réel lorsqu'un paiement est complété, échoue, ou est remboursé.

Événements disponibles:

  • payment.completed - Paiement réussi
  • payment.failed - Paiement échoué
  • payment.refunded - Paiement remboursé
  • payment.pending - Paiement en attente

⚠️ Sécurité: Vérifiez toujours la signature du webhook avec votre secret webhook pour vous assurer que la requête provient bien de QuickPayLink.