Passer au contenu principal
Cette page définit les schémas communs de requête et de réponse utilisés dans les API Payfonte.

​
Conventions de requête

Transport

Utilisez des endpoints HTTPS et des payloads JSON pour les requêtes API.

Authentification

Envoyez les en-têtes client-id et client-secret sur chaque requête.

Montants

Envoyez uniquement des montants entiers en sous-unités. Les décimales ne sont pas prises en charge.

​
En-têtes requis

client-id: <your-client-id>
client-secret: <your-client-secret>
Content-Type: application/json

​
URL de base

EnvironnementURL de base
Sandboxhttps://sandbox-api.payfonte.com
Productionhttps://api.payfonte.com

​
Structure des réponses

​
Réponses de succès, 2xx

La plupart des réponses de succès suivent ce format : 
{
  "data": {}
}
Certains endpoints de liste renvoient aussi des métadonnées de pagination : 
{
  "statusCode": 200,
  "total": 1253,
  "page": 1,
  "pages": 314,
  "limit": 4,
  "data": []
}

​
Réponses d’erreur, 4xx ou 5xx

{
  "error": "Validation failed",
  "errorCode": "ValidationError"
}
Basez toujours votre logique de traitement à la fois sur le code HTTP et sur errorCode.

​
Pagination et filtrage

Les endpoints de liste comme GET /payments/v1/checkouts et GET /billing/v1/disbursements prennent en charge :
  • page, valeur par défaut 1
  • limit, valeur par défaut 4, max 100
  • dateFrom, optionnel, format YYYY-MM-DD
  • dateTo, optionnel, format YYYY-MM-DD
Exemple : 
curl --location 'https://sandbox-api.payfonte.com/payments/v1/checkouts?page=1&limit=20&dateFrom=2025-01-01&dateTo=2025-01-31' \
  --header 'client-id: <your-client-id>' \
  --header 'client-secret: <your-client-secret>'

​
Champs de surcharge webhook

Certains endpoints autorisent une surcharge du webhook à l’échelle de la requête :
  • Les endpoints de collecte utilisent webhook
  • La demande de décaissement utilise webhookURL
Utilisez-les uniquement lorsque vous avez besoin d’un callback différent de celui défini par défaut dans le dashboard.

​
Règle de formatage des montants

Payfonte ne prend pas en charge les montants décimaux dans les requêtes API.
  • Incorrect : "amount": 1250.75
  • Correct : "amount": 125075
Voir Spécification des montants pour la règle de conversion.

​
Documentation associée

Autorisation

En-têtes requis et gestion sécurisée des identifiants.

Codes d'erreur

Dépanner les erreurs API courantes.

Référence API

Détails opération par opération et schémas.